Skip to content

krknctl backup-restore scripts documentation (tejugang:backup-restore) and (tejugang:feat/backup-restore-s3-from-shared-pr-clean) - #683

Open
tejugang wants to merge 1 commit into
krkn-chaos:mainfrom
tejugang:krknctl-backup-restore-scripts
Open

tejugang wants to merge 1 commit into
krkn-chaos:mainfrom
tejugang:krknctl-backup-restore-scripts

Conversation

@tejugang

@tejugang tejugang commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

Documentation Update

Related Feature:

Changes:

Added documentation for the new krknctl operator backup and krknctl operator restore CLI commands to the krknctl usage page. Includes command descriptions, usage examples, and supported flags tables for both commands.

@netlify

netlify Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for krkn-chaos ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 4050b56
🔍 Latest deploy log https://app.netlify.com/projects/krkn-chaos/deploys/6aeb6355977ac0cb34b9b56f
😎 Deploy Preview https://deploy-preview-683--krkn-chaos.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can turn these tips off under Display > Comment parts

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Document krknctl operator backup and restore commands

📝 Documentation 🕐 10-20 Minutes

Grey Divider

AI Description

• Document operator backup and restore usage, examples, and supported flags.
• Clarify archive contents, restore validation, and the risk of replacing existing resources.
Diagram

graph TD
  Source["Source namespace"] --> Backup["Backup command"] --> Archive[("Backup archive")] --> Restore["Restore command"] --> Target["Target namespace"]
Loading
High-Level Assessment

Adding both commands beside the existing operator usage instructions is appropriate; a separate page would fragment this concise command reference.

Files changed (1) +57 / -0

Documentation (1) +57 / -0
usage.mdDocument operator backup and restore usage +57/-0

Document operator backup and restore usage

• Adds command syntax, examples, and flag tables for backup and restore. Describes excluded backup data, restore validation and update behavior, and warns that restoration replaces existing operator-managed resources.

content/en/docs/krknctl/usage.md

@tejugang
tejugang force-pushed the krknctl-backup-restore-scripts branch from 310db96 to 4aa9d78 Compare October 15, 2026 13:43
@tejugang
tejugang force-pushed the krknctl-backup-restore-scripts branch 2 times, most recently from 2139f03 to da7e594 Compare October 23, 2026 22:23
@tejugang tejugang changed the title krknctl backup-restore scripts documentation (krknctl:backup-restore) krknctl backup-restore scripts documentation (tejugang:backup-restore) Nov 4, 2026
Comment thread content/en/docs/krknctl/usage.md Outdated
|------|---------|-------------|
| `--output` | `.` | Directory to write the backup archive |
| `--kubeconfig` | `~/.kube/config` | Path to kubeconfig |
| `--kind` | `false` | Use the kubeconfig created for a KinD cluster |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its unclear on what this kind. if it is a kind cluster is this required?

@tejugang tejugang Nov 4, 2026 •

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--kind is optional and only needed for kind clusters created through the krknctl operator install command so existing kind clusters can use the default kubeconfig, I can make that more clear

Signed-off-by: Teju Gangisetty <tgangise@redhat.com>
@tejugang
tejugang force-pushed the krknctl-backup-restore-scripts branch from da7e594 to 4050b56 Compare November 4, 2026 16:54
@tejugang tejugang changed the title krknctl backup-restore scripts documentation (tejugang:backup-restore) krknctl backup-restore scripts documentation (tejugang:backup-restore) and (tejugang:feat/backup-restore-s3-from-shared-pr-clean) Nov 4, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Gentle reminder: this PR has been awaiting review for 7 days. @krkn-chaos/krkn-maintainers could you take a look when you get a chance?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants