Skip to content

Commit d7fda37

Browse files
committed
docs: add examples
1 parent 4aece75 commit d7fda37

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

pkg/localize/locales/en/cmd/acl.en.toml

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ By default, every users and service account have limited access to their Kafka i
1010
[kafka.acl.cmd.example]
1111
one = '''
1212
# Grant access to principal for consuming messages from all topics
13-
$ rhoas kafka acl grant-permissions --consumer --user user_name --topic "*" --group "*"
13+
$ rhoas kafka acl grant-permissions --consumer --user user_name --topic all --group all
1414
1515
# Grant access to principal for producing messages to all topics
16-
$ rhoas kafka acl grant-permissions --producer --user user_name --topic "*"
16+
$ rhoas kafka acl grant-permissions --producer --user user_name --topic all
1717
1818
# List ACL rules for a Kafka instance
1919
$ rhoas kafka acl list
@@ -44,10 +44,13 @@ one = 'This command creates ACL rules that grant the specified user access to pr
4444
[kafka.acl.grantPermissions.cmd.example]
4545
one = '''
4646
# Grant access to principal for consuming messages from all topics
47-
$ rhoas kafka acl grant-permissions --consumer --user user_name --topic "*" --group "*"
47+
$ rhoas kafka acl grant-permissions --consumer --user user_name --topic all --group all
48+
49+
# Grant access to principal for consuming messages from all topics in a specified instance
50+
$ rhoas kafka acl grant-permissions --consumer --user user_name --topic all --group all --instance-id c5hv7iru4an1g84pogp0
4851
4952
# Grant access to principal for producing messages to all topics
50-
$ rhoas kafka acl grant-permissions --producer --user user_name --topic "*"
53+
$ rhoas kafka acl grant-permissions --producer --user user_name --topic all
5154
5255
# Grant access to principal for consuming messages from topics starting with "abc"
5356
$ rhoas kafka acl grant-permissions --consumer --user user_name --topic-prefix "abc" --group my-group
@@ -56,13 +59,13 @@ $ rhoas kafka acl grant-permissions --consumer --user user_name --topic-prefix "
5659
$ rhoas kafka acl grant-permissions --producer --user user_name --topic-prefix "abc"
5760
5861
# Grant access to all users for consuming messages from topic "my-topic"
59-
$ rhoas kafka acl grant-permissions --consumer --user "*" --topic my-topic --group my-group
62+
$ rhoas kafka acl grant-permissions --consumer --user all --topic my-topic --group my-group
6063
6164
# Grant access to all users for producing messages to topic "my-topic"
62-
$ rhoas kafka acl grant-permissions --producer --user "*" --topic my-topic
65+
$ rhoas kafka acl grant-permissions --producer --user all --topic my-topic
6366
6467
# Grant access to principal for produce and consume messages from all topics
65-
$ rhoas kafka acl grant-permissions --producer --consumer --user user_name --topic "*" --group "*"
68+
$ rhoas kafka acl grant-permissions --producer --consumer --user user_name --topic all --group all
6669
'''
6770

6871
[kafka.acl.grantPermissions.error.bothPrincipalsSelected]
@@ -115,8 +118,11 @@ The instances are displayed by default in a table, but can also be displayed as
115118

116119
[kafka.acl.list.cmd.example]
117120
one = '''
118-
# Display Kafka ACL rules for the instance
121+
# Display Kafka ACL rules for the Kafka instance
119122
$ rhoas kafka acl list
123+
124+
# Display Kafka ACL rules for a specific Kafka instance
125+
$ rhoas kafka acl list --instance-id c5hv7iru4an1g84pogp0
120126
'''
121127

122128

0 commit comments

Comments
 (0)