You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* docs(cli): update cli guides with contexts
* docs(cli): update registry guides
* fix: remove corner case/additional element non essential to the guide
* chore: Apply suggestions from code review
Co-authored-by: Ben Hardesty <[email protected]>
* chore: apply more suggestions from code review
Co-authored-by: Ben Hardesty <[email protected]>
Co-authored-by: Wojciech Trocki <[email protected]>
Co-authored-by: Ben Hardesty <[email protected]>
Copy file name to clipboardExpand all lines: docs/kafka/rhoas-cli-getting-started-kafka/README.adoc
+35-7Lines changed: 35 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,6 +71,7 @@ This guide describes how to get started quickly by doing the following:
71
71
* {base-url}{rhoas-cli-getting-started-url-kafka}#proc-creating-service-account-cli_getting-started-rhoas-kafka[Create a service account]
72
72
* {base-url}{rhoas-cli-getting-started-url-kafka}#proc-creating-kafka-topic-cli_getting-started-rhoas-kafka[Create a Kafka topic]
73
73
* {base-url}{rhoas-cli-getting-started-url-kafka}#proc-commands-managing-kafka_getting-started-rhoas-kafka[Use `rhoas` to manage your Kafka instances, service accounts, and Kafka topics]
74
+
* {base-url}{rhoas-cli-getting-started-url-kafka}#proc-generating-kafka-configs-cli_getting-started-rhoas-kafka[Generate configurations for a Kafka instance]
74
75
75
76
//Additional line break to resolve mod docs generation error
76
77
@@ -105,6 +106,9 @@ This example creates a Kafka instance called `my-kafka`.
105
106
$ rhoas kafka create --name my-kafka
106
107
----
107
108
109
+
CLI uses service contexts to group service instances against which commands are executed.
110
+
The created Kafka instance is set automatically in the current context.
111
+
108
112
[NOTE]
109
113
====
110
114
If you do not want to use the default values,
@@ -119,17 +123,14 @@ You will be prompted to enter the `Name`, `Cloud Provider`, and `Cloud Region` f
119
123
.Reviewing details of a Kafka instance
120
124
[source,shell]
121
125
----
122
-
$ rhoas status kafka
126
+
$ rhoas context status kafka
123
127
----
124
128
125
-
This command shows that the Kafka instance is ready to use,
126
-
because the `Status` field is `ready`.
127
129
128
130
[NOTE]
129
131
====
130
-
When you created the Kafka instance, it was set as the current instance automatically.
131
132
If you have multiple Kafka instances,
132
-
you can switch to a different instance by using the `rhoas kafka use` command.
133
+
you can make the current context switch to a different instance by using the `rhoas context use-kafka` command.
133
134
====
134
135
--
135
136
@@ -208,7 +209,7 @@ After creating a Kafka instance, you can create Kafka topics to start producing
208
209
209
210
[NOTE]
210
211
====
211
-
You can use `rhoas kafka list` and `rhoas kafka use` to switch to a specific Kafka instance.
212
+
You can use `rhoas kafka list` and `rhoas context use-kafka` to switch to a specific Kafka instance.
212
213
213
214
.List Kafka instances
214
215
[source,shell]
@@ -218,7 +219,7 @@ $ rhoas kafka list
218
219
.Selecting a Kafka instance to use
219
220
[source,shell]
220
221
----
221
-
$ rhoas kafka use --name my-kafka
222
+
$ rhoas context use-kafka --name my-kafka
222
223
----
223
224
====
224
225
@@ -245,6 +246,33 @@ For more information, use the command help `rhoas kafka topic create -h`.
245
246
246
247
. If necessary, you can edit or delete the topic by using the `rhoas kafka topic update` and `rhoas kafka topic delete` commands.
* {base-url}{rhoas-cli-getting-started-url-registry}#proc-commands-managing-registry_getting-started-rhoas-service-registry[Use `rhoas` to manage your {registry} instance, service accounts, and artifacts]
78
79
79
80
//Additional line break to resolve mod docs generation error
@@ -107,6 +108,9 @@ This example creates a {registry} instance called `my-registry`.
@@ -475,6 +478,32 @@ You can use additional options, such as `--group` and `--instance-id`, to specif
475
478
For more information about any of the options, view the command help `rhoas service-registry rule -h`.
476
479
====
477
480
481
+
[id="proc-generating-registry-configs_{context}"]
482
+
== Generating configurations for Service Registry instance
483
+
484
+
[role="_abstract"]
485
+
After creating a Service Registry instance, you can generate a configuration file that your applications can use to connect to your Service Registry instance.
486
+
487
+
.Prerequisites
488
+
489
+
* You've created a Service Registry instance.
490
+
* The Service Registry instance is set in the current context.
491
+
* Your user account and org have quota for creating service accounts.
492
+
493
+
.Procedure
494
+
495
+
* Generate a configuration file for the current service context.
496
+
+
497
+
--
498
+
This example generates a JSON file with configurations for the Service Registry instance.
0 commit comments