Skip to content

Commit 975f307

Browse files
Gerry-FordeGerry-Forde
committed
RHIDP-7472 - Modularize plugins content in artifacts/rhdh-plugins-reference
1 parent 203f27e commit 975f307

File tree

3 files changed

+78
-74
lines changed

3 files changed

+78
-74
lines changed

‎assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
include::../modules/dynamic-plugins/con-ansible-plugin-admin.adoc[leveloffset=+1]
66

77
// Argo CD
8-
include::../../artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc[leveloffset=+1]
8+
//include::../../artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc[leveloffset=+1]
9+
include::assembly-installing-configuring-argo-cd.adoc[leveloffset=+1]
910

1011
//JFrog Artifactory
1112
include::../../artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-admin.adoc[leveloffset=+1]

‎artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc‎ renamed to ‎modules/dynamic-plugins/proc-enabling-argo-cd-rollouts.adoc‎

Lines changed: 3 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,6 @@
1-
= Enabling the Argo CD plugin
2-
3-
You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflows in OpenShift GitOps. This plugin provides a visual overview of the application’s status, deployment details, commit message, author of the commit, container image promoted to environment and deployment history.
4-
5-
.Prerequisites
6-
7-
* Add Argo CD instance information to your `app-config.yaml` configmap as shown in the following example:
8-
9-
+
10-
[source,yaml]
11-
----
12-
argocd:
13-
appLocatorMethods:
14-
- type: 'config'
15-
instances:
16-
- name: argoInstance1
17-
url: https://argoInstance1.com
18-
username: ${ARGOCD_USERNAME}
19-
password: ${ARGOCD_PASSWORD}
20-
- name: argoInstance2
21-
url: https://argoInstance2.com
22-
username: ${ARGOCD_USERNAME}
23-
password: ${ARGOCD_PASSWORD}
24-
----
25-
26-
* Add the following annotation to the entity’s `catalog-info.yaml` file to identify the Argo CD applications.
27-
28-
+
29-
[source,yaml]
30-
----
31-
annotations:
32-
...
33-
# The label that Argo CD uses to fetch all the applications. The format to be used is label.key=label.value. For example, rht-gitops.com/janus-argocd=quarkus-app.
34-
35-
argocd/app-selector: '${ARGOCD_LABEL_SELECTOR}'
36-
----
37-
38-
* (Optional) Add the following annotation to the entity’s `catalog-info.yaml` file to switch between Argo CD instances as shown in the following example:
39-
40-
+
41-
[source,yaml]
42-
----
43-
annotations:
44-
...
45-
# The Argo CD instance name used in `app-config.yaml`.
46-
47-
argocd/instance-name: '${ARGOCD_INSTANCE}'
48-
----
49-
50-
+
51-
[NOTE]
52-
====
53-
If you do not set this annotation, the Argo CD plugin defaults to the first Argo CD instance configured in `app-config.yaml`.
54-
====
55-
56-
.Procedure
57-
58-
. Add the following to your dynamic-plugins ConfigMap to enable the Argo CD plugin.
59-
+
60-
[source,yaml]
61-
----
62-
global:
63-
dynamic:
64-
includes:
65-
- dynamic-plugins.default.yaml
66-
plugins:
67-
- package: ./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd-backend-dynamic
68-
disabled: false
69-
- package: ./dynamic-plugins/dist/backstage-community-plugin-redhat-argocd
70-
disabled: false
71-
----
72-
73-
== Enabling Argo CD Rollouts
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="enabling-argo-cd-rollouts_{context}"]
3+
= Enabling Argo CD Rollouts
744

755
The optional Argo CD Rollouts feature enhances Kubernetes by providing advanced deployment strategies, such as blue-green and canary deployments, for your applications. When integrated into the backstage Kubernetes plugin, it allows developers and operations teams to visualize and manage Argo CD Rollouts seamlessly within the Backstage interface.
766

‎modules/dynamic-plugins/proc-enabling-the-argo-cd-plugin.adoc‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="enabling-the-argo-cd-plugin_{context}"]
3+
= Enabling the Argo CD plugin
4+
5+
The Argo CD plugin provides a visual overview of the application’s status, deployment details, commit message, author of the commit, container image promoted to environment and deployment history.
6+
7+
.Prerequisites
8+
9+
* Add Argo CD instance information to your `app-config.yaml` configmap as shown in the following example:
10+
11+
+
12+
[source,yaml]
13+
----
14+
argocd:
15+
appLocatorMethods:
16+
- type: 'config'
17+
instances:
18+
- name: argoInstance1
19+
url: https://argoInstance1.com
20+
username: ${ARGOCD_USERNAME}
21+
password: ${ARGOCD_PASSWORD}
22+
- name: argoInstance2
23+
url: https://argoInstance2.com
24+
username: ${ARGOCD_USERNAME}
25+
password: ${ARGOCD_PASSWORD}
26+
----
27+
28+
* Add the following annotation to the entity’s `catalog-info.yaml` file to identify the Argo CD applications.
29+
30+
+
31+
[source,yaml]
32+
----
33+
annotations:
34+
...
35+
# The label that Argo CD uses to fetch all the applications. The format to be used is label.key=label.value. For example, rht-gitops.com/janus-argocd=quarkus-app.
36+
37+
argocd/app-selector: '${ARGOCD_LABEL_SELECTOR}'
38+
----
39+
40+
* (Optional) Add the following annotation to the entity’s `catalog-info.yaml` file to switch between Argo CD instances as shown in the following example:
41+
42+
+
43+
[source,yaml]
44+
----
45+
annotations:
46+
...
47+
# The Argo CD instance name used in `app-config.yaml`.
48+
49+
argocd/instance-name: '${ARGOCD_INSTANCE}'
50+
----
51+
52+
+
53+
[NOTE]
54+
====
55+
If you do not set this annotation, the Argo CD plugin defaults to the first Argo CD instance configured in `app-config.yaml`.
56+
====
57+
58+
.Procedure
59+
60+
. Add the following to your dynamic-plugins ConfigMap to enable the Argo CD plugin.
61+
+
62+
[source,yaml]
63+
----
64+
global:
65+
dynamic:
66+
includes:
67+
- dynamic-plugins.default.yaml
68+
plugins:
69+
- package: ./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd-backend-dynamic
70+
disabled: false
71+
- package: ./dynamic-plugins/dist/backstage-community-plugin-redhat-argocd
72+
disabled: false
73+
----

0 commit comments

Comments
 (0)