Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Original file line number Diff line number Diff line change
Expand Up @@ -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]
7 changes: 3 additions & 4 deletions gitops_cli_argocd/argocd-gitops-cli-reference.adoc
Original file line number Diff line number Diff line change
@@ -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]
Expand All @@ -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
4 changes: 2 additions & 2 deletions gitops_cli_argocd/configuring-argocd-gitops-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]
Original file line number Diff line number Diff line change
@@ -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::[]
Expand Down
4 changes: 2 additions & 2 deletions installing_gitops/installing-argocd-gitops-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
4 changes: 2 additions & 2 deletions modules/collecting-gitops-debugging-data.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}:
Expand Down Expand Up @@ -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]
----
Expand Down
2 changes: 1 addition & 1 deletion modules/gitops-argo-cd-properties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions modules/gitops-openshift-go-common-terms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion modules/gitops-troubleshooting-argocd-principal-agent.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion modules/go-add-infra-nodes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Expand Down
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -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::[]
Expand Down
4 changes: 2 additions & 2 deletions understanding_openshift_gitops/what-is-gitops.adoc
Original file line number Diff line number Diff line change
@@ -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.

Expand Down