starlingx/docs
Code Issues Proposed changes

Install doc refactoring updates

Browse Source 
Correct conditionalization on 2 blocks per install procedure
Add note about initial controller unlock and IPMG (except simplex)

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I65d9f149abf754654822457ea564062b1c203910
This commit is contained in:
Ron Stone 2021-05-06 15:05:57 -04:00
parent c3e43eb4dc
commit 62ef3d1ab8
6 changed files with 86 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/_includes/bootstrapping-and-deploying-starlingx.rest Normal file
View File

@ -0,0 +1,15 @@
.. note::
Controller-0 and controller-1 use IP multicast messaging for
synchronization. If loss of synchronization occurs a few minutes after
controller-1 becomes available, ensure that the switches and other devices
on the management and infrastructure networks are configured with
appropriate settings.
In particular, if |IGMP| snooping is enabled on |ToR| switches, then a
device acting as an |IGMP| querier is required on the network \(on the same
|VLAN|\) to prevent nodes from being dropped from the multicast group. The
|IGMP| querier periodically sends |IGMP| queries to all nodes on the
network, and each node sends an |IGMP| join or report in response. Without
an |IGMP| querier, the nodes do not periodically send |IGMP| join messages
after the initial join sent when the link first goes up, and they are
eventually dropped from the multicast group.

6
doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_extend.rst
View File

@ -3,7 +3,7 @@ Extend Capacity with Worker Nodes
=================================
This section describes the steps to extend capacity with worker nodes on a
**StarlingX R5.0 bare metal All-in-one Duplex** deployment configuration.
|prod| All-in-one Duplex deployment configuration.
.. contents::
:local:
@ -19,8 +19,8 @@ Install software on worker nodes
#. As the worker nodes boot, a message appears on their console instructing
you to configure the personality of the node.
#. On the console of controller-0, list hosts to see newly discovered worker node
hosts (hostname=None):
#. On the console of controller-0, list hosts to see newly discovered worker
node hosts (hostname=None):
::

48
doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_install_kubernetes.rst
View File

@ -71,25 +71,25 @@ Bootstrap system on controller-0
#. Specify user configuration overrides for the Ansible bootstrap playbook.
Ansible is used to bootstrap StarlingX on controller-0. Key files for
Ansible configuration are:
``/etc/ansible/hosts``
The default Ansible inventory file. Contains a single host: localhost.
``/usr/share/ansible/stx-ansible/playbooks/bootstrap.yml``
The Ansible bootstrap playbook.
``/usr/share/ansible/stx-ansible/playbooks/host_vars/bootstrap/default.yml``
The default configuration values for the bootstrap playbook.
``sysadmin home directory ($HOME)``
The default location where Ansible looks for and imports user
configuration override files for hosts. For example:
``$HOME/<hostname>.yml``.
.. only:: starlingx
Ansible is used to bootstrap StarlingX on controller-0. Key files for
Ansible configuration are:
``/etc/ansible/hosts``
The default Ansible inventory file. Contains a single host: localhost.
``/usr/share/ansible/stx-ansible/playbooks/bootstrap.yml``
The Ansible bootstrap playbook.
``/usr/share/ansible/stx-ansible/playbooks/host_vars/bootstrap/default.yml``
The default configuration values for the bootstrap playbook.
``sysadmin home directory ($HOME)``
The default location where Ansible looks for and imports user
configuration override files for hosts. For example:
``$HOME/<hostname>.yml``.
.. include:: ../ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
@ -143,14 +143,12 @@ Bootstrap system on controller-0
.. include:: ../../../_includes/install-playbook-values-aws.rest
.. only:: starlingx
Refer to :ref:`Ansible Bootstrap Configurations
<ansible_bootstrap_configs>` for information on additional Ansible
bootstrap configurations for advanced Ansible bootstrap scenarios, such
as Docker proxies when deploying behind a firewall, etc. Refer to
:ref:`Docker Proxy Configurations <docker_proxy_config>` for details
about Docker proxy settings.
Refer to :ref:`Ansible Bootstrap Configurations <ansible_bootstrap_configs>`
for information on additional Ansible bootstrap configurations for advanced
Ansible bootstrap scenarios, such as Docker proxies when deploying behind a
firewall, etc. Refer to :ref:`Docker Proxy Configurations
<docker_proxy_config>` for details about Docker proxy settings.
#. Run the Ansible bootstrap playbook:
@ -795,3 +793,5 @@ machine.
----------
.. include:: ../kubernetes_install_next.txt
.. include:: /_includes/bootstrapping-and-deploying-starlingx.rest

46
doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_install_kubernetes.rst
View File

@ -72,25 +72,25 @@ Bootstrap system on controller-0
#. Specify user configuration overrides for the Ansible bootstrap playbook.
Ansible is used to bootstrap StarlingX on controller-0. Key files for
Ansible configuration are:
``/etc/ansible/hosts``
The default Ansible inventory file. Contains a single host: localhost.
``/usr/share/ansible/stx-ansible/playbooks/bootstrap.yml``
The Ansible bootstrap playbook.
``/usr/share/ansible/stx-ansible/playbooks/host_vars/bootstrap/default.yml``
The default configuration values for the bootstrap playbook.
``sysadmin home directory ($HOME)``
The default location where Ansible looks for and imports user
configuration override files for hosts. For example:
``$HOME/<hostname>.yml``.
.. only:: starlingx
Ansible is used to bootstrap StarlingX on controller-0. Key files for
Ansible configuration are:
``/etc/ansible/hosts``
The default Ansible inventory file. Contains a single host: localhost.
``/usr/share/ansible/stx-ansible/playbooks/bootstrap.yml``
The Ansible bootstrap playbook.
``/usr/share/ansible/stx-ansible/playbooks/host_vars/bootstrap/default.yml``
The default configuration values for the bootstrap playbook.
``sysadmin home directory ($HOME)``
The default location where Ansible looks for and imports user
configuration override files for hosts. For example:
``$HOME/<hostname>.yml``.
.. include:: ../ansible_install_time_only.txt
Specify the user configuration override file for the Ansible bootstrap
@ -142,14 +142,12 @@ Bootstrap system on controller-0
.. include:: ../../../_includes/install-playbook-values-aws.rest
.. only:: starlingx
Refer to :ref:`Ansible Bootstrap Configurations
<ansible_bootstrap_configs>` for information on additional Ansible
bootstrap configurations for advanced Ansible bootstrap scenarios, such
as Docker proxies when deploying behind a firewall, etc. Refer to
:ref:`Docker Proxy Configuration <docker_proxy_config>` for details about
Docker proxy settings.
Refer to :ref:`Ansible Bootstrap Configurations <ansible_bootstrap_configs>`
for information on additional Ansible bootstrap configurations for advanced
Ansible bootstrap scenarios, such as Docker proxies when deploying behind a
firewall, etc. Refer to :ref:`Docker Proxy Configuration
<docker_proxy_config>` for details about Docker proxy settings.
#. Run the Ansible bootstrap playbook:

40
doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_install_kubernetes.rst
View File

@ -71,24 +71,24 @@ Bootstrap system on controller-0
#. Specify user configuration overrides for the Ansible bootstrap playbook.
.. only:: starlingx
Ansible is used to bootstrap StarlingX on controller-0. Key files for
Ansible configuration are:
Ansible is used to bootstrap StarlingX on controller-0. Key files for
Ansible configuration are:
``/etc/ansible/hosts``
The default Ansible inventory file. Contains a single host: localhost.
``/etc/ansible/hosts``
The default Ansible inventory file. Contains a single host: localhost.
``/usr/share/ansible/stx-ansible/playbooks/bootstrap.yml``
``/usr/share/ansible/stx-ansible/playbooks/bootstrap.yml``
The Ansible bootstrap playbook.
``/usr/share/ansible/stx-ansible/playbooks/host_vars/bootstrap/default.yml``
The default configuration values for the bootstrap playbook.
``/usr/share/ansible/stx-ansible/playbooks/host_vars/bootstrap/default.yml``
The default configuration values for the bootstrap playbook.
``sysadmin home directory ($HOME)``
The default location where Ansible looks for and imports user
configuration override files for hosts. For example:
``$HOME/<hostname>.yml``.
``sysadmin home directory ($HOME)``
The default location where Ansible looks for and imports user
configuration override files for hosts. For example:
``$HOME/<hostname>.yml``.
.. only:: starlingx
.. include:: ../ansible_install_time_only.txt
@ -143,14 +143,12 @@ Bootstrap system on controller-0
.. include:: ../../../_includes/install-playbook-values-aws.rest
.. only:: starlingx
Refer to :ref:`Ansible Bootstrap Configurations
<ansible_bootstrap_configs>` for information on additional Ansible
bootstrap configurations for advanced Ansible bootstrap scenarios, such
as Docker proxies when deploying behind a firewall, etc. Refer to
:ref:`Docker Proxy configuration <docker_proxy_config>` for details about
Docker proxy settings.
Refer to :ref:`Ansible Bootstrap Configurations <ansible_bootstrap_configs>`
for information on additional Ansible bootstrap configurations for advanced
Ansible bootstrap scenarios, such as Docker proxies when deploying behind a
firewall, etc. Refer to :ref:`Docker Proxy configuration
<docker_proxy_config>` for details about Docker proxy settings.
#. Run the Ansible bootstrap playbook:
@ -441,6 +439,8 @@ machine.
.. incl-unlock-controller-1-end:
.. include:: /_includes/bootstrapping-and-deploying-starlingx.rest
----------------------
Configure worker nodes
----------------------

2
doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_install_kubernetes.rst
View File

@ -176,6 +176,8 @@ Unlock controller-1
:start-after: incl-unlock-controller-1-start:
:end-before: incl-unlock-controller-1-end:
.. include:: /_includes/bootstrapping-and-deploying-starlingx.rest
-----------------------
Configure storage nodes
-----------------------