[Doc] Installation Guide Xml Definitions

Installation guides should list the XML server definitions for each
configuration:

- Controller-N
- Compute-N
- Storage-N

Additionally, where it applies:

- Add method to power up virtual servers.
- Reword system configuration section.
- Use host-if-modify syntax valid for current release.

Minor changes:

- Remove DRAFT from the top of Release Notes Contribute Guide.
- Fix api-ref broken links

Change-Id: I2aed6a2dadd58bf5f701f15b94257afd5d79e6de
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
This commit is contained in:
Abraham Arce 2018-10-22 07:28:21 -05:00
parent 53e30879f9
commit ad56abc446
7 changed files with 118 additions and 69 deletions

View File

@ -1,6 +1,6 @@
======================
=======================
stx-docs API Reference
======================
=======================
StarlingX Project API References:

View File

@ -16,7 +16,7 @@ StarlingX also has API References for the modified OpenStack APIs:
* `Block Storage v2 <stx-docs/api-ref-blockstorage-v2-cgcs-ext.html>`__
* `Compute v2 <stx-docs/api-ref-compute-v2-cgcs-ext.html>`__
* `Image v2 <api-ref/api-ref-image-v2-cgcs-ext.html>`__
* `Network v2 <api-ref/api-ref-networking-v2-cgcs-ext.html>`__
* `Image v2 <stx-docs/api-ref-image-v2-cgcs-ext.html>`__
* `Network v2 <stx-docs/api-ref-networking-v2-cgcs-ext.html>`__
:ref:`search`

View File

@ -2,8 +2,6 @@
Release Notes Contributor Guide
===============================
**[DRAFT]**
Release notes for StarlingX projects are managed using Reno allowing release
notes go through the same review process used for managing code changes.
Release documentation information comes from YAML source files stored in the

View File

@ -70,7 +70,31 @@ Building xmls for definition of virtual servers:
::
$ bash setup_standard_controller.sh -i <starlingx iso image>
$ bash setup_controller_storage.sh -i <starlingx iso image>
The xml server definitions that are created by the previous script are:
- controller-0
- controller-1
- compute-0
- compute-1
Powering Up a Virtual Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To power up a virtual server, run the following command:
::
$ sudo virsh start <server-xml-name>
e.g.
::
$ sudo virsh start controller-0
Accessing Virtual Server Consoles
@ -568,22 +592,13 @@ been discovered:
[wrsroot@controller-0 ~(keystone_admin)]$ system host-port-list controller-1
Provision the oam interface for Controller-1.
**Temporal** changes to host-if-modify command: check help 'system help
host-if-modify'. If the help text lists '-c ' option then execute the
following command; otherwise use the form with '-nt' listed below:
Provision the oam interface for Controller-1:
::
[wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -n <oam interface> -c platform --networks oam controller-1 <oam interface>
::
[wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -n <oam interface> -nt oam controller-1 <oam interface>
Provisioning Storage on Controller-1
************************************
@ -757,21 +772,13 @@ pci-addresses that have been discovered:
[wrsroot@controller-0 ~(keystone_admin)]$ system host-port-list compute-0
Provision the data interface for Compute. **Temporal** changes to
host-if-modify command: check help 'system help host-if-modify'. If the
help text lists '-c ' option then execute the following command;
otherwise use the form with '-nt' listed below:
Provision the data interface for Compute:
::
[wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -p providernet-a -c data compute-0 eth1000
::
[wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -p providernet-a -nt data compute-0 eth1000
VSwitch Virtual Environment
***************************

View File

@ -75,7 +75,33 @@ Building xmls for definition of virtual servers:
::
$ bash setup_standard_controller.sh -i <starlingx iso image>
$ bash setup_dedicated_storage.sh -i <starlingx iso image>
The xml server definitions that are created by the previous script are:
- controller-0
- controller-1
- compute-0
- compute-1
- storage-0
- storage-1
Powering Up a Virtual Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To power up a virtual server, run the following command:
::
$ sudo virsh start <server-xml-name>
e.g.
::
$ sudo virsh start controller-0
Accessing Virtual Server Consoles
@ -517,22 +543,13 @@ been discovered:
[wrsroot@controller-0 ~(keystone_admin)]$ system host-port-list controller-1
Provision the oam interface for Controller-1.
**Temporal** changes to host-if-modify command: check help 'system help
host-if-modify'. If the help text lists '-c ' option then execute the
following command; otherwise use the form with '-nt' listed below:
Provision the oam interface for Controller-1:
::
[wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -n <oam interface> -c platform --networks oam controller-1 <oam interface>
::
[wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -n <oam interface> -nt oam controller-1 <oam interface>
Unlocking Controller-1
**********************
@ -684,21 +701,13 @@ pci-addresses that have been discovered:
[wrsroot@controller-0 ~(keystone_admin)]$ system host-port-list compute-0
Provision the data interface for Compute. **Temporal** changes to
host-if-modify command: check help 'system help host-if-modify'. If the
help text lists '-c ' option then execute the following command;
otherwise use the form with '-nt' listed below:
Provision the data interface for Compute:
::
[wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -p providernet-a -c data compute-0 eth1000
::
[wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -p providernet-a -nt data compute-0 eth1000
VSwitch Virtual Environment
***************************

View File

@ -67,6 +67,28 @@ Building xmls for definition of virtual servers:
$ bash setup_allinone.sh -i <starlingx iso image>
The xml server definitions that are created by the previous script are:
- controller-0
- controller-1
Powering Up a Virtual Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To power up a virtual server, run the following command:
::
$ sudo virsh start <server-xml-name>
e.g.
::
$ sudo virsh start controller-0
Accessing Virtual Server Consoles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -202,12 +224,10 @@ Select [y] for System Date and Time:
Is the current date and time correct? [y/N]: y
Accept all the default values immediately after system date and time,
for System mode choose "duplex":
For System mode choose "duplex":
::
...
System mode. Available options are:
1) duplex-direct: two node-redundant configuration. Management and
@ -215,7 +235,11 @@ for System mode choose "duplex":
2) duplex - two node redundant configuration
3) simplex - single node non-redundant configuration
System mode [duplex-direct]: 2
...
After System Date / Time and System mode:
::
Applying configuration (this will take several minutes):
01/08: Creating bootstrap configuration ... DONE
@ -661,22 +685,7 @@ configure a backup controller controller-1.
Initializing Controller-1 Host
******************************
Bare Metal
^^^^^^^^^^
Power on Controller-1 node
Virtual Environment
^^^^^^^^^^^^^^^^^^^
Start Controller-1 in the workstation:
::
$ sudo virsh start controller-1
In Controller-1 console you will see:
Power on Controller-1. In Controller-1 console you will see:
::

View File

@ -66,6 +66,28 @@ Building xmls for definition of virtual servers:
$ bash setup_allinone.sh -i <starlingx iso image>
The xml server definitions that are created by the previous script are:
- 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:
::
$ sudo virsh start <server-xml-name>
e.g.
::
$ sudo virsh start controller-0
Accessing Virtual Server Consoles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -201,8 +223,7 @@ Select [y] for System Date and Time:
Is the current date and time correct? [y/N]: y
Accept all the default values immediately after system date and time,
for System mode choose "simplex":
For System mode choose "simplex":
::
@ -212,7 +233,12 @@ for System mode choose "simplex":
2) duplex - two node redundant configuration
3) simplex - single node non-redundant configuration
System mode [duplex-direct]: 3
...
After System Date / Time and System mode:
::
Applying configuration (this will take several minutes):
01/08: Creating bootstrap configuration ... DONE