diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index fa8eff01e8d..7839436b90d 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -33,11 +33,11 @@ Name: Understanding OpenShift GitOps Dir: understanding_openshift_gitops Distros: openshift-gitops Topics: -- Name: What is GitOps? +- Name: What is OpenShift GitOps? File: what-is-gitops -- Name: About OpenShift GitOps +- Name: About Red Hat OpenShift GitOps File: about-redhat-openshift-gitops -- Name: Gathering diagnostic information for support +- Name: Escalate to Red Hat Support File: gathering-gitops-diagnostic-information-for-support --- Name: Managing cluster configuration @@ -191,9 +191,9 @@ Distros: openshift-gitops Topics: - Name: Configuring the GitOps CLI File: configuring-argocd-gitops-cli -- Name: Logging in to the Argo CD server in the default mode +- Name: Default mode File: logging-in-to-argocd-server-in-default-mode -- Name: Basic GitOps argocd commands +- Name: GitOps CLI reference File: argocd-gitops-cli-reference --- Name: Observability @@ -224,14 +224,14 @@ Name: GitOps workloads on infrastructure nodes Dir: gitops_workloads_infranodes Distros: openshift-gitops Topics: -- Name: Running GitOps control plane workloads on infrastructure nodes +- Name: Configure infrastructure placement File: running-gitops-control-plane-workloads-on-infrastructure-nodes --- Name: Troubleshooting issues Dir: troubleshooting_gitops_issues Distros: openshift-gitops Topics: -- Name: Auto-reboot during Argo CD sync with machine configurations +- Name: Troubleshoot common GitOps issues File: auto-reboot-during-argo-cd-sync-with-machine-configurations --- Name: Removing GitOps diff --git a/argocd_applications/creating-an-application-using-gitops-argocd-cli.adoc b/argocd_applications/creating-an-application-using-gitops-argocd-cli.adoc index c06c313c9ee..897cffca18a 100644 --- a/argocd_applications/creating-an-application-using-gitops-argocd-cli.adoc +++ b/argocd_applications/creating-an-application-using-gitops-argocd-cli.adoc @@ -20,4 +20,4 @@ include::modules/gitops-argocd-cli-creating-an-application-in-core-mode.adoc[lev == Additional resources * xref:../installing_gitops/installing-argocd-gitops-cli.adoc#installing-argocd-gitops-cli[Installing the {gitops-shortname} CLI] -* xref:../gitops_cli_argocd/argocd-gitops-cli-reference.adoc#argocd-gitops-cli-reference[Basic {gitops-shortname} argocd commands] +* xref:../gitops_cli_argocd/argocd-gitops-cli-reference.adoc#argocd-gitops-cli-reference[GitOps CLI reference] diff --git a/declarative_clusterconfig/configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations.adoc b/declarative_clusterconfig/configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations.adoc index c37b887b84c..a227c4cdd10 100644 --- a/declarative_clusterconfig/configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations.adoc +++ b/declarative_clusterconfig/configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations.adoc @@ -86,6 +86,6 @@ include::modules/gitops-configuring-respect-rbac-using-web-console.adoc[leveloff == Additional resources * xref:../installing_gitops/installing-argocd-gitops-cli.adoc#installing-argocd-gitops-cli[Installing the {gitops-shortname} CLI] -* xref:../gitops_cli_argocd/argocd-gitops-cli-reference.adoc#argocd-gitops-cli-reference[Basic {gitops-shortname} argocd commands] +* xref:../gitops_cli_argocd/argocd-gitops-cli-reference.adoc#argocd-gitops-cli-reference[GitOps CLI reference] * xref:../declarative_clusterconfig/configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations.adoc#using-argo-cd-instance-to-manage-cluster-scoped-resources_configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations[Using an Argo CD instance to manage cluster-scoped resources] * link:https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/#auto-respect-rbac-for-controller[Auto respect RBAC for controller] diff --git a/gitops_cli_argocd/argocd-gitops-cli-reference.adoc b/gitops_cli_argocd/argocd-gitops-cli-reference.adoc index 121be71b819..c338d28623f 100644 --- a/gitops_cli_argocd/argocd-gitops-cli-reference.adoc +++ b/gitops_cli_argocd/argocd-gitops-cli-reference.adoc @@ -1,14 +1,13 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="argocd-gitops-cli-reference"] -= {gitops-shortname} argocd CLI reference += GitOps CLI reference :context: argocd-gitops-cli-reference toc::[] [role="_abstract"] - -This section lists the basic {gitops-shortname} `argocd` CLI commands. +The following topics describe the basic {gitops-shortname} `argocd` CLI commands, global options, and utility commands. // Basic syntax include::modules/gitops-argocd-cli-basic-syntax.adoc[leveloffset=+1] @@ -25,7 +24,7 @@ include::modules/gitops-argocd-cli-utility-commands.adoc[leveloffset=+1] * xref:../installing_gitops/installing-argocd-gitops-cli.adoc#installing-argocd-gitops-cli[Installing the {gitops-shortname} CLI] * xref:../gitops_cli_argocd/configuring-argocd-gitops-cli.adoc#configuring-argocd-gitops-cli[Configuring the {gitops-shortname} CLI] -* xref:../gitops_cli_argocd/logging-in-to-argocd-server-in-default-mode.adoc#logging-in-to-argocd-server-in-default-mode[Logging in to the Argo CD server in the default mode] +* xref:../gitops_cli_argocd/logging-in-to-argocd-server-in-default-mode.adoc#logging-in-to-argocd-server-in-default-mode[Default mode] * link:https://github.com/redhat-developer/gitops-operator/blob/7ac4b2ce179c167b39be259b8d9be37dc280f689/docs/OpenShift%20GitOps%20CLI%20User%20Guide.md#login-related-commands[OpenShift {gitops-shortname} CLI User Guide] * link:https://argo-cd.readthedocs.io/en/release-{upstream-ver}/user-guide/commands/argocd/[`argocd` Command Reference] //update the upstream version attribute value for every release diff --git a/gitops_cli_argocd/configuring-argocd-gitops-cli.adoc b/gitops_cli_argocd/configuring-argocd-gitops-cli.adoc index 93648be7c27..8c0242b20ea 100644 --- a/gitops_cli_argocd/configuring-argocd-gitops-cli.adoc +++ b/gitops_cli_argocd/configuring-argocd-gitops-cli.adoc @@ -18,5 +18,5 @@ include::modules/gitops-argocd-cli-enabling-tab-completion.adoc[leveloffset=+1] == Additional resources * xref:../installing_gitops/installing-argocd-gitops-cli.adoc#installing-argocd-gitops-cli[Installing the {gitops-shortname} CLI] -* xref:../gitops_cli_argocd/logging-in-to-argocd-server-in-default-mode.adoc#logging-in-to-argocd-server-in-default-mode[Logging in to the Argo CD server in the default mode] -* xref:../gitops_cli_argocd/argocd-gitops-cli-reference.adoc#argocd-gitops-cli-reference[Basic {gitops-shortname} argocd commands] +* xref:../gitops_cli_argocd/logging-in-to-argocd-server-in-default-mode.adoc#logging-in-to-argocd-server-in-default-mode[Default mode] +* xref:../gitops_cli_argocd/argocd-gitops-cli-reference.adoc#argocd-gitops-cli-reference[GitOps CLI reference] diff --git a/gitops_cli_argocd/logging-in-to-argocd-server-in-default-mode.adoc b/gitops_cli_argocd/logging-in-to-argocd-server-in-default-mode.adoc index 1e99813cf4b..c18412e519c 100644 --- a/gitops_cli_argocd/logging-in-to-argocd-server-in-default-mode.adoc +++ b/gitops_cli_argocd/logging-in-to-argocd-server-in-default-mode.adoc @@ -1,13 +1,12 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="logging-in-to-argocd-server-in-default-mode"] -= Logging in to the Argo CD server in the default mode += Default mode :context: logging-in-to-argocd-server-in-default-mode toc::[] [role="_abstract"] - You can log in to the Argo CD server in the default mode using the {gitops-shortname} `argocd` CLI and your Argo CD credentials to execute commands. // Logging in to the Argo CD server @@ -19,4 +18,4 @@ include::modules/gitops-argocd-cli-logging-in-to-argocd-server.adoc[leveloffset= * xref:../installing_gitops/installing-argocd-gitops-cli.adoc#installing-argocd-gitops-cli[Installing the {gitops-shortname} CLI] * xref:../gitops_cli_argocd/configuring-argocd-gitops-cli.adoc#configuring-argocd-gitops-cli[Configuring the {gitops-shortname} CLI] -* xref:../gitops_cli_argocd/argocd-gitops-cli-reference.adoc#argocd-gitops-cli-reference[Basic {gitops-shortname} argocd commands] +* xref:../gitops_cli_argocd/argocd-gitops-cli-reference.adoc#argocd-gitops-cli-reference[GitOps CLI reference] diff --git a/gitops_workloads_infranodes/running-gitops-control-plane-workloads-on-infrastructure-nodes.adoc b/gitops_workloads_infranodes/running-gitops-control-plane-workloads-on-infrastructure-nodes.adoc index 96ac880dc43..92ba65bed39 100644 --- a/gitops_workloads_infranodes/running-gitops-control-plane-workloads-on-infrastructure-nodes.adoc +++ b/gitops_workloads_infranodes/running-gitops-control-plane-workloads-on-infrastructure-nodes.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="running-gitops-control-plane-workloads-on-infrastructure-nodes"] -= Running {gitops-shortname} control plane workloads on infrastructure nodes += Configure infrastructure placement :context: running-gitops-control-plane-workloads-on-infrastructure-nodes toc::[] diff --git a/installing_gitops/installing-argocd-gitops-cli.adoc b/installing_gitops/installing-argocd-gitops-cli.adoc index 9943b4e1fd4..9094f2cabbf 100644 --- a/installing_gitops/installing-argocd-gitops-cli.adoc +++ b/installing_gitops/installing-argocd-gitops-cli.adoc @@ -31,7 +31,7 @@ include::modules/gitops-installing-argocd-cli-on-macos.adoc[leveloffset=+1] == Additional resources * xref:../gitops_cli_argocd/configuring-argocd-gitops-cli.adoc#configuring-argocd-gitops-cli[Configuring the {gitops-shortname} CLI] -* xref:../gitops_cli_argocd/logging-in-to-argocd-server-in-default-mode.adoc#logging-in-to-argocd-server-in-default-mode[Logging in to the Argo CD server in the default mode] -* xref:../gitops_cli_argocd/argocd-gitops-cli-reference.adoc#argocd-gitops-cli-reference[Basic {gitops-shortname} argocd commands] +* xref:../gitops_cli_argocd/logging-in-to-argocd-server-in-default-mode.adoc#logging-in-to-argocd-server-in-default-mode[Default mode] +* xref:../gitops_cli_argocd/argocd-gitops-cli-reference.adoc#argocd-gitops-cli-reference[GitOps CLI reference] * xref:../installing_gitops/installing-openshift-gitops.adoc#installing-openshift-gitops[Installing {gitops-title}] * xref:../argocd_instance/setting-up-argocd-instance.adoc#setting-up-argocd-instance[Setting up a new Argo CD instance] diff --git a/modules/collecting-gitops-debugging-data.adoc b/modules/collecting-gitops-debugging-data.adoc index 2ebaa3fc29b..d02d6d08a00 100644 --- a/modules/collecting-gitops-debugging-data.adoc +++ b/modules/collecting-gitops-debugging-data.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="collecting-debugging-data-for-gitops_{context}"] -= Collecting debugging data for {gitops-title} += Collect debugging data for GitOps [role="_abstract"] Use the `oc adm must-gather` CLI command to collect the following details about the cluster that is associated with {gitops-title}: @@ -52,7 +52,7 @@ $ oc adm must-gather --image=registry.redhat.io/openshift-gitops-1/must-gather-r + The `must-gather` tool creates a new directory that starts with `./must-gather.local` in the current directory. For example, `./must-gather.local.4157245944708210399`. -. Create a compressed file from the directory that was just created. For example, on a computer that uses a Linux operating system, run the following command: +. Create a compressed file from the directory that was created in the previous step. For example, on a computer that uses a Linux operating system, run the following command: + [source,terminal] ---- diff --git a/modules/gitops-argo-cd-properties.adoc b/modules/gitops-argo-cd-properties.adoc index 8aed896f894..004c793d36a 100644 --- a/modules/gitops-argo-cd-properties.adoc +++ b/modules/gitops-argo-cd-properties.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: REFERENCE [id="argo-cd-properties_{context}"] -= Argo CD custom resource properties += Argo CD CR properties [role="_abstract"] The Argo CD Custom Resource consists of the following properties: diff --git a/modules/gitops-openshift-go-common-terms.adoc b/modules/gitops-openshift-go-common-terms.adoc index 4196a95e35e..36909884350 100644 --- a/modules/gitops-openshift-go-common-terms.adoc +++ b/modules/gitops-openshift-go-common-terms.adoc @@ -2,9 +2,9 @@ // // * understanding_openshift_gitops/about-redhat-openshift-gitops.adoc -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="gitops-openshift-go-common-terms_{context}"] -= Glossary of common terms for OpenShift {gitops-shortname} += GitOps terminology and technical reference [role="_abstract"] This glossary defines common OpenShift {gitops-shortname} terms. diff --git a/modules/gitops-troubleshooting-argocd-principal-agent.adoc b/modules/gitops-troubleshooting-argocd-principal-agent.adoc index 5e75c122c3a..24eaaa9c22b 100644 --- a/modules/gitops-troubleshooting-argocd-principal-agent.adoc +++ b/modules/gitops-troubleshooting-argocd-principal-agent.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: REFERENCE [id="gitops-troubleshooting-argocd-principal-agent_{context}"] -= Troubleshooting Principal-Agent communication and deployment issues += Principal-Agent communication troubleshooting [role="_abstract"] Use the following troubleshooting steps if you encounter issues during Principal-Agent communication or application deployment. diff --git a/modules/gitops-troubleshooting-managed-by-url-annotation.adoc b/modules/gitops-troubleshooting-managed-by-url-annotation.adoc index a40f48032ec..30a3fb5bd91 100644 --- a/modules/gitops-troubleshooting-managed-by-url-annotation.adoc +++ b/modules/gitops-troubleshooting-managed-by-url-annotation.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: REFERENCE [id="gitops-troubleshooting-managed-by-url-annotation_{context}"] -= Troubleshooting the managed-by-url annotation += Managed-by-url annotation troubleshooting [role="_abstract"] Use the following guidelines to troubleshoot issues with the `argocd.argoproj.io/managed-by-url` annotation. diff --git a/modules/go-add-infra-nodes.adoc b/modules/go-add-infra-nodes.adoc index 6188bea5eb2..4313863602d 100644 --- a/modules/go-add-infra-nodes.adoc +++ b/modules/go-add-infra-nodes.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="add-infra-nodes_{context}"] -= Moving {gitops-shortname} control plane workloads to infrastructure nodes += Move GitOps workloads to infrastructure nodes [role="_abstract"] You can move the {gitops-shortname} control plane workloads installed by the {gitops-title} to the infrastructure nodes. The following are the control plane workloads that you can move: diff --git a/modules/moving-the-gitops-operator-pod-to-infrastructure-nodes.adoc b/modules/moving-the-gitops-operator-pod-to-infrastructure-nodes.adoc index a6d87926639..3c2c6940775 100644 --- a/modules/moving-the-gitops-operator-pod-to-infrastructure-nodes.adoc +++ b/modules/moving-the-gitops-operator-pod-to-infrastructure-nodes.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="moving-the-gitops-operator-pod-to-infrastructure-nodes_{context}"] -= Moving the {gitops-shortname} Operator pod to infrastructure nodes += Move the GitOps Operator pod to infrastructure nodes [role="_abstract"] You can move the {gitops-shortname} Operator pod to the infrastructure nodes. diff --git a/modules/performance-challenges-in-machine-configurations-and-argo-cd.adoc b/modules/performance-challenges-in-machine-configurations-and-argo-cd.adoc index aed1bc7afe5..4fb2c17d3d9 100644 --- a/modules/performance-challenges-in-machine-configurations-and-argo-cd.adoc +++ b/modules/performance-challenges-in-machine-configurations-and-argo-cd.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: CONCEPT [id="performance-challenges-in-machine-configurations-and-argo-cd_{context}"] -= Enhance performance in machine configurations and Argo CD += Auto-reboot during Argo CD sync with machine configurations [role="_abstract"] Using the Machine Config Operator (MCO) with Argo CD GitOps workflows can impact performance when node reboots interrupt synchronization operations. diff --git a/modules/proc_configuring-notificationsconfiguration-crd-by-using-the-ocp-cli.adoc b/modules/proc_configuring-notificationsconfiguration-crd-by-using-the-ocp-cli.adoc index 5f829f08d72..cd4a0087192 100644 --- a/modules/proc_configuring-notificationsconfiguration-crd-by-using-the-ocp-cli.adoc +++ b/modules/proc_configuring-notificationsconfiguration-crd-by-using-the-ocp-cli.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="configuring-notificationsconfiguration-cr-by-using-cli_{context}"] -= Configuring the NotificationsConfiguration CR by using the CLI += Configure the NotificationsConfiguration CR [role="_abstract"] You can configure the `NotificationsConfiguration` custom resource (CR) by using the CLI (`oc`). diff --git a/troubleshooting_gitops_issues/auto-reboot-during-argo-cd-sync-with-machine-configurations.adoc b/troubleshooting_gitops_issues/auto-reboot-during-argo-cd-sync-with-machine-configurations.adoc index f04756f5c18..01135c646fd 100644 --- a/troubleshooting_gitops_issues/auto-reboot-during-argo-cd-sync-with-machine-configurations.adoc +++ b/troubleshooting_gitops_issues/auto-reboot-during-argo-cd-sync-with-machine-configurations.adoc @@ -1,13 +1,13 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="auto-reboot-during-argo-cd-sync-with-machine-configurations"] -= Auto-reboot during Argo CD sync with machine configurations += Troubleshoot common GitOps issues :context: auto-reboot-during-argo-cd-sync-with-machine-configurations toc::[] [role="_abstract"] -When using the Machine Config Operator (MCO) with Argo CD GitOps workflows, node reboots triggered by machine configuration changes can interrupt application synchronization and impact performance. This can occur when the MCO reboots a node that hosts the Argo CD application controller, terminating an active sync operation. Prevent these interruptions and ensure that the MCO and Argo CD work together reliably. +When using the Machine Config Operator (MCO) with Argo CD GitOps workflows, node reboots triggered by machine configuration changes can interrupt application synchronization and impact performance. // Enhance performance in machine configurations and Argo CD include::modules/performance-challenges-in-machine-configurations-and-argo-cd.adoc[leveloffset=+1] diff --git a/understanding_openshift_gitops/about-redhat-openshift-gitops.adoc b/understanding_openshift_gitops/about-redhat-openshift-gitops.adoc index da4bad75432..3b02037cc00 100644 --- a/understanding_openshift_gitops/about-redhat-openshift-gitops.adoc +++ b/understanding_openshift_gitops/about-redhat-openshift-gitops.adoc @@ -1,13 +1,13 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="about-redhat-openshift-gitops"] -= About {gitops-title} += About Red Hat OpenShift GitOps :context: about-redhat-openshift-gitops toc::[] [role="_abstract"] -{gitops-title} is an Operator that uses Argo CD as the declarative GitOps engine. It enables GitOps workflows across multicluster OpenShift and Kubernetes infrastructure. Using {gitops-title}, administrators can consistently configure and deploy Kubernetes-based infrastructure and applications across clusters and development lifecycles. +{gitops-title} is an Operator that uses Argo CD as the declarative GitOps engine. It enables GitOps workflows across multicluster OpenShift and Kubernetes infrastructure. {gitops-title} is based on the open source project Argo CD. It provides similar features to the upstream project, with additional automation and integration into {OCP}. It also includes Red Hat enterprise support, quality assurance, and a focus on enterprise security. diff --git a/understanding_openshift_gitops/gathering-gitops-diagnostic-information-for-support.adoc b/understanding_openshift_gitops/gathering-gitops-diagnostic-information-for-support.adoc index 99cde803039..099279a37a3 100644 --- a/understanding_openshift_gitops/gathering-gitops-diagnostic-information-for-support.adoc +++ b/understanding_openshift_gitops/gathering-gitops-diagnostic-information-for-support.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="gathering-gitops-diagnostic-information-for-support"] -= Gathering diagnostic information for support += Escalate to Red Hat Support :context: gathering-gitops-diagnostic-information-for-support toc::[] diff --git a/understanding_openshift_gitops/what-is-gitops.adoc b/understanding_openshift_gitops/what-is-gitops.adoc index 9ced0caa23b..3e387bf68ce 100644 --- a/understanding_openshift_gitops/what-is-gitops.adoc +++ b/understanding_openshift_gitops/what-is-gitops.adoc @@ -1,13 +1,13 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="what-is-gitops"] -= What is {gitops-shortname}? += What is OpenShift GitOps? :context: what-is-gitops toc::[] [role="_abstract"] -GitOps is a declarative way to implement continuous deployment for cloud native applications. You can use GitOps to create repeatable processes for managing {OCP} clusters and applications across multicluster Kubernetes environments. GitOps handles and automates complex deployments at a fast pace, saving time during deployment and release cycles. +GitOps is a declarative way to implement continuous deployment for cloud native applications. You can use GitOps to create repeatable processes for managing {OCP} clusters and applications across multicluster Kubernetes environments. The GitOps workflow pushes an application through development, testing, staging, and production. GitOps either deploys a new application or updates an existing one, so you only need to update the repository; GitOps automates everything else.