starlingx/docs
Code Issues Proposed changes

Update system configuration

Browse Source 
There are minor changes here, that update the content of some files
here is the link to the commit on downstream
http://bitbucket.wrs.com/projects/DOCS/repos/
starlingx_upstreaming/commits/3b193cc3aa566b2040c7226a9ed32d08bd91b82f


Signed-off-by: Rafael Jardim <rafaeljordao.jardim@windriver.com>
Change-Id: I461fce0c81f4605c200572ff71ae52cc889a856b
This commit is contained in:
Rafael Jardim 2021-03-08 10:52:00 -03:00
parent b60579b001
commit 01ba8ebfd6
12 changed files with 76 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
doc/source/system_configuration/kubernetes/application-commands-and-helm-overrides.rst
View File

@ -16,7 +16,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system application-list [--nowrap]
~(keystone_admin)]$ system application-list [--nowrap]
where:
@ -27,7 +27,7 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)$ system application-list --nowrap
~(keystone_admin)]$ system application-list --nowrap
+-------------+---------+---------------+----------------+----------+-----------+
| application | version | manifest name | manifest file | status | progress |
@ -43,7 +43,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system application-show <app_name>
~(keystone_admin)]$ system application-show <app_name>
where:
@ -54,7 +54,7 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)$ system application-show |prefix|-openstack
~(keystone_admin)]$ system application-show |prefix|-openstack
+---------------+----------------------------------+
| Property | Value |
@ -75,7 +75,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system application-upload [-n | --app-name] <app_name> [-v | --version] <version> <tar_file>
~(keystone_admin)]$ system application-upload [-n | --app-name] <app_name> [-v | --version] <version> <tar_file>
where the following are optional arguments:
@ -95,7 +95,7 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)$ system application-upload |prefix|-openstack-1.0-18.tgz
~(keystone_admin)]$ system application-upload |prefix|-openstack-1.0-18.tgz
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
@ -116,7 +116,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system helm-override-list
~(keystone_admin)]$ system helm-override-list
usage: system helm-override-list [--nowrap] [-l | --long] <app_name>
where the following is a positional argument:
@ -136,7 +136,7 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)$ system helm-override-list |prefix|-openstack --long
~(keystone_admin)]$ system helm-override-list |prefix|-openstack --long
+---------------------+--------------------------------+---------------+
| chart name | overrides namespaces | chart enabled |
+---------------------+--------------------------------+---------------+
@ -175,7 +175,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system helm-override-show
~(keystone_admin)]$ system helm-override-show
usage: system helm-override-show <app_name> <chart_name> <namespace>
where the following are positional arguments:
@ -193,7 +193,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system helm-override-show |prefix|-openstack glance openstack
~(keystone_admin)]$ system helm-override-show |prefix|-openstack glance openstack
- To modify service configuration parameters using user-specified overrides,
use the following command. To update a single configuration parameter, you
@ -202,7 +202,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system helm-override-update
~(keystone_admin)]$ system helm-override-update
usage: system helm-override-update <app_name> <chart_name> <namespace> --reuse-values --reset-values --values <file_name> --set <commandline_overrides>
where the following are positional arguments:
@ -240,7 +240,7 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)$ system helm-override-update |prefix|-openstack glance openstack --set conf.glance.DEFAULT.DEBUG=true
~(keystone_admin)]$ system helm-override-update |prefix|-openstack glance openstack --set conf.glance.DEFAULT.DEBUG=true
+----------------+-------------------+
| Property | Value |
+----------------+-------------------+
@ -266,7 +266,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system helm-chart-attribute-modify [--enabled <true/false>] <app_name> <chart_name> <namespace>
~(keystone_admin)]$ system helm-chart-attribute-modify [--enabled <true/false>] <app_name> <chart_name> <namespace>
where the following is an optional argument:
@ -292,7 +292,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system helm-override-delete
~(keystone_admin)]$ system helm-override-delete
usage: system helm-override-delete <app_name> <chart_name> <namespace>
where the following are positional arguments:
@ -310,7 +310,7 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)$ system helm-override-delete |prefix|-openstack glance openstack
~(keystone_admin)]$ system helm-override-delete |prefix|-openstack glance openstack
Deleted chart overrides glance:openstack for application |prefix|-openstack
- Use the following command to apply or reapply an application, making it
@ -318,7 +318,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system application-apply [-m | --mode] <mode> <app_name>
~(keystone_admin)]$ system application-apply [-m | --mode] <mode> <app_name>
where the following is an optional argument:
@ -336,7 +336,7 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)$ system application-apply |prefix|-openstack
~(keystone_admin)]$ system application-apply |prefix|-openstack
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
@ -356,7 +356,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system application-abort <app_name>
~(keystone_admin)]$ system application-abort <app_name>
where:
@ -367,7 +367,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system application-abort |prefix|-openstack
~(keystone_admin)]$ system application-abort |prefix|-openstack
Application abort request has been accepted. If the previous operation has not
completed/failed, it will be cancelled shortly.
@ -379,7 +379,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system application-update [-n | --app-name] <app_name> [-v | --app-version] <version> <tar_file>
~(keystone_admin)]$ system application-update [-n | --app-name] <app_name> [-v | --app-version] <version> <tar_file>
where the following are optional arguments:
@ -390,7 +390,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system application-list
~(keystone_admin)]$ system application-list
+--------------------------+----------+-------------------------------+---------------------------+----------+-----------+
| application | version | manifest name | manifest file | status | progress |
+--------------------------+----------+-------------------------------+---------------------------+----------+-----------+
@ -418,7 +418,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system application-remove <app_name>
~(keystone_admin)]$ system application-remove <app_name>
where:
@ -429,7 +429,7 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)$ system application-remove |prefix|-openstack
~(keystone_admin)]$ system application-remove |prefix|-openstack
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
@ -452,7 +452,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)$ system application-delete <app_name>
~(keystone_admin)]$ system application-delete <app_name>
where:
@ -465,5 +465,5 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)$ system application-delete |prefix|-openstack
~(keystone_admin)]$ system application-delete |prefix|-openstack
Application |prefix|-openstack deleted.

4
doc/source/system_configuration/kubernetes/branding-the-login-banner-on-a-commissioned-system.rst
View File

@ -98,8 +98,8 @@ commissioned system:
.. code-block:: none
~(keystone_admin)$ system host-lock worker-0
~(keystone_admin)$ system host-unlock worker-0
~(keystone_admin)]$ system host-lock worker-0
~(keystone_admin)]$ system host-unlock worker-0
.. rubric:: |result|

14
doc/source/system_configuration/kubernetes/changing-the-mtu-of-an-oam-interface-using-the-cli.rst
View File

@ -21,7 +21,7 @@ requires a swact.
.. code-block:: none
~(keystone_admin)$ system host-lock controller-1
~(keystone_admin)]$ system host-lock controller-1
#. Use the :command:`system host-if-modify` command to specify the interface
and the new MTU value on the standby controller. This example assumes the
@ -29,34 +29,34 @@ requires a swact.
.. code-block:: none
~(keystone_admin)$ system host-if-modify controller-1 oam0 --imtu 1600
~(keystone_admin)]$ system host-if-modify controller-1 oam0 --imtu 1600
#. Unlock the standby controller.
.. code-block:: none
~(keystone_admin)$ system host-unlock controller-1
~(keystone_admin)]$ system host-unlock controller-1
#. Swact the controllers.
.. code-block:: none
~(keystone_admin)$ system host-swact controller-1
~(keystone_admin)]$ system host-swact controller-1
#. Lock the new standby controller.
.. code-block:: none
~(keystone_admin)$ system host-lock controller-0
~(keystone_admin)]$ system host-lock controller-0
#. Modify the |MTU| of the corresponding interface on the standby controller.
.. code-block:: none
~(keystone_admin)$ system host-if-modify controller-0 oam0 --imtu 1600
~(keystone_admin)]$ system host-if-modify controller-0 oam0 --imtu 1600
#. Unlock the standby controller.
.. code-block:: none
~(keystone_admin)$ system host-unlock controller-0
~(keystone_admin)]$ system host-unlock controller-0

5
doc/source/system_configuration/kubernetes/changing-the-oam-ip-configuration-using-horizon.rst
View File

@ -22,6 +22,11 @@ interface or the CLI. You can use IPv4 or IPv6 addresses.
be required. In addition, |VNC| console access to worker-node hosts is
interrupted until the hosts are locked and unlocked.
Once the |OAM| IP addresses are changed, any existing server certificates
\(ssl, docker\_registry, OpenStack etc.\) that have the old |OAM| IP
addresses in their |SANs| must be updated with new certificates reflecting
the new addresses.
.. rubric:: |prereq|
Before changing the |OAM| IP configuration, review the Fault Management page

8
doc/source/system_configuration/kubernetes/changing-the-oam-ip-configuration-using-the-cli.rst
View File

@ -12,7 +12,7 @@ To view the existing |OAM| IP configuration, use the following command.
.. code-block:: none
~(keystone_admin)$ system oam-show
~(keystone_admin)]$ system oam-show
+-----------------+--------------------------------------+
| Property | Value |
+-----------------+--------------------------------------+
@ -32,7 +32,7 @@ controller IP addresses, use the following command syntax.
.. code-block:: none
~(keystone_admin)$ system oam-modify oam_subnet=<subnet>/<netmask> \
~(keystone_admin)]$ system oam-modify oam_subnet=<subnet>/<netmask> \
oam_gateway_ip=<gateway_ip_address> \
oam_floating_ip=<floating_IP_address> \
oam_c0_ip=<controller-0_IP_address> \
@ -42,7 +42,7 @@ For example:
.. code-block:: none
~(keystone_admin)$ system oam-modify oam_subnet=10.10.10.0/24 \
~(keystone_admin)]$ system oam-modify oam_subnet=10.10.10.0/24 \
oam_gateway_ip=10.10.10.1 \
oam_floating_ip=10.10.10.2 \
oam_c0_ip=10.10.10.3 \
@ -58,7 +58,7 @@ For example:
.. code-block:: none
~(keystone_admin)$ system oam-modify oam_subnet=10.10.10.0/24 oam_gateway_ip=10.10.10.1 oam_ip=10.10.10.2
~(keystone_admin)]$ system oam-modify oam_subnet=10.10.10.0/24 oam_gateway_ip=10.10.10.1 oam_ip=10.10.10.2
.. note::
If you change the IP address version \(IPv4 or IPv6\), ensure that the

10
doc/source/system_configuration/kubernetes/configuring-ntp-servers-and-services-using-the-cli.rst
View File

@ -17,7 +17,7 @@ To view the existing |NTP| server configuration, use the following command.
.. code-block:: none
~(keystone_admin)$ system ntp-show
~(keystone_admin)]$ system ntp-show
+--------------+----------------------------------------------+
| Property | Value |
+--------------+----------------------------------------------+
@ -38,14 +38,14 @@ ntpservers option takes a comma-delimited list of |NTP| server names.
.. code-block:: none
~(keystone_admin)$ system ntp-modify \
~(keystone_admin)]$ system ntp-modify \
ntpservers=<server_1[,server_2][,server_3]>
For example:
.. code-block:: none
~(keystone_admin)$ system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org,3.pool.ntp.org
~(keystone_admin)]$ system ntp-modify ntpservers=0.pool.ntp.org,1.pool.ntp.org,3.pool.ntp.org
**NTP Service**
@ -63,7 +63,7 @@ Use the following command to change the clock synchronization on the host:
.. code-block:: none
~(keystone_admin)$ system host-update controller-0 clock_synchronization=ntp
~(keystone_admin)]$ system host-update controller-0 clock_synchronization=ntp
+-----------------------+--------------------------------------------+
| Property | Value |
+-----------------------+--------------------------------------------+
@ -113,7 +113,7 @@ To view the |NTP| service configuration, use the following command:
.. code-block:: none
~(keystone_admin)$ system host-show controller-0
~(keystone_admin)]$ system host-show controller-0
+-----------------------+------------------------------------------------+
| Property | Value |
+-----------------------+------------------------------------------------+

22
doc/source/system_configuration/kubernetes/configuring-ptp-service-using-the-cli.rst
View File

@ -28,7 +28,7 @@ To view the existing |PTP| status, use the following command.
.. code-block:: none
~(keystone_admin)$ system ptp-show
~(keystone_admin)]$ system ptp-show
+--------------+--------------------------------------+
| Property | Value |
+--------------+--------------------------------------+
@ -51,7 +51,7 @@ and |PTP| are configured per host. Lock/unlock the host when updating.
.. code-block:: none
~(keystone_admin)$ system host-update controller-0 clock_synchronization=ptp
~(keystone_admin)]$ system host-update controller-0 clock_synchronization=ptp
+-----------------------+---------------------------------------+
| Property | Value |
+-----------------------+---------------------------------------+
@ -100,7 +100,7 @@ To view the |PTP| service configuration, use the following command:
.. code-block:: none
~(keystone_admin)$ system host-show controller-0
~(keystone_admin)]$ system host-show controller-0
+-----------------------+------------------------------------------------+
| Property | Value |
+-----------------------+------------------------------------------------+
@ -155,7 +155,7 @@ To view the |PTP| service configuration, use the following command:
.. code-block:: none
~(keystone_admin)$ system ptp-modify --mode=<hardware/software/legacy>
~(keystone_admin)]$ system ptp-modify --mode=<hardware/software/legacy>
- **PTP Network Transport**: Switch between IEEE 802.3 network
transport \(L2\) or |UDP| IPv4/v6 network transport for |PTP|
@ -163,7 +163,7 @@ To view the |PTP| service configuration, use the following command:
.. code-block:: none
~(keystone_admin)$ system ptp-modify --transport=<l2/UDP>
~(keystone_admin)]$ system ptp-modify --transport=<l2/UDP>
.. note::
L2 is the default option.
@ -184,7 +184,7 @@ To view the |PTP| service configuration, use the following command:
.. code-block:: none
~(keystone_admin)$ system ptp-modify --mechanism=<e2e/p2p>
~(keystone_admin)]$ system ptp-modify --mechanism=<e2e/p2p>
- **PTP Role**
@ -205,13 +205,13 @@ To view the |PTP| service configuration, use the following command:
.. code-block:: none
~(keystone_admin)$ system host-if-modify compute-3 ens803f0 -n sriovptp --ptp-role slave
~(keystone_admin)]$ system host-if-modify compute-3 ens803f0 -n sriovptp --ptp-role slave
To apply changes to hosts, use the following command:
.. code-block:: none
~(keystone_admin)$ system ptp-apply
~(keystone_admin)]$ system ptp-apply
|PTP| changes will be applied to all unlocked hosts configured with ptp
clock\_synchronization.
@ -239,7 +239,7 @@ The following service parameters are available:
.. code-block:: none
~(keystone_admin)$ system service-parameter-add ptp global domainNumber=24
~(keystone_admin)]$ system service-parameter-add ptp global domainNumber=24
results in the following being written to the configuration file:
@ -253,7 +253,7 @@ The following service parameters are available:
.. code-block:: none
~(keystone_admin)$ system service-parameter-add ptp global delay_mechanism=P2P
~(keystone_admin)]$ system service-parameter-add ptp global delay_mechanism=P2P
Then the **P2P** will be used instead.
@ -269,7 +269,7 @@ To apply service parameter changes to hosts, use the following command:
.. code-block:: none
~(keystone_admin)$ system service-parameter-apply ptp
~(keystone_admin)]$ system service-parameter-apply ptp
|PTP| changes will be applied to all unlocked hosts configured with
ptp clock\_synchronization.

12
doc/source/system_configuration/kubernetes/console-keyboard-mapping.rst
View File

@ -10,9 +10,19 @@ You can change the keyboard layout settings used on the text console for
a |prod| node.
You can log in to the console using the US keyboard layout and then change
the keyboard settings, if required. Use the following CLI commands to change
the keyboard settings, if required. Use the following |CLI| commands to change
the keyboard layout settings on your keyboard:
.. note::
When you log in to |prod| for the first time using the default US keyboard
layout, you are prompted to provide a new password. The new password you
enter may get mapped differently than you expect, since you are not using a
US keyboard. You should use as simple a password as possible in order to
avoid any unexpected key mappings. Then, after you have successfully logged
in to |prod| and updated your keyboard layout, you should update your
sysadmin password \(':command:`passwd sysadmin`'\) to a more secure
password.
To display the current console keyboard settings that are configured for the
virtual console:

2
doc/source/system_configuration/kubernetes/converting-a-duplex-system-to-direct-connection.rst
View File

@ -23,7 +23,7 @@ it at any time. You must use the CLI to make the change.
.. code-block:: none
~(keystone_admin)$ system modify --system_mode=duplex-direct
~(keystone_admin)]$ system modify --system_mode=duplex-direct
This raises **Config-out-of-date** alarm messages on both controllers.

2
doc/source/system_configuration/kubernetes/modifying-oam-firewall-rules.rst
View File

@ -13,7 +13,7 @@ These policies are defined using yaml syntax. For example:
.. code-block:: yaml
~(keystone_admin)$ kubectl get globalnetworkpolicies.crd.projectcalico.org -o yaml
~(keystone_admin)]$ kubectl get globalnetworkpolicies.crd.projectcalico.org -o yaml
apiVersion: v1
items:
- apiVersion: crd.projectcalico.org/v1

6
doc/source/system_configuration/kubernetes/specifying-dns-servers-using-the-cli.rst
View File

@ -12,7 +12,7 @@ To view the existing DNS server configuration, use the following command:
.. code-block:: none
~(keystone_admin)$ system dns-show
~(keystone_admin)]$ system dns-show
+--------------+--------------------------------------+
| Property | Value |
+--------------+--------------------------------------+
@ -28,10 +28,10 @@ nameservers option takes a comma-delimited list of IP addresses.
.. code-block:: none
~(keystone_admin)$ system dns-modify nameservers=<IP_address_1[,IP_address_2][,IP_address_3]>
~(keystone_admin)]$ system dns-modify nameservers=<IP_address_1[,IP_address_2][,IP_address_3]>
For example:
.. code-block:: none
~(keystone_admin)$ system dns-modify nameservers=8.8.8.8,8.8.4.4
~(keystone_admin)]$ system dns-modify nameservers=8.8.8.8,8.8.4.4

2
doc/source/system_configuration/kubernetes/system-config-helm-package-manager.rst
View File

@ -26,7 +26,7 @@ Use the following command to list the helm repositories:
.. parsed-literal::
~(keystone_admin)$ helm repo list
~(keystone_admin)]$ helm repo list
NAME URL
stable https://kubernetes-charts.storage.googleapis.com
local http://127.0.0.1:8879/charts