From 7eccf13d3f30fd60c36c4428e56397c2a31819ab Mon Sep 17 00:00:00 2001 From: Jiri Stransky Date: Fri, 10 May 2024 09:52:45 +0200 Subject: [PATCH 1/6] Remove mentions of the test VM from user docs --- .../proc_adopting-compute-services-to-the-data-plane.adoc | 2 -- docs_user/modules/proc_deploying-backend-services.adoc | 3 --- 2 files changed, 5 deletions(-) diff --git a/docs_user/modules/proc_adopting-compute-services-to-the-data-plane.adoc b/docs_user/modules/proc_adopting-compute-services-to-the-data-plane.adoc index 76adb5a42..d08f4e260 100644 --- a/docs_user/modules/proc_adopting-compute-services-to-the-data-plane.adoc +++ b/docs_user/modules/proc_adopting-compute-services-to-the-data-plane.adoc @@ -83,14 +83,12 @@ PODIFIED_DB_ROOT_PASSWORD=$(oc get -o json secret/osp-secret | jq -r .data.DbRoo CEPH_FSID=$(oc get secret ceph-conf-files -o json | jq -r '.data."ceph.conf"' | base64 -d | grep fsid | sed -e 's/fsid = //' alias openstack="oc exec -t openstackclient -- openstack" -FIP=192.168.122.20 declare -A computes export computes=( ["standalone.localdomain"]="192.168.122.100" # ... ) ---- -** Replace the value for `FIP` with the floating IP address of the test instance that you created on the source cloud. ** Replace `["standalone.localdomain"]="192.168.122.100"` with the name of the Compute node and its IP address. .Procedure diff --git a/docs_user/modules/proc_deploying-backend-services.adoc b/docs_user/modules/proc_deploying-backend-services.adoc index ff662155a..dca35317f 100644 --- a/docs_user/modules/proc_deploying-backend-services.adoc +++ b/docs_user/modules/proc_deploying-backend-services.adoc @@ -11,9 +11,6 @@ In subsequent steps, you import the original databases and then add * The cloud that you want to adopt is up and running, and it is on the {OpenStackShort} {rhos_prev_ver} release. -* A VM instance named `test` is running on the source cloud and its -floating IP is set into `FIP` env var. You can use a helper script to create that test VM. -//xref:../docs_dev/assemblies/development_environment.adoc#virtual-machine-steps[helper script] kgilliga: Engineers, do we want this link here? It points to dev docs. * The `openstack-operator` is deployed, but `OpenStackControlPlane` is not deployed. ifeval::["{build}" != "downstream"] From a76dea77cf438b4153133fe5a8790a06988ee3df Mon Sep 17 00:00:00 2001 From: Jiri Stransky Date: Fri, 10 May 2024 09:57:13 +0200 Subject: [PATCH 2/6] Mention that all source cloud hosts must be up and running --- docs_user/modules/proc_deploying-backend-services.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs_user/modules/proc_deploying-backend-services.adoc b/docs_user/modules/proc_deploying-backend-services.adoc index dca35317f..908558415 100644 --- a/docs_user/modules/proc_deploying-backend-services.adoc +++ b/docs_user/modules/proc_deploying-backend-services.adoc @@ -11,6 +11,8 @@ In subsequent steps, you import the original databases and then add * The cloud that you want to adopt is up and running, and it is on the {OpenStackShort} {rhos_prev_ver} release. +* All control plane and data plane hosts of the source cloud are up +and running, and continue to run throughout the adoption procedure. * The `openstack-operator` is deployed, but `OpenStackControlPlane` is not deployed. ifeval::["{build}" != "downstream"] From 3fdf384826e557924196b20404e2f14c93e471be Mon Sep 17 00:00:00 2001 From: Jiri Stransky Date: Fri, 10 May 2024 10:09:55 +0200 Subject: [PATCH 3/6] Mention that in order to use RHEL 9.4, minor update should be done --- docs_user/adoption-attributes.adoc | 6 +++++- ...rforming-a-fast-forward-upgrade-on-compute-services.adoc | 5 +++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs_user/adoption-attributes.adoc b/docs_user/adoption-attributes.adoc index 9a1ca5a53..6bf97a9a1 100644 --- a/docs_user/adoption-attributes.adoc +++ b/docs_user/adoption-attributes.adoc @@ -11,6 +11,8 @@ ifeval::["{build}" == "upstream"] :OpenShiftShort: OCP :rhos_curr_ver: Antelope :rhos_prev_ver: Wallaby +:rhel_curr_ver: 9.4 +:rhel_prev_ver: 9.2 :OpenStackPreviousInstaller: TripleO :Ceph: Ceph :CephCluster: Ceph Storage @@ -74,6 +76,8 @@ ifeval::["{build}" == "downstream"] :OpenStackShort: RHOSP :rhos_curr_ver: 18.0 :rhos_prev_ver: 17.1 +:rhel_curr_ver: 9.4 +:rhel_prev_ver: 9.2 :OpenShift: Red Hat OpenShift Container Platform :OpenShiftShort: RHOCP :OpenStackPreviousInstaller: director @@ -129,4 +133,4 @@ ifeval::["{build}" == "downstream"] //Telemetry service :telemetry: Telemetry service -endif::[] \ No newline at end of file +endif::[] diff --git a/docs_user/modules/proc_performing-a-fast-forward-upgrade-on-compute-services.adoc b/docs_user/modules/proc_performing-a-fast-forward-upgrade-on-compute-services.adoc index 6252990a6..1924fe726 100644 --- a/docs_user/modules/proc_performing-a-fast-forward-upgrade-on-compute-services.adoc +++ b/docs_user/modules/proc_performing-a-fast-forward-upgrade-on-compute-services.adoc @@ -131,3 +131,8 @@ ${BASH_ALIASES[openstack]} server list | grep -F '| test | ACTIVE |' && \ ${BASH_ALIASES[openstack]} server --os-compute-api-version 2.48 show --diagnostics test --fit-width -f json | jq -r '.state' | grep running || echo FAIL ---- +[NOTE] +After the data plane adoption, the hosts continue to run RHEL +{rhel_prev_ver}. In order to take advantage of RHEL {rhel_curr_ver}, +perform a minor update procedure after finishing the adoption +procedure. From ac87f0449cad354f1bee8a15caae99fe81746c24 Mon Sep 17 00:00:00 2001 From: Jiri Stransky Date: Fri, 10 May 2024 10:38:28 +0200 Subject: [PATCH 4/6] Improve section naming: Retrieving topology-specific service configuration --- .../assembly_adopting-openstack-control-plane-services.adoc | 4 ++-- docs_user/modules/proc_adopting-the-compute-service.adoc | 6 +++--- .../proc_migrating-databases-to-mariadb-instances.adoc | 4 ++-- ...retrieving-topology-specific-service-configuration.adoc} | 4 ++-- docs_user/modules/proc_stopping-openstack-services.adoc | 3 +-- 5 files changed, 10 insertions(+), 11 deletions(-) rename docs_user/modules/{proc_retrieving-services-topology-specific-configuration.adoc => proc_retrieving-topology-specific-service-configuration.adoc} (97%) diff --git a/docs_user/assemblies/assembly_adopting-openstack-control-plane-services.adoc b/docs_user/assemblies/assembly_adopting-openstack-control-plane-services.adoc index 8bb62ca9f..d40718a09 100644 --- a/docs_user/assemblies/assembly_adopting-openstack-control-plane-services.adoc +++ b/docs_user/assemblies/assembly_adopting-openstack-control-plane-services.adoc @@ -6,7 +6,7 @@ Adopt your {rhos_prev_long} {rhos_prev_ver} control plane services to deploy them in the {rhos_long} {rhos_curr_ver} control plane. -include::../modules/proc_retrieving-services-topology-specific-configuration.adoc[leveloffset=+1] +include::../modules/proc_retrieving-topology-specific-service-configuration.adoc[leveloffset=+1] include::../modules/proc_adopting-the-identity-service.adoc[leveloffset=+1] @@ -38,4 +38,4 @@ include::../modules/proc_adopting-autoscaling.adoc[leveloffset=+1] include::assembly_reviewing-the-openstack-control-plane-configuration.adoc[leveloffset=+1] -include::../modules/proc_rolling-back-the-control-plane-adoption.adoc[leveloffset=+1] \ No newline at end of file +include::../modules/proc_rolling-back-the-control-plane-adoption.adoc[leveloffset=+1] diff --git a/docs_user/modules/proc_adopting-the-compute-service.adoc b/docs_user/modules/proc_adopting-the-compute-service.adoc index 71513ce7b..557f1908b 100644 --- a/docs_user/modules/proc_adopting-the-compute-service.adoc +++ b/docs_user/modules/proc_adopting-the-compute-service.adoc @@ -21,8 +21,8 @@ must already be imported into the control plane MariaDB; ** the xref:adopting-the-networking-service_adopt-control-plane[Adopting the Networking service] needs to be imported; ** the {bare_metal} needs to be imported; //kgilliga:I removed the link because it did not work. I might rewrite this section anyway. - ** Required services specific topology -xref:proc_retrieving-services-topology-specific-configuration_adopt-control-plane[Retrieving services from a topology specific-configuration]. + ** Required topology-specific service configuration. For more information, see +xref:proc_retrieving-topology-specific-service-configuration_adopt-control-plane[Retrieving topology-specific service configuration]. ** {rhos_prev_long} services have been stopped. For more information, see xref:stopping-openstack-services_migrating-databases[Stopping {rhos_prev_long} services]. * Define the following shell variables. The values that are used are examples. Replace these example values with values that are correct for your environment: ---- @@ -142,7 +142,7 @@ $ openstack endpoint list | grep nova $ openstack server list ---- -Compare the following outputs with the topology specific configuration in xref:proc_retrieving-services-topology-specific-configuration_adopt-control-plane[Retrieving services from a topology specific-configuration]. +Compare the following outputs with the topology specific configuration in xref:proc_retrieving-topology-specific-service-configuration_adopt-control-plane[Retrieving topology-specific service configuration]. * Query the superconductor for cell1 existance and compare it to pre-adoption values: + 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 16bcf6e98..51b9bad0e 100644 --- a/docs_user/modules/proc_migrating-databases-to-mariadb-instances.adoc +++ b/docs_user/modules/proc_migrating-databases-to-mariadb-instances.adoc @@ -18,7 +18,7 @@ here this time). * Make sure the previous Adoption steps have been performed successfully. ** The `OpenStackControlPlane` resource must be already created. ** The control plane MariaDB and RabbitMQ are running. No other control plane services are running. - ** Required services specific topology. For more information, see xref:proc_retrieving-services-topology-specific-configuration_adopt-control-plane[Retrieving services from a topology specific-configuration]. + ** Required services specific topology. For more information, see xref:proc_retrieving-topology-specific-service-configuration_adopt-control-plane[Retrieving topology-specific service configuration]. ** {OpenStackShort} services have been stopped. For more information, see xref:stopping-openstack-services_{context}[Stopping {rhos_prev_long} services]. ** There must be network routability between the original MariaDB and the MariaDB for the control plane. * Define the following shell variables. The values that are used are examples. Replace these example values with values that are correct for your environment: @@ -227,7 +227,7 @@ EOF .Verification Compare the following outputs with the topology specific configuration. -For more information, see xref:proc_retrieving-services-topology-specific-configuration_adopt-control-plane[Retrieving services from a topology specific-configuration]. +For more information, see xref:proc_retrieving-topology-specific-service-configuration_adopt-control-plane[Retrieving topology-specific service configuration]. . Check that the databases were imported correctly: + diff --git a/docs_user/modules/proc_retrieving-services-topology-specific-configuration.adoc b/docs_user/modules/proc_retrieving-topology-specific-service-configuration.adoc similarity index 97% rename from docs_user/modules/proc_retrieving-services-topology-specific-configuration.adoc rename to docs_user/modules/proc_retrieving-topology-specific-service-configuration.adoc index f6de69cb7..eb8f3a966 100644 --- a/docs_user/modules/proc_retrieving-services-topology-specific-configuration.adoc +++ b/docs_user/modules/proc_retrieving-topology-specific-service-configuration.adoc @@ -1,6 +1,6 @@ -[id="proc_retrieving-services-topology-specific-configuration_{context}"] +[id="proc_retrieving-topology-specific-service-configuration_{context}"] -= Retrieving services from a topology specific-configuration += Retrieving topology-specific service configuration .Prerequisites diff --git a/docs_user/modules/proc_stopping-openstack-services.adoc b/docs_user/modules/proc_stopping-openstack-services.adoc index d93d8876f..559e072e9 100644 --- a/docs_user/modules/proc_stopping-openstack-services.adoc +++ b/docs_user/modules/proc_stopping-openstack-services.adoc @@ -34,8 +34,7 @@ openstack volume backup list --all-projects -c ID -c Status |grep -E '\| .+ing \ openstack share list --all-projects -c ID -c Status |grep -E '\| .+ing \|'| grep -vi error openstack image list -c ID -c Status |grep -E '\| .+ing \|' ---- -* Collect the services topology-specific configuration before stopping services required to gather it live. You need it to compare it with the post-adoption values later on. For more information, see xref:proc_retrieving-services-topology-specific-configuration_adopt-control-plane[Retrieving services from a topology specific-configuration]. -//kgilliga: Question for Mathieu and Jiri: Should the "Retrieving services from a topology specific-configuration" module be moved to the beginning of the "Migrating databases to the control plane chapter?". +* Collect the services topology-specific configuration before stopping services required to gather it live. You need it to compare it with the post-adoption values later on. For more information, see xref:proc_retrieving-topology-specific-service-configuration_adopt-control-plane[Retrieving topology-specific service configuration]. * Define the following shell variables. The values that are used are examples and refer to a single node standalone {OpenStackPreviousInstaller} deployment. Replace these example values with values that are correct for your environment: + [subs=+quotes] From e83a77e5a948e2138917993ed0f26df06e227150 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ji=C5=99=C3=AD=20Str=C3=A1nsk=C3=BD?= Date: Fri, 10 May 2024 15:28:51 +0200 Subject: [PATCH 5/6] Review suggestion accepted Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- ...rforming-a-fast-forward-upgrade-on-compute-services.adoc | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs_user/modules/proc_performing-a-fast-forward-upgrade-on-compute-services.adoc b/docs_user/modules/proc_performing-a-fast-forward-upgrade-on-compute-services.adoc index 1924fe726..61c847234 100644 --- a/docs_user/modules/proc_performing-a-fast-forward-upgrade-on-compute-services.adoc +++ b/docs_user/modules/proc_performing-a-fast-forward-upgrade-on-compute-services.adoc @@ -132,7 +132,5 @@ ${BASH_ALIASES[openstack]} server list | grep -F '| test | ACTIVE |' && \ ---- [NOTE] -After the data plane adoption, the hosts continue to run RHEL -{rhel_prev_ver}. In order to take advantage of RHEL {rhel_curr_ver}, -perform a minor update procedure after finishing the adoption -procedure. +After the data plane adoption, the hosts continue to run Red Hat Enterprise Linux (RHEL) +{rhel_prev_ver}. To take advantage of RHEL {rhel_curr_ver}, perform a minor update procedure after finishing the adoption procedure. From 98bef2bd709de452087e0624d2da31d3644bb710 Mon Sep 17 00:00:00 2001 From: Jiri Stransky Date: Fri, 10 May 2024 15:58:18 +0200 Subject: [PATCH 6/6] Move "Retrieving topology-specific service config" before service stopping One of the commands is doing a 'podman exec' into the 'nova_api' container, so we need it running. --- .../assembly_adopting-openstack-control-plane-services.adoc | 2 -- .../assembly_migrating-databases-to-the-control-plane.adoc | 4 +++- docs_user/modules/proc_adopting-the-compute-service.adoc | 4 ++-- .../proc_migrating-databases-to-mariadb-instances.adoc | 4 ++-- docs_user/modules/proc_stopping-openstack-services.adoc | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs_user/assemblies/assembly_adopting-openstack-control-plane-services.adoc b/docs_user/assemblies/assembly_adopting-openstack-control-plane-services.adoc index d40718a09..aa134dc5d 100644 --- a/docs_user/assemblies/assembly_adopting-openstack-control-plane-services.adoc +++ b/docs_user/assemblies/assembly_adopting-openstack-control-plane-services.adoc @@ -6,8 +6,6 @@ Adopt your {rhos_prev_long} {rhos_prev_ver} control plane services to deploy them in the {rhos_long} {rhos_curr_ver} control plane. -include::../modules/proc_retrieving-topology-specific-service-configuration.adoc[leveloffset=+1] - include::../modules/proc_adopting-the-identity-service.adoc[leveloffset=+1] include::../modules/proc_adopting-key-manager-service.adoc[leveloffset=+1] diff --git a/docs_user/assemblies/assembly_migrating-databases-to-the-control-plane.adoc b/docs_user/assemblies/assembly_migrating-databases-to-the-control-plane.adoc index 5dd31943c..a48fdfb07 100644 --- a/docs_user/assemblies/assembly_migrating-databases-to-the-control-plane.adoc +++ b/docs_user/assemblies/assembly_migrating-databases-to-the-control-plane.adoc @@ -6,6 +6,8 @@ To begin creating the control plane, enable backend services and import the databases from your original {rhos_prev_long} {rhos_prev_ver} deployment. +include::../modules/proc_retrieving-topology-specific-service-configuration.adoc[leveloffset=+1] + include::../modules/proc_deploying-backend-services.adoc[leveloffset=+1] include::../modules/proc_configuring-a-ceph-backend.adoc[leveloffset=+1] @@ -16,4 +18,4 @@ include::../modules/proc_stopping-openstack-services.adoc[leveloffset=+1] include::../modules/proc_migrating-databases-to-mariadb-instances.adoc[leveloffset=+1] -include::../modules/proc_migrating-ovn-data.adoc[leveloffset=+1] \ No newline at end of file +include::../modules/proc_migrating-ovn-data.adoc[leveloffset=+1] diff --git a/docs_user/modules/proc_adopting-the-compute-service.adoc b/docs_user/modules/proc_adopting-the-compute-service.adoc index 557f1908b..0446e4bba 100644 --- a/docs_user/modules/proc_adopting-the-compute-service.adoc +++ b/docs_user/modules/proc_adopting-the-compute-service.adoc @@ -22,7 +22,7 @@ must already be imported into the control plane MariaDB; ** the {bare_metal} needs to be imported; //kgilliga:I removed the link because it did not work. I might rewrite this section anyway. ** Required topology-specific service configuration. For more information, see -xref:proc_retrieving-topology-specific-service-configuration_adopt-control-plane[Retrieving topology-specific service configuration]. +xref:proc_retrieving-topology-specific-service-configuration_migrating-databases[Retrieving topology-specific service configuration]. ** {rhos_prev_long} services have been stopped. For more information, see xref:stopping-openstack-services_migrating-databases[Stopping {rhos_prev_long} services]. * Define the following shell variables. The values that are used are examples. Replace these example values with values that are correct for your environment: ---- @@ -142,7 +142,7 @@ $ openstack endpoint list | grep nova $ openstack server list ---- -Compare the following outputs with the topology specific configuration in xref:proc_retrieving-topology-specific-service-configuration_adopt-control-plane[Retrieving topology-specific service configuration]. +Compare the following outputs with the topology specific configuration in xref:proc_retrieving-topology-specific-service-configuration_migrating-databases[Retrieving topology-specific service configuration]. * Query the superconductor for cell1 existance and compare it to pre-adoption values: + 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 51b9bad0e..e4ce44c8e 100644 --- a/docs_user/modules/proc_migrating-databases-to-mariadb-instances.adoc +++ b/docs_user/modules/proc_migrating-databases-to-mariadb-instances.adoc @@ -18,7 +18,7 @@ here this time). * Make sure the previous Adoption steps have been performed successfully. ** The `OpenStackControlPlane` resource must be already created. ** The control plane MariaDB and RabbitMQ are running. No other control plane services are running. - ** Required services specific topology. For more information, see xref:proc_retrieving-topology-specific-service-configuration_adopt-control-plane[Retrieving topology-specific service configuration]. + ** Required services specific topology. For more information, see xref:proc_retrieving-topology-specific-service-configuration_migrating-databases[Retrieving topology-specific service configuration]. ** {OpenStackShort} services have been stopped. For more information, see xref:stopping-openstack-services_{context}[Stopping {rhos_prev_long} services]. ** There must be network routability between the original MariaDB and the MariaDB for the control plane. * Define the following shell variables. The values that are used are examples. Replace these example values with values that are correct for your environment: @@ -227,7 +227,7 @@ EOF .Verification Compare the following outputs with the topology specific configuration. -For more information, see xref:proc_retrieving-topology-specific-service-configuration_adopt-control-plane[Retrieving topology-specific service configuration]. +For more information, see xref:proc_retrieving-topology-specific-service-configuration_migrating-databases[Retrieving topology-specific service configuration]. . Check that the databases were imported correctly: + diff --git a/docs_user/modules/proc_stopping-openstack-services.adoc b/docs_user/modules/proc_stopping-openstack-services.adoc index 559e072e9..04c69b83b 100644 --- a/docs_user/modules/proc_stopping-openstack-services.adoc +++ b/docs_user/modules/proc_stopping-openstack-services.adoc @@ -34,7 +34,7 @@ openstack volume backup list --all-projects -c ID -c Status |grep -E '\| .+ing \ openstack share list --all-projects -c ID -c Status |grep -E '\| .+ing \|'| grep -vi error openstack image list -c ID -c Status |grep -E '\| .+ing \|' ---- -* Collect the services topology-specific configuration before stopping services required to gather it live. You need it to compare it with the post-adoption values later on. For more information, see xref:proc_retrieving-topology-specific-service-configuration_adopt-control-plane[Retrieving topology-specific service configuration]. +* Collect the services topology-specific configuration before stopping services required to gather it live. The topology-specific configuration is necessary for migrating the databases. For more information, see xref:proc_retrieving-topology-specific-service-configuration_migrating-databases[Retrieving topology-specific service configuration]. * Define the following shell variables. The values that are used are examples and refer to a single node standalone {OpenStackPreviousInstaller} deployment. Replace these example values with values that are correct for your environment: + [subs=+quotes]