Skip to content

Commit 6f71631

Browse files
docs: add CONNECTOR resource type for granular connector-level permissions
- Add CONNECTOR to supported resource types - Document connector actions and value format (connectName/connectorName) - Add examples for specific connector and wildcard permissions - Remove outdated "connectors selector not implemented yet" comment
1 parent e36f381 commit 6f71631

File tree

1 file changed

+13
-7
lines changed
  • configuration/rbac-role-based-access-control

1 file changed

+13
-7
lines changed

configuration/rbac-role-based-access-control/README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Find the more detailed examples in a full example file lower.
9999

100100
The next thing which is present in your roles file is, surprisingly, permissions. They consist of:
101101

102-
1. Resource Can be one of the: `CLUSTERCONFIG`, `TOPIC`, `CONSUMER`, `SCHEMA`, `CONNECT`, `KSQL`, `ACL`.
102+
1. Resource Can be one of the: `CLUSTERCONFIG`, `TOPIC`, `CONSUMER`, `SCHEMA`, `CONNECT`, `CONNECTOR`, `KSQL`, `ACL`.
103103
2. The resource value is either a fixed string or a regular expression identifying a resource. Value is not applicable to `clusterconfig` and `ksql` resources. Please do not fill it out.
104104
3. Actions It's a list of actions (the possible values depend on the resource, see the lists below) that will be applied to the certain permission. Also, note, there's a special action for any of the resources called "all", it will virtually grant all the actions within the corresponding resource. An example for enabling viewing and creating topics whose name start with "derp":
105105

@@ -119,7 +119,8 @@ A list of all the actions for the corresponding resources (please note neither r
119119
* `topic`: `view`, `create`, `edit`, `delete`, `messages_read`, `messages_produce`, `messages_delete`, `analysis_run`, `analysis_view`
120120
* `consumer`: `view`, `delete`, `reset_offsets`
121121
* `schema`: `view`, `create`, `delete`, `edit`, `modify_global_compatibility`
122-
* `connect`: `view`, `edit`, `create`, `delete`,`operate`, `reset_offsets`
122+
* `connect`: `view`, `edit`, `create`, `delete`, `operate`, `reset_offsets` — applies to all connectors in a connect cluster
123+
* `connector`: `view`, `edit`, `create`, `delete`, `operate`, `reset_offsets` — granular per-connector permissions (value format: `connectName/connectorName`)
123124
* `ksql`: `execute`
124125
* `acl`: `view`, `edit`
125126
* `audit`: `view`
@@ -215,11 +216,16 @@ rbac:
215216
- resource: connect
216217
value: "local"
217218
actions: [ view, edit, create, delete, operate, reset_offsets ]
218-
# connectors selector not implemented yet, use connects
219-
# selector:
220-
# connector:
221-
# name: ".*"
222-
# class: 'io.kafbat.connectorName'
219+
220+
# Granular connector-level permissions (value format: connectName/connectorName)
221+
- resource: connector
222+
value: "local/my-specific-connector"
223+
actions: [ view, edit, operate ]
224+
225+
# Wildcard for all connectors in a connect cluster
226+
- resource: connector
227+
value: "local/prod-.*"
228+
actions: [ view ]
223229
224230
- resource: ksql
225231
# value not applicable for ksql

0 commit comments

Comments
 (0)