Uploaded image for project: 'Operator Runtime'
  1. Operator Runtime
  2. OPRUN-3070

[upstream] Documentation for semver upgrade edge constraints support

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • None
    • None
    • None
    • Key 245

      Need to create user-facing documentation for initial support for semver upgrade edge constraints which is based on this RFC.

      Acceptance critera:

      • 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

              mradchuk@redhat.com Mikalai Radchuk (Inactive)
              agreene1991 Alexander Greene (Inactive)
              None
              None
              None
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: