docs(operations): correct the cozy-default backup override path, add backupStorage to the platform values table#621
Closed
Andrey Kolkov (androndo) wants to merge 1 commit into
Conversation
…backupStorage to the platform values table The admin-override example on the Backup Classes page told admins to set spec.components.backupstrategy-controller.values on the cozystack.cozystack-platform Package, a path the cozystack operator silently ignores (cozystack/cozystack#3245): that PackageSource exposes only the platform component. cozystack/cozystack#3333 wires the working path — spec.components.platform.values.backupStorage — which the platform chart forwards into the backupstrategy-controller component. Update the example to the working path, explain the forwarding, call out the two plausible-looking paths that do not work, and add the new backupStorage key to the platform-package values reference table. Only the next/ copy is touched: the v1.4 copy stays as-is until the cozystack fix is backported, since no working override path exists on released versions yet. Assisted-By: Claude <noreply@anthropic.com> Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Andrey Kolkov <androndo@gmail.com>
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
11 tasks
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for configuring backup storage in Cozystack. It documents the backupStorage block under the platform package and corrects the override instructions in the backup classes documentation to target the platform component instead of backupstrategy-controller. The review feedback suggests capitalizing "Cozystack" when referring to the operator to maintain consistency with the rest of the documentation.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| - cozy-velero | ||
| ``` | ||
|
|
||
| The platform chart forwards this block into the child `Package cozystack.backupstrategy-controller` as component values, from where the cozystack operator merges it into the `backupstrategy-controller` HelmRelease over the chart defaults. Two paths that look plausible do **not** work: `spec.components.backupstrategy-controller` on the `cozystack.cozystack-platform` Package is silently ignored (the only component under that PackageSource is `platform`), and patching the child `Package cozystack.backupstrategy-controller` directly is reverted whenever the platform helm-reconcile re-renders it. |
Contributor
There was a problem hiding this comment.
For consistency with the rest of the documentation, "Cozystack" should be capitalized when referring to the operator (i.e., "Cozystack operator" instead of "cozystack operator").
Contributor
Author
Andrey Kolkov (androndo)
added a commit
that referenced
this pull request
Jul 20, 2026
…in override path (next + v1.5) (#622) ## What this PR does Supersedes #547 and #621, combining both into one PR based on `main` and covering the documentation versions that actually ship the feature: **`next/` and `v1.5/`**. **Commit 1** (retarget of #547): simplify the backup guides around the platform-provided default strategies and the `cozy-default` BackupClass — a new Backup Classes admin page replaces `managed-app-backup-configuration.md` and `velero-backup-configuration.md`, and the applications / virtualization / velero-addon guides are rewritten around `backupClassName: cozy-default`. Applied to `next/` and ported to `v1.5/` (the v1.5 base pages were identical to the v1.4 ones modulo version refs). **`v1.4/` is untouched**: release-1.4 does not ship `cozy-default` (`packages/system/backupstrategy-controller` there has no default BackupClass/strategy templates and no `backupStorage` values block), so the v1.4 guides for the manual flow remain correct as they are. **Commit 2** (override path + review findings, both versions): the admin-override example documented a path the cozystack operator silently ignores — `spec.components.backupstrategy-controller.values` on the `Package cozystack.cozystack-platform` (cozystack/cozystack#3245). cozystack/cozystack#3333 wires the working path: `spec.components.platform.values.backupStorage`. In `next/` and `v1.5/`: - `operations/services/backup-classes.md` — the override example uses `components.platform.values.backupStorage`, a paragraph explains the forwarding and calls out the two plausible-looking paths that do **not** work; the external-S3 section uses the same platform Package path; `aliases:` frontmatter keeps the deleted pages' permalinks resolving (the release announcements link them as absolute URLs, which Hugo's ref checking cannot see). - `operations/configuration/platform-package.md` — the `spec.components.platform.values.*` reference table gains the new `backupStorage` key. - Review fixes from #622: valid `kubectl wait --for=jsonpath='{.status.phase}'=Available` readiness checks instead of the malformed `= Available` tail, `flux reconcile helmrelease backupstrategy-controller -n cozy-backup-controller` (the namespace the HelmRelease actually lives in — not `cozy-system`), anchor link for the FoundationDB caveat, "Starting with v1.4" phrasing, Etcd mentioned in the tenant guide intro and escalation diagnostics (`etcd.aenix.io/EtcdBackup`), merged duplicate "See also" bullet. ## Merge ordering - **Do not merge before cozystack/cozystack#3333 lands** — until then the documented override path does not work on `main` either. - The `v1.5/` half additionally assumes cozystack/cozystack#3333 is **backported to release-1.5** (the feature ships there; only the values forwarding is missing). #3333 carries the `backport` label for this. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a new **Backup Classes** guide for the platform-managed default `cozy-default` `BackupClass`, covering Postgres, MariaDB, ClickHouse, and **Etcd**, credential projection, tuning, and troubleshooting/observability. * Updated the platform values reference with a **Backup storage** (`backupStorage`) block for `cozy-default`. * Refreshed application and virtualization backup/restore docs to use `cozy-default`, updated cross-references to **Backup Classes**, and clarified the fresh-cluster availability window. * Removed legacy documentation pages for Velero and managed-application backup configuration. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
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
1 participant
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.
What this PR does
Docs follow-up for cozystack/cozystack#3245, fixed by cozystack/cozystack#3333.
The admin-override example on the Backup Classes page (added by #547) documents a path the cozystack operator silently ignores:
spec.components.backupstrategy-controller.valueson thePackage cozystack.cozystack-platform— that PackageSource exposes only theplatformcomponent. cozystack/cozystack#3333 wires the working path:spec.components.platform.values.backupStorage, which the platform chart forwards into thebackupstrategy-controllercomponent.Changes (both in
content/en/docs/next/only):operations/services/backup-classes.md— the override example now usescomponents.platform.values.backupStorage, with a paragraph explaining the forwarding and calling out the two plausible-looking paths that do not work (the old documented one, and patching the childPackage cozystack.backupstrategy-controllerdirectly, which the platform helm-reconcile reverts). Mirrors the upstreamdocs/operations/backup-classes.mdupdate in fix(platform): forward backupStorage overrides to the backupstrategy-controller Package cozystack#3333.operations/configuration/platform-package.md— the hand-writtenspec.components.platform.values.*reference table gains the newbackupStoragekey.Merge ordering
feat/backup-default-class): the Backup Classes page this PR edits is introduced there. When fix(backup): simplify UX with default backupclass #547 merges, GitHub retargets this PR tomain.v1.4copy of the page (also added by fix(backup): simplify UX with default backupclass #547) is deliberately left as-is: no working override path exists on released versions until the cozystack fix is backported. If fix(platform): forward backupStorage overrides to the backupstrategy-controller Package cozystack#3333 gets backported, thev1.4copy should get the same edit; if not, its "Admin overrides" section should probably be softened instead — maintainer's call.