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/data-transforms/build.adoc
+2-45Lines changed: 2 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,57 +22,14 @@ endif::[]
22
22
ifdef::env-cloud[]
23
23
== Enable data transforms
24
24
25
-
Data transforms are disabled on all clusters by default. Before you can deploy data transforms to a cluster, you must first enable the feature with either the `rpk` command-line tool or the Cloud API.
26
-
27
-
[tabs]
28
-
======
29
-
`rpk`::
30
-
+
31
-
--
32
-
Set the `data_transforms_enabled` cluster property to `true`:
25
+
Data transforms are disabled on all clusters by default. Before you can deploy data transforms to a cluster, you must first enable the feature with the `rpk` command-line tool. To enable data transforms, set the xref:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`] cluster property to `true`:
33
26
34
27
[source,bash]
35
28
----
36
29
rpk cluster config set data_transforms_enabled true
37
30
----
38
31
39
-
40
-
NOTE: Some properties require a rolling restart, and it can take several minutes for the update to complete. The `rpk cluster config set` command returns the operation ID.
41
-
42
-
--
43
-
Cloud API::
44
-
+
45
-
--
46
-
Create a cluster by making a xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/clusters[`POST /v1/clusters`] request. Edit `cluster_configuration` in the request body to set xref:ROOT:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`] to `true`.
47
-
48
-
Update a cluster by making a xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /v1/clusters/{cluster.id}`] request, passing the cluster ID as a parameter. For example:
49
-
50
-
[source,bash]
51
-
----
52
-
# Store your cluster ID in a variable
53
-
export RP_CLUSTER_ID=<cluster-id>
54
-
55
-
# Retrieve a Redpanda Cloud access token
56
-
export RP_CLOUD_TOKEN=`curl -X POST "https://auth.prd.cloud.redpanda.com/oauth/token" \
The xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /clusters/{cluster.id}`] request returns the operation ID. You can check the status of the operation by polling the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /operations/\{id}`] endpoint.
71
-
72
-
NOTE: Some properties require a rolling restart for the update to take effect. This triggers a xref:manage:api/cloud-byoc-controlplane-api.adoc#lro[long-running operation] that can take several minutes to complete.
73
-
74
-
--
75
-
======
32
+
NOTE: This property requires a rolling restart, and it can take several minutes for the update to complete.
0 commit comments