Skip to content

Commit 132c8e5

Browse files
authored
DOC-1401 RPCN Secrets navigation change in UI (#386)
* DOC-1401 RPCN Secrets navigation change in UI * minor edit * Incorporate coderabbit suggestions * remove quick-add
1 parent 60f722d commit 132c8e5

File tree

2 files changed

+52
-87
lines changed

2 files changed

+52
-87
lines changed

modules/develop/pages/connect/configuration/resource-management.adoc

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
== Prerequisites
88

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.
1010
- 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].
1111

1212
=== Understanding compute units
@@ -143,7 +143,7 @@ Data Plane API::
143143
. 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.
144144
+
145145
* 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.
147147
148148
--
149149
=====
@@ -182,14 +182,15 @@ curl -X PUT "https://<data-plane-api-url>/v1/redpanda-connect/pipelines/xxx..."
182182
-H 'accept: application/json'\
183183
-H 'authorization: Bearer xxx...' \
184184
-H "content-type: application/json" \
185-
-d '{"config_yaml":"input:\n generate:\n interval: 1s\n mapping: |\n root.id = uuid_v4()\n root. user.name = fake(\"name\")\n root.user.email = fake(\"email\")\n root.content = fake(\"paragraph\")\n\npipeline:\n processors:\n - mutation: |\n root.title = \"PRIVATE AND CONFIDENTIAL\"\n\noutput:\n kafka_franz:\n seed_brokers:\n - seed-j888.byoc.prd.cloud.redpanda.com:9092\n sasl:\n - mechanism: SCRAM-SHA-256\n password: password\n username: connect\n topic: processed-emails\n tls:\n enabled: true\n", \
186-
"description":"Email processor", \
187-
"display_name":"emailprocessor-pipeline", \
188-
"resources":{ \
189-
"memory_shares":"800M" \
190-
"cpu_shares":"200m", \
191-
} \
192-
}'
185+
-d '{
186+
"config_yaml": "input:\n generate:\n interval: 1s\n mapping: |\n root.id = uuid_v4()\n root.user.name = fake(\"name\")\n root.user.email = fake(\"email\")\n root.content = fake(\"paragraph\")\n\npipeline:\n processors:\n - mutation: |\n root.title = \"PRIVATE AND CONFIDENTIAL\"\n\noutput:\n kafka_franz:\n seed_brokers:\n - seed-j888.byoc.prd.cloud.redpanda.com:9092\n sasl:\n mechanism: SCRAM-SHA-256\n password: password\n username: connect\n topic: processed-emails\n tls:\n enabled: true\n",
187+
"description": "Email processor",
188+
"display_name": "emailprocessor-pipeline",
189+
"resources": {
190+
"memory_shares": "800M",
191+
"cpu_shares": "200m"
192+
}
193+
}'
193194
----
194195
+
195196
A successful response shows the updated resource allocations with the `cpu_shares` value returned in milliCPU.

modules/develop/pages/connect/configuration/secret-management.adoc

Lines changed: 41 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -3,56 +3,31 @@
33

44
Learn how to manage secrets in Redpanda Connect, and how to add them to your data pipelines without exposing them.
55

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.
197

208
== Manage secrets
219

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.
2311

2412
=== Create a secret
2513

2614
You can create a secret and reference it in multiple data pipelines on the same cluster.
2715

2816
[tabs]
2917
=====
30-
Cloud UI (BYOC and Dedicated)::
18+
Cloud UI::
3119
+
3220
--
3321
. 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.
3923
. 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**.
4429
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>>.
5631
5732
--
5833
@@ -63,7 +38,7 @@ You must use a Base64-encoded secret.
6338
6439
. xref:manage:api/cloud-api-quickstart.adoc#try-the-cloud-api[Authenticate and get the base URL] for the Data Plane API.
6540
. Make a request to xref:api:ROOT:cloud-dataplane-api.adoc#post-/v1/secrets[`POST /v1/secrets`].
66-
+
41+
6742
[,bash]
6843
----
6944
curl -X POST "https://<dataplane-api-url>/v1/secrets" \
@@ -72,15 +47,14 @@ curl -X POST "https://<dataplane-api-url>/v1/secrets" \
7247
-H 'content-type: application/json' \
7348
-d '{"id":"<secret-name>","scopes":["SCOPE_REDPANDA_CONNECT"],"secret_data":"<secret-value>"}'
7449
----
75-
+
50+
7651
You must include the following values:
7752
7853
- `<dataplane-api-url>`: The base URL for the Data Plane API.
7954
- `<token>`: The API key you generated during authentication.
8055
- `<secret-name>`: The ID or name of the secret you want to add. Use only the following characters: `^[A-Z][A-Z0-9_]*$`.
8156
- `<secret-value>`: The Base64-encoded secret.
8257
- This scope: `"SCOPE_REDPANDA_CONNECT"`.
83-
8458
+
8559
The response returns the name of the secret and the scope `"SCOPE_REDPANDA_CONNECT"`.
8660
@@ -97,26 +71,13 @@ NOTE: Changes to secret values do not take effect until a pipeline is restarted.
9771

9872
[tabs]
9973
=====
100-
Cloud UI (BYOC and Dedicated)::
74+
Cloud UI::
10175
+
10276
--
10377
. 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**.
12081
. Start and stop any pipelines that reference the secret.
12182
12283
--
@@ -161,24 +122,12 @@ NOTE: Changes do not affect pipelines that are already running.
161122

162123
[tabs]
163124
=====
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::
176126
+
177127
--
178128
. 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.
182131
. Confirm your deletion.
183132
184133
--
@@ -207,13 +156,28 @@ You must include the following values:
207156

208157
== Add a secret to a data pipeline
209158

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+
--
211167
168+
Data Plane API::
169+
+
170+
--
171+
You can add a secret to any pipeline in your cluster using the notation `${secrets.SECRET_NAME}`.
212172
For example:
213173
214-
```yml
215-
sasl:
216-
- mechanism: SCRAM-SHA-256
217-
username: "user"
218-
password: "${secrets.PASSWORD}"
219-
```
174+
[,yml]
175+
----
176+
sasl:
177+
- mechanism: SCRAM-SHA-256
178+
username: "user"
179+
password: "${secrets.PASSWORD}"
180+
----
181+
--
182+
=====
183+

0 commit comments

Comments
 (0)