K8SPS-849 Documented the support of binlog encryption - #240
Open
nastena1606 wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures the Point-in-Time Recovery (PITR) documentation by separating the conceptual overview from step-by-step restore tutorials, and documents binlog encryption support (including required configuration fields and updated cross-links) across the docs set.
Changes:
- Restructured PITR docs into an overview page plus a dedicated PITR restore tutorial page.
- Documented binlog encryption configuration (cipher/KEK/keyring Secret) and restore-time keyring handling.
- Updated site navigation and adjusted links/anchors across restore, encryption, features, and release notes.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs-base.yml | Updates nav to nest PITR pages under Backup and restore. |
| docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN1.2.0.md | Updates release-notes link to the new PITR restore tutorial page/anchor. |
| docs/backups-encrypted.md | Adds guidance linking encrypted backups vs encrypted binlogs. |
| docs/backups-incremental.md | Updates PITR “How it works” anchor reference. |
| docs/backups-pitr.md | Expands PITR overview and adds binlog encryption section and workflow details. |
| docs/backups-restore-pitr.md | New tutorial covering PITR restore (same-cluster/new-cluster) incl. encrypted binlogs. |
| docs/backups-restore-to-new-cluster.md | Removes PITR tutorial content and points to the dedicated PITR restore page. |
| docs/backups-restore.md | Simplifies same-cluster restore page and points PITR restores to the new tutorial. |
| docs/backups.md | Updates PITR section to link to the new PITR restore tutorial and mentions binlog encryption. |
| docs/debug-backup-restore.md | Adds PITR-specific troubleshooting guidance (jobs, binlog server, encryption/keyring issues). |
| docs/encryption.md | Clarifies binlogs are not covered by data-at-rest encryption and links to binlog encryption docs. |
| docs/features.md | Adds a “Encrypted binlogs” feature bullet linking to PITR binlog encryption section. |
| docs/operator.md | Documents new/updated binlog encryption-related configuration keys. |
| docs/restore-cr.md | Documents restore-time pitr.keyringSecret and updates PITR restore links. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| The Operator must know where to take the backup from. Run this command on the **source cluster**: | ||
|
|
||
| `kubectl get ps-backup -n <source-namespace` |
Comment on lines
+115
to
+118
| * `pitr` section: | ||
|
|
||
| * | ||
|
|
| ## Restore from a backup without point-in-time recovery | ||
| ## Restore from a backup | ||
|
|
||
| When the correct names for the backup and the cluster are known,configure the `PerconaServerMySQLRestore` Custom Resource. Specify the following keys: |
|
|
||
| !!! warning "Keep your encryption keys safe" | ||
|
|
||
| To restore the encrypted data you must have the original key that was used to encrypt it. For data-at-rest encryption, this is the **the original Vault master encryption key**. For encrypted backups, this is the **backup encryption key** from the Kubernetes Secret. |
Restructured PITR docs to have a high-level overview page and PITR tutorials
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN1.2.0.md
modified: docs/backups-encrypted.md
modified: docs/backups-incremental.md
modified: docs/backups-pitr.md
new file: docs/backups-restore-pitr.md
modified: docs/backups-restore-to-new-cluster.md
modified: docs/backups-restore.md
modified: docs/backups.md
modified: docs/debug-backup-restore.md
modified: docs/encryption.md
modified: docs/features.md
modified: docs/operator.md
modified: docs/restore-cr.md
modified: mkdocs-base.yml
Updated links in affected pages
nastena1606
force-pushed
the
K8SPS-849-Doc-binlog-encryption
branch
from
August 27, 2026 15:18
e2b9504 to
cb27096
Compare
nastena1606
marked this pull request as ready for review
August 27, 2026 15:18
nastena1606
requested review from
DhruthiKV,
egegunes,
eleo007,
gkech,
hors,
jvpasinatto,
mayankshah1607,
nmarukovich,
pooknull and
valmiranogueira
as code owners
August 27, 2026 15:18
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Restructured PITR docs to have a high-level overview page and PITR tutorials
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN1.2.0.md
modified: docs/backups-encrypted.md
modified: docs/backups-incremental.md
modified: docs/backups-pitr.md
new file: docs/backups-restore-pitr.md
modified: docs/backups-restore-to-new-cluster.md
modified: docs/backups-restore.md
modified: docs/backups.md
modified: docs/debug-backup-restore.md
modified: docs/encryption.md
modified: docs/features.md
modified: docs/operator.md
modified: docs/restore-cr.md
modified: mkdocs-base.yml
Updated links in affected pages