diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index d504b3aadf..143f2d4bde 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -474,6 +474,15 @@ ***** xref:reference:rpk/rpk-security/rpk-security-user-delete.adoc[] ***** xref:reference:rpk/rpk-security/rpk-security-user-update.adoc[] ***** xref:reference:rpk/rpk-security/rpk-security-user-list.adoc[] +*** xref:reference:rpk/rpk-shadow/rpk-shadow.adoc[] +**** xref:reference:rpk/rpk-shadow/rpk-shadow-config-generate.adoc[] +**** xref:reference:rpk/rpk-shadow/rpk-shadow-create.adoc[] +**** xref:reference:rpk/rpk-shadow/rpk-shadow-delete.adoc[] +**** xref:reference:rpk/rpk-shadow/rpk-shadow-describe.adoc[] +**** xref:reference:rpk/rpk-shadow/rpk-shadow-failover.adoc[] +**** xref:reference:rpk/rpk-shadow/rpk-shadow-list.adoc[] +**** xref:reference:rpk/rpk-shadow/rpk-shadow-status.adoc[] +**** xref:reference:rpk/rpk-shadow/rpk-shadow-update.adoc[] *** xref:reference:rpk/rpk-topic/rpk-topic.adoc[] **** xref:reference:rpk/rpk-topic/rpk-topic-add-partitions.adoc[] **** xref:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[] diff --git a/modules/get-started/pages/release-notes/redpanda.adoc b/modules/get-started/pages/release-notes/redpanda.adoc index 356c7dc543..8efb07488d 100644 --- a/modules/get-started/pages/release-notes/redpanda.adoc +++ b/modules/get-started/pages/release-notes/redpanda.adoc @@ -19,6 +19,7 @@ Redpanda v25.3 introduces xref:deploy:redpanda/manual/disaster-recovery/shadowin The shadow cluster operates in read-only mode while continuously receiving updates from the source cluster. During a disaster, you can failover individual topics or an entire shadow link to make resources fully writable for production traffic. See xref:deploy:redpanda/manual/disaster-recovery/shadowing/failover-runbook.adoc[] for emergency procedures. + == Connected client monitoring You can view details about Kafka client connections using `rpk` or the Admin API ListKafkaConnections endpoint. This allows you to view detailed information about active client connections on a cluster, and identify and troubleshoot problematic clients. For more information, see the xref:manage:cluster-maintenance/manage-throughput.adoc#view-connected-client-details[connected client details] example in the Manage Throughput guide. @@ -49,10 +50,23 @@ You can now generate a security report for your Redpanda cluster using the link: Redpanda v25.3 implements topic identifiers using 16 byte UUIDs as proposed in https://cwiki.apache.org/confluence/display/KAFKA/KIP-516%3A+Topic+Identifiers[KIP-516^]. -== New rpk commands +== New commands + +Redpanda v25.3 introduces new xref:reference:rpk/rpk-shadow/rpk-shadow.adoc[`rpk shadow`] commands for managing Redpanda shadow links: + +* xref:reference:rpk/rpk-shadow/rpk-shadow-config-generate.adoc[`rpk shadow config generate`] - Generate configuration files for shadow links +* xref:reference:rpk/rpk-shadow/rpk-shadow-create.adoc[`rpk shadow create`] - Create new shadow links +* xref:reference:rpk/rpk-shadow/rpk-shadow-update.adoc[`rpk shadow update`] - Update existing shadow link configurations +* xref:reference:rpk/rpk-shadow/rpk-shadow-list.adoc[`rpk shadow list`] - List all shadow links +* xref:reference:rpk/rpk-shadow/rpk-shadow-describe.adoc[`rpk shadow describe`] - View shadow link configuration details +* xref:reference:rpk/rpk-shadow/rpk-shadow-status.adoc[`rpk shadow status`] - Monitor shadow link replication status +* xref:reference:rpk/rpk-shadow/rpk-shadow-failover.adoc[`rpk shadow failover`] - Perform emergency failover operations +* xref:reference:rpk/rpk-shadow/rpk-shadow-delete.adoc[`rpk shadow delete`] - Delete shadow links + +In addition, the following commands have been added: -* **xref:reference:rpk/rpk-cluster/rpk-cluster-connections.adoc[rpk cluster connections]** - Monitor cluster connections and client statistics. -* **xref:reference:rpk/rpk-redpanda/rpk-redpanda-config-print.adoc[rpk redpanda config print]** - Display node configuration. +* xref:reference:rpk/rpk-cluster/rpk-cluster-connections.adoc[`rpk cluster connections`] - Monitor cluster connections and client statistics. +* xref:reference:rpk/rpk-redpanda/rpk-redpanda-config-print.adoc[`rpk redpanda config print`] - Display node configuration. == Deprecations diff --git a/modules/manage/pages/disaster-recovery/shadowing/failover-runbook.adoc b/modules/manage/pages/disaster-recovery/shadowing/failover-runbook.adoc index 442ff4b51b..570ad3b6b1 100644 --- a/modules/manage/pages/disaster-recovery/shadowing/failover-runbook.adoc +++ b/modules/manage/pages/disaster-recovery/shadowing/failover-runbook.adoc @@ -78,6 +78,8 @@ rpk shadow describe rpk shadow status ---- +For detailed command options, see xref:reference:rpk/rpk-shadow/rpk-shadow-list.adoc[`rpk shadow list`], xref:reference:rpk/rpk-shadow/rpk-shadow-describe.adoc[`rpk shadow describe`], and xref:reference:rpk/rpk-shadow/rpk-shadow-status.adoc[`rpk shadow status`]. + Verify that the following conditions exist before proceeding with failover: * Shadow link state should be `ACTIVE`. @@ -86,7 +88,7 @@ Verify that the following conditions exist before proceeding with failover: **Understanding replication lag:** -Use `rpk shadow status ` to check lag, which shows the message count difference between source and shadow partitions: +Use xref:reference:rpk/rpk-shadow/rpk-shadow-status.adoc[`rpk shadow status`] to check lag, which shows the message count difference between source and shadow partitions: * **Acceptable lag examples**: 0-1000 messages for low-throughput topics, 0-10000 messages for high-throughput topics * **Concerning lag examples**: Growing lag over 50,000 messages, or lag that continuously increases without recovering @@ -106,7 +108,7 @@ rpk shadow status > failover-status-$(date +%Y%m%d-%H%M%S).lo // TODO: Verify this output format by running actual rpk shadow status command Example output showing healthy replication before failover: ---- -Shadow Link: +shadow link: Overview: NAME @@ -139,6 +141,8 @@ A complete cluster failover is appropriate If you observe that the source cluste rpk shadow failover --all ---- +For detailed command options, see xref:reference:rpk/rpk-shadow/rpk-shadow-failover.adoc[`rpk shadow failover`]. + For selective topic failover (when only specific services are affected): [,bash] @@ -165,7 +169,7 @@ rpk shadow status --print-topic // TODO: Verify this output format by running actual rpk shadow status command during failover Example output during successful failover: ---- -Shadow Link: +shadow link: Overview: NAME @@ -217,6 +221,8 @@ After all applications are running normally: rpk shadow delete ---- +For detailed command options, see xref:reference:rpk/rpk-shadow/rpk-shadow-delete.adoc[`rpk shadow delete`]. + Document the time of failover initiation and completion, applications affected and recovery times, data loss estimates based on replication lag, and issues encountered during failover. == Troubleshoot common issues diff --git a/modules/manage/pages/disaster-recovery/shadowing/failover.adoc b/modules/manage/pages/disaster-recovery/shadowing/failover.adoc index 6d1850b9f5..83c8a5bf4f 100644 --- a/modules/manage/pages/disaster-recovery/shadowing/failover.adoc +++ b/modules/manage/pages/disaster-recovery/shadowing/failover.adoc @@ -35,7 +35,7 @@ To fail over a specific shadow topic while leaving other topics in the shadow li rpk shadow failover --topic ---- -Use this approach when you need to selectively failover specific workloads or when testing failover procedures. +Use this approach when you need to selectively failover specific workloads or when testing failover procedures. For detailed command options, see xref:reference:rpk/rpk-shadow/rpk-shadow-failover.adoc[`rpk shadow failover`]. === Complete shadow link failover (cluster failover) @@ -88,7 +88,7 @@ Monitor failover progress using the status command: rpk shadow status ---- -The output shows individual topic states and any issues encountered during the failover process. +The output shows individual topic states and any issues encountered during the failover process. For detailed command options, see xref:reference:rpk/rpk-shadow/rpk-shadow-status.adoc[`rpk shadow status`]. **Task states during monitoring:** diff --git a/modules/manage/pages/disaster-recovery/shadowing/monitor.adoc b/modules/manage/pages/disaster-recovery/shadowing/monitor.adoc index c50053490d..ca533b2070 100644 --- a/modules/manage/pages/disaster-recovery/shadowing/monitor.adoc +++ b/modules/manage/pages/disaster-recovery/shadowing/monitor.adoc @@ -28,6 +28,8 @@ View shadow link configuration details: rpk shadow describe ---- +For detailed command options, see xref:reference:rpk/rpk-shadow/rpk-shadow-list.adoc[`rpk shadow list`] and xref:reference:rpk/rpk-shadow/rpk-shadow-describe.adoc[`rpk shadow describe`]. + This command shows the complete configuration of the shadow link, including connection settings, filters, and synchronization options. Check your shadow link status to ensure proper operation: @@ -44,7 +46,7 @@ rpk shadow status rpk shadow status ---- -For troubleshooting specific issues, you can use command options to show individual status sections. See the rpk reference for available status options. +For troubleshooting specific issues, you can use command options to show individual status sections. See xref:reference:rpk/rpk-shadow/rpk-shadow-status.adoc[`rpk shadow status`] for available status options. The status output includes: diff --git a/modules/manage/pages/disaster-recovery/shadowing/setup.adoc b/modules/manage/pages/disaster-recovery/shadowing/setup.adoc index 9f0035943c..7595c72b1b 100644 --- a/modules/manage/pages/disaster-recovery/shadowing/setup.adoc +++ b/modules/manage/pages/disaster-recovery/shadowing/setup.adoc @@ -276,7 +276,7 @@ Use `rpk` to generate a sample configuration file with common filter patterns: rpk shadow config generate --output shadow-config.yaml ---- -This creates a template configuration file that you can customize for your environment. +This creates a template configuration file that you can customize for your environment. For detailed command options, see xref:reference:rpk/rpk-shadow/rpk-shadow-config-generate.adoc[`rpk shadow config generate`]. === Networking @@ -374,6 +374,8 @@ You can establish a shadow link using either xref:get-started:rpk/index.adoc[`rp rpk shadow create --config-file shadow-config.yaml ---- +For detailed command options, see xref:reference:rpk/rpk-shadow/rpk-shadow-create.adoc[`rpk shadow create`]. + === Update an existing shadow link If you need to modify a shadow link configuration after creation, use the update command: @@ -383,6 +385,8 @@ If you need to modify a shadow link configuration after creation, use the update rpk shadow update ---- +For detailed command options, see xref:reference:rpk/rpk-shadow/rpk-shadow-update.adoc[`rpk shadow update`]. + This opens your default editor to modify the shadow link configuration. Only changed fields are updated on the server. The shadow link name cannot be changed - you must delete and recreate the link to rename it. [TIP] diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc new file mode 100644 index 0000000000..99d6fd1d80 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc @@ -0,0 +1,71 @@ += rpk shadow config generate +// tag::single-source[] + +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. + +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. + +After you generate the configuration file, update the placeholder values with your actual connection details and settings. Then use xref:reference:rpk/rpk-shadow/rpk-shadow-create.adoc[`rpk shadow create`] to create the shadow link. + +== Usage + +[,bash] +---- +rpk shadow config generate [flags] +---- + +== Examples + +Generate a sample configuration and print it to standard output: +[,bash] +---- +rpk shadow config generate +---- + +Generate a configuration template with all the field documentation: + +[,bash] +---- +rpk shadow config generate --print-template +---- + +Save the sample configuration to a file: + +[,bash] +---- +rpk shadow config generate -o shadow-link.yaml +---- + +Save the template with documentation to a file: + +[,bash] +---- +rpk shadow config generate --print-template -o shadow-link.yaml +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-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. + +|-h, --help |- |Help for generate. + +|--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 |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc new file mode 100644 index 0000000000..451cfef6d2 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc @@ -0,0 +1,56 @@ += rpk shadow create +// tag::single-source[] + +Creates a Redpanda shadow link. + +This command creates a shadow link using a configuration file that defines the connection details and synchronization settings. + +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. + +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 + +[,bash] +---- +rpk shadow create [flags] +---- + +== Examples + +Create a shadow link using a configuration file: + +[,bash] +---- +rpk shadow create --config-file shadow-link.yaml +---- + +Create a shadow link without a confirmation prompt: + +[,bash] +---- +rpk shadow create -c shadow-link.yaml --no-confirm +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-c, --config-file |string |Path to configuration file to use for the shadow link; use `--help` for details. + +|--no-confirm |- |Disable confirmation prompt. + +|-h, --help |- |Help for create. + +|--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 |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc new file mode 100644 index 0000000000..ccc2dd0ae5 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc @@ -0,0 +1,63 @@ += rpk shadow delete +// tag::single-source[] + +Delete a Redpanda shadow link. + +This command deletes a shadow link by name. By default, you cannot delete a shadow link that has active shadow topics. Use xref:reference:rpk/rpk-shadow/rpk-shadow-failover.adoc[`rpk shadow failover`] first to deactivate topics before deletion, or use the `--force` flag to delete the shadow link and failover all its active shadow topics. + +The command prompts you to confirm the deletion. Use the `--no-confirm` flag to skip the confirmation prompt. The `--force` flag automatically disables the confirmation prompt. + +WARNING: Deleting a shadow link with `--force` permanently removes all shadow topics and stops replication. This operation cannot be undone. + +== Usage + +[,bash] +---- +rpk shadow delete [LINK_NAME] [flags] +---- + +== Examples + +Delete a shadow link: + +[,bash] +---- +rpk shadow delete my-shadow-link +---- + +Delete a shadow link without confirmation: + +[,bash] +---- +rpk shadow delete my-shadow-link --no-confirm +---- + +Force delete a shadow link with active shadow topics: + +[,bash] +---- +rpk shadow delete my-shadow-link --force +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-f, --force |- |If set, forces a delete while there are active shadow topics; disables confirmation prompts as well. + +|--no-confirm |- |Disable confirmation prompt. + +|-h, --help |- |Help for delete. + +|--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 |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc new file mode 100644 index 0000000000..c91c689b6b --- /dev/null +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc @@ -0,0 +1,76 @@ += rpk shadow describe +// tag::single-source[] + +Describes a Redpanda shadow link. + +This command shows the shadow link configuration, including connection settings, synchronization options, and filters. Use the flags to display specific sections or all sections of the configuration. + +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. + +== Usage + +[,bash] +---- +rpk shadow describe [LINK_NAME] [flags] +---- + +== Examples + +Describe a shadow link with default sections (overview and client): + +[,bash] +---- +rpk shadow describe my-shadow-link +---- + +Display all configuration sections: + +[,bash] +---- +rpk shadow describe my-shadow-link --print-all +---- + +Display specific sections: + +[,bash] +---- +rpk shadow describe my-shadow-link --print-overview --print-topic +---- + +Display only the client configuration: + +[,bash] +---- +rpk shadow describe my-shadow-link -c +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-a, --print-all |- |Print all sections. + +|-c, --print-client |- |Print the client configuration section. + +|-r, --print-consumer |- |Print the detailed consumer offset configuration section. + +|-o, --print-overview |- |Print the overview section. + +|-s, --print-security |- |Print the detailed security configuration section. + +|-t, --print-topic |- |Print the detailed topic configuration section. + +|-h, --help |- |Help for describe. + +|--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 |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc new file mode 100644 index 0000000000..1dbf2fe357 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc @@ -0,0 +1,67 @@ += rpk shadow failover +// tag::single-source[] + +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. + +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. + +== Usage + +[,bash] +---- +rpk shadow failover [LINK_NAME] [flags] +---- + +== Examples + +Failover all topics for a shadow link: + +[,bash] +---- +rpk shadow failover my-shadow-link --all +---- + +Failover a specific topic: + +[,bash] +---- +rpk shadow failover my-shadow-link --topic my-topic +---- + +Failover without confirmation: + +[,bash] +---- +rpk shadow failover my-shadow-link --all --no-confirm +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|--all |- |Failover all shadow topics associated with the shadow link. + +|--no-confirm |- |Disable confirmation prompt. + +|--topic |string |Specific topic to failover. If `--all` is not set, at least one topic must be provided. + +|-h, --help |- |Help for failover. + +|--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 |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc new file mode 100644 index 0000000000..54d89ff397 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc @@ -0,0 +1,32 @@ += rpk shadow list +// tag::single-source[] + +Lists Redpanda shadow links. + +This command lists all shadow links on the shadow cluster, showing their names, unique identifiers, and current states. Use this command to get an overview of all configured shadow links and their operational status. + +== Usage + +[,bash] +---- +rpk shadow list [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-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`. + +|-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 |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc new file mode 100644 index 0000000000..a178b93545 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc @@ -0,0 +1,58 @@ += rpk shadow status +// tag::single-source[] + +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. + +== Usage + +[,bash] +---- +rpk shadow status [LINK_NAME] [flags] +---- + +== Examples + +Display the status of a shadow link: + +[,bash] +---- +rpk shadow status my-shadow-link +---- + +Display specific sections: + +[,bash] +---- +rpk shadow status my-shadow-link --print-overview --print-topic +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-a, --print-all |- |Print all sections. + +|-o, --print-overview |- |Print the overview section. + +|-k, --print-task |- |Print the task status section. + +|-t, --print-topic |- |Print the detailed topic status section. + +|-h, --help |- |Help for status. + +|--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 |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc new file mode 100644 index 0000000000..5b6e1a6769 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc @@ -0,0 +1,45 @@ += rpk shadow update +// tag::single-source[] + +Updates a shadow link. + +This command opens your default editor with the current shadow link configuration, and allows you to update the fields you want to change, save the file, and close the editor. The command applies only the changed fields to the shadow link. + +You cannot change the shadow link name. If you need to rename a shadow link, delete it and create a new one with the desired name. + +The editor respects your EDITOR environment variable. If EDITOR is not set, the command uses 'vi' on Unix-like systems. + +== Usage + +[,bash] +---- +rpk shadow update [LINK_NAME] [flags] +---- + +== Examples + +Update a shadow link configuration: + +[,bash] +---- +rpk shadow update my-shadow-link +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for update. + +|--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 |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc new file mode 100644 index 0000000000..42226eab3f --- /dev/null +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc @@ -0,0 +1,29 @@ += rpk shadow + +Manage Redpanda shadow links. + +Shadowing is Redpanda's enterprise-grade disaster recovery solution that establishes asynchronous, offset-preserving replication between two distinct Redpanda clusters. A cluster is able to create a dedicated client that continuously replicates source cluster data, including offsets, timestamps, and cluster metadata. + +== Usage + +[,bash] +---- +rpk shadow [command] [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for shadow. + +|--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 |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