Skip to content

AM0001

Jump to bottom
sugarraysam edited this page Dec 28, 2021 · 6 revisions

default_channel

Problematic configuration:

1. (deprecated) defaultChannel is not listed in channels

# addon.yaml
defaultChannel: alpha
channels:
  - currentCSV: dba-operator.v0.1.0
    name: beta

The defaultChannel has to be listed in the channels list. You can ignore this requirement if your bundles live outside of the managed-tenants repository. It was only required to perform legacy builds.

2. defaultChannel is not an accepted enum value

# addon.yaml
defaultChannel: invalid

Accepted enum values are:

  • alpha
  • beta
  • stable
  • edge
  • rc

Please note they differ from OLM recommended channel naming conventions: https://olm.operatorframework.io/docs/best-practices/channel-naming/#recommended-channel-naming

3. defaultChannel does not match the bundle's channel annotations

# addon.yaml
defaultChannel: beta

# metadata/annotations.yaml (bundle X.Y.Z)
annotations:
  operators.operatorframework.io.bundle.channels.v1: alpha,beta
  operators.operatorframework.io.bundle.channel.default.v1: alpha

The operators.operatorframework.io.bundle.channels.v1 annotation is required and has to include defaultChannel. If your bundle supports a single channel, you can omit the operators.operatorframework.io.bundle.channel.default.v1 but we suggest adding it and making sure it matches the defaultChannel value.

Correct configuration:

# addon.yaml
defaultChannel: alpha
channels:
  - currentCSV: dba-operator.v0.1.0
    name: alpha

# metadata/annotations.yaml (bundle X.Y.Z)
annotations:
  operators.operatorframework.io.bundle.channels.v1: alpha,beta
  operators.operatorframework.io.bundle.channel.default.v1: alpha
  • (deprecated) defaultChannel is listed in channels
  • defaultChannel is an accepted enum value ("alpha", "beta", "stable", "edge", "rc")
  • defaultChannel is including in the comma-separated bundle annotation operators.operatorframework.io.bundle.channels.v1
  • defaultChannel matches the bundle annotation operators.operatorframework.io.bundle.channel.default.v1

Related resources:

Clone this wiki locally