-
Notifications
You must be signed in to change notification settings - Fork 48
Rpk shadow #1466
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Rpk shadow #1466
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
16f65dd
add rpk shadow
paulohtb6 edf53d7
add nav
paulohtb6 02dabd8
add cross-ref
paulohtb6 bcf9d65
add whats new
paulohtb6 96d8bf3
update whats new
paulohtb6 e137dcb
Apply suggestions from code review
paulohtb6 5ea90ae
lower case shadow link
paulohtb6 b976af1
fix whats new
paulohtb6 c9c8d2a
Update modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc
paulohtb6 b75dbde
code blocks
paulohtb6 4334049
add single source tags
paulohtb6 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
71 changes: 71 additions & 0 deletions
71
modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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[] | ||
56 changes: 56 additions & 0 deletions
56
modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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[] |
63 changes: 63 additions & 0 deletions
63
modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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[] |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.