Skip to content

Commit 4c81fe3

Browse files
docs: Update credential info in guides (#549)
* docs: replace real creds * docs: update two more occurrences of real creds
1 parent 9bc8ec7 commit 4c81fe3

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

docs/kafka/rhoas-cli-getting-started-kafka/README.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -191,11 +191,11 @@ view the `credentials.json` file that you created.
191191
+
192192
--
193193
.Example `credentials.json` file
194-
[source,json,subs="+attributes"]
194+
[source,json,subs="+attributes,+quotes"]
195195
----
196196
{
197-
"clientID":"srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1",
198-
"clientSecret":"facf3df1-ab97-2253-aa87-ab97",
197+
"clientID":"_<client-id>_",
198+
"clientSecret":"_<client-secret>_",
199199
"oauthTokenUrl": "{sso-token-url}"
200200
}
201201
----
@@ -205,13 +205,13 @@ You use these credentials and the bootstrap server URL to connect your applicati
205205
. Set the permissions for your service account to access the Kafka instance resources.
206206
+
207207
--
208-
This example allows applications to produce and consume messages from topics starting with a specified prefix that belong to any consumer group. The service account information you input here is the 'clientID' from the previous step.
208+
This example allows applications to produce and consume messages from topics starting with a specified prefix that belong to any consumer group. The service account information you input here is the `clientID` value from the previous step.
209209

210210
.Assigning access permissions to a service account
211-
[source,shell]
211+
[source,shell,subs="+quotes"]
212212
----
213213
$ rhoas kafka acl grant-access --consumer --producer \
214-
--service-account srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1 --topic-prefix myapp --group all
214+
--service-account _<client-id>_ --topic-prefix myapp --group all
215215
----
216216

217217
The permissions you assign depend on whether your application produces or consumes messages.

docs/registry/rhoas-cli-getting-started-registry/README.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -195,11 +195,11 @@ view the `credentials.json` file that you created.
195195
+
196196
--
197197
.Example `credentials.json` file
198-
[source,json,subs="+attributes"]
198+
[source,json,subs="+attributes,+quotes"]
199199
----
200200
{
201-
"clientID":"srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1",
202-
"clientSecret":"facf3df1-ab97-2253-aa87-ab97",
201+
"clientID":"_<client-id>_",
202+
"clientSecret":"_<client-secret>_",
203203
"oauthTokenUrl": "{sso-token-url}"
204204
}
205205
----
@@ -217,9 +217,9 @@ By connecting your applications to your {registry} instance, you can retrieve ar
217217
This example creates a role called `manager` for the service account.
218218

219219
.Creating a role for the service account
220-
[source,shell]
220+
[source,shell,subs="+quotes"]
221221
----
222-
$ rhoas service-registry role add --role=manager --service-account=srvc-acct-8c95ca5e1225-94a-41f1-ab97-aacf3df1
222+
$ rhoas service-registry role add --role=manager --service-account=_<client-id>_
223223
----
224224
--
225225

docs/rhoas/rhoas-service-contexts/README.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -292,19 +292,19 @@ $ cp ./producer/.env ./consumer/.env
292292
For a service context with single Kafka and {registry} instances, the `.env` file looks like the following example:
293293
+
294294
.Example environment variables file for connection configuration information
295-
[source,shell,subs="+attributes"]
295+
[source,shell,subs="+attributes,+quotes"]
296296
----
297-
## Generated by rhoas cli
297+
\\## Generated by rhoas cli
298298
## Kafka Configuration
299299
KAFKA_HOST=kafka-inst-cafkr-jma--lhulbl-ca.bf2.kafka.rhcloud.com:443
300-
## Service Registry Configuration
300+
\\## Service Registry Configuration
301301
SERVICE_REGISTRY_URL=https://bu98.serviceregistry.rhcloud.com/t/0aa1dd8b-63d5-466c-9de8-7c03320a81c2
302302
SERVICE_REGISTRY_CORE_PATH=/apis/registry/v2
303303
SERVICE_REGISTRY_COMPAT_PATH=/apis/ccompat/v6
304304
305305
## Authentication Configuration
306-
RHOAS_CLIENT_ID=srvc-acct-14295e3c-f72d-4bae-876c-3172a96eb7eb
307-
RHOAS_CLIENT_SECRET=5c3a20e0-d946-4edf-94d2-35db41f3b2ad
306+
RHOAS_CLIENT_ID=_<client-id>_
307+
RHOAS_CLIENT_SECRET=_<client-secret>_
308308
RHOAS_OAUTH_TOKEN_URL={sso-token-url}
309309
----
310310
+
@@ -313,19 +313,19 @@ As shown in the example, the file that you generate contains the endpoints for y
313313
. Set Access Control List (ACL) permissions to enable the new service account to access resources in the Kafka instance.
314314
+
315315
.Example command for granting access to Kafka instance
316-
[source,shell]
316+
[source,shell,subs="+quotes"]
317317
----
318-
$ rhoas kafka acl grant-access --producer --consumer --service-account srvc-acct-14295e3c-f72d-4bae-876c-3172a96eb7eb --topic quotes --group all
318+
$ rhoas kafka acl grant-access --producer --consumer --service-account _<client-id>_ --topic quotes --group all
319319
----
320320
+
321321
The command you entered allows applications to use the service account to produce and consume messages in the `quotes` topic. Applications can use any consumer group and producer.
322322

323323
. Use Role-Based Access Control (RBAC) to enable the new service account to access the {registry} instance and the artifacts (such as schemas) that it contains.
324324
+
325325
.Example command for granting access to {registry} instance
326-
[source,shell]
326+
[source,shell,subs="+quotes"]
327327
----
328-
$ rhoas service-registry role add --role manager --service-account srvc-acct-14295e3c-f72d-4bae-876c-3172a96eb7eb
328+
$ rhoas service-registry role add --role manager --service-account _<client-id>_
329329
----
330330

331331
. In the guides and samples repository, navigate to the directory for the producer component. Use Apache Maven to run the producer component in developer mode.

0 commit comments

Comments
 (0)