diff --git a/workspaces/rbac/.changeset/orange-kings-invite.md b/workspaces/rbac/.changeset/orange-kings-invite.md new file mode 100644 index 0000000000..edade7a5c5 --- /dev/null +++ b/workspaces/rbac/.changeset/orange-kings-invite.md @@ -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. diff --git a/workspaces/rbac/plugins/rbac-backend/README.md b/workspaces/rbac/plugins/rbac-backend/README.md index a744c4b0e9..967b1c67bd 100644 --- a/workspaces/rbac/plugins/rbac-backend/README.md +++ b/workspaces/rbac/plugins/rbac-backend/README.md @@ -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. @@ -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). diff --git a/workspaces/rbac/plugins/rbac/README.md b/workspaces/rbac/plugins/rbac/README.md index 90dac8ca88..a554e355dd 100644 --- a/workspaces/rbac/plugins/rbac/README.md +++ b/workspaces/rbac/plugins/rbac/README.md @@ -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).