docs(operations): correct the cozy-default backup override path, add backupStorage to the platform values table#621
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>
|
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 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
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. |
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").
1 participant
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.