fix(ocm): update ocm frontend plugin readme (#1611)

janus-idp · May 6, 2024 · 9960cc0 · 9960cc0
1 parent e73b7bc
commit 9960cc0
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/plugins/ocm-backend/src/helpers/parser.ts b/plugins/ocm-backend/src/helpers/parser.ts
@@ -85,7 +85,7 @@ export const parseUpdateInfo = (clusterInfo: ManagedClusterInfo) => {
       available: true,
       version,
       url: versionAvailableUpdates[availableUpdates.indexOf(version as string)]
-        .url,
+        ?.url,
     },
   };
 };

diff --git a/plugins/ocm/README.md b/plugins/ocm/README.md
@@ -31,7 +31,7 @@ If you are interested in Resource discovery and do not want any of the front-end
 
 #### Prerequisites
 
-- OCM is deployed and configured on a Kubernetes cluster.
+- OCM is [deployed and configured](https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/install/installing#doc-wrapper) on a Kubernetes cluster.
 - [Kubernetes plugin for Backstage](https://backstage.io/docs/features/kubernetes) is installed and configured (Optional)
 - On the target Hub clusters please create a `ServiceAccount` and grant it the following `ClusterRole`:
 
@@ -419,6 +419,12 @@ The OCM plugin integrates your Backstage instance with multi-cluster engines and
 
 - Your Backstage application is installed and running.
 - You have installed the OCM plugin. For the installation process, see [Installation](#installation).
+- If RBAC permission framework is enabled, ensure adding the following permission policies in an external permission policies configuration file named `rbac-policy.csv` to allow the rbac admins or your desired user(s)/group(s) to access the ocm backend plugin:
+
+```csv rbac-policy.csv
+p, role:default/rbac_admin, ocm.entity.read, read, allow
+p, role:default/rbac_admin, ocm.cluster.read, read, allow
+```
 
 #### Procedure
 

diff --git a/plugins/rbac-backend/docs/permissions.md b/plugins/rbac-backend/docs/permissions.md
@@ -59,3 +59,10 @@ When defining a permission for the RBAC Backend plugin to consume, follow these
 | scaffolder.action.execute          | scaffolder-action   |        | Allows the execution of an action from a template | scaffolder.template.parameter.read, scaffolder.template.step.read |
 | scaffolder.template.parameter.read | scaffolder-template | read   | Allows the user to read parameters of a template  | scaffolder.template.step.read                                     |
 | scaffolder.template.step.read      | scaffolder-template | read   | Allows the user to read steps of a template       | scaffolder.template.paramater.read                                |
+
+## OCM
+
+| Name             | Resource Type | Policy | Description                                                       | Requirements |
+| ---------------- | ------------- | ------ | ----------------------------------------------------------------- | ------------ |
+| ocm.entity.read  |               | read   | Allows the user to read from the ocm plugin                       | X            |
+| ocm.cluster.read |               | read   | Allows the user to read the cluster information in the ocm plugin | X            |
-Original file line number
+Diff line change
@@ Expand Up @@
           available: true,
           version,
           url: versionAvailableUpdates[availableUpdates.indexOf(version as string)]
-            .url,
+            ?.url,
         },
       };
     };
@@ Expand Down @@