Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/explanation/microcloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ You can also manage MicroCloud through the {ref}`command line <ref-commands>` or

MicroCloud is designed to be replicable at scale, enabling you to create consistent environments across multiple sites or clusters. All configuration performed during initialization can be captured in a {ref}`preseed file <howto-initialize-preseed>` to reproduce the deployment. This allows you to deploy identical MicroCloud clusters with minimal manual input.

Once deployed, each MicroCloud component (LXD, MicroCeph, MicroOVN) is designed to scale horizontally, meaning you can add more machines to increase capacity, performance, and redundancy. When new cluster members are added, these components automatically integrate them as control plane, storage, and networking peers without requiring manual reconfiguration. This includes {doc}`automatic failure domain adjustment <microceph:explanation/cluster-scaling>` for MicroCeph.
Once deployed, each MicroCloud component (LXD, MicroCeph, MicroOVN) is designed to scale horizontally, meaning you can add more machines to increase capacity, performance, and redundancy. When new cluster members are added, these components automatically integrate them as control plane, storage, and networking peers without requiring manual reconfiguration. This includes {doc}`automatic failure domain adjustment <microceph:snap/explanation/cluster-scaling>` for MicroCeph.

Furthermore, MicroCloud's snap-based updates help keep deployments consistent at scale. By updating cluster members to the latest version available on the LTS snap channel, you can ensure that all machines are using the same version with the latest security updates and bugfixes. Refer to {ref}`ref-releases-snaps` to learn more.

Expand All @@ -75,7 +75,7 @@ MicroCloud achieves high availability (HA) through its distributed architecture:

LXD provides control plane HA by allowing each cluster member to manage the cluster. If one member goes down, another can serve requests in its place. For data plane HA, LXD also provides automatic {ref}`cluster healing <lxd:cluster-healing>`. For more information, refer to the LXD documentation on {ref}`lxd:clusters-high-availability`.

Using distributed storage with MicroCeph means that data is replicated across the cluster, so even if one member goes offline, its data remains available on others. Ceph's {doc}`Controlled Replication Under Scalable Hashing (CRUSH) algorithm <ceph:rados/operations/crush-map>` automatically redistributes data when parts of the system fail, maintaining availability. For more information, refer to the {ref}`MicroCloud storage requirements for high availability <reference-requirements-storage-ha>` and the {doc}`MicroCeph documentation on its failure domain management <microceph:explanation/cluster-scaling>`.
Using distributed storage with MicroCeph means that data is replicated across the cluster, so even if one member goes offline, its data remains available on others. Ceph's {doc}`Controlled Replication Under Scalable Hashing (CRUSH) algorithm <ceph:rados/operations/crush-map>` automatically redistributes data when parts of the system fail, maintaining availability. For more information, refer to the {ref}`MicroCloud storage requirements for high availability <reference-requirements-storage-ha>` and the {doc}`MicroCeph documentation on its failure domain management <microceph:snap/explanation/cluster-scaling>`.

MicroOVN brings a distributed overlay network, meaning that switching and routing functions are not centralized on any single cluster member. Each member hosts its own virtual switch, avoiding a single point of failure for internal, intra-cluster traffic: every member can continue forwarding packets even if others are offline. External connectivity relies on a virtual router that is active on one member at a time; if that member fails, another takes over to keep uplink connectivity available. For more information, refer to {ref}`exp-networking-ovn`.

Expand Down
2 changes: 1 addition & 1 deletion doc/explanation/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ For details on LXD’s security architecture and operational guidance, see the {
(exp-security-microceph)=
## MicroCeph

The {doc}`MicroCeph security documentation <microceph:explanation/security/security-overview>` provides information on encryption, authentication, best practices for secure deployment and operation, and more.
The {doc}`MicroCeph security documentation <microceph:snap/explanation/security/security-overview>` provides information on encryption, authentication, best practices for secure deployment and operation, and more.

(exp-security-microovn)=
## MicroOVN
Expand Down
4 changes: 2 additions & 2 deletions doc/how-to/initialize.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You run the initialization on one of the machines, and it configures the require
## Pre-initialization requirements

- Complete the steps in {ref}`howto-install` before initialization.
- If you intend to use full disk encryption (FDE) on any cluster member, that member must meet the prerequisites listed on this page: {doc}`microceph:explanation/security/about-fde`.
- If you intend to use full disk encryption (FDE) on any cluster member, that member must meet the prerequisites listed on this page: {doc}`microceph:snap/explanation/security/about-fde`.
- Follow only the instructions in the Prerequisites section on that page. Skip its Usage section; the MicroCloud initialization process handles the disk encryption.

(howto-initialize-interactive)=
Expand Down Expand Up @@ -97,7 +97,7 @@ Complete the following steps to initialize MicroCloud:
Encrypting a disk will store the encryption keys in the Ceph key ring inside the Ceph configuration folder.

```{warning}
Cluster members with disks to be encrypted require a kernel with `dm-crypt` enabled. The snap `dm-crypt` plug must also be connected. See the Prerequisites section of this page for more information: {doc}`microceph:explanation/security/about-fde`.
Cluster members with disks to be encrypted require a kernel with `dm-crypt` enabled. The snap `dm-crypt` plug must also be connected. See the Prerequisites section of this page for more information: {doc}`microceph:snap/explanation/security/about-fde`.

If you have not enabled and connected `dm-crypt` on any cluster member that you want to encrypt, do so now before you continue.

Expand Down
2 changes: 1 addition & 1 deletion doc/how-to/member_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sudo microcloud remove <name>
Before removing the cluster member, ensure that there are no LXD instances, storage volumes, or MicroCeph OSDs located on it.

See {ref}`how to remove instances <lxd:instances-manage-delete>` in the LXD documentation.
See {doc}`how to remove OSDs <microceph:how-to/remove-disk>` in the MicroCeph documentation.
See {doc}`how to remove OSDs <microceph:snap/how-to/remove-disk>` in the MicroCeph documentation.

````{note}
If local storage was created, MicroCloud will have also added some default storage volumes that will need to be cleaned up:
Expand Down
4 changes: 2 additions & 2 deletions doc/how-to/update_upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Performing an update or upgrade requires going through the list of snaps one aft
Before performing an update or upgrade, make sure to back up your data to prevent any data loss in case of failure.
Consult the following backup guides for each of the snaps:

* {doc}`How to back up MicroCeph <microceph:explanation/taking-snapshots>`
* {doc}`How to back up MicroCeph <microceph:snap/explanation/taking-snapshots>`
* {ref}`How to back up LXD <lxd:backups>`

In case of error, refer to {ref}`howto-recover` for troubleshooting details.
Expand Down Expand Up @@ -199,7 +199,7 @@ As MicroCloud consumes the services offered by its component snaps, the upgrade

Make sure to consult the dedicated upgrade guides of each component before you perform the actual upgrade:

* {doc}`How to upgrade MicroCeph <microceph:how-to/major-upgrade>`
* {doc}`How to upgrade MicroCeph <microceph:snap/how-to/major-upgrade>`
* {doc}`How to upgrade MicroOVN <microovn:how-to/major-upgrades>`
* {doc}`How to upgrade LXD <lxd:howto/cluster_manage>`

Expand Down
2 changes: 1 addition & 1 deletion doc/reference/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ MicroCloud 2.1.0 LTS <https://discourse.ubuntu.com/t/microcloud-2-1-0-lts-has-be
## Release notes for MicroCloud components

- {ref}`LXD release notes <lxd:ref-release-notes>`
- {doc}`MicroCeph release notes <microceph:reference/release-notes>`
- {doc}`MicroCeph release notes <microceph:snap/reference/release-notes>`

MicroOVN does not yet publish release notes.

Expand Down
2 changes: 1 addition & 1 deletion doc/reference/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ For production environments, we recommend at least 3 NVMe disks per cluster memb

If you intend to use full disk encryption on any cluster member, the `dm-crypt` kernel module must be available, and the snap `dm-crypt` plug must be connected to MicroCeph. The `dm-crypt` module is available by default in Ubuntu 24.04 and higher.

For further information, see the Prerequisites section of this page: {doc}`microceph:explanation/security/about-fde`. Note that the command shown on that page to connect the snap `dm-crypt` plug can only be performed once MicroCeph is installed. The MicroCloud installation steps include installing MicroCeph; thus, {ref}`install MicroCloud first<howto-install>`, then connect the plug.
For further information, see the Prerequisites section of this page: {doc}`microceph:snap/explanation/security/about-fde`. Note that the command shown on that page to connect the snap `dm-crypt` plug can only be performed once MicroCeph is installed. The MicroCloud installation steps include installing MicroCeph; thus, {ref}`install MicroCloud first<howto-install>`, then connect the plug.

(reference-requirements-network)=
## Networking requirements
Expand Down
Loading