Skip to content

Commit 7ed3ab1

Browse files
micheleRPclaude
andauthored
DOC-1896 Document feature RPCN Improve troubleshooting (#535)
* DOC-1896 Document feature RPCN Improve troubleshooting * minor edits * minor edits * minor edits * minor edit * separate input/output steps * style edits * fix steps for adding input/output + redpanda topic/user * quickstart edits * quickstart edits + add image * incorporate review feedback * clarify image components, per doc review feedback * fix style issues: align example output with mapping, update dates, fix formatting Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 982e426 commit 7ed3ab1

File tree

5 files changed

+88
-76
lines changed

5 files changed

+88
-76
lines changed

modules/develop/pages/connect/connect-quickstart.adoc

Lines changed: 82 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
11
= Redpanda Connect Quickstart
2-
:description: Learn how to quickly start building data pipelines with Redpanda Connect.
2+
:description: Learn how to quickly start building data pipelines with Redpanda Connect.
3+
:page-topic-type: tutorial
4+
:personas: streaming_developer
5+
:learning-objective-1: Build a producer pipeline that generates and publishes data to a topic
6+
:learning-objective-2: Build a consumer pipeline that reads, transforms, and logs data from a topic
37

4-
The *Connect* page provides a wizard to create pipelines for streaming data into and out of Redpanda. The wizard populates the YAML configuration automatically, so you can get started quickly.
8+
In this quickstart, you build data pipelines to generate, transform, and handle streaming data end-to-end. You create two pipelines: one that generates dad jokes and writes them to a topic in your cluster, and another that reads those jokes and gives each one a random "cringe rating".
59

6-
TIP: Advanced users can skip directly to the *Edit pipeline* step in the wizard to configure the YAML file themselves.
10+
After completing this quickstart, you will be able to:
711

8-
This quickstart shows how Redpanda Connect can generate, transform, and handle streaming data end-to-end. It creates the following pipelines:
12+
* [ ] {learning-objective-1}
13+
* [ ] {learning-objective-2}
914
10-
* The first pipeline generates (produces) dad jokes and writes them to a topic in your cluster.
11-
* The second pipeline reads (consumes) those dad jokes and gives each one a random "cringe rating" from 1-10.
15+
16+
== Prerequisites
17+
18+
You must have a Redpanda Cloud account with a Serverless, Dedicated, or standard BYOC cluster. If you don't already have an account, https://redpanda.com/try-redpanda/cloud-trial[sign up for a free trial^].
19+
20+
NOTE: Clusters can create up to 100 pipelines. For additional pipelines, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda support^].
21+
22+
== Quickstart pipelines
23+
24+
This quickstart creates the following pipelines:
25+
26+
* The first pipeline produces dad jokes and writes them to a topic in your cluster.
27+
* The second pipeline consumes those dad jokes and gives each one a random "cringe rating" from 1-10.
1228

1329
The *producer pipeline* uses the following Redpanda Connect components:
1430

@@ -17,7 +33,7 @@ The *producer pipeline* uses the following Redpanda Connect components:
1733
|Component type |Component |Purpose
1834

1935
|Input
20-
|xref:develop:connect/components/inputs/generate.adoc[`generate`]
36+
|xref:components:inputs/generate.adoc[`generate`]
2137
|Creates jokes
2238

2339
|Output
@@ -61,29 +77,32 @@ The *consumer pipeline* uses the following Redpanda Connect components:
6177
|Catches errors
6278
|===
6379

64-
== Prerequisites
80+
TIP: The pipeline editor provides an IDE-like experience for creating pipelines. After a component has been added, you can click the leaf icon in the left sidebar to open its documentation.
6581

66-
You must have a Redpanda Cloud account with a Serverless, Dedicated, or standard BYOC cluster. If you don't already have an account, https://redpanda.com/try-redpanda/cloud-trial[sign up for a free trial^].
82+
image::shared:connect_ui.png[Redpanda Connect user interface]
6783

68-
NOTE: Clusters can create up to 100 pipelines. For additional pipelines, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda support^].
6984

7085
== Build a producer pipeline
7186

72-
Follow these steps to create the producer pipeline:
87+
Every pipeline requires an input and an output in a configuration file. You can select components in the left sidebar and customize the YAML in the editor.
7388

74-
. Go to the **Connect** page for your cluster to create a pipeline.
89+
To create the producer pipeline:
7590

76-
. **Add an input**: Search for and select `generate` from the list of connectors. Click **Next**.
91+
. Go to the *Connect* page for your cluster and click *Create a pipeline*.
7792

78-
. **Add an output**: Search for and select `redpanda` from the list of connectors. Click **Next**.
93+
. Enter this name for the pipeline: `joke-generator-producer`.
7994

80-
. **Add a topic**: Create a new topic called `dad-jokes`. This is where Redpanda will store the generated messages. Click **Next**.
95+
. In the left sidebar, click *Add input +* and search for and select the `generate` input connector. The YAML for this connector appears in the editor.
8196

82-
. **Add permissions**: Create a new user called `connect`. Leave the rest of the default settings. The user will be created with the necessary permissions. Click **Next**.
97+
. Click *Add output +* and search for and select the `redpanda` output connector. The YAML for this connector also appears in the editor.
8398

84-
. **Edit pipeline**:
85-
.. Enter this name for the pipeline: `joke-generator-producer`.
86-
.. The **Configuration** section automatically populates the YAML with your selected components. Under *Connectors*, you can add the processors `log` and `catch` to log generated jokes and monitor for errors. However, for simplicity in this quickstart, replace the entire configuration with the following YAML, which includes the processors and the `mapping` for joke generation:
99+
. The `redpanda` connector requires a Redpanda topic and user:
100+
101+
.. In the `redpanda` output connector, click *Topic +* to create a new topic. Toggle to *New* and enter `dad-jokes` for the topic name. Click *Add*.
102+
103+
.. In the `redpanda` output connector, click *User +* to create a new user. Toggle to *New* and enter `connect` for the username. Click *Add*.
104+
105+
. Replace the generated YAML in the editor with the following. This configuration includes the `log` and `catch` processors and the `mapping` for joke generation. Bloblang is Redpanda Connect's scripting language used to add logic.
87106
+
88107
[source,yaml]
89108
----
@@ -151,79 +170,78 @@ output:
151170
152171
----
153172

154-
.. Click **Create**.
155-
156173
+
157174
[NOTE]
158175
====
159-
* Notice the `$\{REDPANDA_BROKERS}` xref:develop:connect/configuration/contextual-variables.adoc[contextual variable] in the configuration. This automatically references your cluster's bootstrap server address, so you can use it in any pipeline without hardcoding connection details.
160-
* Notice `${secrets.KAFKA_USER_CONNECT}` and `${secrets.KAFKA_PASSWORD_CONNECT}`. These were generated when you created the `connect` user.
176+
* Notice the `$\{REDPANDA_BROKERS}` xref:develop:connect/configuration/contextual-variables.adoc[contextual variable] in the configuration. This references your cluster's bootstrap server address, so you can use it in any pipeline without hardcoding connection details. Use the slash command menu in the YAML editor or use the command palette to insert the Redpanda broker's contextual variable.
177+
* Notice `${secrets.KAFKA_USER_CONNECT}` and `${secrets.KAFKA_PASSWORD_CONNECT}`. These reference secrets that you can create using the slash command menu in the YAML editor or on the *Security* page.
161178
* The Brave browser does not fully support code snippets.
162179
163180
====
164181

165-
. Your pipeline details display, and after a few seconds, the status changes from **Starting** to **Running**. If you don't see this change, refresh the page. Once running, your pipeline generates a new joke every five seconds and writes the joke to your topic.
166-
182+
. Click *Save*.
167183
+
168-
After a minute, select the pipeline and click **Stop** so you can examine the results.
184+
Your pipeline details display, and after a few seconds, the pipeline starts running. The pipeline generates jokes and writes the jokes to your Redpanda topic.
185+
169186

170187
=== Review the pipeline logs
171188

172-
. Click the **Logs** tab to see the pipeline's activity log.
173-
. Click through the log messages to see the startup sequence. For example, you'll see when the output becomes active:
189+
The page loads new log messages as they come in. When Live mode is disabled, you can filter logs, for example, by level, message content, or path. The log shows activity from the past five hours.
190+
191+
Click through the log messages to see the startup sequence. For example, you'll see when the output becomes active:
174192

175-
+
176193
[source,json]
177194
----
178195
{
179-
"instance_id": "d4548gl54smc73b65t0g",
180-
"label": "",
181-
"level": "INFO",
182-
"message": "Output type redpanda is now active",
183-
"path": "root.output",
184-
"pipeline_id": "d4548fihlips73dmcl80",
185-
"time": "2025-11-04T18:21:55.223350785Z"
196+
"instance_id": "d73c39bp7l8c73d7lll0",
197+
"label": "",
198+
"level": "INFO",
199+
"message": "Output type redpanda is now active",
200+
"path": "root.output",
201+
"pipeline_id": "d73a55ptub9s73agpthg",
202+
"time": "2026-03-27T17:43:02.36416142Z"
186203
}
187204
----
188205

189206

190207
=== View the processed messages
191208

192-
. Go to the **Topics** page and select the `dad-jokes` topic.
209+
. Go to the *Topics* page for your cluster and select the `dad-jokes` topic.
193210
. Click any message to see the structure. For example:
194211
+
195212
[source,json]
196213
----
197214
{
198-
"id": "cf653b9e-ce96-4790-888f-6a867bed56a5",
215+
"id": "d242c355-4cee-4382-817a-190c7a115a19",
199216
"joke": "I used to play piano by ear, but now I use my hands.",
200217
"joke_length": 52,
201218
"source": "dad-joke-generator",
202-
"timestamp": "2025-11-04T18:21:55.020574506Z"
219+
"timestamp": "2026-03-27T15:30:38.963227997Z"
203220
}
204221
----
205222

206223

207224
== Build a consumer pipeline
208225

209-
This pipeline rates the jokes that you generated in the first pipeline. Follow these steps to create the consumer pipeline:
226+
This next pipeline rates the jokes that you generated in the first pipeline. To create the consumer pipeline:
210227

211-
. On the **Connect** page for your cluster, click **Create pipeline**.
228+
. Go back to the *Connect* page for your cluster, and click *Create a pipeline*.
212229

213-
. **Add an input**: Search for and select `redpanda` from the list of connectors. Click **Next**.
230+
. Enter this name for the pipeline: `joke-generator-consumer`.
214231

215-
. **Add an output**: Search for and select `drop` from the list of connectors. (Because this quickstart is just for testing, this output drops the message instead of sending it anywhere else. In a real scenario you'd replace the `drop` connector with your real destination.) Click **Next**.
232+
. In the left sidebar, click *Add input +*, and search for and select the `redpanda` input connector.
233+
. The `redpanda` connector requires a Redpanda topic and user:
216234

217-
. **Add a topic**: Select the existing topic called `dad-jokes`. Click **Next**.
235+
.. In the `redpanda` input connector, click *Topic +* and select the existing topic `dad-jokes`. Click *Add*.
218236

219-
. **Add permissions**:
220-
.. Select the existing user called `connect`.
221-
.. Add a consumer group: Enter `dad-joke-raters` as the name for the consumer group.
222-
.. Click **Next**.
237+
.. In the `redpanda` input connector, click *User +* and select the existing user `connect`. For consumer group, enter `dad-joke-raters`. This allows the user `connect` to be granted READ and DESCRIBE permissions for the `dad-joke-raters` consumer group. Click *Add*.
223238

224-
. **Edit pipeline**:
225-
.. Enter this name for the pipeline: `joke-generator-consumer`.
226-
.. The **Configuration** section automatically populates the YAML with your selected components. To add the `bloblang`, `log`, and `catch` processors, replace the entire configuration with the following YAML. Bloblang is Redpanda Connect's scripting language used to add logic (for example, random ratings).
239+
. Click *Add output +*, and search for and select the `drop` output connector. (For testing purposes, this output drops messages instead of forwarding them. In a real scenario you would replace the `drop` connector with your real destination.)
240+
241+
. Replace the generated YAML in the editor with the following configuration, which includes the `bloblang`, `log`, and `catch` processors.
242+
243+
+
244+
NOTE: This example explicitly includes several optional configuration fields for the `redpanda` input. They're shown here for demonstration purposes, so you can see a range of available settings.
227245

228246
+
229247
[source,yaml]
@@ -243,9 +261,9 @@ input:
243261
metadata_max_age: 5m # Optional (default: "5m")
244262
request_timeout_overhead: 10s # Optional (default: "10s")
245263
conn_idle_timeout: 20s # Optional (default: "20s")
246-
topics: # Optional
264+
topics: # Required (mutually exclusive with regexp_topics)
247265
- dad-jokes
248-
regexp_topics: false # Optional (default: false)
266+
regexp_topics: false # Optional (default: false). Mutually exclusive with topics.
249267
rebalance_timeout: 45s # Optional (default: "45s")
250268
session_timeout: 1m # Optional (default: "1m")
251269
heartbeat_interval: 3s # Optional (default: "3s")
@@ -317,15 +335,9 @@ output:
317335
----
318336

319337

320-
.. Click **Create** to start your pipeline.
321-
322-
+
323-
NOTE: This example explicitly includes several optional configuration fields for the `redpanda` input. They're shown here for demonstration purposes, so you can see a range of available settings.
324-
325-
326-
. Your pipeline details display, and the status changes from **Starting** to **Running**. If you don't see this change, refresh the page.
338+
. Click *Save* to start your pipeline.
327339

328-
. Open the logs to see a rated joke. For example:
340+
. Your pipeline details display, and after a few seconds, the pipeline starts running. Check the logs to see a rated joke. For example:
329341

330342
+
331343
[source,json]
@@ -335,26 +347,26 @@ NOTE: This example explicitly includes several optional configuration fields for
335347
"instance_id": "d454dkn4u2is73ava480",
336348
"label": "",
337349
"level": "INFO",
338-
"message": "🎭 JOKE RATED! 💀\nJoke: \"I used to play piano by ear, but now I use my hands.\"\nCringe Rating: 9/10 - EXTREME - Peak dad joke achievement\nAge: 659 seconds old\nProcessed at: 2025-11-04T18:32:54.340229297Z\n",
350+
"message": "🎭 JOKE RATED! 💀\nJoke: \"I used to play piano by ear, but now I use my hands.\"\nCringe Rating: 9/10 - EXTREME - Peak dad joke achievement\nAge: 659 seconds old\nProcessed at: 2026-03-27T17:54:13.340229297Z\n",
339351
"path": "root.pipeline.processors.1",
340352
"pipeline_id": "d454djahlips73dmcll0",
341-
"time": "2025-11-04T18:32:54.341137527Z"
353+
"time": "2026-03-27T17:54:13.341137527Z"
342354
}
343355
----
344356

345357
== Clean up
346358

347359
When you've finished experimenting with your data pipeline, you can delete the pipelines and the topic you created for this quickstart.
348360

349-
. On the **Connect** page, select the delete icon next to the `joke-generator-producer` pipeline and the `joke-generator-consumer` pipeline.
361+
. On the *Connect* page, click the *...* icon next to the `joke-generator-producer` pipeline and select *Delete*. Repeat for the `joke-generator-consumer` pipeline.
350362
. Confirm your deletion to remove the pipelines and associated logs.
351-
. On the **Topics** page, delete the `dad-jokes` topic.
363+
. On the *Topics* page, delete the `dad-jokes` topic.
352364

353365
== Next steps
354366

355-
* Try one of our xref:cookbooks:index.adoc[Redpanda Connect cookbooks].
367+
* Try one of the xref:cookbooks:index.adoc[Redpanda Connect cookbooks].
356368
* Choose xref:develop:connect/components/about.adoc[connectors for your use case].
357-
* Learn how to xref:develop:connect/configuration/secret-management.adoc[add secrets to your pipeline].
358-
* Learn how to xref:develop:connect/configuration/monitor-connect.adoc[monitor a data pipeline on a BYOC or Dedicated cluster].
359-
* Learn how to xref:develop:connect/configuration/scale-pipelines.adoc[manually scale resources for a pipeline].
360-
* Learn how to xref:redpanda-connect:guides:getting_started.adoc[configure, test, and run a data pipeline locally].
369+
* xref:develop:connect/configuration/secret-management.adoc[Add secrets to your pipeline].
370+
* xref:develop:connect/configuration/monitor-connect.adoc[Monitor a data pipeline on a BYOC or Dedicated cluster].
371+
* xref:develop:connect/configuration/scale-pipelines.adoc[Manually scale resources for a pipeline].
372+
* xref:redpanda-connect:guides:getting_started.adoc[Configure, test, and run a data pipeline locally].

modules/get-started/pages/whats-new-cloud.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ You can now deploy managed MCP servers directly inside your Redpanda Cloud clust
132132

133133
=== Shadowing
134134

135-
Redpanda Cloud now supports xref:manage:disaster-recovery/shadowing/overview.adoc[Shadowing], a disaster recovery solution that provides asynchronous, offset-preserving replication between distinct Redpanda clusters. Shadowing enables cross-region data protection by replicating topic data, configurations, consumer group offsets, ACLs, and Schema Registry data with byte-level fidelity.The shadow cluster operates in read-only mode while continuously receiving updates from the source cluster. During a disaster, you can failover individual topics or an entire shadow link to make resources fully writable for production traffic.
135+
Redpanda Cloud now supports xref:manage:disaster-recovery/shadowing/overview.adoc[Shadowing], a disaster recovery solution that provides asynchronous, offset-preserving replication between distinct Redpanda clusters. Shadowing enables cross-region data protection by replicating topic data, configurations, consumer group offsets, ACLs, and Schema Registry data with byte-level fidelity. The shadow cluster operates in read-only mode while continuously receiving updates from the source cluster. During a disaster, you can failover individual topics or an entire shadow link to make resources fully writable for production traffic.
136136

137137
Shadowing is supported on BYOC and Dedicated clusters running Redpanda version 25.3 and later.
138138

@@ -173,11 +173,11 @@ The message size setting on existing topics is not changed, but the message size
173173

174174
=== Redpanda Connect updates
175175

176-
Redpanda Connect provides a simplified xref:develop:connect/connect-quickstart.adoc[quickstart] experience in the UI that helps you to start building data pipelines. The quickstart wizard creates pipelines to stream data into and out of Redpanda, populating the required YAML configuration automatically.
176+
Redpanda Connect provides a simplified xref:develop:connect/connect-quickstart.adoc[quickstart] experience in the UI that helps you to start building data pipelines. The quickstart creates pipelines to stream data into and out of Redpanda using the pipeline editor.
177177

178178
=== Get Started with Serverless
179179

180-
A Serverless cluster's *Overview* page now provides a *Get Started* wizard to help you start streaming your own data with a xref:develop:connect/connect-quickstart.adoc[Redpanda Connect] pipeline. The wizard lets you stream data into and out of Redpanda without writing producer/consumer code.
180+
A Serverless cluster's *Overview* page now provides a *Get Started* guide to help you start streaming your own data with a xref:develop:connect/connect-quickstart.adoc[Redpanda Connect] pipeline. It lets you stream data into and out of Redpanda without writing producer/consumer code.
181181

182182
=== Remote read replicas: GA
183183

@@ -212,7 +212,7 @@ After the cluster is created, you can change the API Gateway access on the clust
212212
** xref:components:inputs/microsoft_sql_server_cdc.adoc[Microsoft SQL Server CDC]: Streams change data from a Microsoft SQL Server database into Redpanda Connect using Change Data Capture (CDC).
213213

214214
* Outputs:
215-
** xref:develop:connect/components/outputs/cyborgdb.adoc[CyborgDB]: Wite vectors to a CyborgDB encrypted index. CyborgDB provides
215+
** xref:develop:connect/components/outputs/cyborgdb.adoc[CyborgDB]: Write vectors to a CyborgDB encrypted index. CyborgDB provides
216216
end-to-end encrypted vector storage with automatic dimension detection and index optimization.
217217

218218
* Processors:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
TIP: The cluster's *Overview* page includes a *Get Started* wizard to quickly pipeline your data into and out of Redpanda. The wizard guides you to select an input data source (to produce data) or an output data sink (to consume data) and automatically populates the necessary permissions and configurations. See also: xref:develop:connect/connect-quickstart.adoc[Redpanda Connect Quickstart]
1+
TIP: The cluster's *Overview* page includes a *Get Started* guide to help you start streaming data into and out of Redpanda. See also: xref:develop:connect/connect-quickstart.adoc[Redpanda Connect Quickstart]

0 commit comments

Comments
 (0)