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
+32-5Lines changed: 32 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,32 @@ endif::[]
22
22
ifdef::env-cloud[]
23
23
== Enable data transforms
24
24
25
-
Data transforms is disabled on all clusters by default. Before you can deploy data transforms to a cluster, you must first enable the feature.
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
26
27
-
Use the Cloud API to set xref:ROOT:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`] to `true`.
27
+
[tabs]
28
+
======
29
+
`rpk`::
30
+
+
31
+
--
32
+
Set the `data_transforms_enabled` cluster property to `true`:
33
+
34
+
[source,bash]
35
+
----
36
+
rpk cluster config set data_transforms_enabled true
37
+
----
38
+
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`.
28
47
29
-
[,bash]
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:
The xref:api:ROOT:cloud-controlplane-api.adoc#patch-/v1/clusters/-cluster.id-[`PATCH /clusters/{cluster.id}`] request returns the ID of a long-running operation. The operation may take up to ten minutes to complete. 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.
70
+
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
+
======
50
76
51
-
NOTE: You must restart your cluster if you change this configuration for a running cluster.
52
77
endif::[]
53
78
79
+
54
80
[[init]]
55
81
== Initialize a data transforms project
56
82
@@ -471,6 +497,7 @@ JavaScript::
471
497
+
472
498
--
473
499
The JavaScript SDK does not support writing records to a specific output topic.
0 commit comments