starlingx/docs
Code Issues Proposed changes

Update Ansible bootstrap info for clarity

Browse Source 
- Correct configuration file paths
- Update wording for configuration overrides to improve clarity
  and why to select one method over the other.

Change-Id: Iaf31edc1b90f4f6c983bcbe3f427774a0710d11c
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2019-09-27 12:46:53 -07:00
parent aa45ef5175
commit 60aa2bce01
3 changed files with 53 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/source/deploy_install_guides/r2_release/bare_metal/aio_duplex_install_kubernetes.rst
View File

@ -40,7 +40,9 @@ Bootstrap system on controller-0
New Password: New Password:
(repeat) New Password: (repeat) New Password:
#. External connectivity is required to run the Ansible bootstrap playbook. The #. Verify and/or configure IP connectivity.
External connectivity is required to run the Ansible bootstrap playbook. The
StarlingX boot image will DHCP out all interfaces so the server may have StarlingX boot image will DHCP out all interfaces so the server may have
obtained an IP address and have external IP connectivity if a DHCP server is obtained an IP address and have external IP connectivity if a DHCP server is
present in your environment. Verify this using the :command:`ip addr` and present in your environment. Verify this using the :command:`ip addr` and
@ -65,10 +67,10 @@ Bootstrap system on controller-0
``/etc/ansible/hosts`` ``/etc/ansible/hosts``
The default Ansible inventory file. Contains a single host: localhost. The default Ansible inventory file. Contains a single host: localhost.
``/usr/share/ansible/stx-ansible/playbooks/bootstrap/bootstrap.yml`` ``/usr/share/ansible/stx-ansible/playbooks/bootstrap.yml``
The Ansible bootstrap playbook. The Ansible bootstrap playbook.
``/usr/share/ansible/stx-ansible/playbooks/bootstrap/host_vars/default.yml`` ``/usr/share/ansible/stx-ansible/playbooks/host_vars/bootstrap/default.yml``
The default configuration values for the bootstrap playbook. The default configuration values for the bootstrap playbook.
sysadmin home directory ($HOME) sysadmin home directory ($HOME)
@ -78,17 +80,22 @@ Bootstrap system on controller-0
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:
* Copy the default.yml file listed above to ``$HOME/localhost.yml`` and edit #. Use a copy of the default.yml file listed above to provide your overrides.
the configurable values as desired (use the commented instructions in
the file).
or The default.yml file lists all available parameters for bootstrap
configuration with a brief description for each parameter in the file comments.
* Create the minimal user configuration override file as shown in the To use this method, copy the default.yml file listed above to
example below, using the OAM IP SUBNET and IP ADDRESSing applicable to your ``$HOME/localhost.yml`` and edit the configurable values as desired.
deployment environment:
:: #. Create a minimal user configuration override file.
To use this method, create your override file at ``$HOME/localhost.yml``
and provide the minimum required parameters for the deployment configuration
as shown in the example below. Use the OAM IP SUBNET and IP ADDRESSing
applicable to your deployment environment.
::
cd ~ cd ~
cat <<EOF > localhost.yml cat <<EOF > localhost.yml

27
doc/source/deploy_install_guides/r2_release/bare_metal/aio_simplex_install_kubernetes.rst
View File

@ -58,7 +58,9 @@ Bootstrap system on controller-0
New Password: New Password:
(repeat) New Password: (repeat) New Password:
#. External connectivity is required to run the Ansible bootstrap playbook. The #. Verify and/or configure IP connectivity.
External connectivity is required to run the Ansible bootstrap playbook. The
StarlingX boot image will DHCP out all interfaces so the server may have StarlingX boot image will DHCP out all interfaces so the server may have
obtained an IP address and have external IP connectivity if a DHCP server is obtained an IP address and have external IP connectivity if a DHCP server is
present in your environment. Verify this using the :command:`ip addr` and present in your environment. Verify this using the :command:`ip addr` and
@ -83,10 +85,10 @@ Bootstrap system on controller-0
``/etc/ansible/hosts`` ``/etc/ansible/hosts``
The default Ansible inventory file. Contains a single host: localhost. The default Ansible inventory file. Contains a single host: localhost.
``/usr/share/ansible/stx-ansible/playbooks/bootstrap/bootstrap.yml`` ``/usr/share/ansible/stx-ansible/playbooks/bootstrap.yml``
The Ansible bootstrap playbook. The Ansible bootstrap playbook.
``/usr/share/ansible/stx-ansible/playbooks/bootstrap/host_vars/default.yml`` ``/usr/share/ansible/stx-ansible/playbooks/host_vars/bootstrap/default.yml``
The default configuration values for the bootstrap playbook. The default configuration values for the bootstrap playbook.
sysadmin home directory ($HOME) sysadmin home directory ($HOME)
@ -96,15 +98,20 @@ Bootstrap system on controller-0
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:
* Copy the default.yml file listed above to ``$HOME/localhost.yml`` and edit #. Use a copy of the default.yml file listed above to provide your overrides.
the configurable values as desired (use the commented instructions in
the file).
or The default.yml file lists all available parameters for bootstrap
configuration with a brief description for each parameter in the file comments.
* Create the minimal user configuration override file as shown in the To use this method, copy the default.yml file listed above to
example below, using the OAM IP SUBNET and IP ADDRESSing applicable to your ``$HOME/localhost.yml`` and edit the configurable values as desired.
deployment environment:
#. Create a minimal user configuration override file.
To use this method, create your override file at ``$HOME/localhost.yml``
and provide the minimum required parameters for the deployment configuration
as shown in the example below. Use the OAM IP SUBNET and IP ADDRESSing
applicable to your deployment environment.
:: ::

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

@ -50,6 +50,7 @@ Bootstrap system on controller-0
.. incl-bootstrap-sys-controller-0-standard-start: .. incl-bootstrap-sys-controller-0-standard-start:
#. Login using the username / password of "sysadmin" / "sysadmin". #. Login using the username / password of "sysadmin" / "sysadmin".
When logging in for the first time, you will be forced to change the password. When logging in for the first time, you will be forced to change the password.
:: ::
@ -61,7 +62,9 @@ Bootstrap system on controller-0
New Password: New Password:
(repeat) New Password: (repeat) New Password:
#. External connectivity is required to run the Ansible bootstrap playbook. The #. Verify and/or configure IP connectivity.
External connectivity is required to run the Ansible bootstrap playbook. The
StarlingX boot image will DHCP out all interfaces so the server may have StarlingX boot image will DHCP out all interfaces so the server may have
obtained an IP address and have external IP connectivity if a DHCP server is obtained an IP address and have external IP connectivity if a DHCP server is
present in your environment. Verify this using the :command:`ip addr` and present in your environment. Verify this using the :command:`ip addr` and
@ -86,10 +89,10 @@ Bootstrap system on controller-0
``/etc/ansible/hosts`` ``/etc/ansible/hosts``
The default Ansible inventory file. Contains a single host: localhost. The default Ansible inventory file. Contains a single host: localhost.
``/usr/share/ansible/stx-ansible/playbooks/bootstrap/bootstrap.yml`` ``/usr/share/ansible/stx-ansible/playbooks/bootstrap.yml``
The Ansible bootstrap playbook. The Ansible bootstrap playbook.
``/usr/share/ansible/stx-ansible/playbooks/bootstrap/host_vars/default.yml`` ``/usr/share/ansible/stx-ansible/playbooks/host_vars/bootstrap/default.yml``
The default configuration values for the bootstrap playbook. The default configuration values for the bootstrap playbook.
sysadmin home directory ($HOME) sysadmin home directory ($HOME)
@ -99,15 +102,20 @@ Bootstrap system on controller-0
Specify the user configuration override file for the Ansible bootstrap Specify the user configuration override file for the Ansible bootstrap
playbook using one of the following methods: playbook using one of the following methods:
* Copy the default.yml file listed above to ``$HOME/localhost.yml`` and edit #. Use a copy of the default.yml file listed above to provide your overrides.
the configurable values as desired (use the commented instructions in
the file).
or The default.yml file lists all available parameters for bootstrap
configuration with a brief description for each parameter in the file comments.
* Create the minimal user configuration override file as shown in the To use this method, copy the default.yml file listed above to
example below, using the OAM IP SUBNET and IP ADDRESSing applicable to your ``$HOME/localhost.yml`` and edit the configurable values as desired.
deployment environment:
#. Create a minimal user configuration override file.
To use this method, create your override file at ``$HOME/localhost.yml``
and provide the minimum required parameters for the deployment configuration
as shown in the example below. Use the OAM IP SUBNET and IP ADDRESSing
applicable to your deployment environment.
:: ::