Skip to content

Commit

Permalink
doc/how-to: Add service add/list docs
Browse files Browse the repository at this point in the history
Signed-off-by: Max Asnaashari <[email protected]>
  • Loading branch information
masnax committed Jul 25, 2024
1 parent f2d2c2f commit 6d35e1c
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 1 deletion.
46 changes: 46 additions & 0 deletions doc/how-to/add_service.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 4 additions & 1 deletion doc/how-to/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
1 change: 1 addition & 0 deletions doc/how-to/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Initialise MicroCloud </how-to/initialise>
Configure Ceph networking </how-to/ceph_networking>
Add a machine </how-to/add_machine>
Remove a machine </how-to/remove_machine>
Add a service </how-to/add_service>
Get support </how-to/support>
Contribute to MicroCloud </how-to/contribute>
Work with MicroCloud </how-to/commands>
Expand Down

0 comments on commit 6d35e1c

Please sign in to comment.