Skip to content

Commit b479cf3

Browse files
authored
updated kafka flow (#659)
* updated kafka flow * update to prerequisites * made suggested changes * removed x1 * added titles to commands * integrated step 5 and 6 and updated the enter command for the arrow keys step * italizied the user replacements cluster ID
1 parent 9a0ab60 commit b479cf3

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

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

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ This guide describes how to get started quickly by doing the following:
115115
== Prerequisites
116116

117117
[role="_abstract"]
118-
* You have a command-line terminal application.
118+
* You've a command-line terminal application.
119+
* You've a registered OpenShift cluster.
119120
* You've installed the `rhoas` CLI. For more information, see {base-url}{installation-guide-url-cli}[_Installing the rhoas CLI_^].
120121

121122
//Additional line break to resolve mod docs generation error
@@ -128,42 +129,45 @@ A Kafka instance includes a Kafka cluster, bootstrap server, and other required
128129

129130
.Prerequisites
130131

131-
* You are logged in to `rhoas`.
132+
* You're logged in to `rhoas`.
132133

133134
.Procedure
134135

135-
. Enter the following command to create a Kafka instance with default values.
136+
. On the command line, create a Kafka instance.
136137
+
137138
--
138-
This example creates a Kafka instance called `my-kafka`.
139-
140139
.Creating a Kafka instance
141140
[source,shell]
142141
----
143-
$ rhoas kafka create --name my-kafka
142+
$ rhoas kafka create
144143
----
144+
--
145+
146+
. Type `my-kafka` for your instance name.
147+
. When prompted to select a cluster, use the arrows on your keyboard to select your OpenShift cluster and press Enter to provision your Kafka instance.
148+
. When prompted to select an instance size, use the arrows on your keyboard to select 1 or 2 streaming units, and press Enter.
149+
+
150+
--
151+
A streaming unit determines the default maximum capacity of a Kafka instance. An instance with a larger size can handle higher loads and process more events, has more storage, and can handle more clients and connections.
152+
153+
The CLI displays information about the created instance including billing model, cloud provider, cluster ID of the cluster the instance is provisioned on, and instance type.
145154

146155
CLI uses service contexts to group service instances against which commands are executed.
147156
The created Kafka instance is set automatically in the current context.
148157

149158
[NOTE]
150159
====
151-
If you do not want to use the default values,
152-
enter the following command: `rhoas kafka create`.
153-
You will be prompted to enter the `Name`, `Cloud Provider`, and `Cloud Region` for the Kafka instance.
160+
Alternatively, to provision a Kafka instance by specifying the Kafka name and cluster ID, enter the following command: `rhoas kafka create --name my-kafka --cluster-id _<CLUSTER_ID>_`. Replace _<CLUSTER_ID>_ with your cluster ID. Using this command creates an instance with the default value size of 1 streaming unit.
154161
====
155162
--
156-
157-
. Verify that the Kafka instance is ready to use.
163+
. Verify the details and `ready` status of a Kafka instance.
158164
+
159165
--
160-
.Reviewing details of a Kafka instance
166+
.Verifying the Kafka instance
161167
[source,shell]
162168
----
163169
$ rhoas context status kafka
164170
----
165-
166-
167171
[NOTE]
168172
====
169173
If you have multiple Kafka instances,

0 commit comments

Comments
 (0)