Skip to content

Commit 281536d

Browse files
Updating GitOps docs to improve content for argo CD resource, default, and custom argo CD instances
Addressing SME review comments
1 parent 14d428b commit 281536d

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

argocd_instance/setting-up-argocd-instance.adoc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,26 @@ toc::[]
88

99
By default, {gitops-title} installs an instance of Argo CD in the `openshift-gitops` namespace with additional permissions for managing certain cluster-scoped resources. This default Argo CD instance is also called as the default cluster-scoped instance.
1010

11+
To prevent the default Argo CD instance from starting in the `openshift-gitops` namespace, you can use the `openshift-gitops-operator` subscription and configure the `DISABLE_DEFAULT_ARGOCD_INSTANCE` environment variable in it by setting the string value to `"true"`.
12+
1113
[NOTE]
1214
====
1315
For {gitops-shortname} version 1.13 and later:
1416
1517
* Route TLS termination is set as default to the `reencrypt` mode for both the default and user-defined Argo CD instances. TLS connections to the Argo CD instances now receive the default ingress certificate that is set in {OCP}, instead of the self-signed Argo CD certificate. You can modify the route TLS termination policy by configuring the `.spec.server.route.tls` field of the Argo CD CR.
1618
17-
* Restricted pod security admission (PSA) labels are applied to the `openshift-gitops` namespace to ensure compliance with {OCP} standards. If you are running additional workloads in this namespace, such as monitoring or logging, ensure that they comply with the restricted PSA requirements. If compliance is not feasible, consider using a user-defined, cluster-scoped ArgoCD instance, where PSA labels are not applied or controlled by the {gitops-shortname} Operator.
19+
* Restricted pod security admission (PSA) labels are applied to the `openshift-gitops` namespace to ensure compliance with {OCP} standards. If you are running additional workloads in this namespace, such as monitoring or logging, ensure that they comply with the restricted PSA requirements. If compliance is not feasible, consider using a user-defined, cluster-scoped Argo CD instance, where PSA labels are not applied or controlled by the {gitops-shortname} Operator.
1820
====
1921

2022
To manage cluster configurations or deploy applications, you can install and deploy a new user-defined Argo CD instance. By default, any new user-defined instance has permissions to manage resources only in the namespace where it is deployed.
2123

24+
You can create a user-defined Argo CD instance in any namespace, other than the `openshift-gitops` namespace.
25+
26+
[IMPORTANT]
27+
====
28+
If you want to create a user-defined Argo CD instance within the `openshift-gitops` namespace, set the `DISABLE_DEFAULT_ARGOCD_INSTANCE` flag value in the `openshift-gitops-operator` subscription to `"true"` and do not name the instance as `openshift-gitops`.
29+
====
30+
2231
// Installing an Argo CD instance
2332
include::modules/gitops-argo-cd-installation.adoc[leveloffset=+1]
2433
[role="_additional-resources"]

modules/gitops-openshift-go-common-terms.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ An Argo CD component that performs the following actions:
6565
* Returns the result to the Argo CD Application Controller
6666
6767
Argo CD resource (`ArgoCD` CR)::
68-
A CR that describes the wanted state for a given Argo CD instance. It allows you to configure the components and settings that make up an Argo CD instance.
68+
A CR that describes the wanted state for a given Argo CD instance. It allows you to configure the components and settings that make up an Argo CD instance. At any given time, you can have only one `ArgoCD` CR within a namespace.
6969

7070
Argo CD server (Argo CD-server)::
7171
A server that provides the API and UI for Argo CD.
@@ -153,6 +153,8 @@ The wanted state of application resources, as represented by files in a Git repo
153153

154154
User-defined Argo CD instance::
155155
A custom Argo CD instance that you install and deploy to manage cluster configurations or deploy applications. By default, any new user-defined instance has permissions to manage resources only in the namespace where it is deployed.
156+
+
157+
You can create a user-defined Argo CD instance in any namespace, other than the `openshift-gitops` namespace.
156158

157159
Workload::
158160
Any process, usually defined within resources such as `Deployment`, `StatefulSet`, `ReplicaSet`, `Job`, or `Pod`, running within a container. Examples include a Spring Boot application, a NodeJS Express application, or a Ruby on Rails application.

0 commit comments

Comments
 (0)