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

Introduce pluginsWithPermission information #2213

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions workspaces/rbac/.changeset/orange-kings-invite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@backstage-community/plugin-rbac-backend': patch
'@backstage-community/plugin-rbac': patch
---

Update documentation information about `pluginsWithPermission` setting. In order for the RBAC UI to display available permissions provided by installed plugins, this setting needs to be configured.
25 changes: 24 additions & 1 deletion workspaces/rbac/plugins/rbac-backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,29 @@ permission:

For more information on the available API endpoints accessible to the policy administrators, refer to the [API documentation](./docs/apis.md).

### Configure plugins with permission

In order for the RBAC UI to display available permissions provided by installed plugins, add the corresponding
plugin IDs to the `app-config.yaml`.

You can specify the plugins with permission in your application configuration as follows:

```YAML
permission:
enabled: true
rbac:
pluginsWithPermission:
- catalog
- scaffolder
- permission
admin:
users:
- name: user:default/alice
- name: group:default/admins
```

For more information on the available permissions, refer to the [RBAC permissions documentation](./docs/permissions.md).

### Configuring policies via file

The RBAC plugin also allows you to import policies from an external file. These policies are defined in the [Casbin rules format](https://casbin.org/docs/category/the-basics), known for its simplicity and clarity. For a quick start, please refer to the format details in the provided link.
Expand Down Expand Up @@ -125,7 +148,7 @@ permission:
policyFileReload: true
```

For more information on the available permissions within Showcase and RHDH, refer to the [permissions documentation](./docs/permissions.md).
For more information on the available permissions, refer to the [RBAC permissions documentation](./docs/permissions.md).

We also have a fairly strict validation for permission policies and roles based on the originating role's source information, refer to the [api documentation](./docs/apis.md).

Expand Down
23 changes: 23 additions & 0 deletions workspaces/rbac/plugins/rbac/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,26 @@ permission:
```

- Integrate the [`SignIn`](https://backstage.io/docs/auth/#sign-in-configuration) component to be able to sign-in to the Backstage instance.

### Configure plugins with permission

In order for the RBAC UI to display available permissions provided by installed plugins, add the corresponding
plugin IDs to the `app-config.yaml`.

You can specify the plugins with permission in your application configuration as follows:

```YAML
permission:
enabled: true
rbac:
admin:
users:
- name: user:default/alice
- name: group:default/admins
pluginsWithPermission:
- catalog
- scaffolder
- permission
```

For more information on the available permissions, refer to the [RBAC permissions documentation](../rbac-backend/docs/permissions.md).
Loading