starlingx/docs
Code Issues Proposed changes

Minor editorial revisions (R2, R3 install guides)

Browse Source 
- Clarify wording in Access Kubernetes GUI section
- Misc wording edits for consistency across install guides.

Change-Id: I19c37b16e4091cafdb853e6a05f16106e6c964db
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2019-10-09 10:09:09 -07:00
parent a772c47e2a
commit 3fdb20d65b
18 changed files with 58 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage_install_kubernetes.rst
View File

@ -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'.
::

2
doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_hardware.rst
View File

@ -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 |

10
doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_install_kubernetes.rst
View File

@ -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:
::

23
doc/source/deploy_install_guides/r2_release/kubernetes_access.rst
View File

@ -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://<oam-floating-ip-address>: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://<oam-floating-ip-address>:8080`
::
Discover your OAM floating IP address with the :command:`system oam-show` command.
system oam-show
Log in to Horizon with an admin/<sysadmin-password>.
#. Log in to Horizon with an admin/<sysadmin-password>.
********************
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://<oam-floating-ip-address>: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://<oam-floating-ip-address>: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

4
doc/source/deploy_install_guides/r2_release/virtual/aio_duplex_install_kubernetes.rst
View File

@ -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

4
doc/source/deploy_install_guides/r2_release/virtual/aio_simplex_install_kubernetes.rst
View File

@ -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

4
doc/source/deploy_install_guides/r2_release/virtual/controller_storage_install_kubernetes.rst
View File

@ -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

6
doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_environ.rst
View File

@ -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

4
doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_install_kubernetes.rst
View File

@ -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

8
doc/source/deploy_install_guides/r3_release/bare_metal/controller_storage_install_kubernetes.rst
View File

@ -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'.
::

2
doc/source/deploy_install_guides/r3_release/bare_metal/dedicated_storage_hardware.rst
View File

@ -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 |

10
doc/source/deploy_install_guides/r3_release/bare_metal/dedicated_storage_install_kubernetes.rst
View File

@ -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:
::

23
doc/source/deploy_install_guides/r3_release/kubernetes_access.rst
View File

@ -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://<oam-floating-ip-address>: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://<oam-floating-ip-address>:8080`
::
Discover your OAM floating IP address with the :command:`system oam-show` command.
system oam-show
Log in to Horizon with an admin/<sysadmin-password>.
#. Log in to Horizon with an admin/<sysadmin-password>.
********************
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://<oam-floating-ip-address>: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://<oam-floating-ip-address>: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

4
doc/source/deploy_install_guides/r3_release/virtual/aio_duplex_install_kubernetes.rst
View File

@ -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

4
doc/source/deploy_install_guides/r3_release/virtual/aio_simplex_install_kubernetes.rst
View File

@ -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

4
doc/source/deploy_install_guides/r3_release/virtual/controller_storage_install_kubernetes.rst
View File

@ -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

6
doc/source/deploy_install_guides/r3_release/virtual/dedicated_storage_environ.rst
View File

@ -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

4
doc/source/deploy_install_guides/r3_release/virtual/dedicated_storage_install_kubernetes.rst
View File

@ -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