Skip to content

Commit 67c22b5

Browse files
authored
Implemented QE Review feedback for Getting Started Kafka README.adoc (#430)
* Implemented QE Review feedback for Getting Started Kafka README.adoc * Amended link in additional resources and corrected error in step 4 of 'setting permissions for a service account'. * updated attributes. * updated attributes
1 parent 43f26fa commit 67c22b5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ IMPORTANT: The generated credentials are displayed only one time, so ensure that
180180
NOTE: SASL/PLAIN authentication is also available for tools and libraries that don't support SASL/OAUTHBEARER, but SASL/OAUTHBEARER is recommended whenever possible. With SASL/PLAIN authentication, you use only the service account credentials to authenticate the connection to the Kafka instance.
181181

182182
+
183-
You'll use the service account information that you saved to configure your application to connect to your Kafka instances when you're ready. For example, if you plan to use https://github.com/edenhill/kafkacat[Kafkacat^] to interact with your Kafka instance, you'll use this information to set your bootstrap server and client environment variables.
183+
You'll use the service account information that you saved to configure your application to connect to your Kafka instances when you're ready.
184184
. To review your service account information, reset your credentials, or delete the service account, use the left navigation menu to go to the *Service Accounts* page.
185185

186186
.Verification
@@ -207,7 +207,7 @@ After you create a service account to connect to a Kafka instance, you must also
207207
. In the *Kafka Instances* page of the web console, click the name of the Kafka instance that you want the service account to access.
208208
. Click the *Access* tab to view the current ACL for this instance.
209209
. Click *Manage access*, use the *Account* drop-down menu to select the service account that you previously created, and click *Next*.
210-
. Under *Assign Permissions*, use the drop-down menu to select the *Consume from a topic* and the *Produce to a topic* permission options, and set all resource identifiers and values to `Is *`.
210+
. Under *Assign Permissions*, use the drop-down menu to select the *Consume from a topic* and the *Produce to a topic* permission options, and set all resource identifiers to `Is` and all identifier values to `*`.
211211
+
212212
--
213213
These permissions enable applications associated with the service account to create and delete topics in the Kafka instance, to produce and consume messages in any topic in the instance, and to use any consumer group and any producer.
@@ -244,7 +244,7 @@ h|Operation
244244
|`Write`, `Create`, `Describe`
245245
|===
246246

247-
NOTE: Alternatively, you can click *Add permission* to individually create one `Topic` entry and one `Consumer group` entry, both with `Allow` access to `All` operations. This enables both consuming and producing for the topic in a single entry, and enables all permissions for the consumer group in a single entry. But you must configure these entries individually without using the predefined permission options.
247+
NOTE: Alternatively, you can click *Add permission* to create individual permissions as needed. For example, you can create one `Topic` entry and one `Consumer group` entry, both with `Allow` access to `All` operations. This enables both consuming and producing for the specified topic in a single entry, and enables all permissions for the consumer group in another single entry. But you must configure these entries individually without using the predefined permission options.
248248

249249
--
250250
. After you add these permissions for the service account, click *Save* to finish.
@@ -303,7 +303,7 @@ endif::[]
303303

304304
[role="_additional-resources"]
305305
== Additional resources
306-
* https://kafka.apache.org/081/documentation.html#configuration[Configuration^] in Kafka
306+
* https://access.redhat.com/documentation/en-us/red_hat_openshift_streams_for_apache_kafka/1/guide/7d28aec8-e146-44db-a4a5-fafc1f426ca5[_Configuring topics in {product-long-kafka}_^]
307307
* {base-url}{rhoas-cli-getting-started-url-kafka}[_Getting started with the `rhoas` CLI for {product-long-kafka}_^]
308308
* {rhoas-cli-base-url}{rhoas-cli-ref-url}[_CLI command reference (rhoas)_^]
309309
* {base-url}{kafkacat-url-kafka}[_Configuring and connecting Kafkacat with {product-long-kafka}_^]

0 commit comments

Comments
 (0)