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: modules/develop/pages/connect/configuration/resource-management.adoc
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
== Prerequisites
8
8
9
-
- A running xref:get-started:cluster-types/byoc/index.adoc[BYOC] (not BYOVPC/BYOVNet) or xref:get-started:cluster-types/dedicated/create-dedicated-cloud-cluster.adoc[Dedicated] cluster.
9
+
- A running xref:get-started:cluster-types/byoc/index.adoc[BYOC] or xref:get-started:cluster-types/dedicated/create-dedicated-cloud-cluster.adoc[Dedicated] cluster.
10
10
- An estimate of the throughput of your data pipeline. You can get some basic statistics by running your data pipeline locally using the xref:redpanda-connect:components:processors/benchmark.adoc[`benchmark` processor].
11
11
12
12
=== Understanding compute units
@@ -143,7 +143,7 @@ Data Plane API::
143
143
. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#get-/v1/redpanda-connect/pipelines[`GET /v1/redpanda-connect/pipelines`], which lists details of all pipelines on your cluster by ID.
144
144
+
145
145
* Memory (`memory_shares`) is displayed in megabytes. For example, `1` compute unit is `400M` or 400 MB.
146
-
* CPU resources (`cpu_shares`) are displayed milliCPU. For example, `1` compute unit is `100m` or 0.1 CPU.
146
+
* CPU resources (`cpu_shares`) are displayed in milliCPU. For example, `1` compute unit is `100m` or 0.1 CPU.
147
147
148
148
--
149
149
=====
@@ -182,14 +182,15 @@ curl -X PUT "https://<data-plane-api-url>/v1/redpanda-connect/pipelines/xxx..."
Copy file name to clipboardExpand all lines: modules/develop/pages/connect/configuration/secret-management.adoc
+41-77Lines changed: 41 additions & 77 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,56 +3,31 @@
3
3
4
4
Learn how to manage secrets in Redpanda Connect, and how to add them to your data pipelines without exposing them.
5
5
6
-
Secrets are stored in the secret management solution of your Cloud provider and are retrieved when you run a pipeline configuration that references them.
7
-
8
-
== Prerequisites
9
-
10
-
* A running Serverless, Dedicated, or BYOC (not BYOVPC/BYOVNet) cluster
11
-
* On BYOC clusters only, check that secrets management is enabled:
12
-
13
-
.. Log in to https://cloud.redpanda.com[Redpanda Cloud^].
14
-
.. Go to the **Connect** page.
15
-
.. Select the **Redpanda Connect** tab and make sure you can see a **Secrets** tab.
16
-
17
-
+
18
-
If you cannot see a **Secrets** tab, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^]
6
+
Secrets are stored in the secret management solution of your cloud provider and are retrieved when you run a pipeline configuration that references them.
19
7
20
8
== Manage secrets
21
9
22
-
You can manage secrets from the Cloud UI or Data Plane API.
10
+
You can manage secrets from the Cloud UI or the Data Plane API.
23
11
24
12
=== Create a secret
25
13
26
14
You can create a secret and reference it in multiple data pipelines on the same cluster.
27
15
28
16
[tabs]
29
17
=====
30
-
Cloud UI (BYOC and Dedicated)::
18
+
Cloud UI::
31
19
+
32
20
--
33
21
. Log in to https://cloud.redpanda.com[Redpanda Cloud^].
34
-
. Go to the **Connect** page.
35
-
. Select the **Redpanda Connect** tab and then the **Secrets** tab.
36
-
. Click **Create secret**.
37
-
. In **Secret name**, enter a name for the secret. You cannot rename the secret once it is created.
38
-
. In **Secret value**, enter the secret you need to add.
22
+
. Go to the **Secrets Store** page.
39
23
. Click **Create secret**.
40
-
+
41
-
The secret details are listed in the **Secrets** tab ready to <<add-a-secret-to-a-data-pipeline,add to your data pipelines>>.
42
-
43
-
--
24
+
. For **ID**, enter a name for the secret. You cannot rename the secret once it is created.
25
+
. For **Value**, enter the secret you need to add.
26
+
. For **Scopes**, select Redpanda Connect.
27
+
. Optionally, add labels to help organize your secrets.
28
+
. Click **Create**.
44
29
45
-
Cloud UI (Serverless)::
46
-
+
47
-
--
48
-
. Log in to https://cloud.redpanda.com[Redpanda Cloud^].
49
-
. Go to the **Connect** page.
50
-
. Select the **Secrets** tab and click **Create secret**.
51
-
. In **Secret name**, enter a name for the secret. You cannot rename the secret once it is created.
52
-
. In **Secret value**, enter the secret you need to add.
53
-
. Click **Create secret**.
54
-
+
55
-
The secret details are listed in the **Secrets** tab ready to <<add-a-secret-to-a-data-pipeline,add to your data pipelines>>.
30
+
You can now <<add-a-secret-to-a-data-pipeline,add the secret to your data pipeline>>.
56
31
57
32
--
58
33
@@ -63,7 +38,7 @@ You must use a Base64-encoded secret.
63
38
64
39
. xref:manage:api/cloud-api-quickstart.adoc#try-the-cloud-api[Authenticate and get the base URL] for the Data Plane API.
65
40
. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1/secrets[`POST /v1/secrets`].
66
-
+
41
+
67
42
[,bash]
68
43
----
69
44
curl -X POST "https://<dataplane-api-url>/v1/secrets" \
@@ -72,15 +47,14 @@ curl -X POST "https://<dataplane-api-url>/v1/secrets" \
- `<dataplane-api-url>`: The base URL for the Data Plane API.
79
54
- `<token>`: The API key you generated during authentication.
80
55
- `<secret-name>`: The ID or name of the secret you want to add. Use only the following characters: `^[A-Z][A-Z0-9_]*$`.
81
56
- `<secret-value>`: The Base64-encoded secret.
82
57
- This scope: `"SCOPE_REDPANDA_CONNECT"`.
83
-
84
58
+
85
59
The response returns the name of the secret and the scope `"SCOPE_REDPANDA_CONNECT"`.
86
60
@@ -97,26 +71,13 @@ NOTE: Changes to secret values do not take effect until a pipeline is restarted.
97
71
98
72
[tabs]
99
73
=====
100
-
Cloud UI (BYOC and Dedicated)::
74
+
Cloud UI::
101
75
+
102
76
--
103
77
. Log in to https://cloud.redpanda.com[Redpanda Cloud^].
104
-
. Go to the **Connect** page.
105
-
. Select the **Redpanda Connect** tab and then the **Secrets** tab.
106
-
. Find the secret you want to update and click the edit icon.
107
-
. Enter the new secret value and click **Update Secret**.
108
-
. Start and stop any pipelines that reference the secret.
109
-
110
-
--
111
-
112
-
Cloud UI (Serverless)::
113
-
+
114
-
--
115
-
. Log in to https://cloud.redpanda.com[Redpanda Cloud^].
116
-
. Go to the **Connect** page.
117
-
. Select the **Secrets** tab.
118
-
. Find the secret you want to update and click the edit icon.
119
-
. Enter the new secret value and click **Update Secret**.
78
+
. Go to the **Secrets Store** page.
79
+
. Find the secret you want to update, and click the edit icon.
80
+
. Enter the new secret value or labels, and click **Update**.
120
81
. Start and stop any pipelines that reference the secret.
121
82
122
83
--
@@ -161,24 +122,12 @@ NOTE: Changes do not affect pipelines that are already running.
161
122
162
123
[tabs]
163
124
=====
164
-
Cloud UI (BYOC and Dedicated)::
165
-
+
166
-
--
167
-
. Log in to https://cloud.redpanda.com[Redpanda Cloud^].
168
-
. Go to the **Connect** page.
169
-
. Select the **Redpanda Connect** tab and then the **Secrets** tab.
170
-
. Find the secret you want to remove and click the delete icon.
171
-
. Confirm your deletion.
172
-
173
-
--
174
-
175
-
Cloud UI (Serverless)::
125
+
Cloud UI::
176
126
+
177
127
--
178
128
. Log in to https://cloud.redpanda.com[Redpanda Cloud^].
179
-
. Go to the **Connect** page.
180
-
. Select the **Secrets** tab.
181
-
. Find the secret you want to remove and click the delete icon.
129
+
. Go to the **Secrets Store** page.
130
+
. Find the secret you want to remove, and click the delete icon.
182
131
. Confirm your deletion.
183
132
184
133
--
@@ -207,13 +156,28 @@ You must include the following values:
207
156
208
157
== Add a secret to a data pipeline
209
158
210
-
You can add a secret to any pipeline in your cluster using the notation `${secrets.SECRET_NAME}`. In the Cloud UI, you can copy the notation from the **Secrets** tab.
159
+
[tabs]
160
+
=====
161
+
Cloud UI::
162
+
+
163
+
--
164
+
. Go to the **Connect** page, and create a pipeline (or open an existing pipeline to edit).
165
+
. Click the **Secret** button to add a new or existing secret to the pipeline.
166
+
--
211
167
168
+
Data Plane API::
169
+
+
170
+
--
171
+
You can add a secret to any pipeline in your cluster using the notation `${secrets.SECRET_NAME}`.
0 commit comments