starlingx/docs
Code Issues Proposed changes

Replace stx with prefix substitution (3 of 3)

Browse Source 
3rd review in a group to change instances of
stx-openstack to |prefix|-openstack
This group includes old guides for configuration, operations, and
developer resources.
Fixed issue with * in 1 file.

Change-Id: I188fd9bef38a012a1eaf7334a2f5d9fe55e7c75d
Signed-off-by: MCamp859 <maryx.camp@intel.com>
This commit is contained in:
MCamp859 2021-11-15 15:24:39 -05:00
parent 1337709927
commit 4252738a07
10 changed files with 144 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/configuration/cert_config.rst
View File

@ -223,15 +223,15 @@ To enable HTTPS for OpenStack:
#. If not already done, upload the OpenStack application manifest and Helm
charts:
::
.. parsed-literal::
$ system application-upload stx-openstack <stx-openstack-armada-tar-ball>
$ system application-upload |prefix|-openstack <|prefix|-openstack-armada-tar-ball>
#. Update the OpenStack Helm charts and apply them to OpenStack services.
::
.. parsed-literal::
$ system application-apply stx-openstack
$ system application-apply |prefix|-openstack
-----------
Trusted CAs
@ -287,6 +287,6 @@ an external Docker registry with a certificate signed by a non-standard CA.
* To update the OpenStack Helm charts and apply them:
::
.. parsed-literal::
~(keystone_admin)]$ system application-apply stx-openstack
~(keystone_admin)]$ system application-apply |prefix|-openstack

14
doc/source/configuration/openstack_cinder_config.rst
View File

@ -57,15 +57,15 @@ controller-0 using the following example commands:
#. The recommended size for the file system is at least 2 times as
large as the largest converted image from qcow2 to raw.
#. The conversion file system can be added before or after stx-openstack is
applied.
#. The conversion file system can be added before or after
|prefix|-openstack is applied.
#. The conversion file system must be added on both controllers. If not,
stx-openstack will not use the new file system.
|prefix|-openstack will not use the new file system.
#. If the conversion file system is added after stx-openstack is applied,
changes to stx-openstack will only take effect once the application is
re-applied.
#. If the conversion file system is added after |prefix|-openstack is
applied, changes to |prefix|-openstack will only take effect once the
application is re-applied.
The ``image-conversion`` file system can be added only on controller nodes.
@ -110,7 +110,7 @@ removed.
.. Note::
You cannot delete an image-conversion file system when
stx-openstack is in the applying, applied, or removing state.
|prefix|-openstack is in the applying, applied, or removing state.
You cannot add or remove any other file systems using these commands.

8
doc/source/developer_resources/backup_restore.rst
View File

@ -448,11 +448,11 @@ Steps:
a. Delete the old OpenStack application and upload the application again.
(Note that images and volumes will remain in Ceph.)
::
.. parsed-literal::
system application-remove stx-openstack
system application-delete stx-openstack
system application-upload stx-openstack-<ver>.tgz
system application-remove |prefix|-openstack
system application-delete |prefix|-openstack
system application-upload |prefix|-openstack-<ver>.tgz
#. (Optional) If you want to delete the Ceph data, remove old Glance images
and Cinder volumes from the Ceph pool.

16
doc/source/developer_resources/move_to_new_openstack_version_in_starlingx.rst
View File

@ -206,24 +206,24 @@ Here are some tips for testing and debugging your upgrade:
#. Use `system application management <sys_app_management>`_ commands to manage
the application. For example:
::
.. parsed-literal::
system application-upload -n stx-openstack stx-openstack-1.0-16.tgz
system application-apply stx-openstack
system application-remove stx-openstack
system application-delete stx-openstack
system application-upload -n |prefix|-openstack |prefix|-openstack-1.0-16.tgz
system application-apply |prefix|-openstack
system application-remove |prefix|-openstack
system application-delete |prefix|-openstack
watch -n 5 system application-list
#. Use kubectl commands for log analysis. For example:
::
.. parsed-literal::
tail -f /var/log/sysinv.log
tail -f /var/log/armada/stx-openstack-apply.log
tail -f /var/log/armada/|prefix|-openstack-apply.log
kubectl -n openstack get po
kubectl -n openstack logs nova-compute-compute-0-75ea0372-nmtz2
kubectl -n openstack exec -it nova-compute-compute-0-31b0f4b3-2rqgf -- bash
kubectl -n openstack describe pod nova-compute-compute-0-31b0f4b3-2rqgf
kubectl -n openstack get pod nova-compute-compute-0-31b0f4b3-2rqgf -o yaml
/var/log/container/*.log //To see related pod logs for issue debug
/var/log/container/\*.log //To see related pod logs for issue debug

6
doc/source/developer_resources/stx_sdo_rv.rst
View File

@ -109,9 +109,9 @@ Integration Steps
source /etc/platform/openrc
#. Load the stx-openstack application package into |prod|. The tarball
package contains the stx-openstack Airship Armada manifest and stx-openstack
set of Helm charts. For example:
#. Load the |prefix|-openstack application package into |prod|. The tarball
package contains the |prefix|-openstack Airship Armada manifest and
|prefix|-openstack set of Helm charts. For example:
::

16
doc/source/operations/ceph_cluster_aio_duplex_migration.rst
View File

@ -1087,9 +1087,9 @@ Delete pod mariadb-server-0 mariadb-server-1 osh-openstack-rabbitmq-rabbitmq-0 o
Update override for cinder helm chart.
::
.. parsed-literal::
$ system helm-override-update stx-openstack cinder openstack --reuse-value --values cinder_override.yaml
$ system helm-override-update |prefix|-openstack cinder openstack --reuse-value --values cinder_override.yaml
$ controller-0:~$ cat cinder_override.yaml
conf:
@ -1104,25 +1104,25 @@ Update override for cinder helm chart.
rbd1:
volume_driver: ""
Apply application stx-openstack again
Apply application |prefix|-openstack again.
::
.. parsed-literal::
[sysadmin@controller-0 script(keystone_admin)]$ system application-apply stx-openstack
[sysadmin@controller-0 script(keystone_admin)]$ system application-apply |prefix|-openstack
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | True |
| app_version | 1.0-45 |
| created_at | 2020-07-08T05:47:24.019723+00:00 |
| manifest_file | stx-openstack.yaml |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | stx-openstack |
| name | |prefix|-openstack |s| |
| progress | None |
| status | applying |
| updated_at | 2020-07-08T06:27:08.836258+00:00 |
+---------------+----------------------------------+
Please use 'system application-list' or 'system application-show stx-openstack' to view the current progress.
Please use 'system application-list' or 'system application-show |prefix|-openstack' to view the current progress.
[sysadmin@controller-0 script(keystone_admin)]$
Check application apply successfully and all pods work well without error.

16
doc/source/operations/ceph_cluster_aio_simplex_migration.rst
View File

@ -623,9 +623,9 @@ Delete pod mariadb-server-0 osh-openstack-rabbitmq-rabbitmq-0
Update override for cinder helm chart.
::
.. parsed-literal::
$ system helm-override-update stx-openstack cinder openstack --reuse-value --values cinder_override.yaml
$ system helm-override-update |prefix|-openstack cinder openstack --reuse-value --values cinder_override.yaml
$ controller-0:~$ cat cinder_override.yaml
conf:
@ -640,25 +640,25 @@ Update override for cinder helm chart.
rbd1:
volume_driver: ""
Apply application stx-openstack again
Apply application |prefix|-openstack again.
::
.. parsed-literal::
[sysadmin@controller-0 script(keystone_admin)]$ system application-apply stx-openstack
[sysadmin@controller-0 script(keystone_admin)]$ system application-apply |prefix|-openstack
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | True |
| app_version | 1.0-45 |
| created_at | 2020-07-08T05:47:24.019723+00:00 |
| manifest_file | stx-openstack.yaml |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | stx-openstack |
| name | |prefix|-openstack |s| |
| progress | None |
| status | applying |
| updated_at | 2020-07-08T06:27:08.836258+00:00 |
+---------------+----------------------------------+
Please use 'system application-list' or 'system application-show stx-openstack' to view the current progress.
Please use 'system application-list' or 'system application-show |prefix|-openstack' to view the current progress.
[sysadmin@controller-0 script(keystone_admin)]$
Check application apply successfully and all pods work well without error.

16
doc/source/operations/ceph_cluster_migration.rst
View File

@ -744,9 +744,9 @@ Create crush rule "kube-rbd" in pod rook-ceph-tools.
Update override for cinder helm chart.
::
.. parsed-literal::
$ system helm-override-update stx-openstack cinder openstack --reuse-value --values cinder_override.yaml
$ system helm-override-update |prefix|-openstack cinder openstack --reuse-value --values cinder_override.yaml
$ controller-0:~$ cat cinder_override.yaml
conf:
@ -818,25 +818,25 @@ to kube-system.rbd.csi.ceph.com in annotation.
pv.kubernetes.io/bound-by-controller: "yes"
volume.beta.kubernetes.io/storage-provisioner: kube-system.rbd.csi.ceph.com
Apply application stx-openstack again
Apply application |prefix|-openstack again.
::
.. parsed-literal::
[sysadmin@controller-0 script(keystone_admin)]$ system application-apply stx-openstack
[sysadmin@controller-0 script(keystone_admin)]$ system application-apply |prefix|-openstack
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | True |
| app_version | 1.0-45 |
| created_at | 2020-07-08T05:47:24.019723+00:00 |
| manifest_file | stx-openstack.yaml |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | stx-openstack |
| name | |prefix|-openstack |s| |
| progress | None |
| status | applying |
| updated_at | 2020-07-08T06:27:08.836258+00:00 |
+---------------+----------------------------------+
Please use 'system application-list' or 'system application-show stx-openstack' to view the current progress.
Please use 'system application-list' or 'system application-show |prefix|-openstack' to view the current progress.
[sysadmin@controller-0 script(keystone_admin)]$
Check application apply successfully and all pods work well without error.

19
doc/source/operations/storage_migration_from_ceph_to_rook.rst
View File

@ -73,25 +73,26 @@ the migration procedures.
#. Edit pv and pvc provisioner
For already created pv and pvc in openstack, if stx-openstack application
is applied before migration, change the provsioner to kube-system.rbd.csi.ceph.com
from rbd/ceph.com, as csi pod will provide csi service to K8s.
For already created pv and pvc in openstack, if |prefix|-openstack
application is applied before migration, change the provsioner to
kube-system.rbd.csi.ceph.com from rbd/ceph.com, as csi pod will provide csi
service to K8s.
#. Update keyring and conf file on controller-0, controler-1
For k8s pv, it will use host /etc/ceph/keyring for ceph cluster access, update
folder /etc/ceph/ with containerized ceph cluster.
For k8s pv, it will use host /etc/ceph/keyring for ceph cluster access,
update folder /etc/ceph/ with containerized ceph cluster.
#. Update helm override value for application stx-openstack
#. Update helm override value for application |prefix|-openstack
Update helm override value for cinder, to change provisoner from rbd/ceph.com
to kube-system.rbd.csi.ceph.com.
Update helm override value for cinder, to change provisoner from
rbd/ceph.com to kube-system.rbd.csi.ceph.com.
#. Edit secret ceph-admin to update keyring
Update keyring in ceph-admin
#. Re-apply application stx-openstack
#. Re-apply application |prefix|-openstack
------------------
Guide Step by Step

6
doc/source/operations/tsn.rst
View File

@ -192,12 +192,12 @@ Edge cloud platform
#. Enable Nova PCI passthrough configuration in STX.
.. code:: sh
.. parsed-literal::
# set pci-passthrough config
system helm-override-update stx-openstack nova openstack --values
system helm-override-update |prefix|-openstack nova openstack --values
nova-tsn-pt.yaml
system application-apply stx-openstack
system application-apply |prefix|-openstack
#. Create VM instance.