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
2 changes: 1 addition & 1 deletion doc/explanation/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
myst:
html_meta:
description: Deep-dive explanations that introduce you to concepts in MicroCloud, such as its networking approach and local versus distributed storage.
description: An index of explanations about MicroCloud concepts, such as its relationship to LXD, Ceph, and OVN and its approach to networking, storage, and security.
---

(explanation)=
Expand Down
41 changes: 19 additions & 22 deletions doc/how-to/index.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
---
myst:
html_meta:
description: How-to guides for key MicroCloud operations, including installation, initialization, UI access, configuration, cluster management, updates, and more.
description: An index of how-to guides for key MicroCloud operations, including installation, initialization, UI access, configuration, management, and updates.
---

(howto)=
# How-to guides

These MicroCloud how-to guides cover key operations and processes.

## Initial setup
## Set up and deploy

Follow these guides to install MicroCloud in a testing or production environment
and initialize MicroCloud through interactive or automated configuration
processes. You can also set up access to the MicroCloud UI.
MicroCloud can be installed in testing or production environments and
initialized interactively or through an automated process. Once deployed, the
MicroCloud UI provides an interface alongside the {ref}`MicroCloud CLI
<ref-commands>`.

```{toctree}
:maxdepth: 1
Expand All @@ -23,10 +24,19 @@ Initialize MicroCloud </how-to/initialize>
Access the UI </how-to/ui>
```

Terraform makes it possible to automate the MicroCloud deployment process.

```{toctree}
:maxdepth: 1

Deploy a MicroCloud test environment with Terraform </how-to/terraform_automation>
```

## Configure services

You can configure storage with MicroCeph and networking with MicroOVN during the
initialization process, or you can add a service later.
MicroCeph and MicroOVN make it possible to configure storage and networking to
meet your needs. Configure these services during a MicroCloud initialization, or
add a service later.

```{toctree}
:maxdepth: 1
Expand All @@ -38,8 +48,8 @@ Add a service </how-to/add_service>

## Manage clusters and cluster members

As your needs change, follow these steps to manage your clusters and cluster
members and keep your deployment up to date.
As your needs change, manage clusters and cluster members to keep your
deployment up to date.

```{toctree}
:maxdepth: 1
Expand All @@ -51,21 +61,8 @@ Update and upgrade </how-to/update_upgrade>
Manage the snaps </how-to/snaps>
```

## Automated deployment with Terraform

Follow this guide to automate the deployment of MicroCloud with Terraform.

```{toctree}
:maxdepth: 1

Deploy a MicroCloud test environment with Terraform </how-to/terraform_automation>
```

## Engage with us

Find out how to get community and commercial support, and learn how to
contribute to the MicroCloud project.

```{toctree}
:maxdepth: 1

Expand Down
28 changes: 13 additions & 15 deletions doc/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,14 @@
---
myst:
html_meta:
description: Reference guides for MicroCloud such as deployment requirements, releases and snaps details, and the architecture of the MicroCloud Cluster Manager.
description: An index of MicroCloud reference guides covering the Cluster Manager architecture, CLI commands, deployment requirements, releases, and snap details.
---

(reference)=
# Reference

This section provides technical reference guides for MicroCloud.

## Requirements and releases

Find out about requirements for a MicroCloud deployment, as well as information
about its release cycles, release types, and snaps.

```{toctree}
:maxdepth: 1
MicroCloud requirements </reference/requirements>
/reference/releases-snaps
/reference/release-notes/index
```

## MicroCloud Cluster Manager

Consult these pages for information about the system architecture and API of the
Expand All @@ -29,16 +17,26 @@ clusters.

```{toctree}
:maxdepth: 1

Cluster Manager architecture </reference/cluster-manager-architecture>
/reference/cluster-manager-api
```

## Commands

Use this command reference to perform common MicroCloud operations through the
CLI.
Consult this command reference to work with MicroCloud through the CLI.

```{toctree}
:maxdepth: 1

/reference/commands
```
## Requirements and releases

```{toctree}
:maxdepth: 1

MicroCloud requirements </reference/requirements>
/reference/releases-snaps
/reference/release-notes/index
```
2 changes: 1 addition & 1 deletion doc/tutorial/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
myst:
html_meta:
description: Hands-on tutorials to install, initialize, and try out test deployments of MicroCloud, on a single physical machine or multiple virtual machines.
description: An index to hands-on tutorials to install, initialize, and try out test deployments of MicroCloud, on a single physical machine or multiple virtual machines.
---

(get-started)=
Expand Down
Loading