Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for semver upgrade edge constraints support #470

Closed
m1kola opened this issue Oct 19, 2023 · 0 comments · Fixed by #559
Closed

Documentation for semver upgrade edge constraints support #470

m1kola opened this issue Oct 19, 2023 · 0 comments · Fixed by #559
Labels
documentation Improvements or additions to documentation

Comments

@m1kola
Copy link
Member

m1kola commented Oct 19, 2023

Need to create user-facing documentation for #377 which is based on this RFC.


What we should include:

  • Cover ForceSemverUpgradeConstraints feature gate and mention default state (enabled)
  • Explain how semver upgrades work
    • Extensively cover behaviour of major version zero (see semver spec) which behaves differently fromv versions from >=1.0.0.
    • Explain that setting .spec.upgradeConstraintPolicy to Ignore is a way for upgrading versions in major version zero.
  • Explain legacy OLMv0 semantics or link to the existing docs
    • Might be worth mentioning that at this time we only support Replaces and do not support Skips and SkipRange
  • Explain what .spec.upgradeConstraintPolicy on Operator is for
    • Might be worth adding a warning that this need to be used carefully and independent verification for upgrades is required
    • Potentially mention ability to downgrade packages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant