Merge "Add storage backend configuration instructions"

doc/source/deploy_install_guides/r4_release/bare_metal/aio_duplex_install_kubernetes.rst

@@ -160,12 +160,26 @@ Configure controller-0
      system interface-network-assign controller-0 $MGMT_IF mgmt
      system interface-network-assign controller-0 $MGMT_IF cluster-host
 
-#. Configure NTP Servers for network time synchronization:
+#. Configure NTP servers for network time synchronization:
 
    ::
 
      system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org
 
+#. Configure Ceph storage backend
+
+   .. important::
+
+      This step is required only if your application requires
+      persistent storage.
+
+      **If you want to install the StarlingX Openstack application
+      (stx-openstack) this step is mandatory.**
+
+   ::
+
+    system storage-backend-add ceph --confirmed
+
 #. Configure data interfaces for controller-0. Use the DATA port names, for example
    eth0, applicable to your deployment environment.
 
@@ -225,6 +239,10 @@ Configure controller-0
 #. Add an OSD on controller-0 for Ceph. The following example adds an OSD
    to the `sdb` disk:
 
+   .. important::
+
+      This step requires a configured Ceph storage backend
+
    ::
 
       echo ">>> Add OSDs to primary tier"
@@ -370,6 +388,10 @@ Configure controller-1
 
 #. Add an OSD on controller-1 for Ceph:
 
+   .. important::
+
+      This step requires a configured Ceph storage backend
+
    ::
 
       echo ">>> Add OSDs to primary tier"

doc/source/deploy_install_guides/r4_release/bare_metal/aio_simplex_install_kubernetes.rst

@@ -167,12 +167,26 @@ Configure controller-0
      system host-if-modify controller-0 $OAM_IF -c platform
      system interface-network-assign controller-0 $OAM_IF oam
 
-#. Configure NTP Servers for network time synchronization:
+#. Configure NTP servers for network time synchronization:
 
    ::
 
       system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org
 
+#. Configure Ceph storage backend
+
+   .. important::
+
+      This step required only if your application requires
+      persistent storage.
+
+      **If you want to install the StarlingX Openstack application
+      (stx-openstack) this step is mandatory.**
+
+   ::
+
+    system storage-backend-add ceph --confirmed
+
 #. Configure data interfaces for controller-0. Use the DATA port names, for example
    eth0, applicable to your deployment environment.
 
@@ -232,6 +246,10 @@ Configure controller-0
 #. Add an OSD on controller-0 for Ceph. The following example adds an OSD
    to the `sdb` disk:
 
+   .. important::
+
+      This step requires a configured Ceph storage backend
+
    ::
 
      echo ">>> Add OSDs to primary tier"

doc/source/deploy_install_guides/r4_release/bare_metal/controller_storage_install_kubernetes.rst

@@ -187,12 +187,26 @@ Configure controller-0
   	 system interface-network-assign controller-0 $MGMT_IF mgmt
   	 system interface-network-assign controller-0 $MGMT_IF cluster-host
 
-#. Configure NTP Servers for network time synchronization:
+#. Configure NTP servers for network time synchronization:
 
    ::
 
    	 system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org
 
+#. Configure Ceph storage backend
+
+   .. important::
+
+      This step required only if your application requires
+      persistent storage.
+
+      **If you want to install the StarlingX Openstack application
+      (stx-openstack) this step is mandatory.**
+
+   ::
+
+    system storage-backend-add ceph --confirmed
+
 *************************************
 OpenStack-specific host configuration
 *************************************
@@ -553,6 +567,10 @@ Add Ceph OSDs to controllers
 
 #. Add OSDs to controller-0. The following example adds OSDs to the `sdb` disk:
 
+   .. important::
+
+      This step requires a configured Ceph storage backend
+
    ::
 
 	 HOST=controller-0
@@ -568,6 +586,10 @@ Add Ceph OSDs to controllers
 
 #. Add OSDs to controller-1. The following example adds OSDs to the `sdb` disk:
 
+   .. important::
+
+      This step requires a configured Ceph storage backend
+
    ::
 
 	 HOST=controller-1

doc/source/deploy_install_guides/r4_release/bare_metal/dedicated_storage_install_kubernetes.rst

@@ -45,6 +45,12 @@ Configure controller-0
 Unlock controller-0
 -------------------
 
+   .. important::
+
+      Make sure the Ceph storage backend is configured. If it is
+      not configured, you will not be able to configure storage
+      nodes.
+
 Unlock controller-0 in order to bring it into service:
 
 ::

doc/source/deploy_install_guides/r4_release/virtual/aio_duplex_install_kubernetes.rst

@@ -163,7 +163,7 @@ On virtual controller-0:
       system interface-network-assign controller-0 $MGMT_IF mgmt
       system interface-network-assign controller-0 $MGMT_IF cluster-host
 
-#. Configure NTP Servers for network time synchronization:
+#. Configure NTP servers for network time synchronization:
 
    .. note::
 
@@ -175,6 +175,20 @@ On virtual controller-0:
 
       system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org
 
+#. Configure Ceph storage backend
+
+   .. important::
+
+      This step required only if your application requires
+      persistent storage.
+
+      **If you want to install the StarlingX Openstack application
+      (stx-openstack) this step is mandatory.**
+
+   ::
+
+    system storage-backend-add ceph --confirmed
+
 #. Configure data interfaces for controller-0.
 
    .. important::
@@ -218,6 +232,10 @@ On virtual controller-0:
 
 #. Add an OSD on controller-0 for Ceph:
 
+   .. important::
+
+      This step requires a configured Ceph storage backend
+
    ::
 
       system host-disk-list controller-0
@@ -359,6 +377,10 @@ On virtual controller-0:
 
 #. Add an OSD on controller-1 for Ceph:
 
+   .. important::
+
+      This step requires a configured Ceph storage backend
+
    ::
 
     echo ">>> Add OSDs to primary tier"

doc/source/deploy_install_guides/r4_release/virtual/aio_simplex_install_kubernetes.rst

@@ -13,7 +13,8 @@ on a **StarlingX R4.0 virtual All-in-one Simplex** deployment configuration.
 Install software on controller-0
 --------------------------------
 
-In the last step of :doc:`aio_simplex_environ`, the controller-0 virtual server 'simplex-controller-0' was started by the :command:`setup_configuration.sh` command.
+In the last step of :doc:`aio_simplex_environ`, the controller-0 virtual server 'simplex-controller-0'
+was started by the :command:`setup_configuration.sh` command.
 
 On the host, attach to the console of virtual controller-0 and select the
 appropriate installer menu options to start the non-interactive install of
@@ -153,7 +154,7 @@ On virtual controller-0:
      system host-if-modify controller-0 $OAM_IF -c platform
      system interface-network-assign controller-0 $OAM_IF oam
 
-#. Configure NTP Servers for network time synchronization:
+#. Configure NTP servers for network time synchronization:
 
    .. note::
 
@@ -165,6 +166,20 @@ On virtual controller-0:
 
     system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org
 
+#. Configure Ceph storage backend
+
+   .. important::
+
+      This step required only if your application requires
+      persistent storage.
+
+      **If you want to install the StarlingX Openstack application
+      (stx-openstack) this step is mandatory.**
+
+   ::
+
+    system storage-backend-add ceph --confirmed
+
 #. Configure data interfaces for controller-0.
 
    .. important::
@@ -208,6 +223,10 @@ On virtual controller-0:
 
 #. Add an OSD on controller-0 for Ceph:
 
+   .. important::
+
+      This step requires a configured Ceph storage backend
+
    ::
 
     system host-disk-list controller-0
@@ -282,4 +301,4 @@ service. This can take 5-10 minutes, depending on the performance of the host ma
 Next steps
 ----------
 
-.. include:: ../kubernetes_install_next.txt
+.. include:: ../kubernetes_install_next.txt

doc/source/deploy_install_guides/r4_release/virtual/controller_storage_install_kubernetes.rst

@@ -172,7 +172,7 @@ On virtual controller-0:
       system interface-network-assign controller-0 $MGMT_IF mgmt
       system interface-network-assign controller-0 $MGMT_IF cluster-host
 
-#. Configure NTP Servers for network time synchronization:
+#. Configure NTP servers for network time synchronization:
 
    .. note::
 
@@ -184,6 +184,20 @@ On virtual controller-0:
 
       system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org
 
+#. Configure Ceph storage backend
+
+   .. important::
+
+      This step required only if your application requires
+      persistent storage.
+
+      **If you want to install the StarlingX Openstack application
+      (stx-openstack) this step is mandatory.**
+
+   ::
+
+    system storage-backend-add ceph --confirmed
+
 *************************************
 OpenStack-specific host configuration
 *************************************
@@ -516,6 +530,10 @@ On virtual controller-0:
 
 #. Add OSDs to controller-0:
 
+   .. important::
+
+      This step requires a configured Ceph storage backend
+
    ::
 
       HOST=controller-0
@@ -531,6 +549,10 @@ On virtual controller-0:
 
 #. Add OSDs to controller-1:
 
+   .. important::
+
+      This step requires a configured Ceph storage backend
+
    ::
 
       HOST=controller-1

doc/source/deploy_install_guides/r4_release/virtual/dedicated_storage_install_kubernetes.rst

@@ -62,6 +62,12 @@ Configure controller-0
 Unlock controller-0
 -------------------
 
+    .. important::
+
+       Make sure the Ceph storage backend is configured. If it is
+       not configured, you will not be able to configure storage
+       nodes.
+
 Unlock virtual controller-0 in order to bring it into service:
 
 ::