Skip to content

Commit 18ec67b

Browse files
authored
Merge pull request #56632 from shipsing/RHDEVDOCS-4365-new
RHDEVDOCS-4365-new: Added a procedure to customize the Argo CD link
2 parents effb926 + edc5af6 commit 18ec67b

6 files changed

+47
-6
lines changed

cicd/gitops/setting-up-argocd-instance.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: ASSEMBLY
22
[id="setting-up-argocd-instance"]
3-
= Setting up a new Argo CD instance
3+
= Setting up an Argo CD instance
44
include::_attributes/common-attributes.adoc[]
55
:context: setting-up-argocd-instance
66

@@ -13,3 +13,5 @@ include::modules/gitops-argo-cd-installation.adoc[leveloffset=+1]
1313
include::modules/gitops-enable-replicas-for-argo-cd-server.adoc[leveloffset=+1]
1414

1515
include::modules/gitops-deploy-resources-different-namespaces.adoc[leveloffset=+1]
16+
17+
include::modules/gitops-customize-argo-cd-consolelink.adoc[leveloffset=+1]

modules/gitops-argo-cd-installation.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * gitops-argo-cd-installation.adoc
3+
// * cicd/gitops/setting-up-argocd-instance.adoc
44

55
:_content-type: PROCEDURE
66
[id="gitops-argo-cd-installation_{context}"]
@@ -23,4 +23,4 @@ To manage cluster configurations or deploy applications, you can install and dep
2323

2424
.. Create an external OS Route to access Argo CD server. Click *Server* -> *Route* and check *Enabled*.
2525

26-
. To open the Argo CD web UI, click the route by navigating to **Networking -> Routes -> <instance name> -> server** in the project where the Argo CD instance is installed.
26+
. To open the Argo CD web UI, click the route by navigating to **Networking -> Routes -> <instance name>-server** in the project where the Argo CD instance is installed.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// Module included in the following assembly:
2+
//
3+
// * cicd/gitops/setting-up-argocd-instance.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="gitops-customize-argo-cd-consolelink_{context}"]
7+
= Customizing the Argo CD console link
8+
9+
In a multi-tenant cluster, users might have to deal with multiple instances of Argo CD. For example, after installing an Argo CD instance in your namespace, you might find a different Argo CD instance attached to the Argo CD console link, instead of your own Argo CD instance, in the Console Application Launcher.
10+
11+
You can customize the Argo CD console link by setting the `DISABLE_DEFAULT_ARGOCD_CONSOLELINK` environment variable:
12+
13+
* When you set `DISABLE_DEFAULT_ARGOCD_CONSOLELINK` to `true`, the Argo CD console link is permanently deleted.
14+
* When you set `DISABLE_DEFAULT_ARGOCD_CONSOLELINK` to `false` or use the default value, the Argo CD console link is temporarily deleted and visible again when the Argo CD route is reconciled.
15+
16+
.Prerequisites
17+
* You have logged in to the {product-title} cluster as an administrator.
18+
* You have installed the {gitops-title} Operator.
19+
20+
.Procedure
21+
22+
. In the *Administrator* perspective, navigate to *Administration* -> *CustomResourceDefinitions*.
23+
. Find the *Subscription* CRD and click to open it.
24+
. Select the *Instances* tab and click the *openshift-gitops-operator* subscription.
25+
. Select the *YAML* tab and make your customization:
26+
** To enable or disable the Argo CD console link, edit the value of `DISABLE_DEFAULT_ARGOCD_CONSOLELINK` as needed:
27+
+
28+
[source,yaml]
29+
----
30+
apiVersion: operators.coreos.com/v1alpha1
31+
kind: Subscription
32+
metadata:
33+
name: openshift-gitops-operator
34+
spec:
35+
config:
36+
env:
37+
- name: DISABLE_DEFAULT_ARGOCD_CONSOLELINK
38+
value: 'true'
39+
----

modules/gitops-deploy-resources-different-namespaces.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * gitops-argo-cd-installation.adoc
3+
// * cicd/gitops/setting-up-argocd-instance.adoc
44

55
:_content-type: PROCEDURE
66
[id="gitops-deploy-resources-different-namespaces_{context}"]

modules/gitops-enable-replicas-for-argo-cd-server.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * gitops-argo-cd-installation.adoc
3+
// * cicd/gitops/setting-up-argocd-instance.adoc
44

55
:_content-type: PROCEDURE
66
[id="gitops-enable-replicas-for-argo-cd-server_{context}"]

modules/go-compatibility-and-support-matrix.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ In the table, features are marked with the following statuses:
3535
[id="GitOps-technology-preview_{context}"]
3636
== Technology Preview features
3737

38-
Some features in this release are currently in Technology Preview (TP). These experimental features are not intended for production use.
38+
The features mentioned in the following table are currently in Technology Preview (TP). These experimental features are not intended for production use.
3939

4040
.Technology Preview tracker
4141
[cols="4,1,1",options="header"]

0 commit comments

Comments
 (0)