Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(rbac): add more clarification around requirements for old and new backend #2170

Merged
Merged
Changes from all commits
Commits
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
13 changes: 10 additions & 3 deletions plugins/rbac-backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Before you dive into utilizing the RBAC plugin for Backstage, there are a few es

### Setup Permission Framework

**NOTE**: This section is only relevant if you are still on the old backend system.

To effectively utilize the RBAC plugin, you must have the Backstage permission framework in place. If you're using the Red Hat Developer Hub, some of these steps may have already been completed for you. However, for other Backstage application instances, please verify that the following prerequisites are satisfied:

You need to [set up the permission framework in Backstage](https://backstage.io/docs/permissions/getting-started/).Since this plugin provides a dynamic policy that replaces the traditional one, there's no need to create a policy manually. Please note that one of the requirements for permission framework is enabling the [service-to-service authentication](https://backstage.io/docs/auth/service-to-service-auth/#setup). Ensure that you complete these authentication setup steps as well.
Expand Down Expand Up @@ -98,10 +100,15 @@ async function main() {

The RBAC plugin supports the integration with the new backend system.

Add the RBAC plugin to the `packages/backend/src/index.ts` file.
Add the RBAC plugin to the `packages/backend/src/index.ts` file and remove the Permission backend plugin and Allow All Permission policy module.

```ts
backend.add(import('@janus-idp/backstage-plugin-rbac-backend'));
```diff
// permission plugin
- backend.add(import('@backstage/plugin-permission-backend/alpha'));
- backend.add(
- import('@backstage/plugin-permission-backend-module-allow-all-policy'),
- );
+ backend.add(import('@janus-idp/backstage-plugin-rbac-backend'));
```

### Configure policy admins
Expand Down