From 36698324a98e65ec1d046fea558b6c7143784edc Mon Sep 17 00:00:00 2001 From: Ngairangbam Mili Date: Thu, 18 Jan 2024 05:08:04 +0000 Subject: [PATCH] New review for - Add warning about using quotation marks in keystone passwords for bootstrap Old review ink: https://review.opendev.org/c/starlingx/docs/+/903352 Change-Id: I3b31aa6b9c8263dcd62332689da200659a91deb5 Signed-off-by: Ngairangbam Mili --- .../_includes/quotation-marks-in-keystone-password.rest | 4 ++++ .../release/bare_metal/aio_duplex_install_kubernetes.rst | 2 ++ .../release/bare_metal/aio_simplex_install_kubernetes.rst | 2 ++ .../release/bare_metal/rook_storage_install_kubernetes.rst | 2 ++ .../changing-the-admin-password-on-distributed-cloud.rst | 1 + doc/source/security/kubernetes/password-recovery.rst | 2 ++ ...tarlingx-system-accounts-system-account-password-rules.rst | 1 + .../_includes/incl-bootstrap-sys-controller-0-standard.rest | 2 ++ 8 files changed, 16 insertions(+) create mode 100644 doc/source/_includes/quotation-marks-in-keystone-password.rest diff --git a/doc/source/_includes/quotation-marks-in-keystone-password.rest b/doc/source/_includes/quotation-marks-in-keystone-password.rest new file mode 100644 index 000000000..7422d574a --- /dev/null +++ b/doc/source/_includes/quotation-marks-in-keystone-password.rest @@ -0,0 +1,4 @@ +.. note:: + + During system bootstrap, the platform does not support the use of + quotation characters in the keystone user password. \ No newline at end of file diff --git a/doc/source/deploy_install_guides/release/bare_metal/aio_duplex_install_kubernetes.rst b/doc/source/deploy_install_guides/release/bare_metal/aio_duplex_install_kubernetes.rst index 921d51b94..c38445127 100644 --- a/doc/source/deploy_install_guides/release/bare_metal/aio_duplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/release/bare_metal/aio_duplex_install_kubernetes.rst @@ -374,6 +374,8 @@ Bootstrap system on controller-0 configuration as shown in the example below. Use the OAM IP SUBNET and IP ADDRESSing applicable to your deployment environment. + .. include:: /_includes/quotation-marks-in-keystone-password.rest + .. include:: /_includes/min-bootstrap-overrides-non-simplex.rest diff --git a/doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst index 85cf99f8d..2ce46b1bd 100644 --- a/doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst @@ -346,6 +346,8 @@ Bootstrap system on controller-0 configuration as shown in the example below. Use the OAM IP SUBNET and IP ADDRESSing applicable to your deployment environment. + .. include:: /_includes/quotation-marks-in-keystone-password.rest + .. include:: /_includes/min-bootstrap-overrides-simplex.rest .. only:: starlingx diff --git a/doc/source/deploy_install_guides/release/bare_metal/rook_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/release/bare_metal/rook_storage_install_kubernetes.rst index 1468b633c..998ab7703 100644 --- a/doc/source/deploy_install_guides/release/bare_metal/rook_storage_install_kubernetes.rst +++ b/doc/source/deploy_install_guides/release/bare_metal/rook_storage_install_kubernetes.rst @@ -126,6 +126,8 @@ Bootstrap system on controller-0 as shown in the example below. Use the OAM IP SUBNET and IP ADDRESSing applicable to your deployment environment. + .. include:: /_includes/quotation-marks-in-keystone-password.rest + :: cd ~ diff --git a/doc/source/dist_cloud/kubernetes/changing-the-admin-password-on-distributed-cloud.rst b/doc/source/dist_cloud/kubernetes/changing-the-admin-password-on-distributed-cloud.rst index 2b04a89bb..880ecbfc2 100644 --- a/doc/source/dist_cloud/kubernetes/changing-the-admin-password-on-distributed-cloud.rst +++ b/doc/source/dist_cloud/kubernetes/changing-the-admin-password-on-distributed-cloud.rst @@ -38,6 +38,7 @@ Ensure that all subclouds are managed and online. Respond to the prompts to complete the process. + .. include:: /_includes/quotation-marks-in-keystone-password.rest #. Source the script /etc/platform/openrc if you will continue to use the environment from the previous |CLI| command. diff --git a/doc/source/security/kubernetes/password-recovery.rst b/doc/source/security/kubernetes/password-recovery.rst index 800297148..fffbc3021 100644 --- a/doc/source/security/kubernetes/password-recovery.rst +++ b/doc/source/security/kubernetes/password-recovery.rst @@ -32,6 +32,8 @@ This section describes how to change or reset a Keystone user password. where is the username and is a temporary password. + .. include:: /_includes/quotation-marks-in-keystone-password.rest + .. only:: partner .. include:: /_includes/dm-credentials-on-keystone-pwds.rest diff --git a/doc/source/security/kubernetes/starlingx-system-accounts-system-account-password-rules.rst b/doc/source/security/kubernetes/starlingx-system-accounts-system-account-password-rules.rst index 69cf54c2c..a2ae46f1c 100644 --- a/doc/source/security/kubernetes/starlingx-system-accounts-system-account-password-rules.rst +++ b/doc/source/security/kubernetes/starlingx-system-accounts-system-account-password-rules.rst @@ -29,6 +29,7 @@ other Linux Accounts, and Keystone accounts): - at least one special character +.. include:: /_includes/quotation-marks-in-keystone-password.rest The following additional rules apply to Local Linux accounts only (Local LDAP, sysadmin, and other Linux accounts): diff --git a/doc/source/shared/_includes/incl-bootstrap-sys-controller-0-standard.rest b/doc/source/shared/_includes/incl-bootstrap-sys-controller-0-standard.rest index dbcd76027..83473c174 100644 --- a/doc/source/shared/_includes/incl-bootstrap-sys-controller-0-standard.rest +++ b/doc/source/shared/_includes/incl-bootstrap-sys-controller-0-standard.rest @@ -91,6 +91,8 @@ configuration as shown in the example below. Use the OAM IP SUBNET and IP ADDRESSing applicable to your deployment environment. + .. include:: /_includes/quotation-marks-in-keystone-password.rest + .. include:: /_includes/min-bootstrap-overrides-non-simplex.rest .. only:: starlingx