Skip to content

Commit baa277f

Browse files
themr0cthemr0c
authored
Merge branch 'main' into RHIDP-3681-Remove-Incorrect-Links-In-Documentation
2 parents f3d4d16 + a23c431 commit baa277f

File tree

181 files changed

+3551
-495
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

181 files changed

+3551
-495
lines changed

‎.asciidoctor/docs.css‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ table {
220220
border:0;
221221
font-size:1rem;
222222
line-height:1.6667;
223-
table-layout:fixed
223+
/* commented out as it breaks on Safari on Mac // table-layout:fixed */
224224
}
225225
table caption {
226226
color:#585858;

‎artifacts/attributes.adoc‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
:product-version: 1.3
1414
:product-bundle-version: 1.3.0
1515
:product-chart-version: 1.3.0
16-
:product-backstage-version: 1.27.7
16+
:product-backstage-version: 1.29.2
1717
:rhdeveloper-name: Red Hat Developer
1818
:rhel: Red Hat Enterprise Linux
1919
:odf-name: OpenShift Data Foundation
@@ -43,6 +43,8 @@
4343
:aks-short: AKS
4444
:gke-brand-name: Google Kubernetes Engine
4545
:gke-short: GKE
46+
:gcp-brand-name: Google Cloud Platform
47+
:gcp-short: GCP
4648

4749
// Release Notes
4850
:rn-product-title: Release notes for Red Hat Developer Hub
@@ -68,23 +70,33 @@
6870
:LinkPluginsGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring_plugins_in_red_hat_developer_hub/index
6971
:NameOfPluginsGuide: Configuring plugins in {product}
7072

73+
:release-notes-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/release_notes/index
74+
:release-notes-title: Release notes
75+
76+
:installing-and-viewing-dynamic-plugins-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_dynamic_plugins/index
77+
:installing-and-viewing-dynamic-plugins-title: Installing and viewing dynamic plugins
78+
79+
7180
:authentication-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authentication/index
7281
:authentication-book-title: Authentication
7382

7483
:authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index
7584
:authorization-book-title: Authorization
7685

77-
:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/installing_red_hat_developer_hub_on_openshift_container_platform/index
86+
:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_on_openshift_container_platform/index
7887
:installing-on-ocp-book-title: Installing {product} on {ocp-short}
7988

80-
:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
89+
:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
8190
:installing-on-eks-book-title: Installing {product} on {eks-brand-name}
8291

83-
:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
92+
:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
8493
:installing-on-aks-book-title: Installing {product} on {aks-brand-name}
8594

86-
:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
95+
:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
8796
:installing-in-air-gap-book-title: Installing {product} in an air-gapped environment
8897

89-
:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/upgrading_red_hat_developer_hub/index
90-
:upgrading-book-title: Upgrading {product}
98+
:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/upgrading_red_hat_developer_hub/index
99+
:upgrading-book-title: Upgrading {product}
100+
101+
:plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/configuring_dynamic_plugins/index
102+
:plugins-configure-book-title: Configuring dynamic plugins

‎artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
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+
[role="_additional-resources"]
74+
.Additional resources
75+
76+
* The package path, scope, and name of the {company-name} ArgoCD plugin has changed since 1.2. For more information, see link:{release-notes-url}#removed-functionality-rhidp-4293[Breaking Changes] in the _{rn-product-title}_.
77+
78+
* For more information on installing dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].

‎artifacts/rhdh-plugins-reference/argocd/argocd-plugin-readme.adoc‎

Lines changed: 1 addition & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -2,79 +2,7 @@
22

33
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.
44

5-
== For administrators
6-
7-
=== Enabling Argo CD plugin
8-
9-
.Prerequisites
10-
11-
* Add Argo CD instance information to your `app-config.yaml` configmap as shown in the following example:
12-
13-
+
14-
[source,yaml]
15-
----
16-
argocd:
17-
appLocatorMethods:
18-
- type: 'config'
19-
instances:
20-
- name: argoInstance1
21-
url: https://argoInstance1.com
22-
username: ${ARGOCD_USERNAME}
23-
password: ${ARGOCD_PASSWORD}
24-
- name: argoInstance2
25-
url: https://argoInstance2.com
26-
username: ${ARGOCD_USERNAME}
27-
password: ${ARGOCD_PASSWORD}
28-
----
29-
30-
* Add the following annotation to the entity’s `catalog-info.yaml` file to identify the Argo CD applications.
31-
32-
+
33-
[source,yaml]
34-
----
35-
annotations:
36-
...
37-
# 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.
38-
39-
argocd/app-selector: '${ARGOCD_LABEL_SELECTOR}'
40-
----
41-
42-
* (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:
43-
44-
+
45-
[source,yaml]
46-
----
47-
annotations:
48-
...
49-
# The Argo CD instance name used in `app-config.yaml`.
50-
51-
argocd/instance-name: '${ARGOCD_INSTANCE}'
52-
----
53-
54-
+
55-
[NOTE]
56-
====
57-
If you do not set this annotation, the Argo CD plugin defaults to the first Argo CD instance configured in `app-config.yaml`.
58-
====
59-
60-
.Procedure
61-
62-
. Add the following to your dynamic-plugins ConfigMap to enable the Argo CD plugin.
63-
+
64-
[source,yaml]
65-
----
66-
global:
67-
dynamic:
68-
includes:
69-
- dynamic-plugins.default.yaml
70-
plugins:
71-
- package: ./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd-backend-dynamic
72-
disabled: false
73-
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-argocd
74-
disabled: false
75-
----
76-
77-
== For Users
5+
== Using the Argo CD plugin
786

797
.Prerequisites
808

‎artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
= Using 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+
* You have enabled the Argo CD plugin in {product} {product-very-short}.
8+
9+
.Procedures
10+
11+
. Select the *Catalog* tab and choose the component that you want to use.
12+
13+
. Select the *CD* tab to view insights into deployments managed by Argo CD.
14+
15+
+
16+
image::rhdh-plugins-reference/argocd.png[CD tab Argo CD]
17+
18+
. Select an appropriate card to view the deployment details (for example, commit message, author name, and deployment history).
19+
20+
+
21+
image::rhdh-plugins-reference/sidebar.png[Sidebar]
22+
23+
.. Click the link icon (image:rhdh-plugins-reference/link.png[Link icon]) to open the deployment details in Argo CD.
24+
25+
. Select the *Overview* tab and navigate to the Deployment summary section to review the summary of your application's deployment across namespaces. Additionally, select an appropriate Argo CD app to open the deployment details in Argo CD, or select a commit ID from the Revision column to review the changes in GitLab or GitHub.
26+
27+
+
28+
image::rhdh-plugins-reference/deployment_summary.png[Deployment summary]
29+
30+
31+
[role="_additional-resources"]
32+
.Additional resources
33+
34+
* For more information on dynamic plugins, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/configuring_plugins_in_red_hat_developer_hub/rhdh-installing-dynamic-plugins[Dynamic plugin installation].

0 commit comments

Comments
 (0)