From 6d35e1ca8ebcc1d6626db7a2300835cc5519e7d7 Mon Sep 17 00:00:00 2001 From: Max Asnaashari Date: Tue, 23 Jul 2024 18:15:44 +0000 Subject: [PATCH] doc/how-to: Add service add/list docs Signed-off-by: Max Asnaashari --- doc/how-to/add_service.md | 46 +++++++++++++++++++++++++++++++++++++++ doc/how-to/commands.md | 5 ++++- doc/how-to/index.md | 1 + 3 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 doc/how-to/add_service.md diff --git a/doc/how-to/add_service.md b/doc/how-to/add_service.md new file mode 100644 index 000000000..936cd9c60 --- /dev/null +++ b/doc/how-to/add_service.md @@ -0,0 +1,46 @@ +(howto-add-service)= +# How to add a service + +If you set up the MicroCloud without MicroOVN or MicroCeph initially, you can add those services with the {command}`microcloud service add` command: + + sudo microcloud service add + +If MicroCloud detects a service is installed but not set up, it will ask to configure the service. + +To add MicroCeph: + + ```{note} + To set up distributed storage, you need at least three additional disks on at least three different machines. + The disks must not contain any partitions. + ``` + +1. Select `yes` to set up distributed storage. + + 1. Select the disks that you want to use for distributed storage. + You must select at least three disks. + + 1. Select whether you want to wipe any of the disks. + Wiping a disk will destroy all data on it. + + 1. You can choose to optionally encrypt the chosen disks. + + 1. You can choose to optionally set up a CephFS distributed file system. + + 1. Select either an IPv4 or IPv6 CIDR subnet for the Ceph internal traffic. You can leave it empty to use the default value, which is the MicroCloud internal network (see {ref}`howto-ceph-networking` for how to configure it). + +To add MicroOVN: + +1. Select `yes` to set up distributed networking. + + 1. Select the network interfaces that you want to use (see {ref}`microcloud-networking-uplink`). + You must select one network interface per machine. + + 1. If you want to use IPv4, specify the IPv4 gateway on the uplink network (in CIDR notation) and the first and last IPv4 address in the range that you want to use with LXD. + + 1. If you want to use IPv6, specify the IPv6 gateway on the uplink network (in CIDR notation). + +MicroCloud now starts to bootstrap the cluster for only the new services. + +Monitor the output to see whether all steps complete successfully. + +See {ref}`bootstrapping-process` for more information. diff --git a/doc/how-to/commands.md b/doc/how-to/commands.md index 5cfae791e..97caafbc9 100644 --- a/doc/how-to/commands.md +++ b/doc/how-to/commands.md @@ -260,7 +260,10 @@ See {ref}`lxd:cluster-manage-instance` and {ref}`lxd:cluster-evacuate`. ```{list-table} :widths: 2 3 - * - Inspect the cluster status + * - Inspect the cluster status for all services at once + - :command:`microcloud service list` + + * - Inspect the cluster status for each service - {command}`microcloud cluster list` {command}`lxc cluster list` diff --git a/doc/how-to/index.md b/doc/how-to/index.md index 77c18d828..b6270e9f4 100644 --- a/doc/how-to/index.md +++ b/doc/how-to/index.md @@ -12,6 +12,7 @@ Initialise MicroCloud Configure Ceph networking Add a machine Remove a machine +Add a service Get support Contribute to MicroCloud Work with MicroCloud