Skip to content

Commit e503f2c

Browse files
committed
match latest v25.2.1-rc6 docs
1 parent a4d3976 commit e503f2c

File tree

4 files changed

+63
-8
lines changed

4 files changed

+63
-8
lines changed

modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,34 @@ operation is required to create a single ACL.
1414

1515
== Examples
1616

17-
Allow all permissions to user bar on topic `foo` and group `g`:
17+
Allow all permissions to user bar on topic "foo" and group "g":
1818

1919
```bash
2020
rpk security acl create --allow-principal bar --operation all --topic foo --group g
2121
```
2222

23+
Allow all permissions to role bar on topic "foo" and group "g":
24+
25+
```bash
26+
rpk security acl create --allow-role bar --operation all --topic foo --group g
27+
```
28+
2329
Allow read permissions to all users on topics biz and baz:
2430

2531
```bash
26-
rpk security acl create --allow-principal * --operation read --topic biz,baz
32+
rpk security acl create --allow-principal '*' --operation read --topic biz,baz
2733
```
2834

29-
Allow write permissions to user buzz to transactional ID `txn`:
35+
Allow write permissions to user buzz to transactional ID "txn":
3036

3137
```bash
3238
rpk security acl create --allow-principal User:buzz --operation write --transactional-id txn
3339
```
3440

35-
Allow all permissions to role bar on topic "foo" and group "g":
41+
Allow read permissions to user panda on topic "bar" and schema registry subject "bar-value":
3642

3743
```bash
38-
--allow-role bar --operation all --topic foo --group g
44+
rpk security acl create --allow-principal panda --operation read --topic bar --registry-subject bar-value
3945
```
4046

4147
== Usage
@@ -75,6 +81,10 @@ be denied (repeatable).
7581

7682
|--operation |strings |Operation to grant (repeatable).
7783

84+
|--registry-global |- |Whether to grant ACLs for the schema registry.
85+
86+
|--registry-subject |strings |Schema Registry subjects to grant ACLs for (repeatable).
87+
7888
|--resource-pattern-type |string |Pattern to use when matching resource
7989
names (literal or prefixed) (default "literal").
8090

modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,10 @@ rpk security acl delete [flags]
8888
|-f, --print-filters |- |Print the filters that were requested (failed
8989
filters are always printed).
9090

91+
|--registry-global |- |Whether to remove ACLs for the schema registry.
92+
93+
|--registry-subject |strings |Schema Registry subjects to remove ACLs for (repeatable).
94+
9195
|--resource-pattern-type |string |Pattern to use when matching resource
9296
names (any, match, literal, or prefixed) (default "any").
9397

modules/reference/pages/rpk/rpk-security/rpk-security-acl-list.adoc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,41 @@ resource names:
2222
* "prefix" returns prefix patterns that match your input (prefix "fo" matches "foo")
2323
* "literal" returns exact name matches
2424
25+
26+
The list command lists ACLs for both Kafka and Schema Registry. To limit the results to a specific subsystem, use the `--subsystem` flag with either `kafka` or `registry`.
27+
28+
== Examples
29+
30+
List all ACLs:
31+
32+
```bash
33+
rpk security acl list
34+
```
35+
36+
List all Schema Registry ACLs:
37+
38+
```bash
39+
rpk security acl list --subsystem registry
40+
```
41+
42+
List all ACLs for topic "foo":
43+
44+
```bash
45+
rpk security acl list --topic foo
46+
```
47+
48+
List all ACLs for user "bar" on topic "foo":
49+
50+
```bash
51+
rpk security acl list --allow-principal bar --topic foo
52+
```
53+
54+
List all ACLs for role "admin" on schema registry subject "foo-value":
55+
56+
```bash
57+
rpk security acl list --allow-role admin --registry-subject foo-value
58+
```
59+
2560
== Usage
2661

2762
[,bash]
@@ -68,9 +103,15 @@ list, ls, describe
68103
|-f, --print-filters |- |Print the filters that were requested (failed
69104
filters are always printed).
70105

106+
|--registry-global |- |Whether to grant ACLs for the schema registry.
107+
108+
|--registry-subject |strings |Schema Registry subjects to grant ACLs for (repeatable).
109+
71110
|--resource-pattern-type |string |Pattern to use when matching resource
72111
names (any, match, literal, or prefixed) (default "any").
73112

113+
|--subsystem |strings |Subsystem to match ACLs for. Possible values: `kafka`, `registry`, `kafka,registry` (both). Default: `kafka,registry`.
114+
74115
|--topic |strings |Topic to match ACLs for (repeatable).
75116

76117
|--transactional-id |strings |Transactional IDs to match ACLs for

modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ When you create a role, you must bind or associate ACLs to it before it can be u
6060

6161
== Resources
6262

63-
A resource is what an ACL allows or denies access to. There are four resources
64-
within Redpanda: topics, groups, the cluster itself, and transactional IDs.
63+
A resource is what an ACL allows or denies access to. There are six resources
64+
within Redpanda: topics, groups, the cluster itself, transactional IDs, schema registry, and schema registry subjects.
6565
Names for each of these resources can be specified with their respective flags.
6666

6767
Resources combine with the operation that is allowed or denied on that
@@ -88,7 +88,7 @@ Redpanda has the following operations:
8888
|`all` |Allows all operations below.
8989
|`read` |Allows reading a given resource.
9090
|`write` |Allows writing to a given resource.
91-
|`create` |Allows creating a given resource.
91+
|`create` |Allows creating a given resource (Except for Redpanda Schema Registry).
9292
|`delete` |Allows deleting a given resource.
9393
|`alter` |Allows altering non-configurations.
9494
|`describe` |Allows querying non-configurations.

0 commit comments

Comments
 (0)