Updated plugin doc for Argo CD Rollouts feature #725

gtrivedi88 · 2024-11-21T08:57:44Z

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

In this PR:

I added content for the Argo CD Rollouts feature

Version(s): RHDH 1.4 and RHTAP 1.3

Issue:
HACDOCS-1157

Output:

rhdh-bot · 2024-11-21T08:59:54Z

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-725/ @ 12/02/24 16:07:17

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

karthikjeeyar

/lgtm

subhashkhileri · 2024-11-25T12:00:09Z

LGTM

openshift-ci · 2024-12-02T16:04:27Z

New changes are detected. LGTM label has been removed.

linfraze

Thanks for the content! A couple suggestions.

linfraze · 2025-01-02T18:35:54Z

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

@@ -70,6 +70,143 @@ global:
        disabled: false
 ----

+== (Optional) Enabling Argo CD Rollouts feature


Suggested change

== (Optional) Enabling Argo CD Rollouts feature

== Enabling Argo CD Rollouts

linfraze · 2025-01-02T18:37:53Z

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

@@ -70,6 +70,143 @@ global:
        disabled: false
 ----

+== (Optional) Enabling Argo CD Rollouts feature
+
+The 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 team to visualize and manage these Rollouts seamlessly within the Backstage interface.


Suggested change

The 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 team to visualize and manage these Rollouts seamlessly within the Backstage interface.

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.

linfraze · 2025-01-02T18:41:22Z

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

+
+.Prerequisites
+
+* *Backstage Kubernetes plugin installed:* Verify that the Kubernetes plugin in Backstage (`@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.


Suggested change

* *Backstage Kubernetes plugin installed:* Verify that the Kubernetes plugin in Backstage (`@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.

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

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

linfraze · 2025-01-02T18:42:13Z

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

+
+* *Backstage Kubernetes plugin installed:* Verify that the Kubernetes plugin in Backstage (`@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.
+
+* *Kubernetes cluster access:* Ensure you have access to the Kubernetes cluster with the necessary permissions to create and manage custom resources and `ClusterRoles`.


Suggested change

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

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

linfraze · 2025-01-02T18:42:47Z

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

+
+* *Kubernetes cluster access:* Ensure you have access to the Kubernetes cluster with the necessary permissions to create and manage custom resources and `ClusterRoles`.
+
+* *Argo Rollouts resources:* Confirm that the Kubernetes cluster has the `argoproj.io` group resources (for example, Rollouts and AnalysisRuns) installed.


Suggested change

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

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

linfraze · 2025-01-02T18:45:53Z

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

+. Update `app-config.yaml` for custom resources.
+
+.. Open 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'
+----


Suggested change

. Update `app-config.yaml` for custom resources.

.. Open 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'

----

. 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'

----

linfraze · 2025-01-02T18:49:19Z

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

+
+. Grant `ClusterRole` permissions for custom resources.
+
+.. Verify whether the Backstage Kubernetes plugin is already configured. If it is, the `ClusterRole` for Rollouts and AnalysisRuns might already be granted.


Suggested change

.. Verify whether the Backstage Kubernetes plugin is already configured. If it is, the `ClusterRole` for Rollouts and AnalysisRuns might already be granted.

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

linfraze · 2025-01-02T18:53:15Z

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

+Use a link:https://raw.githubusercontent.com/backstage/community-plugins/main/workspaces/redhat-argocd/plugins/argocd/manifests/clusterrole.yaml[prepared manifest] for a read-only `ClusterRole` that provides access for both the Kubernetes plugin and the ArgoCD plugin.
+====
+
+.. If not already granted, use the following YAML manifest to create the ClusterRole:


Suggested change

.. If not already granted, use the following YAML manifest to create the ClusterRole:

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

should the second instance of ClusterRole also be formatted as ClusterRole?

linfraze · 2025-01-02T18:56:44Z

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

+  backstage.io/kubernetes-namespace: <RESOURCE_NAMESPACE>
+----
+
+.. For using custom label selectors (takes precedence over the above annotations):


Technical documentation generally strives to avoid the use of "pointing language", such as "above." Consider replacing "above annotations" with the actual annotations you are referring to. This also prevents users from having to scroll back up to see what you are referencing "above".

linfraze · 2025-01-02T19:01:29Z

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

+. Confirm that:
+
+** Kubernetes resources, such as Rollouts and AnalysisRuns, are visible under the *Kubernetes* tab.
+
+** The Argo CD Rollouts feature is functioning as expected, allowing you to monitor rollouts status and manage deployments.
+


Suggested change

. Confirm that:

** Kubernetes resources, such as Rollouts and AnalysisRuns, are visible under the *Kubernetes* tab.

** The Argo CD Rollouts feature is functioning as expected, allowing you to monitor rollouts status and manage deployments.

. Confirm that the Argo CD Rollouts feature is functioning as expected by performing the following checks:

** Kubernetes resources, such as Rollouts and AnalysisRuns, are visible under the *Kubernetes* tab.

** You are able to effectively monitor rollouts status and manage deployments.

gtrivedi88 temporarily deployed to external November 21, 2024 08:57 — with GitHub Actions Inactive

karthikjeeyar reviewed Nov 22, 2024

View reviewed changes

artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc Outdated Show resolved Hide resolved

artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc Outdated Show resolved Hide resolved

gtrivedi88 force-pushed the HACDOCS-1157 branch from c15cf57 to 4bddf6e Compare November 22, 2024 05:16

gtrivedi88 temporarily deployed to external November 22, 2024 05:16 — with GitHub Actions Inactive

gtrivedi88 force-pushed the HACDOCS-1157 branch from 4bddf6e to 47bfe03 Compare November 22, 2024 05:56

gtrivedi88 temporarily deployed to external November 22, 2024 05:57 — with GitHub Actions Inactive

Updated plugin doc for Argo CD rollout feature

3d5f93b

gtrivedi88 force-pushed the HACDOCS-1157 branch from 47bfe03 to 3d5f93b Compare November 22, 2024 05:58

gtrivedi88 temporarily deployed to external November 22, 2024 05:58 — with GitHub Actions Inactive

karthikjeeyar approved these changes Nov 22, 2024

View reviewed changes

openshift-ci bot assigned karthikjeeyar Nov 22, 2024

openshift-ci bot added the lgtm label Nov 22, 2024

themr0c added Peer review needed 📖 SME review done ⛅ QE review needed 🔧 labels Nov 28, 2024

themr0c requested a review from Gerry-Forde November 28, 2024 09:03

Merge branch 'main' into HACDOCS-1157

d468400

openshift-ci bot removed the lgtm label Dec 2, 2024

themr0c temporarily deployed to external December 2, 2024 16:04 — with GitHub Actions Inactive

linfraze reviewed Jan 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated plugin doc for Argo CD Rollouts feature #725

Updated plugin doc for Argo CD Rollouts feature #725

gtrivedi88 commented Nov 21, 2024

rhdh-bot commented Nov 21, 2024 •

edited

Loading

karthikjeeyar left a comment

subhashkhileri commented Nov 25, 2024

openshift-ci bot commented Dec 2, 2024

linfraze left a comment

linfraze Jan 2, 2025

linfraze Jan 2, 2025

linfraze Jan 2, 2025

linfraze Jan 2, 2025

linfraze Jan 2, 2025

linfraze Jan 2, 2025

linfraze Jan 2, 2025

linfraze Jan 2, 2025

linfraze Jan 2, 2025

linfraze Jan 2, 2025

	== (Optional) Enabling Argo CD Rollouts feature
	== Enabling Argo CD Rollouts

	The 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 team to visualize and manage these Rollouts seamlessly within the Backstage interface.
	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

		* Backstage Kubernetes plugin installed: Verify that the Kubernetes plugin in Backstage (`@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.

	* Backstage Kubernetes plugin installed: Verify that the Kubernetes plugin in Backstage (`@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.
	* The Backstage Kubernetes plugin (`@backstage/plugin-kubernetes`) is installed and configured.
	** To install and configure a Kubernetes plugin in Backstage, see the link:https://backstage.io/docs/features/kubernetes/installation/[Installaltion] and link:https://backstage.io/docs/features/kubernetes/configuration/[Configuration] guides.


		* Backstage Kubernetes plugin installed: Verify that the Kubernetes plugin in Backstage (`@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.

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

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


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

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

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


		. Grant `ClusterRole` permissions for custom resources.

		.. Verify whether the Backstage Kubernetes plugin is already configured. If it is, the `ClusterRole` for Rollouts and AnalysisRuns might already be granted.

	.. Verify whether the Backstage Kubernetes plugin is already configured. If it is, the `ClusterRole` for Rollouts and AnalysisRuns might already be granted.
	.. If the Backstage Kubernetes plugin is already configured, the `ClusterRole` permission for Rollouts and AnalysisRuns might already be granted.

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

Updated plugin doc for Argo CD Rollouts feature #725

Are you sure you want to change the base?

Updated plugin doc for Argo CD Rollouts feature #725

Conversation

gtrivedi88 commented Nov 21, 2024

rhdh-bot commented Nov 21, 2024 • edited Loading

karthikjeeyar left a comment

Choose a reason for hiding this comment

subhashkhileri commented Nov 25, 2024

openshift-ci bot commented Dec 2, 2024

linfraze left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rhdh-bot commented Nov 21, 2024 •

edited

Loading