25.1 rpk single source

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']

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc

@@ -29,5 +29,4 @@ rpk cluster config get <key> [flags]
 |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
 
 |-v, --verbose |- |Enable verbose logging.
-|===
-
+|===

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[]

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[]

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 (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 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[]

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 (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[]

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[]

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'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 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[]

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[]