From 3fdb20d65b655c32e08dd6db6db613a5ec48917f Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Wed, 9 Oct 2019 10:09:09 -0700 Subject: [PATCH] Minor editorial revisions (R2, R3 install guides) - Clarify wording in Access Kubernetes GUI section - Misc wording edits for consistency across install guides. Change-Id: I19c37b16e4091cafdb853e6a05f16106e6c964db Signed-off-by: Kristal Dale --- .../controller_storage_install_kubernetes.rst | 8 +++---- .../bare_metal/dedicated_storage_hardware.rst | 2 +- .../dedicated_storage_install_kubernetes.rst | 10 ++++---- .../r2_release/kubernetes_access.rst | 23 ++++++++----------- .../virtual/aio_duplex_install_kubernetes.rst | 4 +--- .../aio_simplex_install_kubernetes.rst | 4 +--- .../controller_storage_install_kubernetes.rst | 4 ++-- .../virtual/dedicated_storage_environ.rst | 6 ++--- .../dedicated_storage_install_kubernetes.rst | 4 ++-- .../controller_storage_install_kubernetes.rst | 8 +++---- .../bare_metal/dedicated_storage_hardware.rst | 2 +- .../dedicated_storage_install_kubernetes.rst | 10 ++++---- .../r3_release/kubernetes_access.rst | 23 ++++++++----------- .../virtual/aio_duplex_install_kubernetes.rst | 4 +--- .../aio_simplex_install_kubernetes.rst | 4 +--- .../controller_storage_install_kubernetes.rst | 4 ++-- .../virtual/dedicated_storage_environ.rst | 6 ++--- .../dedicated_storage_install_kubernetes.rst | 4 ++-- 18 files changed, 58 insertions(+), 72 deletions(-) diff --git a/doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage_install_kubernetes.rst index 221ea051e..4ebeeb5f1 100644 --- a/doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage_install_kubernetes.rst @@ -10,9 +10,9 @@ configuration. :local: :depth: 1 ---------------------- -Create a bootable USB ---------------------- +------------------- +Create bootable USB +------------------- Refer to :doc:`/deploy_install_guides/bootable_usb` for instructions on how to create a bootable USB with the StarlingX ISO on your system. @@ -316,7 +316,7 @@ Install software on controller-1 and compute nodes system host-update 4 personality=worker hostname=compute-1 #. Wait for the software installation on controller-1, compute-0, and compute-1 to - complete, for all servers to reboot, and for to all show as locked/disabled/online in + complete, for all servers to reboot, and for all to show as locked/disabled/online in 'system host-list'. :: diff --git a/doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_hardware.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_hardware.rst index eddec0124..124884725 100644 --- a/doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_hardware.rst +++ b/doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_hardware.rst @@ -30,7 +30,7 @@ host types are: | Primary disk | 500 GB SDD or NVM | 120 GB (min. 10k RPM) | 120 GB (min. 10k RPM) | +---------------------+-----------------------+-----------------------+-----------------------+ | Additional disks | None | - 1 or more 500 GB | - For OpenStack, | -| | | (min.10K RPM) for | recommend 1 or more | +| | | (min. 10K RPM) for | recommend 1 or more | | | | Ceph OSD | 500 GB (min. 10K | | | | - Recommended, but | RPM) for VM | | | | not required: 1 or | ephemeral storage | diff --git a/doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_install_kubernetes.rst index 6249d8810..6e129591f 100644 --- a/doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_install_kubernetes.rst @@ -10,12 +10,12 @@ configuration. :local: :depth: 1 --------------------------------------------- -Create a bootable USB with the StarlingX ISO --------------------------------------------- +------------------- +Create bootable USB +------------------- Refer to :doc:`/deploy_install_guides/bootable_usb` for instructions on how to -create a bootable USB on your system. +create a bootable USB with the StarlingX ISO on your system. -------------------------------- Install software on controller-0 @@ -249,7 +249,7 @@ Configure compute nodes For Kubernetes SRIOV network attachments: - * Configure the SRIOV device plug in: + * Configure SRIOV device plug in: :: diff --git a/doc/source/deploy_install_guides/r2_release/kubernetes_access.rst b/doc/source/deploy_install_guides/r2_release/kubernetes_access.rst index 99711e61f..0b0494038 100644 --- a/doc/source/deploy_install_guides/r2_release/kubernetes_access.rst +++ b/doc/source/deploy_install_guides/r2_release/kubernetes_access.rst @@ -86,16 +86,14 @@ GUI StarlingX Horizon GUI ********************* -Access the StarlingX Horizon GUI in your browser using the OAM floating IP -address. For example: `\http://:8080`. +Access the StarlingX Horizon GUI with the following steps: -To determine your OAM floating IP address, use: +#. Enter the OAM floating IP address in your browser: + `\http://:8080` -:: + Discover your OAM floating IP address with the :command:`system oam-show` command. - system oam-show - -Log in to Horizon with an admin/. +#. Log in to Horizon with an admin/. ******************** Kubernetes dashboard @@ -158,16 +156,15 @@ To install the Kubernetes dashboard, execute the following steps on controller-0 kubectl -n kube-system describe secret $(kubectl -n kube-system get secret | grep admin-user | awk '{print $1}') -#. Access the Kubernetes dashboard GUI in your browser using the OAM floating IP - address. For example: `\https://:30000`. - To determine your OAM floating IP address, use: +Access the Kubernetes dashboard GUI with the following steps: - :: +#. Enter the OAM floating IP address in your browser: + `\https://:30000`. - system oam-show + Discover your OAM floating IP address with the :command:`system oam-show` command. -#. Log in with the ``admin-user`` TOKEN. +#. Log in to the Kubernetes dashboard using the ``admin-user`` token. --------- REST APIs diff --git a/doc/source/deploy_install_guides/r2_release/virtual/aio_duplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/virtual/aio_duplex_install_kubernetes.rst index d81f79260..848d2734b 100644 --- a/doc/source/deploy_install_guides/r2_release/virtual/aio_duplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r2_release/virtual/aio_duplex_install_kubernetes.rst @@ -13,9 +13,7 @@ on a **StarlingX R2.0 virtual All-in-one Duplex** deployment configuration. Install software on controller-0 -------------------------------- -In the last step of "Prepare virtual environment and servers" the -controller-0 virtual server 'duplex-controller-0' was started by the -:command:`setup_configuration.sh` command. +In the last step of :doc:`aio_duplex_environ`, the controller-0 virtual server 'duplex-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 diff --git a/doc/source/deploy_install_guides/r2_release/virtual/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/virtual/aio_simplex_install_kubernetes.rst index c4db1b4dc..16eeb85ac 100644 --- a/doc/source/deploy_install_guides/r2_release/virtual/aio_simplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r2_release/virtual/aio_simplex_install_kubernetes.rst @@ -13,9 +13,7 @@ on a **StarlingX R2.0 virtual All-in-one Simplex** deployment configuration. Install software on controller-0 -------------------------------- -In the last step of "Prepare virtual environment and servers", 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 diff --git a/doc/source/deploy_install_guides/r2_release/virtual/controller_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/virtual/controller_storage_install_kubernetes.rst index 2d06f4507..31ea07d86 100644 --- a/doc/source/deploy_install_guides/r2_release/virtual/controller_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r2_release/virtual/controller_storage_install_kubernetes.rst @@ -14,8 +14,8 @@ configuration. Install software on controller-0 -------------------------------- -In the last step of "Prepare the virtual environment and virtual servers" the -controller-0 virtual server 'controllerstorage-controller-0' was started by the +In the last step of :doc:`controller_storage_environ`, the controller-0 virtual +server 'controllerstorage-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 diff --git a/doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_environ.rst b/doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_environ.rst index 557b835b2..6cc83f249 100644 --- a/doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_environ.rst +++ b/doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_environ.rst @@ -16,9 +16,9 @@ Physical host requirements and setup .. include:: physical_host_req.txt ------------------------------------------ -Preparing virtual environment and servers ------------------------------------------ +--------------------------------------- +Prepare virtual environment and servers +--------------------------------------- The following steps explain how to prepare the virtual environment and servers on a physical host for a StarlingX R2.0 virtual Standard with Dedicated Storage diff --git a/doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_install_kubernetes.rst index e0a749e55..86be4a97b 100644 --- a/doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_install_kubernetes.rst @@ -14,8 +14,8 @@ configuration. Install software on controller-0 -------------------------------- -In the last step of "Prepare the virtual environment and virtual servers" the -controller-0 virtual server 'dedicatedstorage-controller-0' was started by the +In the last step of :doc:`dedicated_storage_environ`, the controller-0 virtual +server 'dedicatedstorage-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 diff --git a/doc/source/deploy_install_guides/r3_release/bare_metal/controller_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r3_release/bare_metal/controller_storage_install_kubernetes.rst index 01ace1e25..149c3e2b8 100644 --- a/doc/source/deploy_install_guides/r3_release/bare_metal/controller_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r3_release/bare_metal/controller_storage_install_kubernetes.rst @@ -10,9 +10,9 @@ configuration. :local: :depth: 1 ---------------------- -Create a bootable USB ---------------------- +------------------- +Create bootable USB +------------------- Refer to :doc:`/deploy_install_guides/bootable_usb` for instructions on how to create a bootable USB with the StarlingX ISO on your system. @@ -316,7 +316,7 @@ Install software on controller-1 and compute nodes system host-update 4 personality=worker hostname=compute-1 #. Wait for the software installation on controller-1, compute-0, and compute-1 to - complete, for all servers to reboot, and for to all show as locked/disabled/online in + complete, for all servers to reboot, and for all to show as locked/disabled/online in 'system host-list'. :: diff --git a/doc/source/deploy_install_guides/r3_release/bare_metal/dedicated_storage_hardware.rst b/doc/source/deploy_install_guides/r3_release/bare_metal/dedicated_storage_hardware.rst index 140a05bbc..8a54be78c 100644 --- a/doc/source/deploy_install_guides/r3_release/bare_metal/dedicated_storage_hardware.rst +++ b/doc/source/deploy_install_guides/r3_release/bare_metal/dedicated_storage_hardware.rst @@ -30,7 +30,7 @@ host types are: | Primary disk | 500 GB SDD or NVM | 120 GB (min. 10k RPM) | 120 GB (min. 10k RPM) | +---------------------+-----------------------+-----------------------+-----------------------+ | Additional disks | None | - 1 or more 500 GB | - For OpenStack, | -| | | (min.10K RPM) for | recommend 1 or more | +| | | (min. 10K RPM) for | recommend 1 or more | | | | Ceph OSD | 500 GB (min. 10K | | | | - Recommended, but | RPM) for VM | | | | not required: 1 or | ephemeral storage | diff --git a/doc/source/deploy_install_guides/r3_release/bare_metal/dedicated_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r3_release/bare_metal/dedicated_storage_install_kubernetes.rst index 25e110cc8..a1a25fd2c 100644 --- a/doc/source/deploy_install_guides/r3_release/bare_metal/dedicated_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r3_release/bare_metal/dedicated_storage_install_kubernetes.rst @@ -10,12 +10,12 @@ configuration. :local: :depth: 1 --------------------------------------------- -Create a bootable USB with the StarlingX ISO --------------------------------------------- +------------------- +Create bootable USB +------------------- Refer to :doc:`/deploy_install_guides/bootable_usb` for instructions on how to -create a bootable USB on your system. +create a bootable USB with the StarlingX ISO on your system. -------------------------------- Install software on controller-0 @@ -249,7 +249,7 @@ Configure compute nodes For Kubernetes SRIOV network attachments: - * Configure the SRIOV device plug in: + * Configure SRIOV device plug in: :: diff --git a/doc/source/deploy_install_guides/r3_release/kubernetes_access.rst b/doc/source/deploy_install_guides/r3_release/kubernetes_access.rst index 34a630024..a1667f6c3 100644 --- a/doc/source/deploy_install_guides/r3_release/kubernetes_access.rst +++ b/doc/source/deploy_install_guides/r3_release/kubernetes_access.rst @@ -86,16 +86,14 @@ GUI StarlingX Horizon GUI ********************* -Access the StarlingX Horizon GUI in your browser using the OAM floating IP -address. For example: `\http://:8080`. +Access the StarlingX Horizon GUI with the following steps: -To determine your OAM floating IP address, use: +#. Enter the OAM floating IP address in your browser: + `\http://:8080` -:: + Discover your OAM floating IP address with the :command:`system oam-show` command. - system oam-show - -Log in to Horizon with an admin/. +#. Log in to Horizon with an admin/. ******************** Kubernetes dashboard @@ -158,16 +156,15 @@ To install the Kubernetes dashboard, execute the following steps on controller-0 kubectl -n kube-system describe secret $(kubectl -n kube-system get secret | grep admin-user | awk '{print $1}') -#. Access the Kubernetes dashboard GUI in your browser using the OAM floating IP - address. For example: `\https://:30000`. - To determine your OAM floating IP address, use: +Access the Kubernetes dashboard GUI with the following steps: - :: +#. Enter the OAM floating IP address in your browser: + `\https://:30000`. - system oam-show + Discover your OAM floating IP address with the :command:`system oam-show` command. -#. Log in with the ``admin-user`` TOKEN. +#. Log in to the Kubernetes dashboard using the ``admin-user`` token. --------- REST APIs diff --git a/doc/source/deploy_install_guides/r3_release/virtual/aio_duplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r3_release/virtual/aio_duplex_install_kubernetes.rst index d3befce72..5c012bf47 100644 --- a/doc/source/deploy_install_guides/r3_release/virtual/aio_duplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r3_release/virtual/aio_duplex_install_kubernetes.rst @@ -13,9 +13,7 @@ on a **StarlingX R3.0 virtual All-in-one Duplex** deployment configuration. Install software on controller-0 -------------------------------- -In the last step of "Prepare virtual environment and servers" the -controller-0 virtual server 'duplex-controller-0' was started by the -:command:`setup_configuration.sh` command. +In the last step of :doc:`aio_duplex_environ`, the controller-0 virtual server 'duplex-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 diff --git a/doc/source/deploy_install_guides/r3_release/virtual/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r3_release/virtual/aio_simplex_install_kubernetes.rst index 2293022bd..6d1882672 100644 --- a/doc/source/deploy_install_guides/r3_release/virtual/aio_simplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r3_release/virtual/aio_simplex_install_kubernetes.rst @@ -13,9 +13,7 @@ on a **StarlingX R3.0 virtual All-in-one Simplex** deployment configuration. Install software on controller-0 -------------------------------- -In the last step of "Prepare virtual environment and servers", 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 diff --git a/doc/source/deploy_install_guides/r3_release/virtual/controller_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r3_release/virtual/controller_storage_install_kubernetes.rst index b392a383e..a8dd8780e 100644 --- a/doc/source/deploy_install_guides/r3_release/virtual/controller_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r3_release/virtual/controller_storage_install_kubernetes.rst @@ -14,8 +14,8 @@ configuration. Install software on controller-0 -------------------------------- -In the last step of "Prepare the virtual environment and virtual servers" the -controller-0 virtual server 'controllerstorage-controller-0' was started by the +In the last step of :doc:`controller_storage_environ`, the controller-0 virtual +server 'controllerstorage-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 diff --git a/doc/source/deploy_install_guides/r3_release/virtual/dedicated_storage_environ.rst b/doc/source/deploy_install_guides/r3_release/virtual/dedicated_storage_environ.rst index 601e15bac..f6300867c 100644 --- a/doc/source/deploy_install_guides/r3_release/virtual/dedicated_storage_environ.rst +++ b/doc/source/deploy_install_guides/r3_release/virtual/dedicated_storage_environ.rst @@ -16,9 +16,9 @@ Physical host requirements and setup .. include:: physical_host_req.txt ------------------------------------------ -Preparing virtual environment and servers ------------------------------------------ +--------------------------------------- +Prepare virtual environment and servers +--------------------------------------- The following steps explain how to prepare the virtual environment and servers on a physical host for a StarlingX R3.0 virtual Standard with Dedicated Storage diff --git a/doc/source/deploy_install_guides/r3_release/virtual/dedicated_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r3_release/virtual/dedicated_storage_install_kubernetes.rst index 1f51034eb..faaf4f92e 100644 --- a/doc/source/deploy_install_guides/r3_release/virtual/dedicated_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/r3_release/virtual/dedicated_storage_install_kubernetes.rst @@ -14,8 +14,8 @@ configuration. Install software on controller-0 -------------------------------- -In the last step of "Prepare the virtual environment and virtual servers" the -controller-0 virtual server 'dedicatedstorage-controller-0' was started by the +In the last step of :doc:`dedicated_storage_environ`, the controller-0 virtual +server 'dedicatedstorage-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