From ad56abc446163b34ce78473206894fdab5eaf1de Mon Sep 17 00:00:00 2001 From: Abraham Arce Date: Mon, 22 Oct 2018 07:28:21 -0500 Subject: [PATCH] [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 Signed-off-by: Abraham Arce --- api-ref/source/index.rst | 4 +- doc/source/api-ref/index.rst | 4 +- .../release_note_contribute_guide.rst | 2 - .../installation_guide/controller_storage.rst | 47 ++++++++++-------- .../installation_guide/dedicated_storage.rst | 49 +++++++++++-------- doc/source/installation_guide/duplex.rst | 49 +++++++++++-------- doc/source/installation_guide/simplex.rst | 32 ++++++++++-- 7 files changed, 118 insertions(+), 69 deletions(-) diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 4240ff0d9..026020b5c 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,6 +1,6 @@ -====================== +======================= stx-docs API Reference -====================== +======================= StarlingX Project API References: diff --git a/doc/source/api-ref/index.rst b/doc/source/api-ref/index.rst index 87c060a40..9bf027629 100644 --- a/doc/source/api-ref/index.rst +++ b/doc/source/api-ref/index.rst @@ -16,7 +16,7 @@ StarlingX also has API References for the modified OpenStack APIs: * `Block Storage v2 `__ * `Compute v2 `__ -* `Image v2 `__ -* `Network v2 `__ +* `Image v2 `__ +* `Network v2 `__ :ref:`search` diff --git a/doc/source/contributor/release_note_contribute_guide.rst b/doc/source/contributor/release_note_contribute_guide.rst index da72604f5..73cba8d7d 100644 --- a/doc/source/contributor/release_note_contribute_guide.rst +++ b/doc/source/contributor/release_note_contribute_guide.rst @@ -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 diff --git a/doc/source/installation_guide/controller_storage.rst b/doc/source/installation_guide/controller_storage.rst index 31e0c8159..05b1eacce 100644 --- a/doc/source/installation_guide/controller_storage.rst +++ b/doc/source/installation_guide/controller_storage.rst @@ -70,7 +70,31 @@ Building xmls for definition of virtual servers: :: - $ bash setup_standard_controller.sh -i + $ bash setup_controller_storage.sh -i + + +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 + + +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 -c platform --networks oam controller-1 -:: - - [wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -n -nt oam controller-1 - - 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 *************************** diff --git a/doc/source/installation_guide/dedicated_storage.rst b/doc/source/installation_guide/dedicated_storage.rst index a71e6fdda..3f60fd02e 100644 --- a/doc/source/installation_guide/dedicated_storage.rst +++ b/doc/source/installation_guide/dedicated_storage.rst @@ -75,7 +75,33 @@ Building xmls for definition of virtual servers: :: - $ bash setup_standard_controller.sh -i + $ bash setup_dedicated_storage.sh -i + + +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 + + +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 -c platform --networks oam controller-1 -:: - - [wrsroot@controller-0 ~(keystone_admin)]$ system host-if-modify -n -nt oam controller-1 - - 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 *************************** diff --git a/doc/source/installation_guide/duplex.rst b/doc/source/installation_guide/duplex.rst index cb36fe68f..d795616c0 100644 --- a/doc/source/installation_guide/duplex.rst +++ b/doc/source/installation_guide/duplex.rst @@ -67,6 +67,28 @@ Building xmls for definition of virtual servers: $ bash setup_allinone.sh -i +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 + + +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: :: diff --git a/doc/source/installation_guide/simplex.rst b/doc/source/installation_guide/simplex.rst index 9819de6fc..cd847fc72 100644 --- a/doc/source/installation_guide/simplex.rst +++ b/doc/source/installation_guide/simplex.rst @@ -66,6 +66,28 @@ Building xmls for definition of virtual servers: $ bash setup_allinone.sh -i +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 + +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