K8SPXC-1431 Fixed example configuration and finalizer description in the on-demand backup doc #274
Conversation
…the on-demand backup doc Added PXC Backup and Restore Custom Resource options reference doc to align this doc set with the rest of the Operators
nastena1606
requested review from
egegunes,
eleo007,
gkech,
hors,
jvpasinatto,
nmarukovich,
pooknull and
valmiranogueira
as code owners
There was a problem hiding this comment.
Pull request overview
This PR fixes documentation issues in the on-demand backup guide and adds two new Custom Resource (CR) reference documents for backup and restore operations. The changes correct a misspelling in the PR title ("comfiguration"), update the finalizer description from delete-s3-backup to percona.com/delete-backup, and restructure the on-demand backup documentation with improved examples and step-by-step instructions.
Key changes:
- Adds dedicated CR reference documentation for
PerconaXtraDBClusterBackupandPerconaXtraDBClusterRestoreresources - Corrects finalizer naming and updates the on-demand backup guide with clearer instructions
- Removes redundant restore CR documentation from the main operator.md file and fixes storage configuration paths
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs-base.yml | Adds navigation entries for the new backup and restore CR reference pages |
| docs/backup-cr.md | New reference documentation for PerconaXtraDBClusterBackup Custom Resource options |
| docs/restore-cr.md | New reference documentation for PerconaXtraDBClusterRestore Custom Resource options |
| docs/backups-ondemand.md | Rewrites the on-demand backup guide with improved structure, examples, and corrected finalizer reference |
| docs/operator.md | Removes duplicate restore CR documentation and fixes storage configuration paths |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/backups-ondemand.md
Outdated
| 2. Now use *a special backup configuration YAML file* with the following | ||
| keys: | ||
| ```bash | ||
| export NAMESPACE = <namespace> |
There was a problem hiding this comment.
Remove the spaces around the = in the export command. Bash does not allow spaces around the assignment operator.
| export NAMESPACE = <namespace> | |
| export NAMESPACE=<namespace> |
docs/backup-cr.md
Outdated
|
|
||
| ### `containerOptions.args.xbcloud` | ||
|
|
||
| Custom [command line options :octicons-link-external-16:](https://docs.percona.com/percona-xtrabackup/latest/xbcloud-options.html) for the `xbcloud` Percona XtraBackup tool. |
There was a problem hiding this comment.
[nitpick] The URL uses 'latest' in the path, which could point to different versions over time. Consider using 'innovation-release' as in the restore-cr.md file (line 52) for consistency across documentation.
docs/backup-cr.md
Outdated
| * <a name="backup-metadata-name"></a> `name` sets the name of your backup resource; | ||
| * `finalizers` subsection: | ||
|
|
||
| * `percona.com/delete-backup` if present, enables deletion of backup files from a backup storage when the backup object is removed (manually or by schedule). |
There was a problem hiding this comment.
Can we add here that for filesystem the PVC is deleted but not backup in it?
nastena1606
changed the title
docs/backup-cr.md
Outdated
|
|
||
| ### `runningDeadlineSeconds` | ||
|
|
||
| The maximum time in seconds for a backup job to run. The Operator compares the timestamp when the backup job started running against the current time. After the defined running time expires, the backup is automatically marked as "failed". |
There was a problem hiding this comment.
people might confuse this with activeDeadlineSeconds. I think we need to say:
The maximum time in seconds for a backup job to reach Running state.
docs/backup-cr.md
Outdated
|
|
||
| ### `startingDeadlineSeconds` | ||
|
|
||
| The maximum time in seconds for a backup to start. The Operator compares the timestamp of the backup object against the current time. If the backup is not started within the set time, the Operator automatically marks it as "failed". |
There was a problem hiding this comment.
In the same vein with my comment about runningDeadlineSeconds, people might confuse this with runningDeadlineSeconds. I think we need to say:
The maximum time in seconds for a backup job to reach Starting state.
it-percona
temporarily deployed
to
K8SPXC-1431-Doc-backup-finalizer - percona-mysql-operator-pxc PR #274
Render
Destroyed
Added PXC Backup and Restore Custom Resource options reference doc to align this doc set with the rest of the Operators