Skip to content

Docs: Implement full support for replaces, skips, and skipRange (and make default) #744

@joelanford

Description

@joelanford

User story

As an admin, when I have an installed ClusterExtension, I expect that the upgrade edges defined in the catalog (i.e. replaces, skips, and skipRange) will be honored.

List the user-facing issues in the epic that require documentation.

Does this epic require new content or updates to existing content?

  • Net-new content
  • Update existing content

My assumption is that there are already docs that talk about how OLMv1 uses semver semantics when assessing upgrade successors in a channel. If that's true, those docs need to be updated to talk about replaces, skips, and skipRange.

Even with this new support for replaces, skips, and skipRange, OLMv1 logic is subtly different:

  • In OLMv0 if there are multiple possible successors, the one closest to the channel head is chosen
  • In OLMv1 if there are multiple possible successors, the one with the highest semver version is chosen.

What type of documentation is required for this epic?

  • Release note
  • Concept
  • Procedure
  • Reference
  • Not sure

Is there prior art or reference materials that would help write the documentation?

https://olm.operatorframework.io/docs/concepts/olm-architecture/operator-catalog/creating-an-update-graph/

Documentation should be contributed to the docs/drafts/ directory

Metadata

Metadata

Labels

kind/documentationCategorizes issue or PR as related to documentation.v1.0Issues related to the initial stable release of OLMv1

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions