Skip to content

Commit

Permalink
Merge pull request #273 from ru-fu/LXD-913-tutorial-updates
Browse files Browse the repository at this point in the history
Doc: tutorial updates
  • Loading branch information
masnax authored Apr 4, 2024
2 parents 306018d + e0d95c6 commit 376c00b
Show file tree
Hide file tree
Showing 6 changed files with 76 additions and 3 deletions.
2 changes: 1 addition & 1 deletion doc/how-to/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ To install MicroCloud, install all required :ref:`snaps` on all machines that yo

To do so, enter the following commands on all machines::

sudo snap install lxd --channel=latest/stable --cohort="+"
sudo snap install lxd --channel=5.21/stable --cohort="+"
sudo snap install microceph --channel=quincy/stable --cohort="+"
sudo snap install microovn --channel=22.03/stable --cohort="+"
sudo snap install microcloud --channel=latest/stable --cohort="+"
Expand Down
2 changes: 1 addition & 1 deletion doc/how-to/support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ How to get support
We recommend using the following channels for the snaps required to run MicroCloud:

* For MicroCloud: ``latest/[stable|candidate|edge]``
* For LXD: ``latest/[stable|candidate|edge]``
* For LXD: ``5.21/[stable|candidate|edge]``
* For MicroCeph: ``quincy/[stable|candidate|edge]``
* For MicroOVN: ``22.03/[stable|candidate|edge]``

Expand Down
Binary file added doc/images/ui_certificate_selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/ui_instances.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/ui_security_warning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
75 changes: 74 additions & 1 deletion doc/tutorial/get_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ Complete the following steps on each VM (``micro1``, ``micro2``, ``micro3``, and
#. The LXD snap is already installed.
Refresh it to the latest version::

snap refresh lxd --channel=latest/stable --cohort="+"
snap refresh lxd --channel=5.21/stable --cohort="+"

6. Initialise MicroCloud
------------------------
Expand Down Expand Up @@ -891,3 +891,76 @@ You can, however, create a different network to isolate some instances from othe
14 packets transmitted, 0 received, 100% packet loss, time 13301ms

You will see that ``u2`` is not reachable, because it is on a different OVN subnet.

10. Access the UI
-----------------

Instead of managing your instances and your LXD setup from the command line, you can also use the LXD UI.
See :ref:`lxd:access-ui` for more information.

1. Check the LXD cluster list to determine the IP addresses of the cluster members:

.. terminal::
:input: lxc cluster list
:user: root
:host: micro1
:scroll:

+--------+----------------------------+------------------+--------------+----------------+-------------+--------+-------------------+
| NAME | URL | ROLES | ARCHITECTURE | FAILURE DOMAIN | DESCRIPTION | STATE | MESSAGE |
+--------+----------------------------+------------------+--------------+----------------+-------------+--------+-------------------+
| micro1 | https://203.0.113.169:8443 | database-leader | x86_64 | default | | ONLINE | Fully operational |
| | | database | | | | | |
+--------+----------------------------+------------------+--------------+----------------+-------------+--------+-------------------+
| micro2 | https://203.0.113.170:8443 | database | x86_64 | default | | ONLINE | Fully operational |
+--------+----------------------------+------------------+--------------+----------------+-------------+--------+-------------------+
| micro3 | https://203.0.113.171:8443 | database | x86_64 | default | | ONLINE | Fully operational |
+--------+----------------------------+------------------+--------------+----------------+-------------+--------+-------------------+
| micro4 | https://203.0.113.172:8443 | database-standby | x86_64 | default | | ONLINE | Fully operational |
+--------+----------------------------+------------------+--------------+----------------+-------------+--------+-------------------+

#. In your web browser, navigate to the URL of one of the machines.
For example, for ``micro1``, navigate to ``https://203.0.113.169:8443``.

#. By default, MicroCloud uses a self-signed certificate, which will cause a security warning in your browser.
Use your browser’s mechanism to continue despite the security warning.

.. figure:: /images/ui_security_warning.png
:alt: Example for a security warning in Chrome

Example for a security warning in Chrome

#. You should now see the LXD UI, prompting you to set up a certificate.

.. figure:: /images/ui_certificate_selection.png
:alt: Certificate selection in the LXD UI

Certificate selection in the LXD UI

Follow the instructions in the UI to set up the certificates.

.. note::
Since LXD 5.21, the LXD UI is enabled by default.

If you don't see the certificate screen, you might have an older version of LXD (run ``snap info lxd`` to check).
In this case, run the following commands on the machine that you're trying to access (for example, ``micro1``) to enable the UI::

snap set lxd ui.enable=true
systemctl reload snap.lxd.daemon

#. You can now browse the UI and inspect, for example, the instances you created and the networks and storage that MicroCloud set up.

.. figure:: /images/ui_instances.png
:alt: Instances view in the LXD UI

Instances view in the LXD UI

Next steps
----------

Now that your MicroCloud is up and running, you can start using it!

If you're already familiar with LXD, see :ref:`howto-commands` for a reference of the most common commands.

If you're new to LXD, check out the :ref:`lxd:first-steps` tutorial to familiarise yourself with what you can do in LXD.
You can skip the first section about installing and initialising LXD, because LXD is already operational as part of your MicroCloud setup.

0 comments on commit 376c00b

Please sign in to comment.