K8SPS-96 Documented backup compression#196
Conversation
backup compression
new file: docs/backups-compressed.md
modified: mkdocs-base.yml
There was a problem hiding this comment.
Pull request overview
Adds documentation for backup compression support and exposes it in the MkDocs navigation under the “Backup and restore” section.
Changes:
- Added a new documentation page describing how to enable backup compression for scheduled and on-demand backups.
- Updated MkDocs navigation to include the new “Compress backups” page.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| mkdocs-base.yml | Adds “Compress backups” to the Backup and restore navigation. |
| docs/backups-compressed.md | New documentation page explaining compression configuration and algorithm selection guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
nastena1606
changed the title
nastena1606
requested review from
egegunes,
eleo007,
gkech,
hors,
jvpasinatto,
mayankshah1607,
nmarukovich,
pooknull and
valmiranogueira
as code owners
| | Algorithm | Best for | Pros | Cons | Why choose it | | ||
| |-----------|----------|------|------|---------------| | ||
| | **ZSTD** | Most production environments | Excellent compression ratio, modern algorithm, good balance of speed and size | Slightly higher CPU usage compared to LZ4 | When you want strong compression without significantly impacting backup time | | ||
| | **LZ4** | High‑throughput environments, frequent backups, or CPU‑constrained nodes | Very fast compression and decompression, low CPU overhead | Larger backup size compared to ZSTD | When speed matters more than maximum compression | |
There was a problem hiding this comment.
Should we even mention this option given that we have a known bug with lz4: https://perconadev.atlassian.net/browse/PXB-3568
There was a problem hiding this comment.
Added as a limitation to the release highlights in the release notes. Deatils: https://github.com/percona/k8sps-docs/pull/197/changes#diff-5ef185f53af46f769b292b8aee97ad0d8bdeb2d004d9d939492a0d7336f69d50R37
| | ----------- | ---------- | | ||
| | :material-code-string: string | `s3://bucket-name/backup-destination/` | | ||
|
|
||
| ### `backupSource.compressed` |
There was a problem hiding this comment.
We don't have this cr option at all. Restores work without knowing whether the backup is compressed or not.
There was a problem hiding this comment.
We only have a new field on the ps-backup objects what indicate if the backup is compressed or not. But it is status! Not sure if we are documenting these as well
There was a problem hiding this comment.
Removed. We may need to document the statuses as a separate task
it-percona
temporarily deployed
to
K8SPS-96-Doc-backup-compression - percona-mysql-operator-ps PR #196
Render
Destroyed
|
|
||
| ## Configure compression for on‑demand backups | ||
|
|
||
| For on‑demand backups, define the compression settings directly in the configuration file for the `PerconaServerMySQLBackup` object: |
There was a problem hiding this comment.
Should we mention how someone can do it like we do on PXC, or we can rely only on that mention? WDTY?
it-percona
temporarily deployed
to
K8SPS-96-Doc-backup-compression - percona-mysql-operator-ps PR #196
Render
Destroyed
nastena1606
force-pushed
the
K8SPS-96-Doc-backup-compression
branch
from
9f07104 to
80126ef
Compare
backup compression
new file: docs/backups-compressed.md
modified: mkdocs-base.yml