Skip to content

Commit 4059278

Browse files
authored
DOC-1444 use different property in cluster config example (#322)
* DOC-1444 use different property in cluster config example * typo
1 parent b1c71f0 commit 4059278

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

modules/manage/pages/cluster-maintenance/config-cluster.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ You can set cluster configuration properties using the `rpk` command-line tool o
2828
--
2929
Use `rpk cluster config` to set cluster properties.
3030
31-
For example, to enable data transforms, set xref:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`] to `true`:
31+
For example, to enable audit logging, set xref:reference:properties/cluster-properties.adoc#audit_enabled[`audit_enabled`] to `true`:
3232
3333
[source,bash]
3434
----
35-
rpk cluster config set data_transforms_enabled true
35+
rpk cluster config set audit_enabled true
3636
----
3737
3838
To set a cluster property with a secret, you must use the following notation:
@@ -55,7 +55,7 @@ Use the Cloud API to set cluster properties:
5555
5656
* 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. Include the properties to update in the request body.
5757
58-
For example, to set xref:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`] to `true`:
58+
For example, to set xref:reference:properties/cluster-properties.adoc#audit_enabled[`audit_enabled`] to `true`:
5959
6060
[source,bash]
6161
----
@@ -69,12 +69,12 @@ export RP_CLOUD_TOKEN=`curl -X POST "https://auth.prd.cloud.redpanda.com/oauth/t
6969
-d "client_id=<client-id>" \
7070
-d "client_secret=<client-secret>"`
7171
72-
# Update your cluster configuration to enable data transforms.
72+
# Update your cluster configuration to enable audit logging.
7373
curl -H "Authorization: Bearer ${RP_CLOUD_TOKEN}" -X PATCH \
7474
"https://api.cloud.redpanda.com/v1/clusters/${RP_CLUSTER_ID}" \
7575
-H 'accept: application/json'\
7676
-H 'content-type: application/json' \
77-
-d '{"cluster_configuration":{"custom_properties": {"data_transforms_enabled":true}}}'
77+
-d '{"cluster_configuration":{"custom_properties": {"audit_enabled":true}}}'
7878
----
7979
8080
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. 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.
@@ -111,11 +111,11 @@ You can see the value of a cluster configuration property using `rpk` or the Clo
111111
--
112112
Use `rpk cluster config get` to view the current cluster property value.
113113
114-
For example, to view the current value of xref:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`], run:
114+
For example, to view the current value of xref:reference:properties/cluster-properties.adoc#audit_enabled[`audit_enabled`], run:
115115
116116
[source,bash]
117117
----
118-
rpk cluster config get data_transforms_enabled
118+
rpk cluster config get audit_enabled
119119
----
120120
121121
@@ -125,7 +125,7 @@ Cloud API::
125125
--
126126
Use the Cloud API to get the current configuration property values for a cluster.
127127
128-
Make a xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/clusters/-id-[`GET /clusters/{cluster.id}`] request, passing the cluster ID as a parameter. The response body contains the current `computed_properties` values. For example, to get the current value of xref:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`]:
128+
Make a xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/clusters/-id-[`GET /clusters/{cluster.id}`] request, passing the cluster ID as a parameter. The response body contains the current `computed_properties` values. For example, to get the current value of xref:reference:properties/cluster-properties.adoc#audit_enabled[`audit_enabled`]:
129129
130130
[source,bash]
131131
----

0 commit comments

Comments
 (0)