Skip to content

Commit 997d990

Browse files
jbyrne-redhatjbyrne-redhat
authored
docs: replace service account id with replaceable value (#550)
1 parent 5053714 commit 997d990

File tree

2 files changed

+27
-31
lines changed

2 files changed

+27
-31
lines changed

‎docs/kafka/service-binding-kafka/README.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -322,10 +322,10 @@ You are prompted to provide an access token. The RHOAS Operator requires this to
322322
The RHOAS Operator uses the API token to create a `KafkaConnection` object on your OpenShift cluster. When this process is complete, you see output like the following example:
323323
+
324324
.Example output from rhoas cluster connect command
325-
[source,options="nowrap"]
325+
[source,subs="+quotes",options="nowrap"]
326326
----
327327
Service Account Secret "rh-cloud-services-service-account" created successfully
328-
Client ID: srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1
328+
Client ID: _<client_id>_
329329
...
330330
KafkaConnection resource "my-kafka-instance" has been created
331331
Waiting for status from KafkaConnection resource.
@@ -341,22 +341,22 @@ The RHOAS Operator also creates a `KafkaConnection` object for your Kafka instan
341341
. Set Access Control List (ACL) permissions to enable the new service account created by the RHOAS Operator to access resources in your Kafka instance. To set permissions, use the `Client ID` value for the service account.
342342
+
343343
.RHOAS CLI command to set access permissions for service account
344-
[source]
344+
[source,subs="+quotes"]
345345
----
346346
$ rhoas kafka acl grant-access --consumer --producer \
347-
--service-account srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 --topic "*" --group "*"
347+
--service-account _<client_id>_ --topic "\*" --group "*"
348348
349349
The following ACL rules are to be created:
350350
351-
PRINCIPAL (7) PERMISSION DESCRIPTION
352-
----------------------------------------------- ------------------ ---------------------------
353-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | DESCRIBE TOPIC is "*"
354-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | READ TOPIC is "*"
355-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | READ GROUP is "*"
356-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | WRITE TOPIC is "*"
357-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | CREATE TOPIC is "*"
358-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | WRITE TRANSACTIONAL_ID is "*"
359-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | DESCRIBE TRANSACTIONAL_ID is "*"
351+
PRINCIPAL (7) PERMISSION DESCRIPTION
352+
-------------- ---------------- -------------
353+
_<client_id>_ ALLOW | DESCRIBE TOPIC is "\*"
354+
_<client_id>_ ALLOW | READ TOPIC is "*"
355+
_<client_id>_ ALLOW | READ GROUP is "\*"
356+
_<client_id>_ ALLOW | WRITE TOPIC is "*"
357+
_<client_id>_ ALLOW | CREATE TOPIC is "\*"
358+
_<client_id>_ ALLOW | WRITE TRANSACTIONAL_ID is "*"
359+
_<client_id>_ ALLOW | DESCRIBE TRANSACTIONAL_ID is "*"
360360
361361
? Are you sure you want to create the listed ACL rules (y/N) Yes
362362
✔️ ACLs successfully created in the Kafka instance "my-kafka-instance"

‎docs/registry/service-binding-registry/README.adoc

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -359,10 +359,10 @@ Based on the cloud service that you previously selected, the RHOAS Operator uses
359359
The following example shows output for a Kafka instance.
360360
+
361361
.Example output from rhoas cluster connect command
362-
[source,options="nowrap"]
362+
[source,subs="+quotes",options="nowrap"]
363363
----
364364
Service Account Secret "rh-cloud-services-service-account" created successfully
365-
Client ID: srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1
365+
Client ID: _<client_id>_
366366
...
367367
KafkaConnection resource "my-kafka-instance" has been created
368368
Waiting for status from KafkaConnection resource.
@@ -381,27 +381,25 @@ The RHOAS Operator also creates a `KafkaConnection` or `ServiceRegistryConnectio
381381
.Setting Kafka access permissions for the service account
382382
[source,options="nowrap",subs="+quotes"]
383383
----
384-
$ rhoas kafka acl grant-access --consumer --producer --service-account __<my-client-id>__ --topic "\*" --group "*"
384+
$ rhoas kafka acl grant-access --consumer --producer --service-account _<client_id>_ --topic "\*" --group "*"
385385
----
386386
+
387-
In the preceding command, replace __<my-client-id>__ with the `Client ID` value for the new service account. This value was previously shown on the command line.
388-
+
389387
You should see output like the following example:
390388
+
391389
.Example output when setting Kafka access permissions
392-
[source,options="nowrap"]
390+
[source,subs="+quotes",options="nowrap"]
393391
----
394392
The following ACL rules are to be created:
395393
396-
PRINCIPAL (7) PERMISSION DESCRIPTION
397-
----------------------------------------------- ------------------ ---------------------------
398-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | DESCRIBE TOPIC is "*"
399-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | READ TOPIC is "*"
400-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | READ GROUP is "*"
401-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | WRITE TOPIC is "*"
402-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | CREATE TOPIC is "*"
403-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | WRITE TRANSACTIONAL_ID is "*"
404-
srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 ALLOW | DESCRIBE TRANSACTIONAL_ID is "*"
394+
PRINCIPAL (7) PERMISSION DESCRIPTION
395+
-------------- ---------------- -------------
396+
_<client_id>_ ALLOW | DESCRIBE TOPIC is "\*"
397+
_<client_id>_ ALLOW | READ TOPIC is "*"
398+
_<client_id>_ ALLOW | READ GROUP is "\*"
399+
_<client_id>_ ALLOW | WRITE TOPIC is "*"
400+
_<client_id>_ ALLOW | CREATE TOPIC is "\*"
401+
_<client_id>_ ALLOW | WRITE TRANSACTIONAL_ID is "*"
402+
_<client_id>_ ALLOW | DESCRIBE TRANSACTIONAL_ID is "*"
405403
406404
? Are you sure you want to create the listed ACL rules (y/N) Yes
407405
✔️ ACLs successfully created in the Kafka instance "my-kafka-instance"
@@ -414,13 +412,11 @@ In this example, the permissions you create allow applications to use the servic
414412
.Setting {registry} access permissions for the service account
415413
[source,options="nowrap",subs="+quotes"]
416414
----
417-
rhoas service-registry role add --role=manager --service-account __<my-client-id>__
415+
rhoas service-registry role add --role=manager --service-account _<client_id>_
418416
Updating role for principal
419417
Role was successfully applied
420418
----
421419
+
422-
In the preceding command, replace __<my-client-id>__ with the `Client ID` value for the new service account. This value was previously shown on the command line.
423-
+
424420
In this example, the `manager` role that you assign to the service account allows applications to use the service account to view and write to schemas in the {registry} instance.
425421

426422
. Use the OpenShift CLI to verify that the RHOAS Operator successfully created the `KafkaConnection` or `ServiceRegistryConnection` object, as shown in the following example:

0 commit comments

Comments
 (0)