Skip to content

doc: update versions in the tutorial #1640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
elijahgreenstein wants to merge 2 commits into
base: main
Choose a base branch
from
+20 −24
Open

doc: update versions in the tutorial #1640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1efc14
doc: update versions in tutorial
elijahgreenstein Oct 27, 2026
e498532
doc: update versions in install guide
elijahgreenstein Oct 27, 2026
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
10 changes: 3 additions & 7 deletions doc/how-to/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,17 +86,13 @@ For detailed information, refer to {ref}`reference-requirements`.
```{youtube} https://www.youtube.com/watch?v=M0y0hQ16YuE
```

Install all required {ref}`snaps <reference-requirements-software-snaps>` on each machine intended as a MicroCloud cluster member. Enter the following commands on all machines:
Install all required {ref}`snaps <reference-requirements-software-snaps>` on each machine intended as a MicroCloud cluster member. Enter the following commands on all machines to install the most recent {ref}`LTS release <ref-releases-microcloud-lts>` of MicroCloud and the {ref}`compatible releases <ref-releases-matrix>` of LXD, MicroCeph, and MicroOVN:

```{admonition} Snap channels
:class: note
The snap channels shown below install the current {ref}`feature release <ref-releases-microcloud-feature>` of MicroCloud, along with the most recent compatible releases for its components. To install the {ref}`current LTS release <ref-releases-microcloud-lts>` of MicroCloud instead, refer to the [install guide for that version](https://canonical.com/microcloud/docs/default/how-to/install/).
```

```bash
sudo snap install lxd --channel=6/stable --cohort="+"
sudo snap install microceph --channel=squid/stable --cohort="+"
sudo snap install microovn --channel=24.03/stable --cohort="+"
sudo snap install microceph --channel=tentacle/stable --cohort="+"
sudo snap install microovn --channel=26.03/stable --cohort="+"
Comment on lines -89 to +95

@elijahgreenstein elijahgreenstein Oct 27, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@roosterfish -- Since we don't have a feature release for 4, yet, I updated this to use the LTS release. This also aligns with the LXD install guide, which provides the default snap install command (sudo snap install lxd) and uses the most recent LTS as the example for changing the channel. In other words, the user has to make a conscious decision to write out the command with a feature release channel to actually get a feature release. We can revisit once we have a first feature release, but it might be prudent to follow the LXD approach and only provide example commands that install an LTS.

sudo snap install microcloud --channel=3/stable --cohort="+"
```

Expand Down
34 changes: 17 additions & 17 deletions doc/tutorial/multi-member.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This tutorial guides you through installing and initializing MicroCloud in a con
However, you should make sure that you have a storage pool set up that is big enough to store four VMs. We recommend a minimum storage pool size of 40 GiB.
```

MicroCloud requires LXD version 5.21:
The MicroCloud tutorial with virtual machines requires an installation of LXD.

1. Install `snapd`:

Expand All @@ -42,13 +42,13 @@ MicroCloud requires LXD version 5.21:
sudo apt update
sudo apt install snapd

1. If LXD is already installed, enter the following command to update it:
1. If LXD is already installed, enter the following command to update it to the most recent LTS release (LXD 6.10):

sudo snap refresh lxd --channel=5.21/stable
sudo snap refresh lxd --channel=6/stable

Otherwise, enter the following command to install LXD:
Otherwise, enter the following command to install LXD 6.10:

sudo snap install lxd
sudo snap install lxd --channel=6/stable

1. Add the current user to the `lxd` group

Expand Down Expand Up @@ -185,10 +185,10 @@ Complete the following steps:

1. Create the VMs, but don't start them yet:

lxc init ubuntu:24.04 micro1 --vm --config limits.cpu=2 --config limits.memory=2GiB -d eth0,ipv4.address=10.1.123.10 -d eth0,ipv6.address=fd42:1:1234:1234::10
lxc init ubuntu:24.04 micro2 --vm --config limits.cpu=2 --config limits.memory=2GiB -d eth0,ipv4.address=10.1.123.20 -d eth0,ipv6.address=fd42:1:1234:1234::20
lxc init ubuntu:24.04 micro3 --vm --config limits.cpu=2 --config limits.memory=2GiB -d eth0,ipv4.address=10.1.123.30 -d eth0,ipv6.address=fd42:1:1234:1234::30
lxc init ubuntu:24.04 micro4 --vm --config limits.cpu=2 --config limits.memory=2GiB -d eth0,ipv4.address=10.1.123.40 -d eth0,ipv6.address=fd42:1:1234:1234::40
lxc init ubuntu:26.04 micro1 --vm --config limits.cpu=2 --config limits.memory=2GiB -d eth0,ipv4.address=10.1.123.10 -d eth0,ipv6.address=fd42:1:1234:1234::10
lxc init ubuntu:26.04 micro2 --vm --config limits.cpu=2 --config limits.memory=2GiB -d eth0,ipv4.address=10.1.123.20 -d eth0,ipv6.address=fd42:1:1234:1234::20
lxc init ubuntu:26.04 micro3 --vm --config limits.cpu=2 --config limits.memory=2GiB -d eth0,ipv4.address=10.1.123.30 -d eth0,ipv6.address=fd42:1:1234:1234::30
lxc init ubuntu:26.04 micro4 --vm --config limits.cpu=2 --config limits.memory=2GiB -d eth0,ipv4.address=10.1.123.40 -d eth0,ipv6.address=fd42:1:1234:1234::40

```{tip}
Run these commands in sequence, not in parallel.
Expand Down Expand Up @@ -265,10 +265,10 @@ Complete the following steps on each VM (`micro1`, `micro2`, `micro3`, and `micr

1. Install the required snaps:

sudo snap install lxd --channel=5.21/stable --cohort="+"
sudo snap install microceph --channel=squid/stable --cohort="+"
sudo snap install microovn --channel=24.03/stable --cohort="+"
sudo snap install microcloud --channel=2/stable --cohort="+"
sudo snap install lxd --channel=6/stable --cohort="+"
sudo snap install microceph --channel=tentacle/stable --cohort="+"
sudo snap install microovn --channel=26.03/stable --cohort="+"
sudo snap install microcloud --channel=3/stable --cohort="+"

```{note}
The `--cohort="+"` flag in the command ensures that the same version of the snap is installed on all machines.
Expand Down Expand Up @@ -798,15 +798,15 @@ Now that your MicroCloud cluster is ready to use, let's launch a few instances:

1. Launch an Ubuntu container with the default settings:

lxc launch ubuntu:24.04 u1
lxc launch ubuntu:26.04 u1

1. Launch another Ubuntu container, but use local storage instead of the default remote storage:

lxc launch ubuntu:24.04 u2 --storage local
lxc launch ubuntu:26.04 u2 --storage local

1. Launch an Ubuntu VM:

lxc launch ubuntu:24.04 u3 --vm
lxc launch ubuntu:26.04 u3 --vm

1. Check the list of instances.
Note that the instances are running on different cluster members.
Expand Down Expand Up @@ -1023,7 +1023,7 @@ You can, however, create a different network to isolate some instances from othe

1. Launch an Ubuntu container that uses the new network:

lxc launch ubuntu:24.04 u4 --network isolated
lxc launch ubuntu:26.04 u4 --network isolated

1. Access the shell in `u4`:

Expand Down
Loading