Skip to content

Commit e9fa144

Browse files
authored
DOC-783 Dedicated Limited availability (#139)
* Dedicated Limited availability * Add secrets management reference * review comments * review comments
1 parent 0cd3c64 commit e9fa144

File tree

4 files changed

+28
-23
lines changed

4 files changed

+28
-23
lines changed

modules/develop/pages/connect/configuration/monitor-connect.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
= Monitor Data Pipelines on BYOC Clusters
1+
= Monitor Data Pipelines on BYOC and Dedicated Clusters
22
:description: Configure Prometheus monitoring of your data pipelines on BYOC clusters.
33

4-
You can configure monitoring on BYOC clusters to understand the behavior, health, and performance of your data pipelines.
4+
You can configure monitoring on BYOC and Dedicated clusters to understand the behavior, health, and performance of your data pipelines.
55

66
Redpanda Connect automatically exports xref:components:metrics/about.adoc[detailed metrics for each component of your data pipeline] to a Prometheus endpoint, along with metrics for all other cluster services. You don’t need to update the configuration of your pipeline.
77

modules/develop/pages/connect/configuration/scale-pipelines.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Scale Data Pipeline Resources on BYOC Clusters
1+
= Scale Data Pipeline Resources on BYOC and Dedicated Clusters
22
:description: Learn how to manually scale resources for data pipelines using the Data Plane API.
33

44
When you create a data pipeline through the Cloud UI, Redpanda Connect reserves compute resources for the exclusive use of that pipeline. This initial resource allocation is enough to experiment with pipelines that create low message volumes.
@@ -16,7 +16,7 @@ Use the Cloud UI or Data Plane API to view resources already allocated to a data
1616
Cloud UI::
1717
+
1818
--
19-
. Log in to https://cloud.redpanda.com[Redpanda Cloud^].
19+
. Log in to https://cloud.redpanda.com[Redpanda Cloud^].
2020
. Go to the cluster where the pipeline is set up.
2121
. On the **Connectors** page, select your pipeline and look at the value for **Resources**.
2222
+
@@ -47,7 +47,7 @@ This example allocates 1.2 vCPU and 500 MB of memory to a data pipeline. For `cp
4747
+
4848
[,bash]
4949
----
50-
curl -X PUT "https://api-dfb1e463.crhjl9gj1v2u1117r1f0.byoc.prd.cloud.redpanda.com/v1alpha2/redpanda-connect/pipelines/xxx..." \
50+
curl -X PUT "https://<data-plane-api-url>/v1alpha2/redpanda-connect/pipelines/xxx..." \
5151
-H "Authorization: Bearer xxx..." \
5252
-H "accept: application/json" \
5353
-H "content-type: application/json" \

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

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ include::develop:partial$availability-message.adoc[]
99

1010
== Prerequisites
1111

12-
A Redpanda Cloud account for Serverless or standard BYOC (not customer-managed VPC). If you don't already have an account, https://redpanda.com/try-redpanda/cloud-trial[sign up for a free trial^].
12+
A Redpanda Cloud account for Serverless, Dedicated or standard BYOC (not customer-managed VPC). If you don't already have an account, https://redpanda.com/try-redpanda/cloud-trial[sign up for a free trial^].
1313

1414
== Before you start
1515

@@ -40,17 +40,26 @@ BYOC::
4040
+
4141
Wait while your cluster is created.
4242
--
43+
Dedicated::
44+
+
45+
--
46+
. Log in to https://cloud.redpanda.com[Redpanda Cloud^].
47+
. On the **Clusters** page, click **Create cluster**, then click **Create Dedicated cluster**.
48+
. On the **Cluster settings** page, enter **connect-quickstart** for the cluster name.
49+
. Select your cloud provider, then click **Next**.
50+
. On the **Networking** page, use the default **Public** connection type, and click **Create**.
51+
+
52+
Wait while your cluster is created.
53+
--
4354
=====
4455

4556
To complete your setup:
4657

4758
. Go to the **Topics** page, click **Create topic** and enter **processed-emails** for the topic name. Use default values for the remaining properties and click **Create** and then **Close**.
48-
. Go to the **Security** page, and click **Create user**. Enter the username **connect**. Use the default values for the remaining properties. Remember to take a note of your password.
59+
. Go to the **Security** page, and click **Create user**. Enter the username **connect** and take a note of the password. You will need to use this later. Use the default values for the remaining properties.
4960
. Click **Create** and **Done**.
5061
. Stay on the **Access control** page and click the **ACLs** tab.
5162
. Select the **connect** user you have just created. Click **Allow all operations** and then scroll down to click **OK**.
52-
. Finally, go to the **Overview** page and click the **Kafka API** tab.
53-
. Copy the bootstrap server URL into a text file. You will need it for the next steps.
5463

5564
== Build your data pipeline
5665

@@ -71,8 +80,7 @@ All Redpanda Connect configurations use a YAML file split into three sections:
7180
| A xref:components:outputs/kafka_franz.adoc[`kafka_franz` output] that writes messages to the **connect-output** topic on your cluster.
7281
|===
7382

74-
. Go to the **Connectors** page on your cluster and click the **Redpanda Connect** tab.
75-
. Click **Create pipeline**.
83+
. Go to the **Connect** page on your cluster and click **Create pipeline**.
7684
. In **Pipeline name**, enter **emailprocessor-pipeline** and add a short description. For example, **Transforms email data using a mutation processor**.
7785
. In the **Configuration** box, paste the following configuration.
7886

@@ -96,7 +104,7 @@ pipeline:
96104
output:
97105
kafka_franz:
98106
seed_brokers:
99-
- <bootstrap-server-url>
107+
- ${REDPANDA_BROKERS}
100108
sasl:
101109
- mechanism: SCRAM-SHA-256
102110
password: <cluster-password>
@@ -106,12 +114,9 @@ output:
106114
enabled: true
107115
----
108116

109-
110117
+
111-
Replace the following placeholders:
112-
113-
* `<bootstrap-server-url>`: The bootstrap server address you copied in <<before-you-start,Before you start>>.
114-
* `<cluster-password>`: The password of the connect user you set up in <<before-you-start,Before you start>>.
118+
* Replace `<cluster-password>` with the password of the connect user you set up in <<before-you-start,Before you start>>. To avoid exposing secrets, Redpanda Connect also supports secret variables. For more information, see xref:develop:connect/configuration/secret-management.adoc[Manage Secrets].
119+
* `$\{REDPANDA_BROKERS}` is a contextual variable that references the bootstrap server address of your cluster. All Redpanda Cloud clusters automatically set this variable to the bootstrap server address so that you can add it to any of your pipelines.
115120

116121
+
117122
NOTE: The Brave browser does not fully support code snippets.
@@ -146,7 +151,7 @@ To see the pipeline output:
146151

147152
To view the logs:
148153

149-
. Return to the **Connectors** page on your cluster and select the **emailprocessor-pipeline**.
154+
. Return to the **Connect** page on your cluster and select the **emailprocessor-pipeline**.
150155
. Click the **Logs** tab and select each of the four log messages. You can see the sequence of events that start the data pipeline. For example, you can see when Redpanda Connect starts to write data to the topic:
151156

152157
+
@@ -196,8 +201,7 @@ The snippet includes new configuration to:
196201

197202

198203
. Click **Update**.
199-
. After a few seconds, click **Stop**.
200-
. Click the **Logs** tab and select the most recent (final) log message. You can see the custom logging fields along with the uppercase user's name.
204+
. Once the pipeline has started running, click the **Logs** tab and select the most recent (final) log message. You can see the custom logging fields along with the uppercase user's name.
201205

202206
+
203207
[source,json]
@@ -214,13 +218,14 @@ The snippet includes new configuration to:
214218
"time": "2024-08-22T17:33:46.676903284Z"
215219
}
216220
----
221+
. Click **Stop**.
217222

218223
== Clean up
219224

220225
When you've finished experimenting with your data pipeline, you can delete the pipeline, topic, and cluster you created for this quickstart.
221226

222-
. On the **Connectors** page, select your pipeline.
223-
. Click **Delete** and confirm your deletion to remove the data pipeline and associated logs.
227+
. On the **Connect** page, select the delete icon next to the **emailprocessor-pipeline**.
228+
. Confirm your deletion to remove the data pipeline and associated logs.
224229
. On the **Topics** page, delete the **processed-emails** topic.
225230
. Go back to the **Clusters** page and delete the **connect-quickstart** cluster.
226231

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
NOTE: Redpanda Connect is currently in a limited availability (LA) release for
2-
BYOC clusters. While it is also available as a beta feature for Serverless clusters, it is not suitable for production deployments.
2+
BYOC and Dedicated clusters. While it is also available as a beta feature for Serverless clusters, it is not suitable for production deployments.

0 commit comments

Comments
 (0)