From 63f8e4f65763cb1d89d470198de1eeabd8de8d84 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Thu, 27 Mar 2025 18:29:06 +0530 Subject: [PATCH 1/4] Added a callout --- .../adoption-insights/proc-install-adoption-insights.adoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/modules/observe/adoption-insights/proc-install-adoption-insights.adoc b/modules/observe/adoption-insights/proc-install-adoption-insights.adoc index b53acc5a57..b96c759f2b 100644 --- a/modules/observe/adoption-insights/proc-install-adoption-insights.adoc +++ b/modules/observe/adoption-insights/proc-install-adoption-insights.adoc @@ -14,7 +14,7 @@ For the {product} Adoption Insights plugin, you must manually install the plugin + [source,yaml] ---- -- package: oci://quay.io/__/adoption-insights:latest!red-hat-developer-hub-backstage-plugin-adoption-insights +- package: oci://quay.io/__/adoption-insights:latest!red-hat-developer-hub-backstage-plugin-adoption-insights # <1> disabled: false pluginConfig: dynamicPlugins: @@ -45,4 +45,5 @@ For the {product} Adoption Insights plugin, you must manually install the plugin red-hat-developer-hub.backstage-plugin-analytics-module-adoption-insights: apiFactories: - importName: AdoptionInsightsAnalyticsApiFactory ----- \ No newline at end of file +---- +<1> Replace the __ variable with the {product} plugins repository in which the image you want to use is present. \ No newline at end of file From 6981b3022cdb2aa280c2ecacfec3842dba7cd232 Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Tue, 1 Apr 2025 19:28:27 +0530 Subject: [PATCH 2/4] Minor changes --- .../proc-install-adoption-insights.adoc | 22 +++++++++++++------ 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/modules/observe/adoption-insights/proc-install-adoption-insights.adoc b/modules/observe/adoption-insights/proc-install-adoption-insights.adoc index b96c759f2b..30ba8e608f 100644 --- a/modules/observe/adoption-insights/proc-install-adoption-insights.adoc +++ b/modules/observe/adoption-insights/proc-install-adoption-insights.adoc @@ -10,11 +10,13 @@ For the {product} Adoption Insights plugin, you must manually install the plugin .Procedure -* To enable the Adoption Insights plugin, set the `disabled` property to `false` in your `app-config-dynamic.yaml` file as shown in the following example: +To enable the Adoption Insights plugin, complete the following steps: + +* Set the `disabled` property to `false` in your `app-config-dynamic.yaml` file as shown in the following example: + [source,yaml] ---- -- package: oci://quay.io/__/adoption-insights:latest!red-hat-developer-hub-backstage-plugin-adoption-insights # <1> +- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-adoption-insights:bs_1.35.1__0.0.2!red-hat-developer-hub-backstage-plugin-adoption-insights disabled: false pluginConfig: dynamicPlugins: @@ -33,11 +35,9 @@ For the {product} Adoption Insights plugin, you must manually install the plugin adoption-insights: parent: admin icon: adoptionInsightsIcon - -- package: oci://quay.io/__/adoption-insights:latest!red-hat-developer-hub-backstage-plugin-adoption-insights-backend-dynamic +- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-adoption-insights-backend:bs_1.35.1__0.0.2!red-hat-developer-hub-backstage-plugin-adoption-insights-backend-dynamic disabled: false - -- package: oci://quay.io/__/adoption-insights:latest!red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights +- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights:bs_1.35.1__0.0.2!red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights disabled: false pluginConfig: dynamicPlugins: @@ -46,4 +46,12 @@ For the {product} Adoption Insights plugin, you must manually install the plugin apiFactories: - importName: AdoptionInsightsAnalyticsApiFactory ---- -<1> Replace the __ variable with the {product} plugins repository in which the image you want to use is present. \ No newline at end of file + +* For non-admin users, add the following permission policies in your permission policies configuration file `rbac-policy.csv`. ++ +[source,yaml] +---- +p, role:default/team_a, adoption-insights.events.read, read, allow +g, user:default/__, role:default/team_a # <1> +---- +<1> Replace __ with the name of the non-admin user. \ No newline at end of file From 9b346db6bbe8a6f66f6d3cae852f057559453aec Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Tue, 1 Apr 2025 19:47:14 +0530 Subject: [PATCH 3/4] Minor change on RBAC --- .../adoption-insights/proc-install-adoption-insights.adoc | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/modules/observe/adoption-insights/proc-install-adoption-insights.adoc b/modules/observe/adoption-insights/proc-install-adoption-insights.adoc index 30ba8e608f..666f4d8998 100644 --- a/modules/observe/adoption-insights/proc-install-adoption-insights.adoc +++ b/modules/observe/adoption-insights/proc-install-adoption-insights.adoc @@ -47,11 +47,12 @@ To enable the Adoption Insights plugin, complete the following steps: - importName: AdoptionInsightsAnalyticsApiFactory ---- -* For non-admin users, add the following permission policies in your permission policies configuration file `rbac-policy.csv`. +* Configure the required RBAC permission for the users who are not administrators as showin the following example: + [source,yaml] ---- p, role:default/team_a, adoption-insights.events.read, read, allow -g, user:default/__, role:default/team_a # <1> +g, user:default/__, role:default/team_a ---- -<1> Replace __ with the name of the non-admin user. \ No newline at end of file ++ + See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. \ No newline at end of file From 1c51e6d552b9779441db8bcbc41925ac100e23ff Mon Sep 17 00:00:00 2001 From: Priyanka Abel Date: Tue, 1 Apr 2025 20:39:22 +0530 Subject: [PATCH 4/4] Lindsey's comments --- .../adoption-insights/proc-install-adoption-insights.adoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/modules/observe/adoption-insights/proc-install-adoption-insights.adoc b/modules/observe/adoption-insights/proc-install-adoption-insights.adoc index 666f4d8998..f9a7c4a60c 100644 --- a/modules/observe/adoption-insights/proc-install-adoption-insights.adoc +++ b/modules/observe/adoption-insights/proc-install-adoption-insights.adoc @@ -12,7 +12,7 @@ For the {product} Adoption Insights plugin, you must manually install the plugin To enable the Adoption Insights plugin, complete the following steps: -* Set the `disabled` property to `false` in your `app-config-dynamic.yaml` file as shown in the following example: +. Set the `disabled` property to `false` in your `app-config-dynamic.yaml` file as shown in the following example: + [source,yaml] ---- @@ -47,12 +47,11 @@ To enable the Adoption Insights plugin, complete the following steps: - importName: AdoptionInsightsAnalyticsApiFactory ---- -* Configure the required RBAC permission for the users who are not administrators as showin the following example: +. Configure the required RBAC permission for the users who are not administrators as shown in the following example: + [source,yaml] ---- p, role:default/team_a, adoption-insights.events.read, read, allow g, user:default/__, role:default/team_a ---- -+ - See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. \ No newline at end of file +See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in {product}].