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
* 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
Copy file name to clipboardExpand all lines: docs/kafka/rhoas-cli-getting-started-kafka/README.adoc
+18-14Lines changed: 18 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -115,7 +115,8 @@ This guide describes how to get started quickly by doing the following:
115
115
== Prerequisites
116
116
117
117
[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.
119
120
* You've installed the `rhoas` CLI. For more information, see {base-url}{installation-guide-url-cli}[_Installing the rhoas CLI_^].
120
121
121
122
//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
128
129
129
130
.Prerequisites
130
131
131
-
* You are logged in to `rhoas`.
132
+
* You're logged in to `rhoas`.
132
133
133
134
.Procedure
134
135
135
-
. Enter the following command to create a Kafka instance with default values.
136
+
. On the command line, create a Kafka instance.
136
137
+
137
138
--
138
-
This example creates a Kafka instance called `my-kafka`.
139
-
140
139
.Creating a Kafka instance
141
140
[source,shell]
142
141
----
143
-
$ rhoas kafka create --name my-kafka
142
+
$ rhoas kafka create
144
143
----
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.
145
154
146
155
CLI uses service contexts to group service instances against which commands are executed.
147
156
The created Kafka instance is set automatically in the current context.
148
157
149
158
[NOTE]
150
159
====
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.
154
161
====
155
162
--
156
-
157
-
. Verify that the Kafka instance is ready to use.
163
+
. Verify the details and `ready` status of a Kafka instance.
0 commit comments