rpk: update reference with dec 12th (#1515)

Co-authored-by: Michele Cyran <[email protected]>

Author: paulohtb6

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

@@ -43,6 +43,10 @@ rpk cluster config set <key> <value> [flags]
 
 |-h, --help |- |Help for set.
 
+|--no-confirm |- |Disable confirmation prompt.
+
+|--timeout |duration |Maximum time to poll for operation completion before displaying operation ID for manual status checking (for example `300ms`, `1.5s`, `30s`). Default `10s`.
+
 |--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.

modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc

@@ -99,6 +99,8 @@ supported, e.g. 3MB, 1GiB (default `132MB`).
 
 |-h, --help |- |Display documentation for `rpk debug bundle`.
 
+|--kafka-connections-limit |int |The maximum number of Kafka connections to store in the bundle (k8s only). Default `256`.
+
 |-l, --label-selector |stringArray |Comma-separated label selectors to filter your resources. e.g: <label>=<value>,<label>=<value> (k8s only) (default ` [app.kubernetes.io/name=redpanda]`).
 
 |--logs-since |string |Include logs dated from specified date onward. This flag accepts a `journalctl` date format such as `YYYY-MM-DD`, `yesterday`, or `today`. Refer to the link:https://man7.org/linux/man-pages/man1/journalctl.1.html[`journalctl` documentation] for more options (default `yesterday`).

modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc

@@ -27,6 +27,8 @@ rpk debug remote-bundle start [flags]
 
 |-h, --help |- |Help for start.
 
+|--kafka-connections-limit |int |The maximum number of Kafka connections to store in the bundle. Default `256`.
+
 |--job-id |string |Custom UUID assigned to the job that generates the debug bundle.
 
 |-l, --label-selector |stringArray |(K8s only) Comma-separated label selectors to filter your resources. For example: `<label>=<value>,<label>=<value>`  (default `[app.kubernetes.io/name=redpanda]`).

modules/reference/pages/rpk/rpk-iotune.adoc

@@ -24,21 +24,23 @@ rpk iotune [flags]
 
 |--directories |strings |List of directories to evaluate.
 
-|--duration |duration |Duration of tests.The value passed is a sequence
+|--duration |duration |Duration of tests. The value passed is a sequence
 of decimal numbers, each with optional fraction and a unit suffix, such
 as `300ms`, `1.5s` or `2h45m`. Valid time units are `ns`, `us` (or
-`µs`), `ms`, `s`, `m`, `h` (default 10m0s).
+`µs`), `ms`, `s`, `m`, `h` (default `10m0s`).
 
 |-h, --help |- |Help for iotune.
 
+|--iotune-path |string |Path to the iotune executable (default: `iotune-redpanda`).
+
 |--no-confirm |- |Disable confirmation prompt if the iotune file already
 exists.
 
 |--out |string |The file path where the IO config will be written
 (default "/etc/redpanda/io-config.yaml").
 
 |--timeout |duration |The maximum time after -- to wait for iotune to
-complete (e.g. 300ms, 1.5s, 2h45m) (default 1h0m0s).
+complete (for example, `300ms`, `1.5s`, `2h45m`). Default `1h0m0s`.
 
 |--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`.
 

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc

@@ -5,6 +5,10 @@ Generate a configuration file for creating a shadow link.
 
 By default, this command creates a sample configuration file with placeholder values that you customize for your environment.
 
+ifdef::env-cloud[]
+Use the `--for-cloud` flag when generating your configuration.
+endif::[]
+
 Use the `--print-template` flag to generate a configuration template with detailed field documentations.
 
 By default, this command prints the configuration to standard output. Use the `--output` flag to save the configuration to a file.
@@ -53,6 +57,10 @@ rpk shadow config generate --print-template -o shadow-link.yaml
 |===
 |*Value* |*Type* |*Description*
 
+ifdef::env-cloud[]
+|--for-cloud |- |Generate configuration suitable for Cloud deployments.
+
+endif::[]
 |-o, --output |string |File path identifying where to save the generated configuration file. If not specified, prints to standard output.
 
 |--print-template |- |Generate a configuration template with field documentation instead of a sample configuration.

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc

@@ -7,6 +7,12 @@ This command creates a shadow link using a configuration file that defines the c
 
 Before you create a shadow link, generate a configuration file with xref:reference:rpk/rpk-shadow/rpk-shadow-config-generate.adoc[`rpk shadow config generate`] and update it with your source cluster details. The command prompts you to confirm the creation. Use the `--no-confirm` flag to skip the confirmation prompt.
 
+ifdef::env-cloud[]
+When creating a shadow link in Redpanda Cloud, use the `--for-cloud` flag.
+
+First log in and select the cluster where you want to create the shadow link before running this command. See xref:reference:rpk/rpk-cloud/rpk-cloud-login.adoc[`rpk cloud login`] and xref:reference:rpk/rpk-cloud/rpk-cloud-select.adoc[`rpk cloud select`]. For SCRAM authentication, store your password in the shadow cluster's secrets store (using either the cluster's secret store or xref:reference:rpk/rpk-security/rpk-security-secret.adoc[`rpk security secret`]), then reference it in your configuration file using `${secrets.SECRET_NAME}` syntax.
+endif::[]
+
 After you create the shadow link, use xref:reference:rpk/rpk-shadow/rpk-shadow-status.adoc[`rpk shadow status`] to monitor the replication progress.
 
 == Usage

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc

@@ -7,6 +7,10 @@ This command shows the shadow link configuration, including connection settings,
 
 By default, the command displays the overview and client configuration sections. Use the flags to display additional sections such as topic synchronization, consumer offset synchronization, and security synchronization settings.
 
+ifdef::env-cloud[]
+The command uses the Redpanda ID of the cluster you are currently logged into. To use a different cluster, either log in and create a profile for it, or use the `--redpanda-id` flag to specify it directly.
+endif::[]
+
 == Usage
 
 [,bash]

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc

@@ -3,13 +3,13 @@
 
 Failover a Redpanda shadow link.
 
-This command performs a failover operation for a shadow link. Failover converts shadow topics into regular topics on the destination cluster, allowing producers and consumers to interact with them directly. After failover, the shadow link stops replicating data from the source cluster.
+Failover converts shadow topics into regular topics on the shadow cluster, allowing producers and consumers to interact with them directly. After failover, the shadow link stops replicating data from the source cluster.
 
 Use the `--all` flag to failover all shadow topics associated with the shadow link, or use the `--topic` flag to failover a specific topic. You must specify either `--all` or `--topic`.
 
 The command prompts you to confirm the failover operation. Use the `--no-confirm` flag to skip the confirmation prompt.
 
-WARNING: Failover is a critical operation. After failover, shadow topics become regular topics and replication stops. Ensure your applications are ready to connect to the destination cluster before performing a failover.
+WARNING: Failover is a critical operation. After failover, shadow topics become regular topics and replication stops. Ensure your applications are ready to connect to the shadow cluster before performing a failover.
 
 == Usage
 

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc

@@ -18,6 +18,8 @@ rpk shadow list [flags]
 |===
 |*Value* |*Type* |*Description*
 
+|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
+
 |-h, --help |- |Help for list.
 
 |--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`.

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc

@@ -5,7 +5,7 @@ Shows the status of a Redpanda shadow link.
 
 This command shows the current status of a shadow link, including the overall state, task statuses, and per-topic replication progress. Use this command to monitor replication health and track how closely shadow topics follow the source cluster.
 
-By default, the command displays all status sections. Use the flags to display specific sections such as overview, task status, or topic status.
+By default, the command displays all status sections. Use the `--print-*` flags to select specific sections (overview, task status, or topic status). The `--format json|yaml` flag changes only the output format, not which sections are included.
 
 == Usage
 
@@ -38,6 +38,8 @@ rpk shadow status my-shadow-link --print-overview --print-topic
 
 |-a, --print-all |- |Print all sections.
 
+|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
+
 |-o, --print-overview |- |Print the overview section.
 
 |-k, --print-task |- |Print the task status section.