Merge pull request #241 from ru-fu/small-doc-updates

Various small doc updates

doc/.custom_wordlist.txt

@@ -4,6 +4,7 @@ AGPL
 backend
 balancers
 Ceph
+Ceph's
 CIDR
 DCO
 DHCP
@@ -12,6 +13,7 @@ GiB
 IOV
 IPv
 LXD
+LXD's
 mDNS
 MicroCeph
 MicroCloud

doc/custom_conf.py

@@ -55,7 +55,7 @@
 html_context = {
 
     # Change to the link to your product website (without "https://")
-    'product_page': 'microcloud.is',
+    'product_page': 'canonical.com/microcloud',
 
     # Add your product tag to ".sphinx/_static" and change the path
     # here (start with "_static"), default is the circle of friends
@@ -170,5 +170,6 @@
 ## Add any configuration that is not covered by the common conf.py file.
 
 intersphinx_mapping = {
-    'lxd': ('https://documentation.ubuntu.com/lxd/en/latest/', None)
+    'lxd': ('https://documentation.ubuntu.com/lxd/en/latest/', None),
+    'ceph': ('https://docs.ceph.com/en/latest/', None)
 }

doc/how-to/install.rst

@@ -5,9 +5,12 @@ How to install MicroCloud
 
 To install MicroCloud, install all required :ref:`snaps` on all machines that you want to include in your cluster.
 
-To do so, enter the following command on all machines::
+To do so, enter the following commands on all machines::
 
-  sudo snap install lxd microceph microovn microcloud --cohort="+"
+  sudo snap install lxd --cohort="+"
+  sudo snap install microceph --cohort="+"
+  sudo snap install microovn --cohort="+"
+  sudo snap install microcloud --cohort="+"
 
 .. note::
    Make sure to install the same version of the snaps on all machines.

doc/how-to/snaps.rst

@@ -66,7 +66,10 @@ Enter the following command to indefinitely hold all updates to the snaps needed
 When you choose to update your installation, use the following commands to remove the hold, update the snaps, and hold the updates again::
 
   sudo snap refresh --unhold lxd microceph microovn microcloud
-  sudo snap refresh lxd microceph microovn microcloud --cohort="+"
+  sudo snap refresh lxd --cohort="+"
+  sudo snap refresh microceph --cohort="+"
+  sudo snap refresh microovn --cohort="+"
+  sudo snap refresh microcloud --cohort="+"
   sudo snap refresh --hold lxd microceph microovn microcloud
 
 See `Hold refreshes`_ in the snap documentation for detailed information about holding snap updates.
@@ -101,7 +104,10 @@ This method can cause a problem for cluster updates if some cluster members are
 
 To avoid this problem, use the ``--cohort="+"`` flag when refreshing your snaps::
 
-  sudo snap refresh lxd microceph microovn microcloud --cohort="+"
+  sudo snap refresh lxd --cohort="+"
+  sudo snap refresh microceph --cohort="+"
+  sudo snap refresh microovn --cohort="+"
+  sudo snap refresh microcloud --cohort="+"
 
 This flag ensures that all machines in a cluster see the same snap revision and are therefore not affected by a progressive rollout.
 

doc/reference/index.rst

@@ -28,6 +28,8 @@ If you want to add further machines after the initial initialisation, you can us
 To use local storage, each machine requires a local disk.
 To use distributed storage, at least three additional disks (not only partitions) for use by Ceph are required, and these disks must be on at least three different machines.
 
+Also see Ceph's :ref:`ceph:hardware-recommendations`.
+
 Networking requirements
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -41,6 +43,8 @@ Software requirements
 
 MicroCloud requires snapd version 2.59 or newer.
 
+Also see LXD's :ref:`lxd:requirements` and Ceph's :doc:`ceph:start/os-recommendations`.
+
 .. _snaps:
 
 Snaps

doc/tutorial/get_started.rst

@@ -220,7 +220,9 @@ Complete the following steps on each VM (``micro1``, ``micro2``, ``micro3``, and
 
 #. Install the required snaps::
 
-     snap install microceph microovn microcloud --cohort="+"
+     snap install microceph --cohort="+"
+     snap install microovn --cohort="+"
+     snap install microcloud --cohort="+"
 
    .. note::
       The ``--cohort="+"`` flag in the command ensures that the same version of the snap is installed on all machines.
@@ -839,7 +841,7 @@ You can, however, create a different network to isolate some instances from othe
 
 #.  Launch an Ubuntu container that uses the new network::
 
-     lxc launch images:ubuntu/22.04 u4 --network isolated
+     lxc launch ubuntu:22.04 u4 --network isolated
 
 #. Access the shell in ``u4``::