Skip to content

Commit bc1decc

Browse files
authored
DOC-1282 rpk cluster config for cloud wasm (#1092)
1 parent 1652101 commit bc1decc

File tree

1 file changed

+32
-5
lines changed

1 file changed

+32
-5
lines changed

modules/develop/pages/data-transforms/build.adoc

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,32 @@ endif::[]
2222
ifdef::env-cloud[]
2323
== Enable data transforms
2424

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

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`.
2847
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:
49+
50+
[source,bash]
3051
----
3152
# Store your cluster ID in a variable
3253
export RP_CLUSTER_ID=<cluster-id>
@@ -46,11 +67,16 @@ curl -H "Authorization: Bearer ${RP_CLOUD_TOKEN}" -X PATCH \
4667
-d '{"cluster_configuration":{"custom_properties": {"data_transforms_enabled":true}}}'
4768
----
4869
49-
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+
======
5076

51-
NOTE: You must restart your cluster if you change this configuration for a running cluster.
5277
endif::[]
5378

79+
5480
[[init]]
5581
== Initialize a data transforms project
5682

@@ -471,6 +497,7 @@ JavaScript::
471497
+
472498
--
473499
The JavaScript SDK does not support writing records to a specific output topic.
500+
474501
--
475502
======
476503

0 commit comments

Comments
 (0)