Skip to content

fix(cozystack-upgrade): drop --reuse-values per upstream docs#9

Open
myasnikovdaniil wants to merge 1 commit intomainfrom
fix/cozystack-upgrade-no-reuse-values
Open

fix(cozystack-upgrade): drop --reuse-values per upstream docs#9
myasnikovdaniil wants to merge 1 commit intomainfrom
fix/cozystack-upgrade-no-reuse-values

Conversation

@myasnikovdaniil
Copy link
Copy Markdown
Contributor

Summary

The Cozystack upgrade docs explicitly forbid --reuse-values when upgrading the operator — the cozy-installer chart pins the platform OCI repository in its default values, so reusing old values would keep the new operator pointing at old package versions. The skill currently does the opposite.

  • Remove --reuse-values from the Step 5 helm upgrade command.
  • Replace its rationale with the warning from upstream docs; add helm get values cozystack -n cozy-system so the user can extract any custom overrides (e.g. disableTelemetry) and re-apply them via --set.
  • Flip the corresponding "Common mistakes" entry to warn against --reuse-values instead of recommending it.
  • De-version the cozystack.io/docs/v1/... URLs (they 404) to <vX.Y> placeholders so they don't go stale, and drop the broken #troubleshooting-checklist anchor that doesn't exist on the rendered Hugo page.

Other guidance and commands in SKILL.md and the reference files were checked against the docs — Step 0 (kubectl get packages.cozystack.io cozystack.cozystack-platform -o yaml), Step 4 protect-resources annotations, the chart path, and Step 6 monitor command all match upstream verbatim.

Test plan

  • Visual review of the rendered SKILL.md (Step 5 command + warning, Common mistakes line, doc URLs)
  • Sanity-check that helm get values cozystack -n cozy-system returns the expected user-override shape on a real v1.x cluster

🤖 Generated with Claude Code

The Cozystack upgrade docs explicitly forbid `--reuse-values` when upgrading
the operator: the `cozy-installer` chart pins the platform OCI repository in
its default values, so reusing old values would keep the new operator pointing
at old package versions.

- Remove `--reuse-values` from the Step 5 helm command.
- Replace its rationale with the warning from upstream docs and add
  `helm get values cozystack -n cozy-system` to extract user overrides for
  re-application via `--set` (e.g. `--set disableTelemetry=true`).
- Flip the corresponding "Common mistakes" entry to warn against
  `--reuse-values` instead of recommending it.
- De-version the `cozystack.io/docs/v1/...` references (which 404) to
  `<vX.Y>` placeholders so they don't go stale and the broken
  `#troubleshooting-checklist` anchor is dropped.

Source: https://cozystack.io/docs/v1.3/operations/cluster/upgrade/

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Warning

Rate limit exceeded

@myasnikovdaniil has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 48 minutes and 11 seconds before requesting another review.

To continue reviewing without waiting, purchase usage credits in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d668e5c9-491a-45ea-9d95-1dfada239b4c

📥 Commits

Reviewing files that changed from the base of the PR and between d97a3d4 and 2bf14ff.

📒 Files selected for processing (1)
  • skills/cozystack-upgrade/skills/cozystack-upgrade/SKILL.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/cozystack-upgrade-no-reuse-values

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the Cozystack upgrade documentation by replacing hardcoded version links with placeholders and revising the Helm upgrade instructions. Specifically, it removes the --reuse-values flag and adds a warning that its use can lead to the operator pointing at outdated package versions, instead advising users to fetch and re-apply overrides manually. A review comment suggests reordering these instructions so that the warning and the command to retrieve current values appear before the upgrade command to prevent accidental configuration loss.

Comment on lines 97 to +99
helm upgrade cozystack oci://ghcr.io/cozystack/cozystack/cozy-installer \
--version X.Y.Z \
--namespace cozy-system \
--reuse-values
--namespace cozy-system
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The helm upgrade command is currently positioned before the warning about --reuse-values and the instructions to fetch current overrides. A user following the guide sequentially might execute the upgrade and lose their custom configurations before reading the subsequent explanation and the command to fetch current values.

It is recommended to reorder Step 5 so that the user is prompted to inspect their current values and warned about the risks of --reuse-values before the upgrade command is presented. For example:

Step 5 — Upgrade

First, inspect the currently-installed user-overrides. You will need to re-apply these explicitly during upgrade because do not use --reuse-values (it pins the operator to old package versions).

helm get values cozystack -n cozy-system

Run the upgrade, passing any discovered overrides via --set (e.g., --set disableTelemetry=true):

helm upgrade cozystack oci://ghcr.io/cozystack/cozystack/cozy-installer \
  --version X.Y.Z \
  --namespace cozy-system

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant