Update os-diff doc with package install instructions and correct usages #452
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jistr
reviewed
May 10, 2024
docs_user/modules/con_comparing-configuration-files-between-deployments.adoc
Outdated
Show resolved
Hide resolved
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
jistr
approved these changes
May 10, 2024
klgill
reviewed
May 10, 2024
docs_user/modules/con_comparing-configuration-files-between-deployments.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/con_comparing-configuration-files-between-deployments.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/con_comparing-configuration-files-between-deployments.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/con_comparing-configuration-files-between-deployments.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/con_comparing-configuration-files-between-deployments.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/con_comparing-configuration-files-between-deployments.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/con_comparing-configuration-files-between-deployments.adoc
Outdated
Show resolved
Hide resolved
…ployments.adoc Co-authored-by: klgill <[email protected]>
…ployments.adoc Co-authored-by: klgill <[email protected]>
…ployments.adoc Co-authored-by: klgill <[email protected]>
…ployments.adoc Co-authored-by: klgill <[email protected]>
…ployments.adoc Co-authored-by: klgill <[email protected]>
…ployments.adoc Co-authored-by: klgill <[email protected]>
…ployments.adoc Co-authored-by: klgill <[email protected]>
klgill
reviewed
May 10, 2024
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
Comment on lines
93
to
145
|
|
||
| With the `hosts` key, os-diff will loop on each host provided and execute the command in `service_command` key: | ||
|
|
||
| ---- | ||
| 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 | ||
| ---- | ||
|
|
There was a problem hiding this comment.
@klgill Yes it's not a necessary "step" but more some guide and help for the usage. I put that in place, but if it's sounds confusing we can drop it.
klgill
reviewed
May 10, 2024
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
…ployment.adoc Co-authored-by: klgill <[email protected]>
…ployment.adoc Co-authored-by: klgill <[email protected]>
…ployment.adoc Co-authored-by: klgill <[email protected]>
…ployment.adoc Co-authored-by: klgill <[email protected]>
…ployment.adoc Co-authored-by: klgill <[email protected]>
…ployment.adoc Co-authored-by: klgill <[email protected]>
…ployment.adoc Co-authored-by: klgill <[email protected]>
klgill
reviewed
May 10, 2024
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
klgill
reviewed
May 10, 2024
docs_user/modules/proc_pulling-configuration-from-a-tripleo-deployment.adoc
Outdated
Show resolved
Hide resolved
…ployment.adoc Co-authored-by: klgill <[email protected]>
…ployment.adoc Co-authored-by: klgill <[email protected]>
…ployment.adoc Co-authored-by: klgill <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.