From f5b6e78cb310fe8e8b23224da6c369bc2b501393 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Mon, 5 May 2025 19:44:03 -0400 Subject: [PATCH 01/17] Add rpk security secret content for single source --- .../rpk-security-secret-create.adoc | 66 +++++++++++++++++++ .../rpk-security-secret-delete.adoc | 34 ++++++++++ .../rpk-security-secret-list.adoc | 32 +++++++++ .../rpk-security-secret-update.adoc | 59 +++++++++++++++++ .../rpk/rpk-security/rpk-security-secret.adoc | 31 +++++++++ 5 files changed, 222 insertions(+) create mode 100644 modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc create mode 100644 modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc create mode 100644 modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc create mode 100644 modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc create mode 100644 modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc new file mode 100644 index 0000000000..8489ac6869 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc @@ -0,0 +1,66 @@ += rpk security secret create +// tag::single-source[] + +Create a new secret for your Redpanda Cloud 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. The name must be in uppercase and can only contain letters, digits, and underscores. Required. + +|--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 execute `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/pages/rpk/rpk-security/rpk-security-secret-delete.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc new file mode 100644 index 0000000000..04521a7a5b --- /dev/null +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc @@ -0,0 +1,34 @@ += rpk security secret delete +// tag::single-source[] + +Delete an existing secret from your Redpanda Cloud 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. The name must be in uppercase and can only contain letters, digits, and underscores. + +|--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 execute `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/pages/rpk/rpk-security/rpk-security-secret-list.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc new file mode 100644 index 0000000000..cbcdb9a243 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc @@ -0,0 +1,32 @@ += rpk security secret list +// tag::single-source[] + +List all secrets in your Redpanda Cloud 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 execute `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/pages/rpk/rpk-security/rpk-security-secret-update.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc new file mode 100644 index 0000000000..f5248f3ea2 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc @@ -0,0 +1,59 @@ += rpk security secret update +// tag::single-source[] + +Update an existing secret for your Redpanda Cloud 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 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 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. + +|--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 execute `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/pages/rpk/rpk-security/rpk-security-secret.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc new file mode 100644 index 0000000000..6e547fd577 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc @@ -0,0 +1,31 @@ += rpk security secret +// tag::single-source[] + +Manage secrets for Redpanda Cloud clusters. + +== 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 execute `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 From b847e75039b57182d95241bf525cc750c7ad4725 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Mon, 5 May 2025 19:54:43 -0400 Subject: [PATCH 02/17] Minor edits --- .../pages/rpk/rpk-security/rpk-security-secret-update.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc index f5248f3ea2..8180e91033 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc @@ -8,7 +8,7 @@ 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 will overwrite its current scopes. +You can set one or both scopes on a secret. Updating a secret's scopes will overwrite its current scopes. == Usage @@ -26,7 +26,7 @@ To update the value of the secret: rpk security secret update --name NETT --value new_value ---- -To update the scope of secret to both `redpanda_connect` and `redpanda_cluster`: +To update the scope of a secret to both `redpanda_connect` and `redpanda_cluster`: [,bash] ---- From 75b109381708ff17b224c28b08234fbb27e510d3 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Mon, 5 May 2025 20:00:46 -0400 Subject: [PATCH 03/17] Set cloud-docs branch for preview --- local-antora-playbook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index 0f53a55d6e..0bba820e95 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -17,7 +17,7 @@ content: - url: https://github.com/redpanda-data/docs branches: [v/*, api, shared, site-search,'!v-end-of-life/*'] - url: https://github.com/redpanda-data/cloud-docs - branches: 'main' + branches: '25.1-rpk' - url: https://github.com/redpanda-data/redpanda-labs branches: main start_paths: [docs,'*/docs'] From 8650becd2585e29a58bc75e5d563a860176125e2 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Mon, 5 May 2025 20:32:13 -0400 Subject: [PATCH 04/17] Apply suggestions from automated review --- .../pages/rpk/rpk-security/rpk-security-secret-create.adoc | 6 +++--- .../pages/rpk/rpk-security/rpk-security-secret-delete.adoc | 2 +- .../pages/rpk/rpk-security/rpk-security-secret-list.adoc | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc index 8489ac6869..09497ac407 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc @@ -48,11 +48,11 @@ rpk security secret create --name NETT2 --value value --scopes "redpanda_connect |-h, --help |- |Help for create. -|--name |string |Name of the secret. The name must be in uppercase and can only contain letters, digits, and underscores. Required. +|--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. +|--scopes |stringArray |Scope(s) of the secret, for example, `redpanda_connect` (required). -|--value |string |Value of the secret. 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`. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc index 04521a7a5b..78bdd3b0e4 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc @@ -20,7 +20,7 @@ rpk security secret delete [flags] |-h, --help |- |Help for delete. -|--name |string |Name of the secret to delete. The name must be in uppercase and can only contain letters, digits, and underscores. +|--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`. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc index cbcdb9a243..b687a218e5 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc @@ -18,7 +18,7 @@ rpk security secret list [flags] |-h, --help |- |Help for list. -|--name-contains |string |Filter secrets whose names contain the specified substring.. +|--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`. From ae1804956a374636cfdc83d46e32313f0debff9d Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Tue, 6 May 2025 18:31:12 -0400 Subject: [PATCH 05/17] Single source rpk cluster config commands for Cloud --- .../rpk-cluster/rpk-cluster-config-get.adoc | 3 +-- .../rpk-cluster/rpk-cluster-config-set.adoc | 3 +++ .../rpk-cluster-config-status.adoc | 20 +++++++++++-------- 3 files changed, 16 insertions(+), 10 deletions(-) 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..dfc2a6c2e7 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,4 +1,5 @@ = rpk cluster config set +// tag::single-source[] Set a single cluster configuration property. @@ -54,3 +55,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..248325a918 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,18 @@ = rpk cluster config status +// tag::single-source[] -Get configuration status of redpanda nodes. +Get 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 indicates whether a restart is required for settings to +take effect, and any settings that the broker has identified as invalid +or unknown. -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. +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. == Usage @@ -37,3 +40,4 @@ rpk cluster config status [flags] |-v, --verbose |- |Enable verbose logging. |=== +// end::single-source[] \ No newline at end of file From a29fcb42a54bca4dcf54b2b84957ec27b2fc4597 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Tue, 6 May 2025 18:42:58 -0400 Subject: [PATCH 06/17] Specify that updating the secret name is not possible --- .../pages/rpk/rpk-security/rpk-security-secret-update.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc index 8180e91033..7306eb85d8 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc @@ -41,7 +41,7 @@ rpk security secret update --name NETT2 --value value --scopes redpanda_connect, |-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. +|--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`). From 62cd53934350eff958f3af20145f2cb5bc8afa50 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Tue, 6 May 2025 19:03:47 -0400 Subject: [PATCH 07/17] Forgot single source tag for main cluster config command --- .../rpk/rpk-cluster/rpk-cluster-config.adoc | 29 ++++++++++++------- 1 file changed, 19 insertions(+), 10 deletions(-) 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..1005dba6fb 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 to broker properties, which 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. The `status` +subcommand can be used 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[] From cbb03a00566c837997a7d31f2abfdcb4d5311f47 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Wed, 7 May 2025 11:12:12 -0400 Subject: [PATCH 08/17] Apply suggestions from SME review --- .../rpk/rpk-cluster/rpk-cluster-config-set.adoc | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) 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 dfc2a6c2e7..a4f108bd28 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,10 +1,17 @@ = 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: +[,bash] +---- +rpk cluster config set audit_enabled true data_transforms_enabled true +---- + +ifndef::env-cloud[] This command is provided for use in scripts. For interactive editing, or bulk changes, use the `edit` and `import` commands respectively. +endif::[] You may also use `=` notation for setting configuration properties: @@ -13,7 +20,11 @@ You may also use `=` notation for setting configuration properties: rpk cluster config set log_retention_ms=-1 ---- -If an empty string is given as the value, the property is reset to its default. +ifndef::env-cloud[] +If you set the cluster property value to an empty string, the property is reset to its default. +endif::[] + +For a list of available properties, see xref:reference:properties/cluster-properties.adoc[]. == Usage From afec12fc8383ea872348f1442a7f5a6ab5751d29 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Wed, 7 May 2025 11:28:41 -0400 Subject: [PATCH 09/17] rpk cluster config status has different behavior in Cloud --- .../rpk-cluster/rpk-cluster-config-status.adoc | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) 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 248325a918..ff394b27a3 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,7 +1,8 @@ = rpk cluster config status // tag::single-source[] -Get configuration status of Redpanda brokers. +ifndef::env-cloud[] +Get the configuration status of Redpanda brokers. For each broker, the command output indicates whether a restart is required for settings to take effect, and any settings that the broker has identified as invalid @@ -13,6 +14,18 @@ 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 executed by the update and their status: + +- In progress +- Completed +- Failed + +endif::[] == Usage From b7bcf8533e9c5c25e62e76e8a1594d623ef83efa Mon Sep 17 00:00:00 2001 From: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> Date: Thu, 8 May 2025 15:35:20 -0400 Subject: [PATCH 10/17] Apply suggestions from code review Co-authored-by: Michele Cyran --- .../rpk/rpk-cluster/rpk-cluster-config-status.adoc | 11 ++++++----- .../pages/rpk/rpk-cluster/rpk-cluster-config.adoc | 8 ++++---- .../rpk/rpk-security/rpk-security-secret-create.adoc | 4 ++-- .../rpk/rpk-security/rpk-security-secret-delete.adoc | 4 ++-- .../rpk/rpk-security/rpk-security-secret-list.adoc | 4 ++-- .../rpk/rpk-security/rpk-security-secret-update.adoc | 4 ++-- .../pages/rpk/rpk-security/rpk-security-secret.adoc | 4 ++-- 7 files changed, 20 insertions(+), 19 deletions(-) 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 ff394b27a3..0232a1eaa8 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 @@ -4,12 +4,13 @@ ifndef::env-cloud[] Get the configuration status of Redpanda brokers. -For each broker, the command output indicates whether a restart is required for settings to -take effect, and any settings that the broker has identified as invalid -or unknown. +For each broker, the command output shows: + +- 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 +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 @@ -19,7 +20,7 @@ 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 executed by the update and their status: +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 - Completed 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 1005dba6fb..c91e4074e6 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc @@ -10,7 +10,7 @@ endif::[] ifndef::env-cloud[] Cluster properties are Redpanda settings that apply to all brokers in -the cluster. These are separate to broker properties, which are set with +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 @@ -23,9 +23,9 @@ to be changed during normal operations. These properties generally require some expertise to set safely, so if in doubt, avoid using `--all`. endif::[] -Modified properties are propagated immediately to all brokers. The `status` -subcommand can be used 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 +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 diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc index 09497ac407..63ec00b5c3 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc @@ -54,9 +54,9 @@ rpk security secret create --name NETT2 --value value --scopes "redpanda_connect |--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`. +|--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 execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|-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. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc index 78bdd3b0e4..b288f46ac0 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc @@ -22,9 +22,9 @@ rpk security secret delete [flags] |--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`. +|--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 execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|-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. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc index b687a218e5..0d290da811 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc @@ -20,9 +20,9 @@ rpk security secret list [flags] |--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`. +|--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 execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|-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. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc index 7306eb85d8..d46abc36bc 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc @@ -47,9 +47,9 @@ rpk security secret update --name NETT2 --value value --scopes 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`. +|--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 execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|-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. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc index 6e547fd577..a84e9df0f4 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc @@ -19,9 +19,9 @@ rpk security secret [flags] |-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`. +|--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 execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. +|-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. From e7ec35ebf178e74a39d06a03a9c9f445fc5756a0 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Thu, 8 May 2025 15:38:53 -0400 Subject: [PATCH 11/17] Move rpk security secret to partials --- .../rpk => partials}/rpk-security/rpk-security-secret-create.adoc | 0 .../rpk => partials}/rpk-security/rpk-security-secret-delete.adoc | 0 .../rpk => partials}/rpk-security/rpk-security-secret-list.adoc | 0 .../rpk => partials}/rpk-security/rpk-security-secret-update.adoc | 0 .../{pages/rpk => partials}/rpk-security/rpk-security-secret.adoc | 0 5 files changed, 0 insertions(+), 0 deletions(-) rename modules/reference/{pages/rpk => partials}/rpk-security/rpk-security-secret-create.adoc (100%) rename modules/reference/{pages/rpk => partials}/rpk-security/rpk-security-secret-delete.adoc (100%) rename modules/reference/{pages/rpk => partials}/rpk-security/rpk-security-secret-list.adoc (100%) rename modules/reference/{pages/rpk => partials}/rpk-security/rpk-security-secret-update.adoc (100%) rename modules/reference/{pages/rpk => partials}/rpk-security/rpk-security-secret.adoc (100%) diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-create.adoc similarity index 100% rename from modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc rename to modules/reference/partials/rpk-security/rpk-security-secret-create.adoc diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-delete.adoc similarity index 100% rename from modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc rename to modules/reference/partials/rpk-security/rpk-security-secret-delete.adoc diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-list.adoc similarity index 100% rename from modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc rename to modules/reference/partials/rpk-security/rpk-security-secret-list.adoc diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-update.adoc similarity index 100% rename from modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc rename to modules/reference/partials/rpk-security/rpk-security-secret-update.adoc diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc b/modules/reference/partials/rpk-security/rpk-security-secret.adoc similarity index 100% rename from modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc rename to modules/reference/partials/rpk-security/rpk-security-secret.adoc From 1a28ddff88367d3de322597198e73417dbe936df Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Thu, 8 May 2025 16:32:24 -0400 Subject: [PATCH 12/17] Add example --- .../rpk-cluster/rpk-cluster-config-set.adoc | 20 ++++++++++--------- .../rpk-cluster-config-status.adoc | 8 +++++++- 2 files changed, 18 insertions(+), 10 deletions(-) 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 a4f108bd28..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 @@ -5,23 +5,25 @@ Set a cluster configuration property. You can set a single property or multiple [,bash] ---- -rpk cluster config set audit_enabled true data_transforms_enabled true +rpk cluster config set audit_enabled true ---- -ifndef::env-cloud[] -This command is provided for use in scripts. For interactive editing, or bulk -changes, use the `edit` and `import` commands respectively. -endif::[] - -You may also use `=` notation for setting configuration properties: - [,bash] ---- -rpk cluster config set log_retention_ms=-1 +rpk cluster config set iceberg_enabled=true iceberg_catalog_type=rest ---- +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[]. 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 0232a1eaa8..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 @@ -22,10 +22,16 @@ 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 +- 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 From 570c3630ef1fffa9988c98c2e8f38c3fa45aa092 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Thu, 8 May 2025 16:35:05 -0400 Subject: [PATCH 13/17] Keep description to generic 'cluster' --- .../partials/rpk-security/rpk-security-secret-create.adoc | 2 +- .../partials/rpk-security/rpk-security-secret-delete.adoc | 2 +- .../partials/rpk-security/rpk-security-secret-list.adoc | 2 +- .../partials/rpk-security/rpk-security-secret-update.adoc | 2 +- .../reference/partials/rpk-security/rpk-security-secret.adoc | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/reference/partials/rpk-security/rpk-security-secret-create.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-create.adoc index 63ec00b5c3..83164ff0e4 100644 --- a/modules/reference/partials/rpk-security/rpk-security-secret-create.adoc +++ b/modules/reference/partials/rpk-security/rpk-security-secret-create.adoc @@ -1,7 +1,7 @@ = rpk security secret create // tag::single-source[] -Create a new secret for your Redpanda Cloud cluster. +Create a new secret for your cluster. Scopes define the areas where the secret can be used. Available scopes are: diff --git a/modules/reference/partials/rpk-security/rpk-security-secret-delete.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-delete.adoc index b288f46ac0..f9e3c097cb 100644 --- a/modules/reference/partials/rpk-security/rpk-security-secret-delete.adoc +++ b/modules/reference/partials/rpk-security/rpk-security-secret-delete.adoc @@ -1,7 +1,7 @@ = rpk security secret delete // tag::single-source[] -Delete an existing secret from your Redpanda Cloud cluster. +Delete an existing secret from your cluster. Deleting a secret is irreversible. Ensure you have backups or no longer need the secret before proceeding. diff --git a/modules/reference/partials/rpk-security/rpk-security-secret-list.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-list.adoc index 0d290da811..be5f917396 100644 --- a/modules/reference/partials/rpk-security/rpk-security-secret-list.adoc +++ b/modules/reference/partials/rpk-security/rpk-security-secret-list.adoc @@ -1,7 +1,7 @@ = rpk security secret list // tag::single-source[] -List all secrets in your Redpanda Cloud cluster. +List all secrets in your cluster. == Usage diff --git a/modules/reference/partials/rpk-security/rpk-security-secret-update.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-update.adoc index d46abc36bc..7e4c350a48 100644 --- a/modules/reference/partials/rpk-security/rpk-security-secret-update.adoc +++ b/modules/reference/partials/rpk-security/rpk-security-secret-update.adoc @@ -1,7 +1,7 @@ = rpk security secret update // tag::single-source[] -Update an existing secret for your Redpanda Cloud cluster. +Update an existing secret for your cluster. Scopes define the areas where the secret can be used. Available scopes are: diff --git a/modules/reference/partials/rpk-security/rpk-security-secret.adoc b/modules/reference/partials/rpk-security/rpk-security-secret.adoc index a84e9df0f4..ba8f37e581 100644 --- a/modules/reference/partials/rpk-security/rpk-security-secret.adoc +++ b/modules/reference/partials/rpk-security/rpk-security-secret.adoc @@ -1,7 +1,7 @@ = rpk security secret // tag::single-source[] -Manage secrets for Redpanda Cloud clusters. +Manage secrets for your cluster. == Usage From 43aeaa70722579fac70daf70c39aa0d10ae40d4c Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Fri, 9 May 2025 17:17:37 -0400 Subject: [PATCH 14/17] Fix glossterm for Tiered Storage --- .../pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc | 2 +- .../pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc | 2 +- .../pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc | 2 +- .../pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) 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..e6524f8aac 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,7 @@ = rpk cluster storage list mount // tag::single-source[] -List mount/unmount operations on a topic in the Redpanda cluster from glossterm:tiered-storage[]. +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-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc index 087ad39f3f..4a625b23da 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,7 @@ = rpk cluster storage mount // tag::single-source[] -Mount a topic to the Redpanda cluster from glossterm:tiered-storage[]. +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..5e9912c031 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,7 @@ = rpk cluster storage status mount // tag::single-source[] -Status of mount/unmount operation on topic in a Redpanda cluster from glossterm:tiered-storage[]. +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..37152d8878 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,7 @@ = rpk cluster storage unmount // tag::single-source[] -Unmount a topic from the Redpanda cluster and secure it in glossterm:tiered-storage[]. +Unmount a topic from the Redpanda cluster and secure it in glossterm:Tiered Storage[]. This command performs an operation that: From 79c5a218b45ff22a75ba806dcc371b797478e3e8 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Fri, 9 May 2025 17:26:18 -0400 Subject: [PATCH 15/17] rpk cluster storage missing single source tag --- .../reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc | 2 ++ 1 file changed, 2 insertions(+) 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..3cc9742e4d 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,5 @@ = rpk cluster storage +// tag::single-source[] Manage the cluster storage. @@ -26,3 +27,4 @@ rpk cluster storage [command] |-v, --verbose |- |Enable verbose logging. |=== +// end::single-source[] \ No newline at end of file From 748bd80d17927502b80a780612fba5160c66d40e Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Fri, 9 May 2025 18:38:26 -0400 Subject: [PATCH 16/17] rpk cluster storage commands for mount/unmount are not available in Serverless --- .../rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc | 5 +++++ .../rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc | 5 +++++ .../rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc | 5 +++++ .../pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc | 5 +++++ .../rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc | 5 +++++ .../pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc | 5 +++++ .../reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc | 5 +++++ 7 files changed, 35 insertions(+) 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 e6524f8aac..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,6 +1,11 @@ = rpk cluster storage list mount // tag::single-source[] +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 4a625b23da..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,6 +1,11 @@ = rpk cluster storage mount // tag::single-source[] +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 5e9912c031..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,6 +1,11 @@ = rpk cluster storage status mount // tag::single-source[] +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 37152d8878..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,6 +1,11 @@ = rpk cluster storage unmount // tag::single-source[] +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 3cc9742e4d..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,6 +1,11 @@ = 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. == Usage From 2a770ef9a1961da086d784374e51fc21dc089e0a Mon Sep 17 00:00:00 2001 From: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> Date: Fri, 9 May 2025 19:24:27 -0400 Subject: [PATCH 17/17] Update local-antora-playbook.yml --- local-antora-playbook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index 0bba820e95..0f53a55d6e 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -17,7 +17,7 @@ content: - url: https://github.com/redpanda-data/docs branches: [v/*, api, shared, site-search,'!v-end-of-life/*'] - url: https://github.com/redpanda-data/cloud-docs - branches: '25.1-rpk' + branches: 'main' - url: https://github.com/redpanda-data/redpanda-labs branches: main start_paths: [docs,'*/docs']