-
Notifications
You must be signed in to change notification settings - Fork 4
DOC-1283 add rpk to config-cluster.adoc #278
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
959cf0e
DOC-1283 add rpk to config-cluster.adoc
micheleRP 18289a7
restructure in tabs
micheleRP f46f001
coderabbit suggestion
micheleRP 6f15b9e
remove rpk stop/start & remove rpk cluster config from list
micheleRP 75c8281
Add rpk to the blurb for What's New
micheleRP d7a09f2
Update modules/manage/pages/cluster-maintenance/config-cluster.adoc
micheleRP b28b3bc
Update modules/manage/pages/cluster-maintenance/config-cluster.adoc
micheleRP 70bd2d6
Update modules/manage/pages/cluster-maintenance/config-cluster.adoc
micheleRP ec146fb
Update modules/manage/pages/cluster-maintenance/config-cluster.adoc
micheleRP 3b1251f
add note back about rolling upgrade
micheleRP 74bcf69
minor edit
micheleRP 308d62b
minor style edits
micheleRP File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
67 changes: 61 additions & 6 deletions
67
modules/manage/pages/cluster-maintenance/config-cluster.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,28 +1,83 @@ | ||
| = Configure Cluster Properties | ||
| :description: Learn how to configure cluster properties to enable and manage features. | ||
|
|
||
| Redpanda cluster configuration properties are automatically set to the default values and are replicated across all brokers. You can edit certain cluster configuration properties with the Cloud API. For example, you can enable and manage xref:manage:iceberg/about-iceberg-topics.adoc[Iceberg topics], xref:develop:data-transforms/index.adoc[data transforms], and xref:manage:audit-logging.adoc[audit logging]. | ||
| Cluster configuration properties are set to their default values and automatically replicated across all brokers. You can use them to enable and manage features such as xref:manage:iceberg/about-iceberg-topics.adoc[Iceberg topics], xref:develop:data-transforms/index.adoc[data transforms], and xref:manage:audit-logging.adoc[audit logging]. | ||
|
|
||
| For a complete list of the cluster configuration properties you can set in Redpanda Cloud, see xref:reference:properties/cluster-properties.adoc[Cluster Configuration Properties]. | ||
|
|
||
| == Limitations | ||
|
|
||
| Cluster configuration with the Cloud API is supported on BYOC and Dedicated clusters running on AWS and GCP. | ||
| Cluster configuration is supported on BYOC and Dedicated clusters running on AWS and GCP. | ||
|
|
||
| - It is not available on Serverless clusters. | ||
| - It is not available on BYOC and Dedicated clusters running on Azure. | ||
|
|
||
| == Set cluster configuration properties | ||
| == Set cluster configuration properties | ||
|
|
||
|
|
||
| [tabs] | ||
| ====== | ||
| `rpk`:: | ||
| + | ||
| -- | ||
| Use `rpk cluster config` to set cluster properties. | ||
|
|
||
| For example, to enable data transforms, set xref:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`] to `true`: | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| rpk cluster config set data_transforms_enabled true | ||
| ---- | ||
|
|
||
| Some properties require a cluster restart for updates to take effect. To restart all brokers, run: | ||
micheleRP marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| You can set cluster configuration properties when you create a cluster, or you can edit an existing cluster. | ||
| [source,bash] | ||
| ---- | ||
| rpk redpanda stop | ||
| rpk redpanda start | ||
| ---- | ||
|
|
||
| -- | ||
| Cloud API:: | ||
| + | ||
| -- | ||
| Use the Cloud API to set cluster properties: | ||
|
|
||
| * 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 with a key-value pair for `custom_properties`. | ||
|
|
||
| * 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. | ||
|
|
||
| For a complete list of the cluster configuration properties you can edit in Redpanda Cloud, see xref:reference:properties/cluster-properties.adoc[Cluster Configuration Properties]. | ||
| For example, to set xref:reference:properties/cluster-properties.adoc#data_transforms_enabled[`data_transforms_enabled`] to `true`: | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| # Store your cluster ID in a variable | ||
|
||
| export RP_CLUSTER_ID=<cluster-id> | ||
|
|
||
| # Retrieve a Redpanda Cloud access token | ||
micheleRP marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| export RP_CLOUD_TOKEN=`curl -X POST "https://auth.prd.cloud.redpanda.com/oauth/token" \ | ||
| -H "content-type: application/x-www-form-urlencoded" \ | ||
| -d "grant_type=client_credentials" \ | ||
| -d "client_id=<client-id>" \ | ||
| -d "client_secret=<client-secret>"` | ||
|
|
||
| # Update cluster configuration to enable data transforms | ||
micheleRP marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| curl -H "Authorization: Bearer ${RP_CLOUD_TOKEN}" -X PATCH \ | ||
| "https://api.cloud.redpanda.com/v1/clusters/${RP_CLUSTER_ID}" \ | ||
| -H 'accept: application/json'\ | ||
| -H 'content-type: application/json' \ | ||
| -d '{"cluster_configuration":{"custom_properties": {"data_transforms_enabled":true}}}' | ||
| ---- | ||
|
|
||
| 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. | ||
|
|
||
| NOTE: You must restart your cluster if you change this configuration for a running cluster. | ||
|
|
||
| NOTE: Some properties require a cluster restart for updates 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. | ||
micheleRP marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| -- | ||
| ====== | ||
|
|
||
| == Suggested reading | ||
|
|
||
| * xref:manage:rpk/intro-to-rpk.adoc[] | ||
micheleRP marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * xref:manage:api/cloud-api-overview.adoc[Redpanda Cloud API Overview] | ||
| * xref:manage:api/cloud-api-quickstart.adoc[Redpanda Cloud API Quickstart] | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove stray
+delimiter linesLines containing just
+appear to be artifacts and will render incorrectly in Asciidoc. Remove these lines so the tab definitions aren't broken.Example diff: