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
Copy file name to clipboardExpand all lines: docs/connectors/getting-started-connectors/README.adoc
+19-5Lines changed: 19 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,11 +77,26 @@ endif::[]
77
77
== Configuring the {product-kafka} instance for use with {product-long-connectors}
78
78
79
79
[role="_abstract"]
80
+
As a prerequisite for using {product-long-connectors} you need a running {product-kafka} instance. P{lease refer to the Getting started with OpenShift Streams for Apache Kafka for instructions to create a Kafka instance.
81
+
80
82
In this step you configure your {product-kafka} for use with {product-long-connectors}. This involves creating topics and setting up access rules for service accounts.
81
83
82
84
.Procedure
83
-
. First step
84
-
. Second step
85
+
. Create a topic for the connectors.
86
+
.. In the *Kafka Instances* page of the web console, click the name of the Kafka instance that you want to add a topic to.
87
+
.. Select the *Topics* tab, click *Create topic*, and follow the guided steps to define the topic details. Click *Next* to complete each step and click *Finish* to complete the setup. +
88
+
Choose a unique name for your topic. Leave the partitions and retention settings to the default settings.
89
+
90
+
. Create a service account for the connectors.
91
+
.. In the *Service Accounts* page of the web console, click *Create service account* to create a new service account.
92
+
.. Enter a unique service account name add an optional description, and click *Create*.
93
+
.. Copy the generated *Client ID* and *Client Secret* to a secure location. These are the credentials that you'll use to connect to this Kafka instance.
94
+
95
+
. Set the appropriate level of access for the new service account in the Access Control List (ACL) of the Kafka instance.
96
+
.. In the *Kafka Instances* page of the web console, click the name of the Kafka instance that you want the service account to access.
97
+
.. Click the *Access* tab to view the current ACL for this instance.
98
+
.. Click *Manage access*, use the *Account* drop-down menu to select the service account that you previously created, and click *Next*.
99
+
.. 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 *`.
85
100
86
101
.Verification
87
102
ifdef::qs[]
@@ -106,7 +121,7 @@ NOTE: From this screen you can also create a new Kafka instance by clicking the
106
121
107
122
. Select the OpenShift Dedicated cluster to host the connector instance. Select the OSD cluster by clicking the box representing the cluster, and click *Next* to complete the step.
108
123
109
-
. In this step you configure the common configuration for your connector. Provide a unique name for the connectorand select *Automatically create a service account for this connector*. As an alternative you can also provide the Client ID and Client Secret of an existing service account. If you did set up the {product-kafka} ACL as explained in the previous task of this quick start, the newly created service account has sufficient rights to produce messages to the topic associated with the connector. Click *Next* to complete the step.
124
+
. In this step you configure the common configuration for your connector. Provide a unique name for the connector. Enter the Client ID and Client Secret of the service account you created in the previous task of this quick start in the *Client ID* and *Client secret* text boxes. If you did set up the {product-kafka} ACL as explained in the previous task, the service account has sufficient rights to produce messages to the topic associated with the connector. Click *Next* to complete the step.
110
125
111
126
. In this step you provide the connector specific configuration.
112
127
.. Leave the *Data shape Format* to `application/octet-stream`
@@ -147,7 +162,7 @@ Enter *http* in the search box. You should see only one connector, called *HTTP
147
162
148
163
. Select the OpenShift Dedicated cluster to host the connector instance. Select the OSD cluster by clicking the box representing the cluster, and click *Next* to complete the step.
149
164
150
-
. In this step you configure the common configuration for your connector. Provide a unique name for the connectorand select *Automatically create a service account for this connector*. As an alternative you can also provide the Client ID and Client Secret of an existing service account. If you did set up the {product-kafka} ACL as explained in the previous task of this quick start, the newly created service account has sufficient rights to consume messages from the topic associated with the connector. Click *Next* to complete the step.
165
+
. In this step you configure the common configuration for your connector. Provide a unique name for the connector. Enter the Client ID and Client Secret of the service account you created in the first task of this quick start in the *Client ID* and *Client secret* text boxes. If you did set up the {product-kafka} ACL as explained in the first task, the service account has sufficient rights to consume messages from the topic associated with the connector. Click *Next* to complete the step.
151
166
152
167
. In this step you provide the connector specific configuration.
153
168
.. Leave the *Data shape Format* to `application/octet-stream`
@@ -165,7 +180,6 @@ After you complete the connector setup, the new connector is listed in the conne
165
180
. In the browser tab pointing to link:https://webhook.site[webhook.site^] you should see the HTTP POST calls from the connector with the message contents as defined in the source connector.
0 commit comments