From fc24a5cbe5fcd108b31c714e5ad5765720ff98c4 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 10:21:41 +0200 Subject: [PATCH 01/20] Update os-diff doc with package install instructions and correct usages --- ...nfiguration-files-between-deployments.adoc | 92 ++++++++++++++- .../modules/proc_adopting-autoscaling.adoc | 3 +- ...pting-image-service-with-ceph-backend.adoc | 3 +- .../proc_adopting-telemetry-services.adoc | 3 +- ...nfiguration-from-a-tripleo-deployment.adoc | 110 +++++++++++++++++- ..._verifying-the-image-service-adoption.adoc | 2 +- 6 files changed, 198 insertions(+), 15 deletions(-) diff --git a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc index de3736e83..d47e40c90 100644 --- a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc +++ b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc @@ -6,14 +6,70 @@ In order to help users to handle the configuration for the {OpenStackPreviousIns services the tool: https://github.com/openstack-k8s-operators/os-diff has been develop to compare the configuration files between the {OpenStackPreviousInstaller} deployment and the {rhos_long} cloud. Make sure Golang is installed and configured on your env: -//kgilliga: Do we want to link to "https://github.com/openstack-k8s-operators/os-diff" downstream? + ---- -git clone https://github.com/openstack-k8s-operators/os-diff -pushd os-diff -make build +dnf install -y golang-github-openstack-k8s-operators-os-diff ---- -Then configure ansible.cfg and ssh-config file according to your environment: +Then configure /etc/os-diff/os-diff.cfg and /etc/os-diff/ssh.config file according to your environment: + +In order to allow os-diff to connect to your clouds and pull files from the services you describe in the config.yaml +file you need to properly set the option in the os-diff.cfg: + +[source,yaml] +[subs=+quotes] +---- +[Default] + +local_config_dir=/tmp/ +service_config_file=config.yaml + +[Tripleo] + +ssh_cmd=ssh -F ssh.config +director_host=standalone +container_engine=podman +connection=ssh +remote_config_path=/tmp/tripleo +local_config_path=/tmp/ + +[Openshift] + +ocp_local_config_path=/tmp/ocp +connection=local +ssh_cmd="" +---- + +The ssh_cmd will be used by os-diff to access your TripleO Undercloud/Director host via SSH, +or the host where your cloud is accessible and the podman/docker binary is installed +and allowed to interract with the running containers. This option could have different form: + +---- +ssh_cmd=ssh -F ssh.config standalone +director_host= +---- + +---- +ssh_cmd=ssh -F ssh.config +director_host=standalone +---- + +or without an SSH config file: + +---- +ssh_cmd=ssh -i /home/user/.ssh/id_rsa stack@my.undercloud.local +director_host= +---- + +or +---- +ssh_cmd=ssh -i /home/user/.ssh/id_rsa stack@ +director_host=my.undercloud.local +---- + +Note that the result of ssh_cmd + director_host should be a "successful ssh access". + +Configure or generate ssh.config file from inventory or hosts file [source,yaml] [subs=+quotes] @@ -49,6 +105,32 @@ Host crc UserKnownHostsFile=/dev/null ---- +os-diff can use an ssh.config file for getting access to your TripleO/OSP environment. +A command can help you to generate this SSH config file from your Ansible inventory (like tripleo-ansible-inventory.yaml file): + +---- +os-diff configure -i tripleo-ansible-inventory.yaml -o ssh.config --yaml +---- + +Note: You will have to set the IdentityFile key in the file in order to get full working access: + +---- +Host standalone + HostName standalone + User root + IdentityFile ~/.ssh/id_rsa + StrictHostKeyChecking no + UserKnownHostsFile /dev/null + +Host undercloud + HostName undercloud + User root + IdentityFile ~/.ssh/id_rsa + StrictHostKeyChecking no + UserKnownHostsFile /dev/null +---- + + And test your connection: ---- diff --git a/docs_user/modules/proc_adopting-autoscaling.adoc b/docs_user/modules/proc_adopting-autoscaling.adoc index 686320d39..5316055f1 100644 --- a/docs_user/modules/proc_adopting-autoscaling.adoc +++ b/docs_user/modules/proc_adopting-autoscaling.adoc @@ -53,8 +53,7 @@ EOF . Optional: If you have previously backed up your {OpenStackShort} services configuration file from the old environment, you can use os-diff to compare and make sure the configuration is correct. This will producre the difference between both ini configuration files: + ---- -pushd os-diff -./os-diff cdiff --service aodh -c /tmp/collect_tripleo_configs/aodh/etc/aodh/aodh.conf -o aodh_patch.yaml +os-diff diff /tmp/collect_tripleo_configs/aodh/etc/aodh/aodh.conf aodh_patch.yaml --crd ---- + For more information, see xref:reviewing-the-openstack-control-plane-configuration_{context}[Reviewing the {rhos_prev_long} control plane configuration]. diff --git a/docs_user/modules/proc_adopting-image-service-with-ceph-backend.adoc b/docs_user/modules/proc_adopting-image-service-with-ceph-backend.adoc index 44a6183e5..8bce7aee8 100644 --- a/docs_user/modules/proc_adopting-image-service-with-ceph-backend.adoc +++ b/docs_user/modules/proc_adopting-image-service-with-ceph-backend.adoc @@ -55,8 +55,7 @@ If you have previously backed up your {OpenStackShort} services configuration fi For more information, see xref:pulling-configuration-from-tripleo-deployment_reviewing-configuration[Pulling the configuration from a {OpenStackPreviousInstaller} deployment]. ---- -pushd os-diff -./os-diff cdiff --service glance -c /tmp/collect_tripleo_configs/glance/etc/glance/glance-api.conf -o glance_patch.yaml +os-diff diff /tmp/collect_tripleo_configs/glance/etc/glance/glance-api.conf glance_patch.yaml --crd ---- This produces the difference between both ini configuration files. diff --git a/docs_user/modules/proc_adopting-telemetry-services.adoc b/docs_user/modules/proc_adopting-telemetry-services.adoc index 2e7189d8e..cb2bd6a42 100644 --- a/docs_user/modules/proc_adopting-telemetry-services.adoc +++ b/docs_user/modules/proc_adopting-telemetry-services.adoc @@ -55,8 +55,7 @@ EOF . Optional: If you previously backed up your {OpenStackShort} services configuration file from the old environment, you can use os-diff to compare and make sure the configuration is correct. This will produce the difference between both ini configuration files: + ---- -pushd os-diff -./os-diff cdiff --service ceilometer -c /tmp/collect_tripleo_configs/ceilometer/etc/ceilometer/ceilometer.conf -o ceilometer_patch.yaml +os-diff diff /tmp/collect_tripleo_configs/ceilometer/etc/ceilometer/ceilometer.conf ceilometer_patch.yaml --crd ---- + For more information, see xref:reviewing-the-openstack-control-plane-configuration_{context}[Reviewing the {rhos_prev_long} control plane configuration]. diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index 228087ddf..9a1eb0add 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -22,7 +22,14 @@ remote_config_path=/tmp/tripleo + Make sure the ssh command you provide in `ssh_cmd` parameter is correct and with key authentication. -. Enable or disable the services you want: +. Enable or disable the services you want in /etc/os-diff/config.yaml: + +Make sure you have the correct rights to edit the file example: + +--- +chown ospng:ospng /etc/os-diff/config.yaml +--- + Example with default {identity_service_first_ref}: + [source,yaml] @@ -58,12 +65,109 @@ services: + Repeat this step for each {OpenStackShort} service that you want to disable or enable. +Os-diff can pull configuration or command output from non-containerized servies such as the ovs-external-ids: + +---- +services: + ovs_external_ids: + hosts: + - standalone + service_command: "ovs-vsctl list Open_vSwitch . | grep external_ids | awk -F ': ' '{ print $2; }'" + cat_output: true + path: + - ovs_external_ids.json + config_mapping: + ovn-bridge-mappings: edpm_ovn_bridge_mappings + ovn-bridge: edpm_ovn_bridge + ovn-encap-type: edpm_ovn_encap_type + ovn-match-northd-version: ovn_match_northd_version + ovn-monitor-all: ovn_monitor_all + ovn-remote-probe-interval: edpm_ovn_remote_probe_interval + ovn-ofctrl-wait-before-clear: edpm_ovn_ofctrl_wait_before_clear +---- + +This service is not an Openstack service executed in a container, so the description and the behavior is different. +It's important to correctly configure an SSH config file or equivalent for non standard services such as OVS. +The ovs_external_ids is not a service which runs in a container and the ovs data is stored +on each host of our cloud: controller_1/controller_2/... + +The hosts key in the config.yaml will allow os-diff to loop over all hosts specified the output of the command, or the file or data that you need to pull from our deployment in order to compare it later: + +---- + ovs_external_ids: + path: + - ovs_external_ids.json + hosts: + - standalone +---- + +The service_command is the command which provides the required information. +It could be a simple cat from a config file. cat_output should be set to true +if you want os-diff to get the output of the command and store the output in a file specified by the key path + +Then you can provide a mapping between in this case the EDPM CRD, and the ovs-vsctl output with config_mapping + +---- + service_command: 'ovs-vsctl list Open_vSwitch . | grep external_ids | awk -F '': '' ''{ print $2; }''' + cat_output: true + config_mapping: + ovn-bridge: edpm_ovn_bridge + ovn-bridge-mappings: edpm_ovn_bridge_mappings + ovn-encap-type: edpm_ovn_encap_type + ovn-match-northd-version: ovn_match_northd_version + ovn-monitor-all: ovn_monitor_all + ovn-ofctrl-wait-before-clear: edpm_ovn_ofctrl_wait_before_clear + ovn-remote-probe-interval: edpm_ovn_remote_probe_interval +---- + +Then you can use this command to compare the values: + +---- +os-diff diff ovs_external_ids.json edpm.crd --crd --service ovs_external_ids +---- + +Lets take the example of checking the /etc/yum.conf on every hosts, you will have to put this statement in the config.yaml, +lets call it yum_config: + +---- +services: + yum_config: + hosts: + - undercloud + - controller_1 + - compute_1 + - compute_2 + service_command: "cat /etc/yum.conf" + cat_output: true + path: + - yum.conf +---- + . Pull the configuration: + + +This command will pull all the configuration files describe into the /etc/os-diff/config.yaml file. +Os-diff can update this file automaticaly according to your running environment with the command --update or --update-only. +This option will set the Podman informations into the config.yaml for all running containers. +It can be useful later, when all the Openstack services will be turned off. + +Note that when the config.yaml is populate automaticaly you have to provide the configuration paths manually for each services. + +---- +# will only update the /etc/os-diff/config.yaml +os-diff pull --update-only +---- + ---- -pushd os-diff -./os-diff pull +# will update the /etc/os-diff/config.yaml and pull configuration +os-diff pull --update ---- + +---- +# will update the /etc/os-diff/config.yaml and pull configuration +os-diff pull +---- + + The configuration will be pulled and stored by default: + diff --git a/docs_user/modules/proc_verifying-the-image-service-adoption.adoc b/docs_user/modules/proc_verifying-the-image-service-adoption.adoc index fa012a86c..484aecb1f 100644 --- a/docs_user/modules/proc_verifying-the-image-service-adoption.adoc +++ b/docs_user/modules/proc_verifying-the-image-service-adoption.adoc @@ -9,7 +9,7 @@ Verify that you successfully adopted your {image_service_first_ref} to the {rhos . Test the {image_service_first_ref} from the {rhos_prev_long} CLI. You can compare and make sure the configuration has been correctly applied to the {image_service} pods: + ---- -./os-diff cdiff --service glance -c /etc/glance/glance.conf.d/02-config.conf -o glance_patch.yaml --frompod -p glance-api +os-diff diff /etc/glance/glance.conf.d/02-config.conf glance_patch.yaml --frompod -p glance-api ---- + If no line appears, then the configuration is correctly done. From 1a047d00915c28e1c8b6cfd8551fc6a31a4e98b3 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 14:06:45 +0200 Subject: [PATCH 02/20] Fix nits and wording --- ...n_comparing-configuration-files-between-deployments.adoc | 2 +- ...roc_pulling-configuration-from-a-tripleo-deployment.adoc | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc index d47e40c90..f4c5774c9 100644 --- a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc +++ b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc @@ -69,7 +69,7 @@ director_host=my.undercloud.local Note that the result of ssh_cmd + director_host should be a "successful ssh access". -Configure or generate ssh.config file from inventory or hosts file +Configure or generate ssh.config file from inventory or hosts file, for example: [source,yaml] [subs=+quotes] diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index 9a1eb0add..f95deb870 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -24,7 +24,7 @@ Make sure the ssh command you provide in `ssh_cmd` parameter is correct and with . Enable or disable the services you want in /etc/os-diff/config.yaml: -Make sure you have the correct rights to edit the file example: +Make sure you have the correct rights to edit the file, for example: --- chown ospng:ospng /etc/os-diff/config.yaml @@ -91,7 +91,7 @@ It's important to correctly configure an SSH config file or equivalent for non s The ovs_external_ids is not a service which runs in a container and the ovs data is stored on each host of our cloud: controller_1/controller_2/... -The hosts key in the config.yaml will allow os-diff to loop over all hosts specified the output of the command, or the file or data that you need to pull from our deployment in order to compare it later: +With the `hosts` key, os-diff will loop on each host provided and execute the command in `service_command` key: ---- ovs_external_ids: @@ -146,7 +146,7 @@ services: . Pull the configuration: + -This command will pull all the configuration files describe into the /etc/os-diff/config.yaml file. +This command will pull all the configuration files describeb in the /etc/os-diff/config.yaml file. Os-diff can update this file automaticaly according to your running environment with the command --update or --update-only. This option will set the Podman informations into the config.yaml for all running containers. It can be useful later, when all the Openstack services will be turned off. From 24a649bc32cd4baf5df2d72baa76c9ba751b7c62 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 14:20:50 +0200 Subject: [PATCH 03/20] fix type describeb->described --- .../proc_pulling-configuration-from-a-tripleo-deployment.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index f95deb870..8a143a6ad 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -146,7 +146,7 @@ services: . Pull the configuration: + -This command will pull all the configuration files describeb in the /etc/os-diff/config.yaml file. +This command will pull all the configuration files described in the /etc/os-diff/config.yaml file. Os-diff can update this file automaticaly according to your running environment with the command --update or --update-only. This option will set the Podman informations into the config.yaml for all running containers. It can be useful later, when all the Openstack services will be turned off. From 00805ac5b985f7f10fbe3a02f8a7722bc717abf7 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:01:57 +0200 Subject: [PATCH 04/20] Update docs_user/modules/con_comparing-configuration-files-between-deployments.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- .../con_comparing-configuration-files-between-deployments.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc index f4c5774c9..3db27aed8 100644 --- a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc +++ b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc @@ -5,7 +5,7 @@ In order to help users to handle the configuration for the {OpenStackPreviousInstaller} and {rhos_prev_long} services the tool: https://github.com/openstack-k8s-operators/os-diff has been develop to compare the configuration files between the {OpenStackPreviousInstaller} deployment and the {rhos_long} cloud. -Make sure Golang is installed and configured on your env: +Make sure Golang is installed and configured on your environment: ---- dnf install -y golang-github-openstack-k8s-operators-os-diff From 5e53b68801c92eb0c056253febf2b37af353b282 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:02:04 +0200 Subject: [PATCH 05/20] Update docs_user/modules/con_comparing-configuration-files-between-deployments.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- ...on_comparing-configuration-files-between-deployments.adoc | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc index 3db27aed8..6e20a356a 100644 --- a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc +++ b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc @@ -11,10 +11,7 @@ Make sure Golang is installed and configured on your environment: dnf install -y golang-github-openstack-k8s-operators-os-diff ---- -Then configure /etc/os-diff/os-diff.cfg and /etc/os-diff/ssh.config file according to your environment: - -In order to allow os-diff to connect to your clouds and pull files from the services you describe in the config.yaml -file you need to properly set the option in the os-diff.cfg: +Then configure the `/etc/os-diff/os-diff.cfg` file and the `/etc/os-diff/ssh.config` file according to your environment. To allow os-diff to connect to your clouds and pull files from the services that you describe in the `config.yaml` file you need to properly set the option in the `os-diff.cfg` file: [source,yaml] [subs=+quotes] From 0fbd1fe5339e33ee0b672271b76ed38cced0fac0 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:02:10 +0200 Subject: [PATCH 06/20] Update docs_user/modules/con_comparing-configuration-files-between-deployments.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- .../con_comparing-configuration-files-between-deployments.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc index 6e20a356a..c38f89b12 100644 --- a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc +++ b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc @@ -64,7 +64,7 @@ ssh_cmd=ssh -i /home/user/.ssh/id_rsa stack@ director_host=my.undercloud.local ---- -Note that the result of ssh_cmd + director_host should be a "successful ssh access". +Note that the result of using `ssh_cmd` and `director_host` should be a "successful ssh access". Configure or generate ssh.config file from inventory or hosts file, for example: From a39ad3a47dadc87cb9d8b6bdc2b8044c0907f3b2 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:02:16 +0200 Subject: [PATCH 07/20] Update docs_user/modules/con_comparing-configuration-files-between-deployments.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- .../con_comparing-configuration-files-between-deployments.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc index c38f89b12..9c9840182 100644 --- a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc +++ b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc @@ -66,7 +66,7 @@ director_host=my.undercloud.local Note that the result of using `ssh_cmd` and `director_host` should be a "successful ssh access". -Configure or generate ssh.config file from inventory or hosts file, for example: +Configure or generate the `ssh.config` file from inventory or hosts file, for example: [source,yaml] [subs=+quotes] From 7d043b09b7ad542dac006360f708e8b3bfb611fb Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:02:24 +0200 Subject: [PATCH 08/20] Update docs_user/modules/con_comparing-configuration-files-between-deployments.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- ...con_comparing-configuration-files-between-deployments.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc index 9c9840182..20ee7d0c1 100644 --- a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc +++ b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc @@ -102,8 +102,8 @@ Host crc UserKnownHostsFile=/dev/null ---- -os-diff can use an ssh.config file for getting access to your TripleO/OSP environment. -A command can help you to generate this SSH config file from your Ansible inventory (like tripleo-ansible-inventory.yaml file): +Os-diff can use an `ssh.config` file for getting access to your {rhos_prev_long} environment. +The following command can help you generate this SSH config file from your Ansible inventory, for example, `tripleo-ansible-inventory.yaml` file: ---- os-diff configure -i tripleo-ansible-inventory.yaml -o ssh.config --yaml From a66a58bb461fa3e967bfe9685ef3cfd027534052 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:02:31 +0200 Subject: [PATCH 09/20] Update docs_user/modules/con_comparing-configuration-files-between-deployments.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- .../con_comparing-configuration-files-between-deployments.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc index 20ee7d0c1..f9abd23ad 100644 --- a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc +++ b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc @@ -109,7 +109,8 @@ The following command can help you generate this SSH config file from your Ansib os-diff configure -i tripleo-ansible-inventory.yaml -o ssh.config --yaml ---- -Note: You will have to set the IdentityFile key in the file in order to get full working access: +[NOTE] +You must set the `IdentityFile` key in the file to get full working access: ---- Host standalone From d410d6c34329c319e0549449a5603e417ee7db46 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:03:08 +0200 Subject: [PATCH 10/20] Update docs_user/modules/con_comparing-configuration-files-between-deployments.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- ...con_comparing-configuration-files-between-deployments.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc index f9abd23ad..afd97deb8 100644 --- a/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc +++ b/docs_user/modules/con_comparing-configuration-files-between-deployments.adoc @@ -37,9 +37,9 @@ connection=local ssh_cmd="" ---- -The ssh_cmd will be used by os-diff to access your TripleO Undercloud/Director host via SSH, +Os-diff uses `ssh_cmd` to access your {OpenStackPreviousInstaller} host via SSH, or the host where your cloud is accessible and the podman/docker binary is installed -and allowed to interract with the running containers. This option could have different form: +and allowed to interact with the running containers. This option could have a different form: ---- ssh_cmd=ssh -F ssh.config standalone From f6d2b4a66cbb3a0b932d45a4d9e1c03a102aa1f3 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:40:39 +0200 Subject: [PATCH 11/20] Update docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- ...roc_pulling-configuration-from-a-tripleo-deployment.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index 8a143a6ad..d28944a72 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -90,9 +90,9 @@ This service is not an Openstack service executed in a container, so the descrip It's important to correctly configure an SSH config file or equivalent for non standard services such as OVS. The ovs_external_ids is not a service which runs in a container and the ovs data is stored on each host of our cloud: controller_1/controller_2/... - -With the `hosts` key, os-diff will loop on each host provided and execute the command in `service_command` key: - ++ +With the `hosts` key, os-diff loops on each host and runs the command in the `service_command` key: ++ ---- ovs_external_ids: path: From 232defb79d9a0af9bdba26292fdf9568f4722d23 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:40:50 +0200 Subject: [PATCH 12/20] Update docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- ...ing-configuration-from-a-tripleo-deployment.adoc | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index d28944a72..59c671091 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -119,16 +119,15 @@ Then you can provide a mapping between in this case the EDPM CRD, and the ovs-vs ovn-ofctrl-wait-before-clear: edpm_ovn_ofctrl_wait_before_clear ovn-remote-probe-interval: edpm_ovn_remote_probe_interval ---- - -Then you can use this command to compare the values: - ++ +Then you can use the following command to compare the values: ++ ---- os-diff diff ovs_external_ids.json edpm.crd --crd --service ovs_external_ids ---- - -Lets take the example of checking the /etc/yum.conf on every hosts, you will have to put this statement in the config.yaml, -lets call it yum_config: - ++ +For example, to check the `/etc/yum.conf` on every host, you must put the following statement in the `config.yaml` file. The following example uses a file called `yum_config`: ++ ---- services: yum_config: From 901f10ebeeece1d36b7fcd478f64f80dfa5bf5f2 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:42:50 +0200 Subject: [PATCH 13/20] Update docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- ...ulling-configuration-from-a-tripleo-deployment.adoc | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index 59c671091..873895564 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -22,13 +22,11 @@ remote_config_path=/tmp/tripleo + Make sure the ssh command you provide in `ssh_cmd` parameter is correct and with key authentication. -. Enable or disable the services you want in /etc/os-diff/config.yaml: - -Make sure you have the correct rights to edit the file, for example: - ---- +. Enable or disable the services that you want in the `/etc/os-diff/config.yaml` file. Make sure that you have the correct rights to edit the file, for example: ++ +---- chown ospng:ospng /etc/os-diff/config.yaml ---- +---- Example with default {identity_service_first_ref}: + From 8f8ac3c1595dab51ea6b5faba07254dd247f5879 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:42:57 +0200 Subject: [PATCH 14/20] Update docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- .../proc_pulling-configuration-from-a-tripleo-deployment.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index 873895564..83cd04268 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -63,8 +63,8 @@ services: + Repeat this step for each {OpenStackShort} service that you want to disable or enable. -Os-diff can pull configuration or command output from non-containerized servies such as the ovs-external-ids: - +. If you are using non-containerized services, such as the `ovs-external-ids`, os-diff can pull configuration or command output: ++ ---- services: ovs_external_ids: From b1008891695d5859fd02a1ff6cfb7a46fb3d793c Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:43:05 +0200 Subject: [PATCH 15/20] Update docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- ...roc_pulling-configuration-from-a-tripleo-deployment.adoc | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index 83cd04268..bdd287e67 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -83,10 +83,8 @@ services: ovn-remote-probe-interval: edpm_ovn_remote_probe_interval ovn-ofctrl-wait-before-clear: edpm_ovn_ofctrl_wait_before_clear ---- - -This service is not an Openstack service executed in a container, so the description and the behavior is different. -It's important to correctly configure an SSH config file or equivalent for non standard services such as OVS. -The ovs_external_ids is not a service which runs in a container and the ovs data is stored ++ +This service is not an {rhos_prev_long} service executed in a container, so the description and the behavior is different. It is important to correctly configure an SSH config file or equivalent for non-standard services such as OVS. The `ovs_external_ids` does not run in a container, and the ovs data is stored on each host of our cloud: controller_1/controller_2/... + With the `hosts` key, os-diff loops on each host and runs the command in the `service_command` key: From 8dd91b818789ac7e849d25f591d7a5777ef2604b Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:43:16 +0200 Subject: [PATCH 16/20] Update docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- ...ulling-configuration-from-a-tripleo-deployment.adoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index bdd287e67..218827ce5 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -141,12 +141,12 @@ services: . Pull the configuration: + -This command will pull all the configuration files described in the /etc/os-diff/config.yaml file. -Os-diff can update this file automaticaly according to your running environment with the command --update or --update-only. -This option will set the Podman informations into the config.yaml for all running containers. -It can be useful later, when all the Openstack services will be turned off. +This command will pull all the configuration files that are described in the `/etc/os-diff/config.yaml` file. +Os-diff can update this file automatically according to your running environment with the command `--update` or `--update-only`. +This option sets the podman information into the `config.yaml` for all running containers. +It can be useful later, when all the {rhos_prev_long} services are turned off. -Note that when the config.yaml is populate automaticaly you have to provide the configuration paths manually for each services. +Note that when the `config.yaml` file is populated automatically you must provide the configuration paths manually for each service. ---- # will only update the /etc/os-diff/config.yaml From 6fe5e71194d38aade92d02af4a88e21ed483de13 Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 16:51:55 +0200 Subject: [PATCH 17/20] Update docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- ...ulling-configuration-from-a-tripleo-deployment.adoc | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index 218827ce5..c69067846 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -96,13 +96,9 @@ With the `hosts` key, os-diff loops on each host and runs the command in the `se hosts: - standalone ---- - -The service_command is the command which provides the required information. -It could be a simple cat from a config file. cat_output should be set to true -if you want os-diff to get the output of the command and store the output in a file specified by the key path - -Then you can provide a mapping between in this case the EDPM CRD, and the ovs-vsctl output with config_mapping - ++ +The `service_command` provides the required information. It could be a simple cat from a config file. If you want os-diff to get the output of the command and store the output in a file specified by the key path, set `cat_output` to true. Then you can provide a mapping between in this case the EDPM CRD, and the ovs-vsctl output with config_mapping: ++ ---- service_command: 'ovs-vsctl list Open_vSwitch . | grep external_ids | awk -F '': '' ''{ print $2; }''' cat_output: true From 66bafae9db26f157813802ea1d6d6314595e7e3b Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 17:12:08 +0200 Subject: [PATCH 18/20] Update docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- .../proc_pulling-configuration-from-a-tripleo-deployment.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index c69067846..5703c44bd 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -29,7 +29,7 @@ chown ospng:ospng /etc/os-diff/config.yaml ---- Example with default {identity_service_first_ref}: -+ + [source,yaml] ---- # service name and file location From f37183d59994b043e35f6c05667135c5c341ad9e Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 17:12:14 +0200 Subject: [PATCH 19/20] Update docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- .../proc_pulling-configuration-from-a-tripleo-deployment.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index 5703c44bd..dcf87032b 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -60,7 +60,6 @@ services: - /etc/keystone/keystone.conf - /etc/keystone/logging.conf ---- -+ Repeat this step for each {OpenStackShort} service that you want to disable or enable. . If you are using non-containerized services, such as the `ovs-external-ids`, os-diff can pull configuration or command output: From 401f215fb87d5a14de7e98195a594e2bc2cab92b Mon Sep 17 00:00:00 2001 From: mathieu bultel Date: Fri, 10 May 2024 17:12:21 +0200 Subject: [PATCH 20/20] Update docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc Co-authored-by: klgill <97464556+klgill@users.noreply.github.com> --- .../proc_pulling-configuration-from-a-tripleo-deployment.adoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc index dcf87032b..d4bfc848e 100644 --- a/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc +++ b/docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc @@ -158,9 +158,7 @@ os-diff pull --update os-diff pull ---- -+ The configuration will be pulled and stored by default: -+ ---- /tmp/tripleo/ ----