Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
82 commits
Select commit Hold shift + click to select a range
2bcae96
feat: add GitHub action to generate supported plugins PR (#905)
BethGriggs Feb 4, 2025
25e2399
Update CVE list and content for release-1.5 (#910)
themr0c Feb 7, 2025
3f7845c
RHIDP-5765 comment out references to GitHub Enterprise (#900)
themr0c Feb 7, 2025
e43fa0c
RHDH-5561: TechDocs content restructure (#877)
linfraze Feb 7, 2025
9279859
fix: fix timestamp, use PIP yq in workflow (#924)
BethGriggs Feb 11, 2025
8f31023
Changed alpha2 to alpha3 (#915)
pabel-rh Feb 13, 2025
1d090f5
Fix inconsistencies with referencing my-rhdh-secrets (#918)
jmagak Feb 13, 2025
95876ff
RHIDP-5592:Wrong definition of Service Monitor for an RHDH instance b…
pabel-rh Feb 14, 2025
33f16cb
Change the layout of the next steps (#893)
jmagak Feb 17, 2025
0105347
chore: bad link in code snippet points to non-existent branch (#931)
nickboldt Feb 17, 2025
e24d5ca
Updated plugin doc for Argo CD rollout feature (#725)
gtrivedi88 Feb 27, 2025
7ef2e57
Rectified the correct case (#926)
pabel-rh Feb 27, 2025
59c965a
RHIDP-3206: Added attribute declaration to the relevant source code b…
pabel-rh Feb 27, 2025
9e97a36
RHIDP-5901: readOnlyRootFilesystem option (#938)
pabel-rh Feb 27, 2025
7200a92
Update the Helm procedure to use oc-mirror for air-gapped OCP environ…
Fortune-Ndlovu Feb 27, 2025
1f1ccc2
RHIDP-1848: Updates the setting up RBAC permission (#906)
jmagak Feb 28, 2025
a399b01
[RHIDP-5813] update scaffolder permissions table to include the scaff…
04kash Mar 5, 2025
78e21c3
RHIDP-5139: Installing RHDH container image plugins (#831)
hmanwani-rh Mar 6, 2025
9a381cb
RHIDP-5491 configure expiry on refresh token cookie (#899)
themr0c Mar 7, 2025
53184bc
RHIDP-5514: Floating action button (#925)
pabel-rh Mar 13, 2025
fc7f261
RHIDP-5959 Update dangerouslyAllowSignInWithoutUserInCatalog config (…
themr0c Mar 13, 2025
7b4379c
RHIDP-5423: Content for Kubernetes scaffolder actions (#951)
pabel-rh Mar 13, 2025
92d2f3f
RHIDP-6391 Release notes script to stop using the issue title (#980)
themr0c Mar 13, 2025
d149296
RHIDP-6130: Update docs to refer to new secret name (#962)
jmagak Mar 13, 2025
2b0ac03
RHIDP-5409 update book links (#976)
themr0c Mar 13, 2025
bf9bf9c
RHIDP-5494: Doc air-gapped installation using Operator (#935)
linfraze Mar 14, 2025
79f1ead
RHIDP-4485: Topology plugin code block formatting (#970)
pabel-rh Mar 17, 2025
9b2dcf2
[main] RHIDP-5605 - Plugin installation documentation improvement fo…
openshift-cherrypick-robot Mar 18, 2025
549280d
RHIDP-5570-2 - Document that the Dynamic Plugin cache PVC is disabled…
Gerry-Forde Mar 19, 2025
7d82675
Update typo in con-dynamic-plugins-cache.adoc
Gerry-Forde Mar 19, 2025
7a0c124
RHIDP-1595: How to use HA in RHDH (#967)
pabel-rh Mar 20, 2025
b0ef8e2
RHIDP-5433: Applied modularization changes for the Customizing title …
pabel-rh Mar 21, 2025
e04c251
RHIDP-5881: Fix inconsistencies with referencing my-rhdh-secrets (#944)
jmagak Mar 21, 2025
f7e9a1d
RHDHPAI-596: Added content for RHDH adoption insights plugin (#1000)
pabel-rh Mar 21, 2025
348fa6a
RHIDP-5372- Fix inconsistent reference to the app config file (#914)
jmagak Mar 21, 2025
a6f04ec
RHIDP-5490: Configure global header in RHDH (#954)
jmagak Mar 21, 2025
2368bb2
[main] RHIDP-6323 - Dynamic Plugins - Update table of dynamic plugins…
openshift-cherrypick-robot Mar 24, 2025
e5018db
RHDH Test Day - FAB Updates (#997)
pabel-rh Mar 24, 2025
74f4dbb
RHIDP-3393-1 - Document how users can access Plugin Marketplace in RH…
Gerry-Forde Mar 24, 2025
9175aa9
RHIDP-5422: TechDocs add-ons doc (#975)
linfraze Mar 24, 2025
e1e8dfb
RHIDP-5681: Update the enabling authentication with rhbk (#960)
jmagak Mar 24, 2025
48069cb
RHIDP-6397: Modularize air-gapped installation doc Helm (#1012)
jmagak Mar 24, 2025
b696cfa
RHIDP-6396: Modularize air-gapped installation doc-Operator (#1010)
jmagak Mar 25, 2025
0cb99ee
RHDHPAI-716: Changing default date value (#1021)
pabel-rh Mar 26, 2025
c550fba
RHIDP-6675: Added screenshots to Extensions chapter (#1029)
hmanwani-rh Mar 28, 2025
c87a8b1
Included images (#1028)
pabel-rh Mar 28, 2025
f74a341
[release-1.6] RHIDP-6667: Update TechDocs add-ons doc (#1045)
openshift-cherrypick-robot Apr 3, 2025
293ec80
[release-1.6] RHIDP-3504: Update the doc on changing RHDH logo (#1048)
openshift-cherrypick-robot Apr 3, 2025
6ac9851
[release-1.6] RHIDP-5604 Configuring entity tab titles and entity det…
openshift-cherrypick-robot Apr 3, 2025
b8f3dfb
[release-1.6] RHIDP-6149: Supported platform list in installation doc…
openshift-cherrypick-robot Apr 8, 2025
c9b7600
RHIDP-6970: Fix headings in Customizing doc (#1075)
openshift-cherrypick-robot Apr 14, 2025
54ce202
RHIDP-6423 Remove references to the custom auditor implementation (#1…
openshift-cherrypick-robot Apr 16, 2025
86543ba
[release-1.6] RHIDP-6499: Modularize Customizing the Learning Paths (…
openshift-cherrypick-robot Apr 22, 2025
28c393c
chore: remove obsolete files related to security updates - content is…
nickboldt Apr 22, 2025
674ff2f
[release-1.6] RHIDP-7076: Changing version number for RHBK (#1093)
openshift-cherrypick-robot Apr 23, 2025
f53a829
RHIDP-6217: Updates in Topology RBAC permissions (#1095)
openshift-cherrypick-robot Apr 24, 2025
feada25
[release-1.6] RHIDP-6525: Modularizing Customizing (#1103)
openshift-cherrypick-robot Apr 28, 2025
b8c0480
Updated the reference (#1109)
pabel-rh Apr 28, 2025
3ba1f74
RHIDP-6882 - RHBK authentication: set the sub claim OIDC resolver as …
openshift-cherrypick-robot Apr 29, 2025
2364649
[release-1.6] RHIDP-6500: Modularize customizing the Tech Radar page …
openshift-cherrypick-robot Apr 29, 2025
720080e
RHIDP-6508 - modularize _Supported ServiceNow custom actions_ (#1114)
openshift-cherrypick-robot Apr 29, 2025
5ac5dce
[release-1.6] RHIDP-6570: Document the permission support to RBAC plu…
openshift-cherrypick-robot Apr 29, 2025
211e3ff
[release-1.6] RHIDP-6567: HA support for AKS (#1116)
openshift-cherrypick-robot Apr 29, 2025
c933e5b
[release-1.6] RHIDP-6566: Rename Create with Self-service (#1117)
openshift-cherrypick-robot Apr 29, 2025
6f98ec9
[release-1.6] RHIDP-6507 - modularize _Monitoring and logging with AW…
openshift-cherrypick-robot Apr 30, 2025
592dc4f
[release-1.6] RHIDP-6502 Modularize Overriding Core Backend Service C…
openshift-cherrypick-robot Apr 30, 2025
2fd36a0
[release-1.6] RHIDP-5515: Document default PVC and Secret configurati…
openshift-cherrypick-robot Apr 30, 2025
1a7e3e7
[release-1.6] RHIDP-6571 - remove configuring the base URL for Operat…
openshift-cherrypick-robot Apr 30, 2025
f0b2b3f
[release-1.6] RHIDP-6504: Modularize modules/dynamic-plugins/proc-top…
openshift-cherrypick-robot Apr 30, 2025
4f835e7
Updated versions for 1.6 (#1125)
hmanwani-rh Apr 30, 2025
d71dff6
RHIDP-6506: Modularize proc-rhdh-deploy-eks-operator.adoc (#1126)
openshift-cherrypick-robot May 1, 2025
7841c14
RHIDP-6850: Add TechDocs subtitle (#1128)
openshift-cherrypick-robot May 1, 2025
66bb26c
[release-1.6] RHIDP-5483: Update Authorization Preface (#1130)
openshift-cherrypick-robot May 1, 2025
5e6893c
Update attributes.adoc
Gerry-Forde May 1, 2025
336033e
RHIDP-6503 - Modularize: Installing and configuring the Redis cache (…
openshift-cherrypick-robot May 2, 2025
617d2da
Manual cherrypick (#1106)
pabel-rh May 2, 2025
8f92761
[release-1.6] RHIDP-6146: Create developer-focused TechDocs content (…
openshift-cherrypick-robot May 5, 2025
c88abe4
[release-1.6] RHIDP-5653: Reorganize Segment/Telemetry instructions i…
openshift-cherrypick-robot May 5, 2025
e96587a
Update attributes.adoc (#1140)
Gerry-Forde May 6, 2025
33e9204
RHIDP-6575-1 - Promote RHDH-local to Dev preview status in RHDH Docs …
Gerry-Forde May 7, 2025
0458a0b
chore: add developer-preview.adoc as a separate query and template th…
nickboldt May 7, 2025
26824cd
update PR so copy is closer to previous version in https://docs.redha…
nickboldt May 7, 2025
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
45 changes: 45 additions & 0 deletions .github/workflows/generate-supported-plugins-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Generate update PR for the Dynamic Plugins tables

on:
workflow_dispatch:
inputs:
branch:
description: "Branch to run the script from"
required: true
default: "main"

jobs:
run-script:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
ref: ${{ github.event.inputs.branch }}
fetch-depth: 0

- name: Install PIP `yq`
run: |
python3 -m pip install --upgrade pip
pip install yq
echo "Installed `yq` version: $(yq --version)"

- name: Set up Git user
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"

- name: Generate timestamp
run: echo "TIMESTAMP=$(date +'%Y%m%d-%H%M%S' -u)" >> $GITHUB_ENV

- name: Run the script on branch
run: bash modules/dynamic-plugins/rhdh-supported-plugins.sh -b ${{ github.event.inputs.branch }}

- name: Create Pull Request
uses: peter-evans/create-pull-request@v6
with:
commit-message: "chore: automated update of supported plugins list"
title: "Automated update of supported plugins list for ${{ github.event.inputs.branch }}"
body: "This PR was automatically generated by running rhdh-supported-plugins.sh."
branch: "update-${{ github.event.inputs.branch }}-${{ env.TIMESTAMP }}"
base: ${{ github.event.inputs.branch }}
110 changes: 53 additions & 57 deletions artifacts/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@
:product: Red Hat Developer Hub
:product-short: Developer Hub
:product-very-short: RHDH
:product-version: 1.5
:product-bundle-version: 1.5.0
:product-chart-version: 1.5.0
:product-backstage-version: 1.35.0
:product-local: Red Hat Developer Hub Local
:product-local-very-short: RHDH Local
:product-version: 1.6
:product-bundle-version: 1.6.0
:product-chart-version: 1.6.0
:product-backstage-version: 1.36.1
:product-custom-resource-type: Backstage
:rhdeveloper-name: Red Hat Developer
:rhel: Red Hat Enterprise Linux
Expand Down Expand Up @@ -47,7 +49,7 @@
:rhsso: RHSSO
:rhbk-brand-name: Red Hat Build of Keycloak
:rhbk: RHBK
:keycloak-version: 24.0
:keycloak-version: 26.0

// RHTAP information
:rhtap-version: 1.3
Expand Down Expand Up @@ -85,75 +87,69 @@
:gcp-brand-name: Google Cloud Platform
:gcp-short: GCP

// Release Notes
:rn-product-title: Release notes for Red Hat Developer Hub

// Red Hat Developer Hub administration guide
:ag-product-title: Administration guide for Red Hat Developer Hub

// Red Hat Developer Hub getting started guide
:gs-product-title: Getting started with Red Hat Developer Hub

// Backstage Plugins for Red Hat Developer Hub
//:bs-product-title: Backstage Plugins for Red Hat Developer Hub

// User Guide
:ug-product-title: Red Hat Developer Hub User Guide

// Links


:LinkPluginsGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring_plugins_in_red_hat_developer_hub/index
:NameOfPluginsGuide: Configuring plugins in {product}

:release-notes-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/release_notes/index
:release-notes-title: Release notes

: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
:installing-and-viewing-dynamic-plugins-title: Installing and viewing dynamic plugins

:authentication-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authentication/index
:authentication-book-title: Authentication

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

:configuring-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring/index
:configuring-book-title: Configuring
:discover-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Discover
:about-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/about_red_hat_developer_hub/index
:about-book-title: About {product}

:customizing-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/customizing/index
:customizing-book-title: Customizing
:release-notes-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Release Notes
:release-notes-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/red_hat_developer_hub_release_notes/index
:release-notes-book-title: {product} release notes

:installing-on-osd-on-gcp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index
:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}

:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
:install-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Install
:installing-on-ocp-book-title: Installing {product} on {ocp-short}

:installing-on-gke-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_google_kubernetes_engine/index
:installing-on-gke-book-title: Installing {product} on {gke-brand-name}

:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
:installing-on-eks-book-title: Installing {product} on {eks-brand-name}

:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
:installing-on-aks-book-title: Installing {product} on {aks-brand-name}

:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}
:installing-on-osd-on-gcp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index
:installing-on-gke-book-title: Installing {product} on {gke-brand-name}
:installing-on-gke-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_google_kubernetes_engine/index
:installing-in-air-gap-book-title: Installing {product} in an air-gapped environment
:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index

:upgrade-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Upgrade
:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/upgrading_red_hat_developer_hub/index
:upgrading-book-title: Upgrading {product}

:configure-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Configure
:configuring-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring_red_hat_developer_hub/index
:configuring-book-title: Configuring {product}
:customizing-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/customizing_red_hat_developer_hub/index
:customizing-book-title: Customizing {product}
:techdocs-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/techdocs_for_red_hat_developer_hub/index
:techdocs-book-title: TechDocs for {product}

:control-access-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Control access
:authentication-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authentication_in_red_hat_developer_hub/index
:authentication-book-title: Authentication in {product}
:authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization_in_red_hat_developer_hub/index
:authorization-book-title: Authorization in {product}

:observability-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Observability
:audit-log-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/audit_logs_in_red_hat_developer_hub/index
:audit-log-book-title: Audit logs in {product}
:monitoring-and-logging-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/monitoring_and_logging/index
:monitoring-and-logging-book-title: Monitoring and logging
:telemetry-data-collection-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/telemetry_data_collection/index
:telemetry-data-collection-book-title: Telemetry data collection

:audit-log-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/audit_log/index
:audit-log-book-title: Audit log
:extend-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Extend
:introduction-to-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/introduction_to_plugins/index
:introduction-to-plugins-book-title: Introduction to plugins
:configuring-dynamic-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/introduction_to_plugins/index
:configuring-dynamic-plugins-book-title: Configuring dynamic plugins
:installing-and-viewing-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
:installing-and-viewing-plugins-book-title: Installing and viewing plugins in {product}
:using-dynamic-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
:using-dynamic-plugins-book-title: Using dynamic plugins
:dynamic-plugins-reference-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/dynamic_plugins_reference/index
:dynamic-plugins-reference-book-title: Dynamic plugins reference

:monitoring-and-logging-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/monitoring_and_logging/index
:monitoring-and-logging-book-title: Monitoring and logging

:plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring_dynamic_plugins/index
:plugins-configure-book-title: Configuring dynamic plugins

157 changes: 155 additions & 2 deletions artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,162 @@ global:
disabled: false
----

== Enabling Argo CD Rollouts

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.

.Prerequisites

* The Backstage Kubernetes plugin (`@backstage/plugin-kubernetes`) is installed and configured.

** To install and configure Kubernetes plugin in Backstage, see link:https://backstage.io/docs/features/kubernetes/installation/[Installaltion] and link:https://backstage.io/docs/features/kubernetes/configuration/[Configuration] guide.

* You have access to the Kubernetes cluster with the necessary permissions to create and manage custom resources and `ClusterRoles`.

* The Kubernetes cluster has the `argoproj.io` group resources (for example, Rollouts and AnalysisRuns) installed.

.Procedure

. In the `app-config.yaml` file in your Backstage instance, add the following `customResources` component under the `kubernetes` configuration to enable Argo Rollouts and AnalysisRuns:

+
[source,yaml]
----
kubernetes:
...
customResources:
- group: 'argoproj.io'
apiVersion: 'v1alpha1'
plural: 'Rollouts'
- group: 'argoproj.io'
apiVersion: 'v1alpha1'
plural: 'analysisruns'
----

. Grant `ClusterRole` permissions for custom resources.

+
[NOTE]
====

* If the Backstage Kubernetes plugin is already configured, the `ClusterRole` permissions for Rollouts and AnalysisRuns might already be granted.

* Use the link:https://raw.githubusercontent.com/backstage/community-plugins/main/workspaces/redhat-argocd/plugins/argocd/manifests/clusterrole.yaml[prepared manifest] to provide read-only `ClusterRole` access to both the Kubernetes and ArgoCD plugins.
====

.. If the `ClusterRole` permission is not granted, use the following YAML manifest to create the `ClusterRole`:

+
[source,yaml]
----
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
name: backstage-read-only
rules:
- apiGroups:
- argoproj.io
resources:
- rollouts
- analysisruns
verbs:
- get
- list
----

.. Apply the manifest to the cluster using `kubectl`:
+
[source,bash]
----
kubectl apply -f <your-clusterrole-file>.yaml
----

.. Ensure the `ServiceAccount` accessing the cluster has this `ClusterRole` assigned.

. Add annotations to `catalog-info.yaml` to identify Kubernetes resources for Backstage.

.. For identifying resources by entity ID:
+
[source,yaml]
----
annotations:
...
backstage.io/kubernetes-id: <BACKSTAGE_ENTITY_NAME>
----

.. (Optional) For identifying resources by namespace:
+
[source,yaml]
----
annotations:
...
backstage.io/kubernetes-namespace: <RESOURCE_NAMESPACE>
----

.. For using custom label selectors, which override resource identification by entity ID or namespace:
+
[source,yaml]
----
annotations:
...
backstage.io/kubernetes-label-selector: 'app=my-app,component=front-end'
----
+
[NOTE]
====
Ensure you specify the labels declared in `backstage.io/kubernetes-label-selector` on your Kubernetes resources. This annotation overrides entity-based or namespace-based identification annotations, such as `backstage.io/kubernetes-id` and `backstage.io/kubernetes-namespace`.
====

. Add label to Kubernetes resources to enable Backstage to find the appropriate Kubernetes resources.

.. Backstage Kubernetes plugin label: Add this label to map resources to specific Backstage entities.
+
[source,yaml]
----
labels:
...
backstage.io/kubernetes-id: <BACKSTAGE_ENTITY_NAME>
----

.. GitOps application mapping: Add this label to map Argo CD Rollouts to a specific GitOps application
+
[source,yaml]
----
labels:
...
app.kubernetes.io/instance: <GITOPS_APPLICATION_NAME>
----

+
[NOTE]
====
If using the label selector annotation (backstage.io/kubernetes-label-selector), ensure the specified labels are present on the resources. The label selector will override other annotations like kubernetes-id or kubernetes-namespace.
====

.Verification

. Push the updated configuration to your GitOps repository to trigger a rollout.

. Open {Product} interface and navigate to the entity you configured.

. Select the *CD* tab and then select the *GitOps application*. The side panel opens.

. In the *Resources* table of the side panel, verify that the following resources are displayed:

* Rollouts

* AnalysisRuns (optional)

. Expand a rollout resource and review the following details:

* The Revisions row displays traffic distribution details for different rollout versions.

* The Analysis Runs row displays the status of analysis tasks that evaluate rollout success.


[role="_additional-resources"]
.Additional resources

* 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}_.
* The package path, scope, and name of the {company-name} ArgoCD plugin has changed since 1.2. For more information, see link:{release-notes-book-url}#removed-functionality-rhidp-4293[Breaking Changes] in the _{release-notes-book-title}_.

* For more information on installing dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ image::rhdh-plugins-reference/deployment_summary.png[Deployment summary]
[role="_additional-resources"]
.Additional resources

* For more information on installing dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ image::rhdh-plugins-reference/deployment_summary.png[Deployment summary]
[role="_additional-resources"]
.Additional resources

* For more information on installing dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
Loading