Spellcheck (r9, dsR9)
Run spellcheck job and correct errors. Fix malformed table Change-Id: I15d30123ce246adcbdde5d0c9b05e3ff4a69abc0 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone
parent
130d05d696
commit
547bc79e7d
@ -218,7 +218,7 @@ For example, follow the steps below:
|
||||
``poll_freq_seconds`` sets how frequently, in seconds the services
|
||||
are checked.
|
||||
|
||||
#. To configure the ``ptp-notification`` v2 API in a seperate section,
|
||||
#. To configure the ``ptp-notification`` v2 API in a separate section,
|
||||
include the following in the ``notification-override.yaml`` file.
|
||||
Ensure that values are updated to match the configured instance
|
||||
names on your system.
|
||||
|
||||
@ -11,7 +11,7 @@ You can perform a system restore (controllers, workers, including or excluding
|
||||
storage nodes) of a |prod| cluster from a previous system backup and bring it
|
||||
back to the operational state it was when the backup procedure took place.
|
||||
|
||||
There are two restore modes- optimized restore and legacy restore. Optmized restore
|
||||
There are two restore modes- optimized restore and legacy restore. Optimized restore
|
||||
must be used on |AIO-SX| and legacy restore must be used on systems that are not |AIO-SX|.
|
||||
|
||||
.. rubric:: |context|
|
||||
|
||||
@ -82,7 +82,7 @@ In this method you can run Ansible Restore playbook and point to controller-0.
|
||||
|
||||
If this parameter is set to true, Ansible Restore playbook will look
|
||||
for the backup file provided on the target server. The parameter
|
||||
``initial_backup_dir`` can be ommited from the command line. In this
|
||||
``initial_backup_dir`` can be ommitted from the command line. In this
|
||||
case, the backup file will be under ``/opt/platform-backup`` directory.
|
||||
|
||||
If this parameter is set to false, the Ansible Restore playbook will
|
||||
|
||||
@ -121,7 +121,7 @@ Documentation for StarlingX is organized into the following sections:
|
||||
Release-specific installation and deployment guides.
|
||||
|
||||
:ref:`Security <index-security-84d0d8aa401b>`
|
||||
Detailed discusion of security configuration.
|
||||
Detailed discussion of security configuration.
|
||||
|
||||
:ref:`System Configuration <index-sysconf-d511820651f0>`
|
||||
Detailed discussion of various post-installation configuration changes.
|
||||
@ -406,7 +406,7 @@ extension to organize content into tabs.
|
||||
Tabs are useful for presenting alternate sets of content in a way that does not
|
||||
require that the reader interact with sets that are not of interest. This is
|
||||
particularly useful in procedures where some steps vary across two or more
|
||||
variable factors. Rather than maintain two or more seperate procedures, tabs
|
||||
variable factors. Rather than maintain two or more separate procedures, tabs
|
||||
can be used to show one of the alternate sets of content. For example, the
|
||||
|prod| installation procedures make heavy use of tabs to allow the reader to
|
||||
switch between virtual and bare-metal versions of the procedures.
|
||||
@ -525,7 +525,7 @@ readers 'dig' for relevant content, making it unnecessarily difficult to find.
|
||||
|
||||
**Group tabs**
|
||||
|
||||
Tab sets can be grouped so that switching to a tab with a certian name in one
|
||||
Tab sets can be grouped so that switching to a tab with a certain name in one
|
||||
set causes all other tab sets on the page to switch to the same tab. This can
|
||||
be very useful when the same alternatives recur many times on the same page.
|
||||
The reader only needs to select the tab that is relevant to them once to have
|
||||
@ -894,7 +894,7 @@ documents:
|
||||
Command prompt conventions
|
||||
--------------------------
|
||||
|
||||
Command examples in |prod| are preceeded by a shell prompt. These prompts
|
||||
Command examples in |prod| are preceded by a shell prompt. These prompts
|
||||
provide readers with important hints about the context in which the command is
|
||||
to be used. It is important that the following prompts be used consistently
|
||||
throughout the |prod| documentation.
|
||||
@ -931,8 +931,8 @@ For example:
|
||||
"Include" files must not end in ``.rst``. The StarlingX convention is to use
|
||||
``.rest``.
|
||||
|
||||
You can store multiple fragements of content in a single include file and use
|
||||
them in various places. To do this, use ``rst`` comments to deliniate where
|
||||
You can store multiple fragments of content in a single include file and use
|
||||
them in various places. To do this, use ``rst`` comments to delineate where
|
||||
each begins and ends:
|
||||
|
||||
.. code-block::
|
||||
@ -1054,10 +1054,11 @@ This will result in the expected numbering sequence:
|
||||
|
||||
.. note::
|
||||
|
||||
* Only the start\ |html-comment|-after and end\ |html-comment|-before paramters work with ..
|
||||
pre\ |html-comment|-include::.
|
||||
* Only the start\ |html-comment|-after and end\ |html-comment|-before
|
||||
parameters work with .. pre\ |html-comment|-include::.
|
||||
|
||||
* Indentation within the ``rest`` file being referenced must match the calling context.
|
||||
* Indentation within the ``rest`` file being referenced must match the
|
||||
calling context.
|
||||
|
||||
* If the list is not indented, the additional step(s) to be inserted should
|
||||
not be indented.
|
||||
@ -1267,8 +1268,8 @@ Hiding empty table rows
|
||||
A table may occasionally contain rows with conditionalized content that applies
|
||||
only in one context, resulting in empty rows in the output from other contexts.
|
||||
|
||||
You can supress the output of empty rows by adding ``|hide-empty-rows|`` to the
|
||||
files in which you want this behavior. All empty rows will be hidden in the
|
||||
You can suppress the output of empty rows by adding ``|hide-empty-rows|`` to
|
||||
the files in which you want this behavior. All empty rows will be hidden in the
|
||||
files where you make this addition.
|
||||
|
||||
.. note::
|
||||
@ -1553,7 +1554,7 @@ Example RST:
|
||||
Release activities
|
||||
------------------
|
||||
|
||||
Several activies must be completed in preparation for each release.
|
||||
Several activities must be completed in preparation for each release.
|
||||
|
||||
*********************
|
||||
Release notes updates
|
||||
|
||||
@ -9,7 +9,7 @@ Development StarlingX Installation
|
||||
This installation guide is for the upcoming release of |prod|, and may not
|
||||
work due to pre-release inconsistencies between documentation and code.
|
||||
|
||||
To install the most recent released verion of |prod|, see:
|
||||
To install the most recent released version of |prod|, see:
|
||||
https://docs.starlingx.io/r/stx.8.0/deploy_install_guides/release/index-install-r7-8966076f0e81.html
|
||||
|
||||
StarlingX provides a pre-defined set of standard :doc:`deployment
|
||||
|
||||
@ -86,8 +86,8 @@ deployment of an All-In-One Simplex configuration.
|
||||
|
||||
.. note::
|
||||
All available configuration options can be found using ``--help``.
|
||||
Parameters as ``--snapshot`` and ``--headless`` may be benefitial if
|
||||
working in a development enviroment.
|
||||
Parameters as ``--snapshot`` and ``--headless`` may be beneficial if
|
||||
working in a development environment.
|
||||
|
||||
|
||||
.. note::
|
||||
|
||||
@ -64,7 +64,7 @@ already configured Docker on your system):
|
||||
|
||||
#. Install Minikube and Helm.
|
||||
#. Build or download the StarlingX k8s development environment.
|
||||
#. Enter the stx-builder pod/container to triger the building task.
|
||||
#. Enter the stx-builder pod/container to trigger the building task.
|
||||
#. Build packages/ISO creation.
|
||||
|
||||
.. note::
|
||||
@ -311,7 +311,7 @@ Once docker images are available locally, you can start & stop them using the ``
|
||||
stx control start
|
||||
|
||||
The script pulls build containers from DockerHub by default, where a new version is
|
||||
built once per day (ie default container images may be slightly out of date when you
|
||||
built once per day (i.e default container images may be slightly out of date when you
|
||||
pull them). You can force a local re-build as follows:
|
||||
|
||||
::
|
||||
|
||||
@ -303,7 +303,7 @@ up-to-date.
|
||||
|
||||
.. note::
|
||||
On it's current version, Docker CLI throws a warning when
|
||||
pulling images that're still using the v1 manifest format.
|
||||
pulling images that are still using the v1 manifest format.
|
||||
The official Docker image registry, on it's latest version, does
|
||||
not allow images that still uses them.
|
||||
A few images used by the StarlingX OS are outdated, so, as of
|
||||
|
||||
@ -89,7 +89,7 @@ The local storage location of backup data files can be customized using
|
||||
``--backup-values <yaml-file>`` option. The ``--backup-values <yaml-file>``is
|
||||
specified on the systemController every time you execute ``dcmanager
|
||||
subcloud-backup create``, so the backup values are easily re-applied to a
|
||||
subcloud regardless of whether it has been re-installled or not.Storage
|
||||
subcloud regardless of whether it has been re-installed or not. Storage
|
||||
location customization and/or backup filename customization can also lead to
|
||||
complications in restoring a group of subclouds.
|
||||
|
||||
|
||||
@ -559,7 +559,7 @@ The table below lists the operations that can/cannot be performed on the protect
|
||||
| | | |
|
||||
| | | #. Remove the subcloud from the |SPG| to make it a local/unprotected subcloud. |
|
||||
| | | |
|
||||
| | | #. Unmange the subcloud. |
|
||||
| | | #. Unmanage the subcloud. |
|
||||
| | | |
|
||||
| | | #. Rename the subcloud. |
|
||||
| | | |
|
||||
@ -587,7 +587,7 @@ The table below lists the operations that can/cannot be performed on the protect
|
||||
| | | |
|
||||
| | | #. Remove the subcloud from the |SPG| to make it a local/unprotected subcloud. |
|
||||
| | | |
|
||||
| | | #. Unmange the subcloud. |
|
||||
| | | #. Unmanage the subcloud. |
|
||||
| | | |
|
||||
| | | #. Restore the subcloud from the backup. |
|
||||
| | | |
|
||||
|
||||
@ -180,7 +180,7 @@ previous (N-1) release, ensure that the following prerequisites are met:
|
||||
upgrading the subcloud, ensure that the system controller has locally
|
||||
stored copies (caches) of container images for all the previous versions of
|
||||
Kubernetes relevant to the platform release. For example, if the system
|
||||
controlle r is installed with Kubernetes 1.24, we need to ensure that all
|
||||
controller is installed with Kubernetes 1.24, we need to ensure that all
|
||||
the system images related to Kubernetes 1.21, 1.22, and 1.23 are stored
|
||||
locally (cached) on the system controller for use when the subcloud tries
|
||||
to upgrade to those versions.
|
||||
|
||||
@ -8,7 +8,7 @@ You can rename an existing subcloud using the |CLI| or Horizon.
|
||||
|
||||
.. rubric:: |prereq|
|
||||
|
||||
In order to rename a partucular subcloud, the subcloud must be in the
|
||||
In order to rename a particular subcloud, the subcloud must be in the
|
||||
**unmanaged** mode and the deployment status must be either **complete** or
|
||||
**prestage-complete**. Otherwise, you will get the following error message:
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@ the following parameters/options:
|
||||
|
||||
``--with-install``
|
||||
Perform remote installation of the subcloud prior to execution of restore
|
||||
procedure. The subcloud must support Redfish Virutal Media Service (version
|
||||
procedure. The subcloud must support Redfish Virtual Media Service (version
|
||||
1.2 or higher) to use this option.
|
||||
|
||||
``--local-only``
|
||||
|
||||
@ -18,7 +18,7 @@ with the possibility of aborting and resuming the deployment.
|
||||
.. rubric:: |context|
|
||||
|
||||
After physically installing the hardware and network connectivity of a
|
||||
subcloud, the subcloud deployment process excutes the following phases in the
|
||||
subcloud, the subcloud deployment process executes the following phases in the
|
||||
central cloud:
|
||||
|
||||
- The :command:`dcmanager subcloud deploy create` command.
|
||||
@ -421,7 +421,7 @@ controllers (for example, ``/home/sysadmin/docker-registry-ca-cert.pem``).
|
||||
|
||||
To install the subcloud using Redfish Virtual Media Service, use the
|
||||
:command:`subcloud deploy install` command. Both ``--install-values`` and
|
||||
``--release`` parameters are optional if they were provided previouslly,
|
||||
``--release`` parameters are optional if they were provided previously,
|
||||
and will replace them if present on request.
|
||||
|
||||
.. code-block:: none
|
||||
@ -499,7 +499,7 @@ controllers (for example, ``/home/sysadmin/docker-registry-ca-cert.pem``).
|
||||
|
||||
To configure the subcloud, use the :command:`subcloud deploy config`
|
||||
command. The ``--deploy-config`` parameter is optional if it was
|
||||
provided previouslly, and will replace it if present on request.
|
||||
provided previously, and will replace it if present on request.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
|
||||
@ -301,10 +301,10 @@ procedure is performed only on the subcloud.
|
||||
|
||||
.. note::
|
||||
|
||||
The endpoints associated with |prod-dc| management will be
|
||||
updated to the endpoints of the new admin network. This can take a few minutes
|
||||
and can be obatined using the :command:`openstack endpoint list` command on the
|
||||
subcloud.
|
||||
The endpoints associated with |prod-dc| management will be updated to
|
||||
the endpoints of the new admin network. This can take a few minutes and
|
||||
can be obtained using the :command:`openstack endpoint list` command on
|
||||
the subcloud.
|
||||
|
||||
#. Before going back to the system controller, perform an additional lock/unlock
|
||||
on both controller-0 and controller-1 and the hosts should be available again.
|
||||
|
||||
@ -13,7 +13,7 @@ community.
|
||||
is typically the responsibility of commercial vendors or the users
|
||||
themselves.
|
||||
|
||||
* The commuity does not provide software updates/patches (i.e. for bug fixes or
|
||||
* The community does not provide software updates/patches (i.e. for bug fixes or
|
||||
new |CVE| vulnerabilities) to |prod| released ISOs.
|
||||
|
||||
* The community does not support or test software upgrades from one |prod|
|
||||
|
||||
@ -22,7 +22,7 @@ Use the following procedure to uninstall the |NFD| application.
|
||||
~(keystone_admin)]$ system application-delete node-feature-discovery
|
||||
|
||||
|
||||
Once uninstallation is complete, all related pods, resources and configurations
|
||||
will be removed from the system.
|
||||
Once the application is uninstalled, all related pods, resources and
|
||||
configurations will be removed from the system.
|
||||
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ Ceph cluster will be containerized and managed by Rook, to improve operation
|
||||
and maintenance efficiency.
|
||||
|
||||
This guide describes a method to migrate the host-based Ceph cluster deployed with
|
||||
StarlingX early releses to the newly containerized Ceph clusters using an upcoming
|
||||
StarlingX early releases to the newly containerized Ceph clusters using an upcoming
|
||||
StarlingX release, while maintaining user data in :abbr:`OSDs (Object Store Devices)`.
|
||||
|
||||
The migration procedure maintains CEPH OSDs and data on OSDs. Although the procedure
|
||||
|
||||
@ -85,7 +85,7 @@ the migration procedures.
|
||||
|
||||
#. Update helm override value for application |prefix|-openstack
|
||||
|
||||
Update helm override value for cinder, to change provisoner from
|
||||
Update helm override value for cinder, to change provisioner from
|
||||
rbd/ceph.com to kube-system.rbd.csi.ceph.com.
|
||||
|
||||
#. Edit secret ceph-admin to update keyring
|
||||
|
||||
@ -47,7 +47,7 @@ Standard
|
||||
:end-before: end-min-hw-reqs-std
|
||||
|
||||
-------------------------------
|
||||
Stardard with dedicated storage
|
||||
Standard with dedicated storage
|
||||
-------------------------------
|
||||
|
||||
.. include:: /shared/_includes/prepare-servers-for-installation-91baad307173.rest
|
||||
|
||||
@ -109,7 +109,7 @@ Helm has been upgraded to v3.12.2 in StarlingX Release 9.0.
|
||||
Support for Silicom TimeSync Server Adaptor
|
||||
*******************************************
|
||||
|
||||
The Silicom network adapter provides local time sync support via a local |GNSS|
|
||||
The Silicom network adaptor provides local time sync support via a local |GNSS|
|
||||
module which is based on the Intel Columbiaville device.
|
||||
|
||||
- ``cvl-4.10`` Silicom driver bundle
|
||||
@ -697,7 +697,7 @@ In previous releases of |prod-long| this has been set to "false" for backward
|
||||
compatibility, but this is no longer an option and it is now hardcoded to "true".
|
||||
|
||||
**Workaround**: Any application that relies on this feature gate being disabled
|
||||
(i.e. assumes the existance of the "self link") must be updated before
|
||||
(i.e. assumes the existence of the "self link") must be updated before
|
||||
upgrading to Kubernetes v1.24.
|
||||
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ CVE Maintenance
|
||||
|
||||
.. note::
|
||||
|
||||
There are no scans executed or |CVE| fixes implemeneted on the released
|
||||
There are no scans executed or |CVE| fixes implemented on the released
|
||||
versions / branches on StarlingX.
|
||||
|
||||
For the current Debian-based versions of StarlingX:
|
||||
|
||||
@ -118,7 +118,7 @@ present on |DC| SystemController systems or |DC| Subclouds.
|
||||
| DC-AdminEp-Server | On SystemController, it is called dc-adminep-certificate. On subcloud, it is called sc-adminep-certificate signed by interCA. | Yes | auto-renewed |
|
||||
+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| **System trusted CA Certificates (ssl_ca)** | One or more (typically external) |CA| certificates to identify remote servers. Example: when using an external Container Registry, the certificate of the | No | NOT AUTO-RENEWED as these are certificates that are not necessarily owned by the platform |
|
||||
| | |CA| that signed the external Container Registry's certificate must be configured to validate the identity of the external Container Regsitry. | | |
|
||||
| | |CA| that signed the external Container Registry's certificate must be configured to validate the identity of the external Container Registry. | | |
|
||||
+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Where:
|
||||
|
||||
@ -42,7 +42,7 @@ either an uploaded certificate or an auto generated certificate.
|
||||
.. rubric:: |proc|
|
||||
|
||||
Before starting the update, it is highly recommended to backup the existing
|
||||
Kubernetes Root |CA| certficate and key, i.e. ``/etc/kubernetes/pki/ca.crt``
|
||||
Kubernetes Root |CA| certificate and key, i.e. ``/etc/kubernetes/pki/ca.crt``
|
||||
and ``/etc/kubernetes/pki/ca.key``.
|
||||
|
||||
#. Create the strategy.
|
||||
|
||||
@ -92,7 +92,7 @@ and ``/etc/kubernetes/pki/ca.key``.
|
||||
|
||||
``--subject``
|
||||
|
||||
Optional argment to specify the distinguished name of the new certificate.
|
||||
Optional arguement to specify the distinguished name of the new certificate.
|
||||
It has to be in the format ``C=<Country> ST=<State/Province> L=<Locality>
|
||||
O=<Organization> OU=<OrganizationUnit> CN=<commonName>``. If not specified,
|
||||
the new certificate will have "Kubernetes" as default.
|
||||
|
||||
@ -5,7 +5,7 @@ Selectively Disable SSH for Local OpenLDAP and WAD Users
|
||||
========================================================
|
||||
|
||||
Local OpenLDAP and |WAD| servers are used for K8s API and |SSH| authentication.
|
||||
Thus, it is neccessary to disallow |SSH| authentication for selective users.
|
||||
Thus, it is necessary to disallow |SSH| authentication for selective users.
|
||||
|
||||
---------------------------------
|
||||
Linux Group denyssh Configuration
|
||||
|
||||
@ -97,7 +97,7 @@ Each of the fields are explained below:
|
||||
Default value: ``37``
|
||||
|
||||
The current offset between TAI and UTC. This value does not need to be
|
||||
altered unless IERS introduces a new leapsecond into UTC. If necessary, the
|
||||
altered unless IERS introduces a new leap-second into UTC. If necessary, the
|
||||
value can be altered for testing purposes using a ``ptp4l`` instance
|
||||
parameter.
|
||||
|
||||
@ -108,14 +108,14 @@ Each of the fields are explained below:
|
||||
``leap61``
|
||||
Default value: ``0``
|
||||
|
||||
This attribute is used to handle the addition of a new leapsecond. |prod|
|
||||
This attribute is used to handle the addition of a new leap-second. |prod|
|
||||
does not currently support altering the **leap61** attribute.
|
||||
|
||||
|
||||
``leap59``
|
||||
Default value: ``0``
|
||||
|
||||
This attribute is used to handle the addition of a new leapsecond. |prod|
|
||||
This attribute is used to handle the addition of a new leap-second. |prod|
|
||||
does not currently support altering the **leap59** attribute.
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@ parameters using helm-overrides.
|
||||
|
||||
.. rubric:: |context|
|
||||
|
||||
On multi-node systems, a homogenous deployment of the Silicom TimeSync (STS)
|
||||
On multi-node systems, a homogeneous deployment of the Silicom TimeSync (STS)
|
||||
cards is necessary since it's not possible to specify different configurations
|
||||
for different nodes.
|
||||
|
||||
|
||||
@ -84,7 +84,7 @@ sources, and manage and monitor the ``phc2sys`` application.
|
||||
cmdline_opts='-w'
|
||||
|
||||
#. Assign required interface parameters. The ``ha_domainNumber`` parameter can
|
||||
be ommited if a shared domain number is used and is configured under the
|
||||
be ommitted if a shared domain number is used and is configured under the
|
||||
global instance parameters.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
@ -253,7 +253,7 @@ You can install reboot-required software updates using the CLI.
|
||||
.. note::
|
||||
Update installations can be triggered in parallel.
|
||||
|
||||
The :command:`sw-patch host-install-async` command ( cooresponding to
|
||||
The :command:`sw-patch host-install-async` command ( corresponding to
|
||||
**install patches** on the Horizon Web interface) can be run on all
|
||||
locked nodes, without waiting for one node to complete the install
|
||||
before triggering the install on the next. If you can lock the nodes at
|
||||
|
||||
@ -322,7 +322,7 @@ system. This feature is not supported in the system which is not |AIO-SX|.
|
||||
this case, we need to repeat steps 9 and 10 twice for the remaining
|
||||
versions v1.23.1 and v1.24.4.
|
||||
|
||||
#. |optional| Uncordon
|
||||
#. |optional| Run the ``uncordon`` subcommand.
|
||||
|
||||
Skip this step if you did not perform step 8.
|
||||
|
||||
|
||||
@ -52,7 +52,7 @@ discussed in :ref:`Install Reboot-Required Software Updates Using Horizon
|
||||
|pn|-|pvr|-PATCH_0001 Applied
|
||||
|
||||
In this example the update is listed in the *Applied* state, but it could
|
||||
alo be in the *Partial-Apply* state.
|
||||
also be in the *Partial-Apply* state.
|
||||
|
||||
#. Remove the update.
|
||||
|
||||
|
||||
@ -46,7 +46,7 @@ abort. It may be necessary to restore the system from a backup.
|
||||
|
||||
#. Lock all storage and worker nodes that don't have ceph-mon configured
|
||||
(ceph-mon usually on worker-0 or storage-0). Execute the
|
||||
:command:`system ceph-mon-list` comand to determine which hosts are running
|
||||
:command:`system ceph-mon-list` command to determine which hosts are running
|
||||
ceph-mon.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
Loading…
Reference in New Issue
Block a user