[Doc] XML Server Definition

Align installation guides input and outputs of scripts dedicated to the
creation of StarlingX configurations under stx-tools repository:

- Dedicated Storage
- Controller Storage
- Simplex
- Duplex

Others

- Remove shell prompt from output after command execution.

Story: 2004780
Task: 28998

Depends-On: https://review.openstack.org/#/c/614813/
Change-Id: I002c789307f028fa47902ef755923df3f5f4e6ab
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>

doc/source/installation_guide/controller_storage.rst

@@ -69,19 +69,20 @@ Management networks:
    $ bash setup_network.sh
 
 
-Building xmls for definition of virtual servers:
+Building XML for definition of virtual servers:
 
 ::
 
-   $ bash setup_controller_storage.sh -i <starlingx iso image>
+   $ bash setup_configuration.sh -c controllerstorage -i <starlingx iso image>
 
 
-The xml server definitions that are created by the previous script are:
+The default XML server definitions that are created by the previous script
+are:
 
-- controller-0
+- controllerstorage-controller-0
-- controller-1
+- controllerstorage-controller-1
-- compute-0
+- controllerstorage-compute-0
-- compute-1
+- controllerstorage-compute-1
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Powering Up a Virtual Server
@@ -98,14 +99,14 @@ e.g.
 
 ::
 
-    $ sudo virsh start controller-0
+    $ sudo virsh start controllerstorage-controller-0
 
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Accessing Virtual Server Consoles
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The xml for virtual servers in stx-tools repo, deployment/libvirt,
+The XML for virtual servers in stx-tools repo, deployment/libvirt,
 provides both graphical and text consoles.
 
 Access the graphical console in virt-manager by right-click on the

doc/source/installation_guide/dedicated_storage.rst

@@ -74,21 +74,22 @@ Management networks:
    $ bash setup_network.sh
 
 
-Building xmls for definition of virtual servers:
+Building XML for definition of virtual servers:
 
 ::
 
-   $ bash setup_dedicated_storage.sh -i <starlingx iso image>
+   $ bash setup_configuration.sh -c dedicatedstorage -i <starlingx iso image>
 
 
-The xml server definitions that are created by the previous script are:
+The default XML server definitions that are created by the previous script
+are:
 
-- controller-0
+- dedicatedstorage-controller-0
-- controller-1
+- dedicatedstorage-controller-1
-- compute-0
+- dedicatedstorage-compute-0
-- compute-1
+- dedicatedstorage-compute-1
-- storage-0
+- dedicatedstorage-storage-0
-- storage-1
+- dedicatedstorage-storage-1
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Powering Up a Virtual Server
@@ -105,14 +106,14 @@ e.g.
 
 ::
 
-    $ sudo virsh start controller-0
+    $ sudo virsh start dedicatedstorage-controller-0
 
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Accessing Virtual Server Consoles
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The xml for virtual servers in stx-tools repo, deployment/libvirt,
+The XML for virtual servers in stx-tools repo, deployment/libvirt,
 provides both graphical and text consoles.
 
 Access the graphical console in virt-manager by right-click on the
@@ -523,11 +524,11 @@ Controller-0 list the hosts:
    | id | hostname     | personality | administrative | operational | availability |
    +----+--------------+-------------+----------------+-------------+--------------+
    | 1  | controller-0 | controller  | unlocked       | enabled     | available    |
-   | 3  | controller-1 | controller  | locked         | disabled    | online      |
+   | 2  | controller-1 | controller  | locked         | disabled    | online       |
-   | 4  | compute-0    | compute     | locked         | disabled    | online      |
+   | 3  | compute-0    | compute     | locked         | disabled    | online       |
-   | 5  | storage-0    | storage     | locked         | disabled    | online      |
+   | 4  | compute-1    | compute     | locked         | disabled    | online       |
-   | 6  | storage-1    | storage     | locked         | disabled    | online      |
+   | 5  | storage-0    | storage     | locked         | disabled    | online       |
-   | 7  | storage-2    | storage     | locked         | disabled    | online      |
+   | 6  | storage-1    | storage     | locked         | disabled    | online       |
    +----+--------------+-------------+----------------+-------------+--------------+
 
 
@@ -867,13 +868,12 @@ Unlocked, Enabled, and Available:
    | id | hostname     | personality | administrative | operational | availability |
    +----+--------------+-------------+----------------+-------------+--------------+
    | 1  | controller-0 | controller  | unlocked       | enabled     | available    |
-   | 3  | controller-1 | controller  | unlocked       | enabled     | available    |
+   | 2  | controller-1 | controller  | unlocked       | enabled     | available    |
-   | 4  | compute-0    | compute     | unlocked       | enabled     | available    |
+   | 3  | compute-0    | compute     | unlocked       | enabled     | available    |
+   | 4  | compute-1    | compute     | unlocked       | enabled     | available    |
    | 5  | storage-0    | storage     | unlocked       | enabled     | available    |
    | 6  | storage-1    | storage     | unlocked       | enabled     | available    |
-   | 7  | storage-2    | storage     | unlocked       | enabled     | available    |
    +----+--------------+-------------+----------------+-------------+--------------+
-   [wrsroot@controller-0 ~(keystone_admin)]$
 
 
 ******************************

doc/source/installation_guide/duplex.rst

@@ -48,7 +48,7 @@ StarlingX Duplex will be deployed, include:
 
 -  Additional Disks:
 
-   -  0 or more 500 GB disks (min. 10K RPM)
+   -  Zero or more 500 GB disks (min. 10K RPM)
 
 -  Network Ports:
 
@@ -71,17 +71,18 @@ Management networks:
    $ bash setup_network.sh
 
 
-Building xmls for definition of virtual servers:
+Building XML for definition of virtual servers:
 
 ::
 
-   $ bash setup_allinone.sh -i <starlingx iso image>
+   $ bash setup_configuration.sh -c duplex -i <starlingx iso image>
 
 
-The xml server definitions that are created by the previous script are:
+The default XML server definitions that are created by the previous script
+are:
 
-- controller-0
+- duplex-controller-0
-- controller-1
+- duplex-controller-1
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Powering Up a Virtual Server
@@ -98,14 +99,14 @@ e.g.
 
 ::
 
-    $ sudo virsh start controller-0
+    $ sudo virsh start duplex-controller-0
 
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Accessing Virtual Server Consoles
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The xml for virtual servers in stx-tools repo, deployment/libvirt,
+The XML for virtual servers in stx-tools repo, deployment/libvirt,
 provides both graphical and text consoles.
 
 Access the graphical console in virt-manager by right-click on the
@@ -633,7 +634,6 @@ Add the partition to the volume group
    | created_at               | 2018-08-28T14:06:05.705546+00:00                 |
    | updated_at               | None                                             |
    +--------------------------+--------------------------------------------------+
-   [wrsroot@controller-0 ~(keystone_admin)]$
 
 
 **********************
@@ -1139,7 +1139,6 @@ Wait for the new partition to be created (i.e. status=Ready)
    | 7a41aab0-6695-4d16-9003-73238adda75b |...| /dev/sdb1   |...| None      | 16237    | Creating (on unlock) |
    | f7bc6095-9375-49fe-83c7-12601c202376 |...| /dev/sdc1   |...| None      | 16237    | Creating (on unlock) |
    +--------------------------------------+...+-------------+...+-----------+----------+----------------------+
-   [wrsroot@controller-0 ~(keystone_admin)]$
 
 
 

doc/source/installation_guide/installation_libvirt_qemu.rst

@@ -53,6 +53,7 @@ an example called madcloud.rc:
 
    export CONTROLLER=madcloud
    export COMPUTE=madnode
+   export STORAGE=madstorage
    export BRIDGE_INTERFACE=madbr
    export INTERNAL_NETWORK=172.30.20.0/24
    export INTERNAL_IP=172.30.20.1/24
@@ -66,6 +67,7 @@ This rc file shows the defaults baked into the scripts:
 
    export CONTROLLER=controller
    export COMPUTE=compute
+   export STORAGE=storage
    export BRIDGE_INTERFACE=stxbr
    export INTERNAL_NETWORK=10.10.10.0/24
    export INTERNAL_IP=10.10.10.1/24
@@ -149,16 +151,22 @@ configuration from libvirt.
 Configure Controllers
 *********************
 
-There are two scripts for creating the controllers: setup_allinone.sh
+One script exists for building different StarlingX cloud
-and setup_standard_controller.sh. They are operated in the same manner
+configurations: setup_configuration.sh.
-but build different StarlingX cloud configurations. Choose wisely.
 
-You need an ISO file for the installation, these scripts take a name
+The script uses the cloud configuration with the -c option:
+
+- simplex
+- duplex
+- controllerstorage
+- dedicatedstorage
+
+You need an ISO file for the installation, the script takes a file name
 with the -i option:
 
 ::
 
-   $SCRIPTS/setup_allinone.sh -i stx-2018-08-28-93.iso
+   $SCRIPTS/setup_configuration.sh -c <cloud configuration> -i <starlingx iso image>
 
 
 And the setup will begin. The scripts create one or more VMs and start
@@ -174,8 +182,12 @@ Then connect to the serial console:
 
 Continue the usual StarlingX installation from this point forward.
 
-Tear down the VMs using destroy_allinone.sh and
+Tear down the VMs using destroy_configuration.sh.
-destroy_standard_controller.sh.
+
+::
+
+   $SCRIPTS/destroy_configuration.sh -c <cloud configuration>
+
 
 --------
 Continue
@@ -192,4 +204,4 @@ Pick up the installation in one of the existing guides at the
 -  All-in-one
 
    - :ref:`StarlingX Cloud Duplex Virtual Environment <duplex>`
-   - :ref:`StarlingX Cloud Simplex Virtual Environment <simplex>`
+   - :ref:`StarlingX Cloud Simplex Virtual Environment <simplex>`

doc/source/installation_guide/simplex.rst

@@ -48,7 +48,7 @@ StarlingX Simplex will be deployed, include:
 
 -  Additional Disks:
 
-   -  0 or more 500 GB disks (min. 10K RPM)
+   -  Zero or more 500 GB disks (min. 10K RPM)
 
 -  Network Ports
 
@@ -70,25 +70,22 @@ Management networks:
    $ bash setup_network.sh
 
 
-Building xmls for definition of virtual servers:
+Building XML for definition of virtual servers:
 
 ::
 
-   $ bash setup_allinone.sh -i <starlingx iso image>
+   $ bash setup_configuration.sh -c simplex -i <starlingx iso image>
 
 
-The xml server definitions that are created by the previous script are:
+The default XML server definition created by the previous script is:
 
-- controller-0
+- simplex-controller-0
-- controller-1
-
-Only controller-0 will be provisioned.
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Powering Up a Virtual Server
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-To power up a virtual server, run the following command:
+To power up the virtual server, run the following command:
 
 ::
 
@@ -98,13 +95,13 @@ e.g.
 
 ::
 
-    $ sudo virsh start controller-0
+    $ sudo virsh start simplex-controller-0
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Accessing Virtual Server Consoles
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The xml for virtual servers in stx-tools repo, deployment/libvirt,
+The XML for virtual servers in stx-tools repo, deployment/libvirt,
 provides both graphical and text consoles.
 
 Access the graphical console in virt-manager by right-click on the
@@ -632,7 +629,6 @@ Add the partition to the volume group
    | created_at               | 2018-08-28T14:06:05.705546+00:00                 |
    | updated_at               | None                                             |
    +--------------------------+--------------------------------------------------+
-   [wrsroot@controller-0 ~(keystone_admin)]$
 
 
 **********************