starlingx
/
docs
Code Issues Proposed changes

[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

- Fix bug "missing items in build documentation"
- Remove shell prompt from output after command execution

Depends-On: https://review.openstack.org/#/c/611978/
Closes-Bug: 1799611
Change-Id: I002c789307f028fa47902ef755923df3f5f4e6ab
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
This commit is contained in:
Abraham Arce 2018-10-23 10:36:03 -05:00
parent ad56abc446
commit ccbf47a092
5 changed files with 55 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/source/developer_guide/index.rst
View File

@ -62,16 +62,33 @@ first need to update the local database list of available packages:
Installation Requirements and Dependencies
******************************************
User
^^^^
1. Make sure you build StarlingX ISO as a non-root user with sudo enabled, use
your existing user or create a separate *<user>*:
.. code:: sh
$ sudo useradd -m -d /home/<user>r <user>
2. Your *<user>* should have sudo privileges:
.. code:: sh
$ sudo sh -c "echo '<user> ALL=(ALL:ALL) ALL' >> /etc/sudoers"
$ sudo su - <user>
Git
^^^
1. Install the required packages in an Ubuntu host system with:
3. Install the required packages in an Ubuntu host system with:
.. code:: sh
$ sudo apt-get install make git curl
2. Make sure to setup your identity
4. Make sure to setup your identity:
.. code:: sh
@ -81,15 +98,22 @@ Git
Docker CE
^^^^^^^^^
3. Install the required Docker CE packages in an Ubuntu host system. See
5. Install the required Docker CE packages in an Ubuntu host system. See
`Get Docker CE for
Ubuntu <https://docs.docker.com/install/linux/docker-ce/ubuntu/#os-requirements>`__
for more information.
6. Add your *<user>* to the Docker group logging out and back in for this to take
effect:
.. code:: sh
$ sudo usermod -aG docker <user>
Android Repo Tool
^^^^^^^^^^^^^^^^^
4. Install the required Android Repo Tool in an Ubuntu host system. Follow
7. Install the required Android Repo Tool in an Ubuntu host system. Follow
the 2 steps in "Installing Repo" section from `Installing
Repo <https://source.android.com/setup/build/downloading#installing-repo>`__
to have Andriod Repo Tool installed.

10
doc/source/installation_guide/controller_storage.rst
View File

@ -75,10 +75,10 @@ Building xmls for definition of virtual servers:
The xml server definitions that are created by the previous script are:
- controller-0
- controller-1
- compute-0
- compute-1
- controllerstorage-controller-0
- controllerstorage-controller-1
- controllerstorage-compute-0
- controllerstorage-compute-1
Powering Up a Virtual Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -94,7 +94,7 @@ e.g.
::
$ sudo virsh start controller-0
$ sudo virsh start controllerstorage-controller-0
Accessing Virtual Server Consoles

34
doc/source/installation_guide/dedicated_storage.rst
View File

@ -80,12 +80,12 @@ Building xmls for definition of virtual servers:
The xml server definitions that are created by the previous script are:
- controller-0
- controller-1
- compute-0
- compute-1
- storage-0
- storage-1
- dedicatedstorage-controller-0
- dedicatedstorage-controller-1
- dedicatedstorage-compute-0
- dedicatedstorage-compute-1
- dedicatedstorage-storage-0
- dedicatedstorage-storage-1
Powering Up a Virtual Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -101,7 +101,7 @@ e.g.
::
$ sudo virsh start controller-0
$ sudo virsh start dedicatedstorage-controller-0
Accessing Virtual Server Consoles
@ -506,11 +506,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 |
| 4 | compute-0 | compute | locked | disabled | online |
| 5 | storage-0 | storage | locked | disabled | online |
| 6 | storage-1 | storage | locked | disabled | online |
| 7 | storage-2 | storage | locked | disabled | online |
| 3 | controller-1 | controller | locked | disabled | online |
| 4 | compute-0 | compute | locked | disabled | online |
| 5 | compute-1 | compute | locked | disabled | online |
| 6 | storage-0 | storage | locked | disabled | online |
| 7 | storage-1 | storage | locked | disabled | online |
+----+--------------+-------------+----------------+-------------+--------------+
@ -801,7 +801,6 @@ physical disk:
| updated_at | None |
+--------------------------+--------------------------------------------+
Remote RAW Ceph storage backed will be used to back nova local ephemeral
volumes:
@ -844,12 +843,10 @@ Unlocked, Enabled, and Available:
| 1 | controller-0 | controller | unlocked | enabled | available |
| 3 | controller-1 | controller | unlocked | enabled | available |
| 4 | compute-0 | 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 |
| 5 | compute-1 | compute | unlocked | enabled | available |
| 6 | storage-0 | storage | unlocked | enabled | available |
| 7 | storage-1 | storage | unlocked | enabled | available |
+----+--------------+-------------+----------------+-------------+--------------+
[wrsroot@controller-0 ~(keystone_admin)]$
Checking StarlingX CEPH Health
******************************
@ -866,7 +863,6 @@ Checking StarlingX CEPH Health
pgmap v168: 1600 pgs, 5 pools, 0 bytes data, 0 objects
87444 kB used, 197 GB / 197 GB avail
1600 active+clean
controller-0:~$
System Alarm List

11
doc/source/installation_guide/duplex.rst
View File

@ -64,13 +64,13 @@ Building xmls for definition of virtual servers:
::
$ bash setup_allinone.sh -i <starlingx iso image>
$ bash setup_duplex.sh -i <starlingx iso image>
The xml server definitions that are created by the previous script are:
- controller-0
- controller-1
- duplex-controller-0
- duplex-controller-1
Powering Up a Virtual Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -86,7 +86,7 @@ e.g.
::
$ sudo virsh start controller-0
$ sudo virsh start duplex-controller-0
Accessing Virtual Server Consoles
@ -612,7 +612,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)]$
Unlocking Controller-0
@ -1108,8 +1107,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)]$
Add the partition to the volume group

8
doc/source/installation_guide/simplex.rst
View File

@ -63,13 +63,12 @@ Building xmls for definition of virtual servers:
::
$ bash setup_allinone.sh -i <starlingx iso image>
$ bash setup_simplex.sh -i <starlingx iso image>
The xml server definitions that are created by the previous script are:
- controller-0
- controller-1
- simplex-controller-0
Only controller-0 will be provisioned.
@ -86,7 +85,7 @@ e.g.
::
$ sudo virsh start controller-0
$ sudo virsh start simplex-controller-0
Accessing Virtual Server Consoles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -612,7 +611,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)]$
Unlocking Controller-0