Skip to content

Commit a5f6da5

Browse files
Docs: Update faulty references to location of Service Accounts page (#564)
* docs: update references to service accounts page * docs: update prereq
1 parent 1f37759 commit a5f6da5

File tree

6 files changed

+16
-18
lines changed

6 files changed

+16
-18
lines changed

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -185,13 +185,13 @@ image::sak-kafka-overview.png[Image of initial empty instances table]
185185
////
186186

187187
[id="proc-creating-service-account_{context}"]
188-
== Creating a service account to connect to a Kafka instance in {product-kafka}
188+
== Creating a service account to connect to a Kafka instance in {product-long-kafka}
189189

190190
[role="_abstract"]
191-
To connect your applications or services to a Kafka instance in the {product-kafka} web console, you need to create a service account that's associated with the instance. You also need to save the bootstrap server endpoint for the instance, the generated service account credentials, and the authentication token endpoint to a secure location. You'll use the service account and Kafka instance information later when you configure your application.
191+
To connect your applications or services to a Kafka instance in {product-long-kafka}, you need to create a service account that's associated with the instance. You also need to save the bootstrap server endpoint for the instance, the generated service account credentials, and the authentication token endpoint to a secure location. You'll use the service account and Kafka instance information later when you configure your application.
192192

193193
.Prerequisites
194-
* You've created a Kafka instance and the instance is in *Ready* state.
194+
* You've created a Kafka instance and the instance is in the *Ready* state.
195195

196196
.Procedure
197197
. In the *Kafka Instances* page of the web console, for the relevant Kafka instance that you want to connect to, select the options icon (three vertical dots) and click *Connection*.
@@ -216,9 +216,7 @@ IMPORTANT: The generated credentials are displayed only one time, so ensure that
216216
+
217217
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.
218218

219-
+
220-
You'll use the service account information that you saved to configure your application to connect to your Kafka instances when you're ready.
221-
. 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.
219+
. To review, reset, or delete the service account, use the {service-accounts-url}[Service Accounts^] page in the *Application Services* section of the Red Hat Hybrid Cloud Console.
222220

223221
.Verification
224222
ifdef::qs[]

docs/kafka/kafka-bin-scripts-kafka/README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ To enable the Kafka scripts to access a Kafka instance, you must configure the c
131131

132132
.Prerequisites
133133
ifndef::qs[]
134-
* You have the generated credentials for your service account. To regenerate the credentials, use the *Service Accounts* page in the {product-kafka} web console to find your service account and update the credentials.
134+
* You have the generated credentials for your service account. To reset the credentials, use the {service-accounts-url}[Service Accounts^] page in the *Application Services* section of the Red Hat Hybrid Cloud Console.
135135
* You've set the permissions for your service account to access the Kafka instance resources. To verify the current permissions, select your Kafka instance in the {product-kafka} web console and use the *Access* page to find your service account permission settings.
136136
endif::[]
137137

docs/kafka/kcat-kafka/README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ NOTE: Kafkacat have been recently renamed to kcat. If you use latest version of
143143
.Prerequisites
144144
ifndef::qs[]
145145
* You have the bootstrap server endpoint for your Kafka instance. To relocate the server endpoint, select your Kafka instance in the {product-kafka} web console, select the options menu (three vertical dots), and click *Connection*.
146-
* You have the generated credentials for your service account. To regenerate the credentials, use the *Service Accounts* page in the {product-kafka} web console to find your service account and update the credentials.
146+
* You have the generated credentials for your service account. To reset the credentials, use the {service-accounts-url}[Service Accounts^] page in the *Application Services* section of the Red Hat Hybrid Cloud Console.
147147
* You've set the permissions for your service account to access the Kafka instance resources. To verify the current permissions, select your Kafka instance in the {product-kafka} web console and use the *Access* page to find your service account permission settings.
148148
endif::[]
149149

docs/kafka/metrics-monitoring-kafka/README.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -157,12 +157,12 @@ Topic metrics::
157157
After you produce and consume messages in your services using methods such as link:https://kafka.apache.org/downloads[Kafka] scripts, link:https://github.com/edenhill/kcat[Kafkacat], or a link:https://quarkus.io/[Quarkus] application, you can return to the Kafka instance in the web console and use the *Dashboard* page to view metrics for the instance and topics. The metrics help you understand the performance and data usage for your Kafka instance and topics.
158158

159159
.Prerequisites
160-
* You have access to a Kafka instance in {product-kafka} that contains topics. For more information about access management in {product-kafka}, see {base-url}{access-mgmt-url-kafka}[_Managing account access in {product-long-kafka}_^].
160+
* You have access to a Kafka instance in {product-kafka} that contains topics. For more information about access management in {product-kafka}, see {base-url}{access-mgmt-url-kafka}[Managing account access in {product-long-kafka}^].
161161

162162
.Procedure
163163
* In the *Kafka Instances* page of the web console, click the name of the Kafka instance and select the *Dashboard* tab.
164164
+
165-
When you create a Kafka instance and add new topics, the *Dashboard* page is initially empty. After you start producing and consuming messages in your services, you can return to this page to view related metrics. For example, to use Kafka scripts to produce and consume messages, see {base-url}{kafka-bin-scripts-url-kafka}[_Configuring and connecting Kafka scripts with {product-long-kafka}_^].
165+
When you create a Kafka instance and add new topics, the *Dashboard* page is initially empty. After you start producing and consuming messages in your services, you can return to this page to view related metrics. For example, to use Kafka scripts to produce and consume messages, see {base-url}{kafka-bin-scripts-url-kafka}[Configuring and connecting Kafka scripts with {product-long-kafka}^].
166166

167167
NOTE: In some cases, after you start producing and consuming messages, you might need to wait several minutes for the latest metrics to appear. You might also need to wait until your instance and topics contain enough data for metrics to appear.
168168

@@ -177,9 +177,9 @@ As an alternative to viewing metrics for a Kafka instance in the {product-kafka}
177177
This procedure follows the https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration-file[Configuration File] method defined by Prometheus for integrating third-party metrics. If you use the Prometheus Operator in your monitoring environment, you can also follow the https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/additional-scrape-config.md#additional-scrape-configuration[Additional Scrape Configuration] method.
178178

179179
.Prerequisites
180-
* You have access to a Kafka instance that contains topics in {product-kafka}. For more information about access management in {product-kafka}, see {base-url}{access-mgmt-url-kafka}[_Managing account access in {product-long-kafka}_^].
180+
* You have access to a Kafka instance that contains topics in {product-kafka}. For more information about access management in {product-kafka}, see {base-url}{access-mgmt-url-kafka}[Managing account access in {product-long-kafka}^].
181181
* You have the ID and the SASL/OAUTHBEARER token endpoint for the Kafka instance. To relocate the Kafka instance ID and the token endpoint, select your Kafka instance in the {product-kafka} web console, select the options menu (three vertical dots), and click *Connection*.
182-
* You have the generated credentials for your service account that has access to the Kafka instance. To regenerate and re-copy the credentials, use the *Service Accounts* page in the {product-kafka} web console to find your service account and update the credentials. For more information about service accounts, see {base-url}{getting-started-url-kafka}#proc-creating-service-account_getting-started[_Getting started with {product-long-kafka}_^].
182+
* You have the generated credentials for your service account that has access to the Kafka instance. To reset the credentials, use the {service-accounts-url}[Service Accounts^] page in the *Application Services* section of the Red Hat Hybrid Cloud Console.
183183
* You've installed a Prometheus instance in your monitoring environment. For installation instructions, see https://prometheus.io/docs/prometheus/latest/getting_started/[Getting Started] in the Prometheus documentation.
184184

185185
.Procedure
@@ -210,7 +210,7 @@ The new scrape target becomes available after the configuration has reloaded.
210210
If you use Grafana with your Prometheus instance, you can import the predefined https://grafana.com/grafana/dashboards/15835[{product-long-kafka} Grafana dashboard] to set up your metrics display. For import instructions, see https://grafana.com/docs/grafana/v7.5/dashboards/export-import/#importing-a-dashboard[Importing a dashboard] in the Grafana documentation.
211211
--
212212

213-
When you create a Kafka instance and add new topics, the metrics are initially empty. After you start producing and consuming messages in your services, you can return to your monitoring tool to view related metrics. For example, to use Kafka scripts to produce and consume messages, see {base-url}{kafka-bin-scripts-url-kafka}[_Configuring and connecting Kafka scripts with {product-long-kafka}_^].
213+
When you create a Kafka instance and add new topics, the metrics are initially empty. After you start producing and consuming messages in your services, you can return to your monitoring tool to view related metrics. For example, to use Kafka scripts to produce and consume messages, see {base-url}{kafka-bin-scripts-url-kafka}[Configuring and connecting Kafka scripts with {product-long-kafka}^].
214214

215215
NOTE: In some cases, after you start producing and consuming messages, you might need to wait several minutes for the latest metrics to appear. You might also need to wait until your instance and topics contain enough data for metrics to appear.
216216

@@ -291,9 +291,9 @@ spec:
291291

292292
[role="_additional-resources"]
293293
.Additional resources
294-
* {base-url}{getting-started-url-kafka}[_Getting started with {product-long-kafka}_^]
295-
* {base-url}{getting-started-rhoas-cli-url-kafka}[_Getting started with the `rhoas` CLI for {product-long-kafka}_^]
296-
* {base-url-cli}{command-ref-url-cli}[_CLI command reference (rhoas)_^]
294+
* {base-url}{getting-started-url-kafka}[Getting started with {product-long-kafka}^]
295+
* {base-url}{getting-started-rhoas-cli-url-kafka}[Getting started with the `rhoas` CLI for {product-long-kafka}^]
296+
* {base-url-cli}{command-ref-url-cli}[CLI command reference (rhoas)^]
297297
* https://prometheus.io/docs/prometheus/latest/getting_started/[Getting Started] in the Prometheus documentation
298298
* https://prometheus.io/docs/visualization/grafana/[Grafana Support for Prometheus]
299299
* https://grafana.com/docs/grafana/latest/datasources/prometheus/[Prometheus Data Source] in the Grafana documentation

docs/kafka/nodejs-kafka/README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ In this task, you'll create a new configuration file called `rhoas.env`. In the
151151
.Prerequisites
152152
ifndef::qs[]
153153
* You have the bootstrap server endpoint for your Kafka instance. To get the server endpoint, select your Kafka instance in the {product-kafka} web console, select the options menu (three vertical dots), and click *Connection*.
154-
* You have the generated credentials for your service account. To reset the credentials, use the https://console.redhat.com/application-services/service-accounts[Service Accounts^] page in the *Application Services* section of the Red Hat Hybrid Cloud Console.
154+
* You have the generated credentials for your service account. To reset the credentials, use the {service-accounts-url}[Service Accounts^] page in the *Application Services* section of the Red Hat Hybrid Cloud Console.
155155
* You've set the permissions for your service account to access the Kafka instance resources. To verify the current permissions, select your Kafka instance in the {product-kafka} web console and use the *Access* page to find your service account permission settings.
156156
endif::[]
157157

docs/kafka/quarkus-kafka/README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Quarkus applications use https://github.com/eclipse/microprofile-reactive-messag
144144
.Prerequisites
145145
ifndef::qs[]
146146
* You have the bootstrap server endpoint and the SASL/OAUTHBEARER token endpoint for the Kafka instance. To get the server endpoint and the SASL/OAUTHBEARER token endpoint, select your Kafka instance in the {product-kafka} web console, select the options menu (three vertical dots), and click *Connection*.
147-
* You have the generated credentials for your service account. To reset the credentials, use the https://console.redhat.com/application-services/service-accounts[Service Accounts^] page in the *Application Services* section of the Red Hat Hybrid Cloud Console.
147+
* You have the generated credentials for your service account. To reset the credentials, use the {service-accounts-url}[Service Accounts^] page in the *Application Services* section of the Red Hat Hybrid Cloud Console.
148148
* You've set the permissions for your service account to access the Kafka instance resources. To verify the current permissions, select your Kafka instance in the {product-kafka} web console and use the *Access* page to find your service account permission settings.
149149
endif::[]
150150

0 commit comments

Comments
 (0)