From 84f57aadda81e1ee603d1d92f1c5bd42a3befe97 Mon Sep 17 00:00:00 2001 From: Bogdan Dobrelya Date: Thu, 12 Dec 2024 16:19:24 +0100 Subject: [PATCH] Update docs_user/modules/proc_deploying-backend-services.adoc Co-authored-by: Katie Gilligan --- .../proc_deploying-backend-services.adoc | 10 ++-- ...rating-databases-to-mariadb-instances.adoc | 46 ++++++++----------- ...pology-specific-service-configuration.adoc | 4 +- ...cture-management-and-compute-services.adoc | 2 +- .../proc_stopping-openstack-services.adoc | 6 +-- 5 files changed, 28 insertions(+), 40 deletions(-) diff --git a/docs_user/modules/proc_deploying-backend-services.adoc b/docs_user/modules/proc_deploying-backend-services.adoc index 7b5663b0b..19dad6193 100644 --- a/docs_user/modules/proc_deploying-backend-services.adoc +++ b/docs_user/modules/proc_deploying-backend-services.adoc @@ -375,13 +375,12 @@ endif::[] + <1> Select an existing storage class in your {OpenShiftShort} cluster. -This example provides required infrastructure database and messaging services for a 1 compute cell -named `cell1`. Adjust the names, counts, IP addresses, and numbers, -like `replicas`, `storage`, or `storageRequest`, as needed. +This example provides the required infrastructure database and messaging services for 1 Compute cell +named `cell1`. Adjust the names, counts, IP addresses, and numbers, such as `replicas`, `storage`, or `storageRequest`, as needed. .Verification -* Verify that MariaDB and RabbitMQ are running, for all defined cells: +* Verify that MariaDB and RabbitMQ are running for all defined cells: + ---- $ RENAMED_CELLS="cell1" @@ -392,7 +391,6 @@ $ for CELL in $(echo $RENAMED_CELLS); do oc get pod rabbitmq-$CELL-server-0 -o jsonpath='{.status.phase}{"\n"}' | grep Running done ---- -Futher on, we will be referring to the given cells names via an environment -variable `RENAMED_CELLS`. +Later on in this guide, the given cells names are referred to by using the environment variable `RENAMED_CELLS`. * Verify that you can access the `OpenStackClient` pod. For more information, see link:{defaultURL}/maintaining_the_red_hat_openstack_services_on_openshift_deployment/assembly_accessing-the-rhoso-cloud#proc_accessing-the-OpenStackClient-pod_cloud-access-admin[Accessing the OpenStackClient pod] in _Maintaining the {rhos_long_noacro} deployment_. diff --git a/docs_user/modules/proc_migrating-databases-to-mariadb-instances.adoc b/docs_user/modules/proc_migrating-databases-to-mariadb-instances.adoc index 740b41941..7dd1fda99 100644 --- a/docs_user/modules/proc_migrating-databases-to-mariadb-instances.adoc +++ b/docs_user/modules/proc_migrating-databases-to-mariadb-instances.adoc @@ -26,13 +26,13 @@ $ STORAGE_CLASS=local-storage $ MARIADB_IMAGE=registry.redhat.io/rhosp-dev-preview/openstack-mariadb-rhel9:18.0 endif::[] -$ CELLS="default" +$ CELLS="default" <1> $ DEFAULT_CELL_NAME="cell1" $ RENAMED_CELLS="$DEFAULT_CELL_NAME" $ NAMESPACE="openstack" -$ CHARACTER_SET=utf8 # <1> +$ CHARACTER_SET=utf8 # <2> $ COLLATION=utf8_general_ci $ declare -A PODIFIED_DB_ROOT_PASSWORD @@ -65,14 +65,14 @@ $ for CELL in $(echo $CELLS); do > done $ declare -A SOURCE_MARIADB_IP -$ SOURCE_MARIADB_IP[default]=** +$ SOURCE_MARIADB_IP[default]=** <3> $ SOURCE_MARIADB_IP[cell1]=** $ SOURCE_MARIADB_IP[cell2]=** # ... $ declare -A SOURCE_GALERA_MEMBERS_DEFAULT $ SOURCE_GALERA_MEMBERS_DEFAULT=( -> ["standalone.localdomain"]=172.17.0.100 +> ["standalone.localdomain"]=172.17.0.100 <4> > # [...]=... > ) $ declare -A SOURCE_GALERA_MEMBERS_CELL1 @@ -85,15 +85,18 @@ $ SOURCE_GALERA_MEMBERS_CELL2=( > ) ---- + -<1> The CHARACTER_SET and collation should match the source DB, if the do not then it will break foreign key relationships for any tables that are created in the future as part of db sync. - -Here, `CELLS` and `RENAMED_CELLS` represent changes that are going to be made +<1> `CELLS` and `RENAMED_CELLS` represent changes that are going to be made after importing databases: the `default` cell takes a new name from `DEFAULT_CELL_NAME`. -In a multi-cell adoption scenario, it may retain its original 'default' name as well. +In a multi-cell adoption scenario, it might retain its original 'default' name as well. +<2> The `CHARACTER_SET` variable and collation should match the source database. If they do not match, then break foreign key relationships break for any tables that are created in the future as part of database sync. +<3> Complete `SOURCE_MARIADB_IP[*]= ...` data for each cell defined in `CELLS`. Provide records for the cell names and VIP addresses of MariaDB Galera clusters. +<4> For each cell defined in `CELLS`, complete `SOURCE_GALERA_MEMBERS_CELL` with the names of MariaDB Galera cluster members and its IP address. Replace `["standalone.localdomain"]="172.17.0.100"` to real hosts data. + +[NOTE] +A standalone {OpenStackPreviousInstaller} environment only creates a 'default' cell, which should be the only `CELLS` value for such a case. The `DEFAULT_CELL_NAME` value should be `cell1`. -Note that the `super` is not a cell, but the top-scope Nova -API "upcall" database instance. A super conductor connects to that database. -In this guide, the upcall and cells' databases are going to use the same password +[NOTE] +The `super` is not a cell, but the top-scope Nova API "upcall" database instance. A super conductor connects to that database. In this guide, the upcall and cells databases are going to use the same password that is defined in `osp-secret`. Old passwords are only needed to prepare the data exports. To get the values for `SOURCE_MARIADB_IP`, query the puppet-generated configurations in a Controller and CellController nodes: @@ -102,29 +105,16 @@ To get the values for `SOURCE_MARIADB_IP`, query the puppet-generated configurat $ sudo grep -rI 'listen mysql' -A10 /var/lib/config-data/puppet-generated/ | grep bind ---- -To get the values for `SOURCE_GALERA_MEMBERS_*`, query the puppet-generated configurations in a Controller and CellController nodes: +* To get the values for `SOURCE_GALERA_MEMBERS_*`, query the puppet-generated configurations in a Controller and CellController nodes: + ---- $ sudo grep -rI 'listen mysql' -A10 /var/lib/config-data/puppet-generated/ | grep server ---- - -The source cloud always uses the same password for cells' databases by design. -For that reason, we chose to use the same passwords file for all cells' stacks. -There is a split-stack topology, however, that allows using different passwords -files for each stack. ++ +The source cloud always uses the same password for cells databases by design. For that reason, the same passwords file is used for all cells stacks. There is a split-stack topology, however, that allows using different passwords files for each stack. * Prepare the MariaDB adoption helper pod: - -. Create a temporary folder to store the adoption helper pod. Choose storage requests that fit the MySQL database size: -A standalone TripleO only creates a 'default' cell, which should be the only `CELLS` value for such a case -(and `DEFAULT_CELL_NAME` should be `cell1`). - -** For each cell defined in `CELLS` -*** Replace `["standalone.localdomain"]="172.17.0.100"`, and complete `SOURCE_GALERA_MEMBERS_*` with the names of MariaDB Galera cluster members and its IP address. -*** Replace `SOURCE_MARIADB_IP[*]= ...`, and complete the records lists for the cell names and VIP addresses of MariaDB Galera clusters. -*** Replace `SOURCE_GALERA_MEMBERS_*[*]= ...`, and complete the records lists for the cell names and IP addresses of MariaDB Galera cluster members. - . Create a temporary volume claim and a pod for the database data copy. Edit the volume claim storage request if necessary, to give it enough space for the overcloud databases: + [source,yaml] @@ -197,7 +187,7 @@ $ for CELL in $(echo $CELLS); do > done ---- + -Each additional Nova v2 cell runs a dedicated Galera database cluster, so the checking is done for all of it. +Each additional Compute service (nova) v2 cell runs a dedicated Galera database cluster, so the checking is done for each cell. . Get the count of source databases with the `NOK` (not-OK) status: + diff --git a/docs_user/modules/proc_retrieving-topology-specific-service-configuration.adoc b/docs_user/modules/proc_retrieving-topology-specific-service-configuration.adoc index 93f052b04..1a27807c4 100644 --- a/docs_user/modules/proc_retrieving-topology-specific-service-configuration.adoc +++ b/docs_user/modules/proc_retrieving-topology-specific-service-configuration.adoc @@ -235,8 +235,8 @@ $ chmod 0600 ~/.source_cloud_exported_variables* ---- + <1> If `neutron-sriov-nic-agent` agents are running in your {OpenStackShort} deployment, get the configuration to use for the data plane adoption - ++ [NOTE] ==== -This configuration will be required later, during the data plane adoption post-checks. +This configuration is required later, during the data plane adoption post-checks. ==== diff --git a/docs_user/modules/proc_stopping-infrastructure-management-and-compute-services.adoc b/docs_user/modules/proc_stopping-infrastructure-management-and-compute-services.adoc index e13eb8b9c..d50547c19 100644 --- a/docs_user/modules/proc_stopping-infrastructure-management-and-compute-services.adoc +++ b/docs_user/modules/proc_stopping-infrastructure-management-and-compute-services.adoc @@ -29,7 +29,7 @@ EDPM_PRIVATEKEY_PATH="" <2> endif::[] ---- + -<1> Complete `CONTROLLER_SSH` settings with SSH connection details for all controllers, including cell controllers, of the source {OpenStackPreviousInstaller} cloud. +<1> Complete `CONTROLLER_SSH` settings with SSH connection details for all Controllers, including cell Controllers, of the source {OpenStackPreviousInstaller} cloud. ifeval::["{build}" == "downstream"] <2> Replace `` with the path to your SSH key. endif::[] diff --git a/docs_user/modules/proc_stopping-openstack-services.adoc b/docs_user/modules/proc_stopping-openstack-services.adoc index 44c4e3ae9..ddbafecc2 100644 --- a/docs_user/modules/proc_stopping-openstack-services.adoc +++ b/docs_user/modules/proc_stopping-openstack-services.adoc @@ -39,7 +39,7 @@ CONTROLLER2_SSH="ssh -i ** root@**" CONTROLLER3_SSH="ssh -i ** root@**" endif::[] ---- -* Specify IP addresses of all controllers, for example: +* Specify the IP addresses of all Controllers, for example: + [subs=+quotes] ---- @@ -51,13 +51,13 @@ endif::[] ifeval::["{build}" == "downstream"] CONTROLLER1_SSH="ssh -i ** root@**" <2> CONTROLLER2_SSH="ssh -i ** root@**" -CONTROLLER3_SSH="ssh -i ** root@**" +CONTROLLER3_SSH="ssh -i ** root@**" # ... endif::[] ---- ifeval::["{build}" == "downstream"] <1> Replace `` with the path to your SSH key. -<2> Replace `` with IP addresses of all controllers. +<2> Replace ` IP>` with IP addresses of all Controllers. endif::[] .Procedure