diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc index 9a5d20a9c8..ccca664eee 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc @@ -29,5 +29,4 @@ rpk cluster config get [flags] |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. -|=== - +|=== \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc index 5463861e71..d3c2eec8d4 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc @@ -1,18 +1,32 @@ = rpk cluster config set +// tag::single-source[] -Set a single cluster configuration property. +Set a cluster configuration property. You can set a single property or multiple properties at once, for example: -This command is provided for use in scripts. For interactive editing, or bulk -changes, use the `edit` and `import` commands respectively. - -You may also use `=` notation for setting configuration properties: +[,bash] +---- +rpk cluster config set audit_enabled true +---- [,bash] ---- -rpk cluster config set log_retention_ms=-1 +rpk cluster config set iceberg_enabled=true iceberg_catalog_type=rest ---- -If an empty string is given as the value, the property is reset to its default. +You must use `=` notation to set multiple properties. + +ifndef::env-cloud[] +If you set the cluster property value to an empty string, the property is reset to its default. + +This command is provided for use in scripts. For interactive editing, or bulk +changes, use the `edit` and `import` commands respectively. +endif::[] + +ifdef::env-cloud[] +The output returns an operation ID. Use the xref:reference:rpk/rpk-cluster/rpk-cluster-config-status.adoc[`status`] command to check the progress of the configuration change. +endif::[] + +For a list of available properties, see xref:reference:properties/cluster-properties.adoc[]. == Usage @@ -54,3 +68,5 @@ Workaround: Use `--` to disable parsing for all subsequent characters. For examp rpk cluster config set -- delete_retention_ms -1 ``` ==== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc index 580a7fcd8c..cd34f333e2 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc @@ -1,15 +1,38 @@ = rpk cluster config status +// tag::single-source[] -Get configuration status of redpanda nodes. +ifndef::env-cloud[] +Get the configuration status of Redpanda brokers. -For each node, indicate whether a restart is required for settings to -take effect, and any settings that the node has identified as invalid -or unknown properties. +For each broker, the command output shows: -Additionally show the version of cluster configuration that each node -has applied: under normal circumstances these should all be equal, -a lower number shows that a node is out of sync, perhaps because it -is offline. +- Whether you need to restart the broker to apply the new settings +- Any settings that the broker has flagged as invalid or unknown + +The command also returns the version of cluster configuration that each broker +has applied. The version should be the same across all brokers, and +it is incremented each time a configuration change is applied to the +cluster. If a broker is using an earlier version as indicated by a lower number, +it may be out of sync with the rest of the cluster. This can happen if a broker +is offline or if it has not yet applied the latest configuration changes. The cluster configuration version number is not the same as the Redpanda version number. +endif::[] + +ifdef::env-cloud[] +Check the progress of a cluster configuration change. + +Some cluster properties require a rolling restart when updated, and it can take several minutes for the update to complete. This command lists the long-running operations run by the update and their status: + +- In progress (running) +- Completed +- Failed + +[,bash,role=no-copy] +---- +OPERATION-ID STATUS STARTED COMPLETED +d0ec1obmpnr7lv17bfpg RUNNING 2025-05-08 14:34:09 +d0ec0sor49uba166af3g RUNNING 2025-05-08 14:32:20 +---- +endif::[] == Usage @@ -37,3 +60,4 @@ rpk cluster config status [flags] |-v, --verbose |- |Enable verbose logging. |=== +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc index 421ea76c87..c91e4074e6 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc @@ -1,24 +1,32 @@ = rpk cluster config +// tag::single-source[] Interact with cluster configuration properties. -Cluster properties are redpanda settings which apply to all nodes in -the cluster. These are separate to node properties, which are set with +ifdef::env-cloud[] +Cluster properties are Redpanda settings that apply to all brokers in +the cluster. +endif::[] + +ifndef::env-cloud[] +Cluster properties are Redpanda settings that apply to all brokers in +the cluster. These are separate from broker properties, which apply to only that broker and are set with `rpk redpanda config`. Use the `edit` subcommand to interactively modify the cluster configuration, or -`export` and `import` to write configuration to a file that can be edited and +`export` and `import` to write the configuration to a file that can be edited and read back later. -These commands take an optional `--all` flag to include all properties including -low level tunables such as internal buffer sizes, that do not usually need +These commands take an optional `--all` flag to include all properties such as +low-level tunables (for example, internal buffer sizes) that do not usually need to be changed during normal operations. These properties generally require -some expertize to set safely, so if in doubt, avoid using `--all`. +some expertise to set safely, so if in doubt, avoid using `--all`. +endif::[] -Modified properties are propagated immediately to all nodes. The `status` -subcommand can be used to verify that all nodes are up to date, and identify -any settings which were rejected by a node, for example if a node is running a -different redpanda version that does not recognize certain properties. +Modified properties are propagated immediately to all brokers. Use the `status` +subcommand to verify that all brokers are up to date and identify +any settings which were rejected by a broker; for example, if the broker is running a +different Redpanda version that does not recognize certain properties. == Usage @@ -46,3 +54,4 @@ rpk cluster config [command] |-v, --verbose |- |Enable verbose logging. |=== +// end::single-source[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc index feb494b6e7..92dd0e47fc 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc @@ -1,6 +1,11 @@ = rpk cluster storage cancel mount // tag::single-source[] +ifdef::env-cloud[] +NOTE: This command is only supported in BYOC and Dedicated clusters. + +endif::[] + Cancels a mount/unmount operation on a topic. Use the migration ID that is emitted when the mount or unmount operation is executed. You can also get the migration ID by listing the mount/unmount operations. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc index 40b9b5dcdf..c2427e78cb 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc @@ -1,7 +1,12 @@ = rpk cluster storage list mount // tag::single-source[] -List mount/unmount operations on a topic in the Redpanda cluster from glossterm:tiered-storage[]. +ifdef::env-cloud[] +NOTE: This command is only supported in BYOC and Dedicated clusters. + +endif::[] + +List mount/unmount operations on a topic in the Redpanda cluster from glossterm:Tiered Storage[]. You can also filter the list by state using the `--filter` flag. The possible states are: diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc index 023f251844..ec6e391a47 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc @@ -1,6 +1,11 @@ = rpk cluster storage list-mountable // tag::single-source[] +ifdef::env-cloud[] +NOTE: This command is only supported in BYOC and Dedicated clusters. + +endif::[] + List topics that are available to mount from object storage. This command displays topics that exist in object storage and can be mounted to your Redpanda cluster. Each topic includes its location in object storage and namespace information if applicable. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc index 087ad39f3f..362b5d5087 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc @@ -1,7 +1,12 @@ = rpk cluster storage mount // tag::single-source[] -Mount a topic to the Redpanda cluster from glossterm:tiered-storage[]. +ifdef::env-cloud[] +NOTE: This command is only supported in BYOC and Dedicated clusters. + +endif::[] + +Mount a topic to the Redpanda cluster from glossterm:Tiered Storage[]. This command mounts a topic in the Redpanda cluster using log segments stored in Tiered Storage. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc index 80db155c18..57bb5fcf92 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc @@ -1,7 +1,12 @@ = rpk cluster storage status mount // tag::single-source[] -Status of mount/unmount operation on topic in a Redpanda cluster from glossterm:tiered-storage[]. +ifdef::env-cloud[] +NOTE: This command is only supported in BYOC and Dedicated clusters. + +endif::[] + +Status of mount/unmount operation on topic in a Redpanda cluster from glossterm:Tiered Storage[]. == Usage diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc index d26343dc3d..2b692affe3 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc @@ -1,7 +1,12 @@ = rpk cluster storage unmount // tag::single-source[] -Unmount a topic from the Redpanda cluster and secure it in glossterm:tiered-storage[]. +ifdef::env-cloud[] +NOTE: This command is only supported in BYOC and Dedicated clusters. + +endif::[] + +Unmount a topic from the Redpanda cluster and secure it in glossterm:Tiered Storage[]. This command performs an operation that: diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc index f53a2f685f..1cdb0b60f3 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc @@ -1,4 +1,10 @@ = rpk cluster storage +// tag::single-source[] + +ifdef::env-cloud[] +NOTE: This command is only supported in BYOC and Dedicated clusters. + +endif::[] Manage the cluster storage. @@ -26,3 +32,4 @@ rpk cluster storage [command] |-v, --verbose |- |Enable verbose logging. |=== +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/partials/rpk-security/rpk-security-secret-create.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-create.adoc new file mode 100644 index 0000000000..83164ff0e4 --- /dev/null +++ b/modules/reference/partials/rpk-security/rpk-security-secret-create.adoc @@ -0,0 +1,66 @@ += rpk security secret create +// tag::single-source[] + +Create a new secret for your cluster. + +Scopes define the areas where the secret can be used. Available scopes are: + +- `redpanda_connect` +- `redpanda_cluster` + +You can set one or both scopes on a secret. + +== Usage + +[,bash] +---- +rpk security secret create [flags] +---- + +== Examples + +To create a secret and set its scope to `redpanda_connect`: + +[,bash] +---- +rpk security secret create --name NETT --value value --scopes redpanda_connect +---- + +To set the scope to both `redpanda_connect` and `redpanda_cluster`: + +[,bash] +---- +rpk security secret create --name NETT2 --value value --scopes redpanda_connect,redpanda_cluster +---- + +You can also pass the scopes as a string: + +[,bash] +---- +rpk security secret create --name NETT2 --value value --scopes "redpanda_connect,redpanda_cluster" +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for create. + +|--name |string |Name of the secret (required). Must be in uppercase and can only contain letters, digits, and underscores. + +|--scopes |stringArray |Scope(s) of the secret, for example, `redpanda_connect` (required). + +|--value |string |Value of the secret (required). + +|--config |string |Redpanda or rpk config file. Default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or run `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--profile |string |rpk profile to use. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/partials/rpk-security/rpk-security-secret-delete.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-delete.adoc new file mode 100644 index 0000000000..f9e3c097cb --- /dev/null +++ b/modules/reference/partials/rpk-security/rpk-security-secret-delete.adoc @@ -0,0 +1,34 @@ += rpk security secret delete +// tag::single-source[] + +Delete an existing secret from your cluster. + +Deleting a secret is irreversible. Ensure you have backups or no longer need the secret before proceeding. + +== Usage + +[,bash] +---- +rpk security secret delete [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for delete. + +|--name |string |Name of the secret to delete (required). + +|--config |string |Redpanda or rpk config file. Default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or run `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--profile |string |rpk profile to use. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/partials/rpk-security/rpk-security-secret-list.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-list.adoc new file mode 100644 index 0000000000..be5f917396 --- /dev/null +++ b/modules/reference/partials/rpk-security/rpk-security-secret-list.adoc @@ -0,0 +1,32 @@ += rpk security secret list +// tag::single-source[] + +List all secrets in your cluster. + +== Usage + +[,bash] +---- +rpk security secret list [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for list. + +|--name-contains |string |Filter secrets whose names contain the specified substring. + +|--config |string |Redpanda or rpk config file. Default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or run `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--profile |string |rpk profile to use. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/partials/rpk-security/rpk-security-secret-update.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-update.adoc new file mode 100644 index 0000000000..7e4c350a48 --- /dev/null +++ b/modules/reference/partials/rpk-security/rpk-security-secret-update.adoc @@ -0,0 +1,59 @@ += rpk security secret update +// tag::single-source[] + +Update an existing secret for your cluster. + +Scopes define the areas where the secret can be used. Available scopes are: + +- `redpanda_connect` +- `redpanda_cluster` + +You can set one or both scopes on a secret. Updating a secret's scopes will overwrite its current scopes. + +== Usage + +[,bash] +---- +rpk security secret update [flags] +---- + +== Examples + +To update the value of the secret: + +[,bash] +---- +rpk security secret update --name NETT --value new_value +---- + +To update the scope of a secret to both `redpanda_connect` and `redpanda_cluster`: + +[,bash] +---- +rpk security secret update --name NETT2 --value value --scopes redpanda_connect,redpanda_cluster +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for update. + +|--name |string |Name of the secret. The name must be in uppercase and can only contain letters, digits, and underscores. You cannot update the name of an existing secret. + +|--scopes |stringArray |Scope(s) of the secret (for example, `redpanda_connect`). + +|--value |string |New value of the secret. + +|--config |string |Redpanda or rpk config file. Default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or run `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--profile |string |rpk profile to use. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/partials/rpk-security/rpk-security-secret.adoc b/modules/reference/partials/rpk-security/rpk-security-secret.adoc new file mode 100644 index 0000000000..ba8f37e581 --- /dev/null +++ b/modules/reference/partials/rpk-security/rpk-security-secret.adoc @@ -0,0 +1,31 @@ += rpk security secret +// tag::single-source[] + +Manage secrets for your cluster. + +== Usage + +[,bash] +---- +rpk security secret [flags] + rpk security secret [command] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for secret. + +|--config |string |Redpanda or rpk config file. Default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or run `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--profile |string |rpk profile to use. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file