starlingx/docs
Code Issues Proposed changes

Merge "Replaced relase version to nn.nn"

Browse Source
This commit is contained in:
Zuul 2021-06-15 02:41:03 +00:00 committed by Gerrit Code Review
commit 0a0854caa3
17 changed files with 74 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/backup/kubernetes/restoring-starlingx-system-data-and-storage.rst
View File

@ -154,10 +154,10 @@ conditions are in place:
$ sudo sw-patch query $ sudo sw-patch query
Patch ID RR Release Patch State Patch ID RR Release Patch State
======================== ========== =========== ======================== ========== ======= ===========
COMPUTECONFIG Available 20.06 n/a COMPUTECONFIG Available nn.nn n/a
LIBCUNIT_CONTROLLER_ONLY Applied 20.06 n/a LIBCUNIT_CONTROLLER_ONLY Applied nn.nn n/a
STORAGECONFIG Applied 20.06 n/a STORAGECONFIG Applied nn.nn n/a
Rerun the Ansible Playbook if there were patches applied and you were Rerun the Ansible Playbook if there were patches applied and you were
prompted to reboot the system. prompted to reboot the system.

2
doc/source/deploy/deploy-edgeworker-nodes.rst
View File

@ -138,7 +138,7 @@ inventory (with personality set to None).
| reserved | False | | reserved | False |
| rootfs_device | /dev/sda | | rootfs_device | /dev/sda |
| serialid | None | | serialid | None |
| software_load | 20.12 | | software_load | nn.nn |
| task | None | | task | None |
| tboot | false | | tboot | false |
| ttys_dcd | None | | ttys_dcd | None |

2
doc/source/developer_resources/stx_ipv6_deployment.rst
View File

@ -469,7 +469,7 @@ reference.
| sdn_enabled | False | | sdn_enabled | False |
| security_feature | spectre_meltdown_v1 | | security_feature | spectre_meltdown_v1 |
| service_project_name | services | | service_project_name | services |
| software_version | 20.01 | | software_version | nn.nn |
| system_mode | duplex | | system_mode | duplex |
| system_type | All-in-one | | system_type | All-in-one |
| timezone | UTC | | timezone | UTC |

2
doc/source/dist_cloud/creating-subcloud-groups.rst
View File

@ -168,7 +168,7 @@ Deletes subcloud group details from the database.
| name | Subcloud1 | | name | Subcloud1 |
| description | Subcloud1 | | description | Subcloud1 |
| location | somewhere | | location | somewhere |
| software_version | 20.06 | | software_version | nn.nn |
| management | managed | | management | managed |
| availability | online | | availability | online |
| deploy_status | complete | | deploy_status | complete |

4
doc/source/dist_cloud/managing-subclouds-using-the-cli.rst
View File

@ -49,7 +49,7 @@ fails, delete subclouds, and monitor or change the managed status of subclouds.
| name | subcloud2 | | name | subcloud2 |
| description | subcloud2 description | | description | subcloud2 description |
| location | subcloud 2 location | | location | subcloud 2 location |
| software_version | 20.06 | | software_version | nn.nn |
| management | managed | | management | managed |
| availability | online | | availability | online |
| deploy_status | complete | | deploy_status | complete |
@ -82,7 +82,7 @@ fails, delete subclouds, and monitor or change the managed status of subclouds.
| name | subcloud2 | | name | subcloud2 |
| description | subcloud2 description | | description | subcloud2 description |
| location | subcloud 2 location | | location | subcloud 2 location |
| software_version | 20.06 | | software_version | nn.nn |
| management | managed | | management | managed |
| availability | online | | availability | online |
| deploy_status | complete | | deploy_status | complete |

12
doc/source/dist_cloud/reviewing-update-status-for-distributed-cloud-using-the-cli.rst
View File

@ -29,11 +29,11 @@ Distributed Cloud Using Horizon
~(keystone_admin)]$ sw-patch --os-region-name SystemController query ~(keystone_admin)]$ sw-patch --os-region-name SystemController query
Patch ID RR Release Patch State Patch ID RR Release Patch State
=================== == ======= =========== =================== == ======= ===========
wrcp_nn.nn_PATCH_0001 N 20.06 Applied wrcp_nn.nn_PATCH_0001 N nn.nn Applied
wrcp_nn.nn_PATCH_0002 N 20.06 Applied wrcp_nn.nn_PATCH_0002 N nn.nn Applied
wrcp_nn.nn_PATCH_0003 N 20.06 Partial wrcp_nn.nn_PATCH_0003 N nn.nn Partial
wrcp_nn.nn_PATCH_0004 N 20.06 Available wrcp_nn.nn_PATCH_0004 N nn.nn Available
wrcp_nn.nn_PATCH_0005 N 20.06 Available wrcp_nn.nn_PATCH_0005 N nn.nn Available
The **Patch State** column indicates whether the Patch is available, The **Patch State** column indicates whether the Patch is available,
partially-applied or applied. **Applied** indicates that the update has partially-applied or applied. **Applied** indicates that the update has
@ -71,7 +71,7 @@ Distributed Cloud Using Horizon
| name | subcloud1 | | name | subcloud1 |
| description | None | | description | None |
| location | None | | location | None |
| software_version | 20.06 | | software_version | nn.nn |
| management | managed | | management | managed |
| availability | online | | availability | online |
| deploy_status | complete | | deploy_status | complete |

2
doc/source/security/kubernetes/enable-https-access-for-starlingx-rest-and-web-server-endpoints.rst
View File

@ -62,7 +62,7 @@ When secure HTTPS connectivity is enabled, HTTP is disabled.
| sdn_enabled | False | | sdn_enabled | False |
| security_feature | spectre_meltdown_v1 | | security_feature | spectre_meltdown_v1 |
| service_project_name | services | | service_project_name | services |
| software_version | 20.06 | | software_version | nn.nn |
| system_mode | duplex | | system_mode | duplex |
| system_type | Standard | | system_type | Standard |
| timezone | Canada/Eastern | | timezone | Canada/Eastern |

2
doc/source/system_configuration/kubernetes/changing-the-timezone-configuration.rst
View File

@ -31,7 +31,7 @@ You can use the CLI to view and change the timezone configuration.
| sdn_enabled | False | | sdn_enabled | False |
| security_feature | spectre_meltdown_v1 | | security_feature | spectre_meltdown_v1 |
| service_project_name | services | | service_project_name | services |
| software_version | 20.06 | | software_version | nn.nn |
| system_mode | duplex | | system_mode | duplex |
| system_type | Standard | | system_type | Standard |
| timezone | Canada/Eastern | | timezone | Canada/Eastern |

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

@ -96,7 +96,7 @@ Use the following command to change the clock synchronization on the host:
| reserved | False | | reserved | False |
| rootfs_device | /dev/disk/by-path/pci-0000:00:1f.2-ata-1.0 | | rootfs_device | /dev/disk/by-path/pci-0000:00:1f.2-ata-1.0 |
| serialid | None | | serialid | None |
| software_load | 20.06 | | software_load | nn.nn |
| subfunction_avail | available | | subfunction_avail | available |
| subfunction_oper | enabled | | subfunction_oper | enabled |
| subfunctions | controller,worker | | subfunctions | controller,worker |
@ -149,7 +149,7 @@ To view the |NTP| service configuration, use the following command:
| rootfs_device | /dev/disk/by-path/pci-0000:04:00.0-sas | | rootfs_device | /dev/disk/by-path/pci-0000:04:00.0-sas |
| | -0x5001e6754aa38000-lun-0 | | | -0x5001e6754aa38000-lun-0 |
| serialid | None | | serialid | None |
| software_load | 20.06 | | software_load | nn.nn |
| task | | | task | |
| tboot | false | | tboot | false |
| ttys_dcd | None | | ttys_dcd | None |

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

@ -86,7 +86,7 @@ and |PTP| are configured per host. Lock/unlock the host when updating.
| rootfs_device | /dev/disk/by-path/pci-0000:04:00.0 | | rootfs_device | /dev/disk/by-path/pci-0000:04:00.0 |
| | -sas-0x5001e6754aa38000-lun-0 | | | -sas-0x5001e6754aa38000-lun-0 |
| serialid | None | | serialid | None |
| software_load | 20.06 | | software_load | nn.nn |
| task | | | task | |
| tboot | false | | tboot | false |
| ttys_dcd | None | | ttys_dcd | None |
@ -136,7 +136,7 @@ To view the |PTP| service configuration, use the following command:
| rootfs_device | /dev/disk/by-path/pci-0000:04:00.0-sas | | rootfs_device | /dev/disk/by-path/pci-0000:04:00.0-sas |
| | -0x5001e6754aa38000-lun-0 | | | -0x5001e6754aa38000-lun-0 |
| serialid | None | | serialid | None |
| software_load | 20.06 | | software_load | nn.nn |
| task | | | task | |
| tboot | false | | tboot | false |
| ttys_dcd | None | | ttys_dcd | None |

2
doc/source/updates/kubernetes/identifying-the-software-version-and-update-level-using-the-cli.rst
View File

@ -37,7 +37,7 @@ For more about working with software updates, see :ref:`Manage Software Updates
| sdn_enabled | False | | sdn_enabled | False |
| security_feature | spectre_meltdown_v1 | | security_feature | spectre_meltdown_v1 |
| service_project_name | services | | service_project_name | services |
| software_version | 20.06 | | software_version | nn.nn |
| system_mode | duplex | | system_mode | duplex |
| system_type | Standard | | system_type | Standard |
| timezone | UTC | | timezone | UTC |

30
doc/source/updates/kubernetes/installing-in-service-software-updates-using-the-cli.rst
View File

@ -26,7 +26,7 @@ unlocked as part of applying the update.
$ sudo sw-patch query $ sudo sw-patch query
Patch ID RR Release Patch State Patch ID RR Release Patch State
==================== == ======= =========== ==================== == ======= ===========
INSVC_HORIZON_SYSINV N 20.04 Available INSVC_HORIZON_SYSINV N nn.nn Available
#. Check the status of the hosts. #. Check the status of the hosts.
@ -35,9 +35,9 @@ unlocked as part of applying the update.
$ sudo sw-patch query-hosts $ sudo sw-patch query-hosts
Hostname IP Address Patch Current Reboot Required Release State Hostname IP Address Patch Current Reboot Required Release State
============ ============== ============= =============== ======= ===== ============ ============== ============= =============== ======= =====
worker-0 192.168.204.24 Yes No 20.01 idle worker-0 192.168.204.24 Yes No nn.nn idle
controller-0 192.168.204.3 Yes No 20.01 idle controller-0 192.168.204.3 Yes No nn.nn idle
controller-1 192.168.204.4 Yes No 20.01 idle controller-1 192.168.204.4 Yes No nn.nn idle
#. Ensure the original update files have been deleted from the root drive. #. Ensure the original update files have been deleted from the root drive.
@ -67,7 +67,7 @@ unlocked as part of applying the update.
$ sudo sw-patch query $ sudo sw-patch query
Patch ID RR Release Patch State Patch ID RR Release Patch State
==================== == ======= ============= ==================== == ======= =============
INSVC_HORIZON_SYSINV N 20.04 Partial-Apply INSVC_HORIZON_SYSINV N nn.nn Partial-Apply
As it is an in-service update, the hosts report that they are not 'patch As it is an in-service update, the hosts report that they are not 'patch
current', but they do not require a reboot. current', but they do not require a reboot.
@ -77,9 +77,9 @@ unlocked as part of applying the update.
$ sudo sw-patch query-hosts $ sudo sw-patch query-hosts
Hostname IP Address Patch Current Reboot Required Release State Hostname IP Address Patch Current Reboot Required Release State
============ ============== ============= =============== ======= ===== ============ ============== ============= =============== ======= =====
worker-0 192.168.204.24 No No 20.04 idle worker-0 192.168.204.24 No No nn.nn idle
controller-0 192.168.204.3 No No 20.04 idle controller-0 192.168.204.3 No No nn.nn idle
controller-1 192.168.204.4 No No 20.04 idle controller-1 192.168.204.4 No No nn.nn idle
#. Install the update on controller-0. #. Install the update on controller-0.
@ -97,9 +97,9 @@ unlocked as part of applying the update.
$ sudo sw-patch query-hosts $ sudo sw-patch query-hosts
Hostname IP Address Patch Current Reboot Required Release State Hostname IP Address Patch Current Reboot Required Release State
============ ============== ============= =============== ======= ===== ============ ============== ============= =============== ======= =====
worker-0 192.168.204.24 No No 20.01 idle worker-0 192.168.204.24 No No nn.nn idle
controller-0 192.168.204.3 Yes No 20.01 idle controller-0 192.168.204.3 Yes No nn.nn idle
controller-1 192.168.204.4 No No 20.01 idle controller-1 192.168.204.4 No No nn.nn idle
The controller-1 host reports it is now 'patch current' and does not The controller-1 host reports it is now 'patch current' and does not
require a reboot, without having been locked or rebooted require a reboot, without having been locked or rebooted
@ -121,11 +121,11 @@ unlocked as part of applying the update.
$ sudo sw-patch query-hosts $ sudo sw-patch query-hosts
Hostname IP Address Patch Current Reboot Required Release State Hostname IP Address Patch Current Reboot Required Release State
============ ============== ============= =============== ======= ===== ============ ============== ============= =============== ======= =====
worker-0 192.168.204.24 Yes No 20.04 idle worker-0 192.168.204.24 Yes No nn.nn idle
controller-0 192.168.204.3 Yes No 20.04 idle controller-0 192.168.204.3 Yes No nn.nn idle
controller-1 192.168.204.4 Yes No 20.04 idle controller-1 192.168.204.4 Yes No nn.nn idle
$ sudo sw-patch query $ sudo sw-patch query
Patch ID RR Release Patch State Patch ID RR Release Patch State
==================== == ======= =========== ==================== == ======= ===========
INSVC_HORIZON_SYSINV N 20.04 Applied INSVC_HORIZON_SYSINV N nn.nn Applied

38
doc/source/updates/kubernetes/installing-reboot-required-software-updates-using-the-cli.rst
View File

@ -85,9 +85,9 @@ You can install reboot-required software updates using the CLI.
Hostname IP Address Patch Current Reboot Required Release State Hostname IP Address Patch Current Reboot Required Release State
============ ============== ============= =============== ======= ===== ============ ============== ============= =============== ======= =====
worker-0 192.168.204.12 Yes No 20.04 idle worker-0 192.168.204.12 Yes No nn.nn idle
controller-0 192.168.204.3 Yes Yes 20.04 idle controller-0 192.168.204.3 Yes Yes nn.nn idle
controller-1 192.168.204.4 Yes Yes 20.04 idle controller-1 192.168.204.4 Yes Yes nn.nn idle
For each host in the cluster, the following status fields are displayed: For each host in the cluster, the following status fields are displayed:
@ -190,14 +190,14 @@ You can install reboot-required software updates using the CLI.
Hostname IP Address Patch Current Reboot Required Release State Hostname IP Address Patch Current Reboot Required Release State
============ ============== ============= =============== ======= ===== ============ ============== ============= =============== ======= =====
compute-0 192.168.204.95 Yes No 20.04 idle compute-0 192.168.204.95 Yes No nn.nn idle
compute-1 192.168.204.63 Yes No 20.04 idle compute-1 192.168.204.63 Yes No nn.nn idle
compute-2 192.168.204.99 Yes No 20.04 idle compute-2 192.168.204.99 Yes No nn.nn idle
compute-3 192.168.204.49 Yes No 20.04 idle compute-3 192.168.204.49 Yes No nn.nn idle
controller-0 192.168.204.3 Yes No 20.04 idle controller-0 192.168.204.3 Yes No nn.nn idle
controller-1 192.168.204.4 Yes No 20.04 idle controller-1 192.168.204.4 Yes No nn.nn idle
storage-0 192.168.204.37 Yes No 20.04 idle storage-0 192.168.204.37 Yes No nn.nn idle
storage-1 192.168.204.90 Yes No 20.04 idle storage-1 192.168.204.90 Yes No nn.nn idle
#. Install all pending updates on **controller-1**. #. Install all pending updates on **controller-1**.
@ -215,14 +215,14 @@ You can install reboot-required software updates using the CLI.
Hostname IP Address Patch Current Reboot Required Release State Hostname IP Address Patch Current Reboot Required Release State
============ ============== ============= =============== ======= ===== ============ ============== ============= =============== ======= =====
compute-0 192.168.204.95 Yes No 20.04 idle compute-0 192.168.204.95 Yes No nn.nn idle
compute-1 192.168.204.63 Yes No 20.04 idle compute-1 192.168.204.63 Yes No nn.nn idle
compute-2 192.168.204.99 Yes No 20.04 idle compute-2 192.168.204.99 Yes No nn.nn idle
compute-3 192.168.204.49 Yes No 20.04 idle compute-3 192.168.204.49 Yes No nn.nn idle
controller-0 192.168.204.3 Yes No 20.04 idle controller-0 192.168.204.3 Yes No nn.nn idle
controller-1 192.168.204.4 Yes No 20.04 idle controller-1 192.168.204.4 Yes No nn.nn idle
storage-0 192.168.204.37 Yes No 20.04 idle storage-0 192.168.204.37 Yes No nn.nn idle
storage-1 192.168.204.90 Yes No 20.04 idle storage-1 192.168.204.90 Yes No nn.nn idle
#. Install any pending updates for the worker or storage hosts. #. Install any pending updates for the worker or storage hosts.

12
doc/source/updates/kubernetes/removing-reboot-required-software-updates.rst
View File

@ -72,12 +72,12 @@ Horizon <installing-reboot-required-software-updates-using-horizon>`.
Hostname IP Address Patch Current Reboot Required Release State Hostname IP Address Patch Current Reboot Required Release State
============ =============== ============= =============== ======= ===== ============ =============== ============= =============== ======= =====
compute-0 192.168.204.179 Yes No 20.04 idle compute-0 192.168.204.179 Yes No nn.nn idle
compute-1 192.168.204.173 Yes No 20.04 idle compute-1 192.168.204.173 Yes No nn.nn idle
controller-0 192.168.204.3 No No 20.04 idle controller-0 192.168.204.3 No No nn.nn idle
controller-1 192.168.204.4 No No 20.04 idle controller-1 192.168.204.4 No No nn.nn idle
storage-0 192.168.204.213 Yes No 20.04 idle storage-0 192.168.204.213 Yes No nn.nn idle
storage-1 192.168.204.181 Yes No 20.04 idle storage-1 192.168.204.181 Yes No nn.nn idle
In this example, the controllers have updates ready to be removed, and In this example, the controllers have updates ready to be removed, and

16
doc/source/updates/kubernetes/update-status-and-lifecycle.rst
View File

@ -66,11 +66,11 @@ updated but not yet rebooted.
Hostname IP Address Patch Current Reboot Required Release State Hostname IP Address Patch Current Reboot Required Release State
============ ============== ============= =============== ======= ===== ============ ============== ============= =============== ======= =====
compute-0 192.168.204.95 Yes No 20.06 idle compute-0 192.168.204.95 Yes No nn.nn idle
compute-1 192.168.204.63 Yes No 20.06 idle compute-1 192.168.204.63 Yes No nn.nn idle
compute-2 192.168.204.99 Yes No 20.06 idle compute-2 192.168.204.99 Yes No nn.nn idle
compute-3 192.168.204.49 Yes No 20.06 idle compute-3 192.168.204.49 Yes No nn.nn idle
controller-0 192.168.204.3 Yes No 20.06 idle controller-0 192.168.204.3 Yes No nn.nn idle
controller-1 192.168.204.4 Yes No 20.06 idle controller-1 192.168.204.4 Yes No nn.nn idle
storage-0 192.168.204.37 Yes No 20.06 idle storage-0 192.168.204.37 Yes No nn.nn idle
storage-1 192.168.204.90 Yes No 20.06 idle storage-1 192.168.204.90 Yes No nn.nn idle

2
doc/source/updates/kubernetes/upgrading-all-in-one-duplex-or-standard.rst
View File

@ -94,7 +94,6 @@ of |prod| software.
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ system load-list ~(keystone_admin)]$ system load-list
+----+----------+------------------+ +----+----------+------------------+
| id | state | software_version | | id | state | software_version |
+----+----------+------------------+ +----+----------+------------------+
@ -102,7 +101,6 @@ of |prod| software.
| 2 | imported | nn.nn | | 2 | imported | nn.nn |
+----+----------+------------------+ +----+----------+------------------+
#. Apply any required software updates. #. Apply any required software updates.
The system must be 'patch current'. All software updates related to your The system must be 'patch current'. All software updates related to your

1
doc/source/updates/kubernetes/upgrading-all-in-one-simplex.rst
View File

@ -97,7 +97,6 @@ the system contains more than 5 GBytes of these images, the upgrade start will f
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ system load-list ~(keystone_admin)]$ system load-list
+----+----------+------------------+ +----+----------+------------------+
| id | state | software_version | | id | state | software_version |
+----+----------+------------------+ +----+----------+------------------+