Skip to content

Latest commit

 

History

History
950 lines (850 loc) · 28.4 KB

coast-to-coast-q4-2023.md

File metadata and controls

950 lines (850 loc) · 28.4 KB
Raw

Coast-to-coast Demo for Q4 2023

This coast-to-coast demo highlights some of the new features introduced to OLMv1 in Q4 of 2023.

New Features:

  • Catalog polling
  • Version range support on the spec.version field for ClusterExtension resources
  • Semver upgrade constraint policy
  • BundleDeployment health status

This document will go through an example that highlights each of these new features. Each step will be documented as if you are following along and will be done sequentially. This document will also use some values specific to this example and in your own projects should be replaced to use a different value.

Prerequisites

Prepare for takeoff

Before we can start exploring the new features we need to do some preparation by creating a new extension and building a few different versions.

Create an extension

Note

In this demo, we aren't going to make the extension do anything.

We will create a new extension using the operator-sdk.

  • Create a new directory for the project and cd into it:
mkdir coastal && cd coastal
  • Initialize the project:
operator-sdk init --domain coastal.operatorframework.io
  • Create a new API:
operator-sdk create api \
    --group coastal.operatorframework.io \
    --version v1alpha1 \
    --kind Coast \
    --resource --controller

Build the extension and bundle images

For this demo we are going to build a several different versions of this extension:

  • v1.0.0-alpha1
  • v1.0.0
  • v1.0.1
  • v1.1.0
  • v2.0.0

Initial setup:

  • Create the manifests/ directory for building the plain bundle
  mkdir -p manifests
  • Create a Dockerfile for the plain bundle image
cat << EOF > plainbundle.Dockerfile
FROM scratch
ADD manifests /manifests
EOF

For each of the versions above, perform the following actions:

  • Generate the manifests
  make generate manifests
  • Build the controller image
  make docker-build IMG="quay.io/operator-framework/coastal:{VERSION}"
  • Populate the manifests/ directory for building the plain bundle
  kustomize build config/default > manifests/manifests.yaml
  • Build the plain bundle image
docker build -t quay.io/operator-framework/coastal-bundle:{VERSION} -f plainbundle.Dockerfile .
  • Push the controller image and plain bundle image
docker push quay.io/operator-framework/coastal:{VERSION} && \
docker push quay.io/operator-framework/coastal-bundle:{VERSION}

A handy little script to run all these steps for you:

#!/usr/bin/env bash
set -e

mkdir -p manifests

cat << EOF > plainbundle.Dockerfile
FROM scratch
ADD manifests /manifests
EOF

versions=( v1.0.0-alpha1 v1.0.0 v1.0.1 v1.1.0 v2.0.0 )
for version in "${versions[@]}"
do
  make generate manifests
  make docker-build IMG="quay.io/operator-framework/coastal:${version}"
  mkdir -p manifests
  kustomize build config/default > manifests/manifests.yaml
  docker build -t "quay.io/operator-framework/coastal-bundle:${version}" -f plainbundle.Dockerfile .
  docker push "quay.io/operator-framework/coastal:${version}"
  docker push "quay.io/operator-framework/coastal-bundle:${version}"
done

Create an initial File-Based Catalog (FBC) Image

Now we need to build and push an initial File-Based Catalog (FBC) image containing our bundles. To help highlight the new polling functionality, we will generate a catalog containing only the v1.0.0-alpha1 bundle and we will mimic active development by incrementally updating the catalog image to include more of our bundles.

  • Create a catalog/ directory
mkdir catalog
  • Create a Dockerfile for the catalog image
cat << EOF > catalog.Dockerfile
FROM scratch
ADD catalog /configs
LABEL operators.operatorframework.io.index.configs.v1=/configs
EOF
  • Create the FBC YAML file
cat << EOF > catalog/index.yaml
schema: olm.package
name: coastal
---
schema: olm.bundle
name: coastal.v1.0.0-alpha1
package: coastal
image: quay.io/operator-framework/coastal-bundle:v1.0.0-alpha1
properties:
  - type: olm.package
    value:
      packageName: coastal
      version: 1.0.0-alpha1
  - type: olm.bundle.mediatype
    value: plain+v0
---
schema: olm.channel
name: stable
package: coastal
entries:
  - name: coastal.v1.0.0-alpha1
EOF
  • Build and push the catalog image
docker build -t quay.io/operator-framework/coastal-catalog:latest -f catalog.Dockerfile . && \
docker push quay.io/operator-framework/coastal-catalog:latest

Create a Catalog Resource

Create a Catalog resource that references the catalog image we built in the previous step and specify a polling interval of 15 seconds. This will make sure that the updates we make to the catalog image are reflected on our cluster relatively quickly.

  • Create the Catalog resource:
kubectl apply -f - <<EOF
apiVersion: catalogd.operatorframework.io/v1alpha1
kind: Catalog
metadata:
  name: coastal
spec:
  source:
    type: image
    image:
      ref: quay.io/operator-framework/coastal-catalog:latest
      pollInterval: 15s
EOF

Only install/upgrade to v1.0.z releases

In this section we are going to create a ClusterExtension resource that attempts to install our extension with a version range of 1.0.x. This version range ensures we only install z-stream releases for v1.0 excluding pre-release versions.

  • Create the ClusterExtension resource:
kubectl apply -f - <<EOF
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  name: coastal
spec:
  packageName: coastal
  version: 1.0.x
EOF

We should see the ClusterExtension resource eventually has a failed resolution status. Verify this with:

kubectl get clusterextension/coastal -o yaml -w
Example 
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"coastal"},"spec":{"packageName":"coastal","version":"1.0.x"}}
  creationTimestamp: "2023-11-27T20:29:18Z"
  generation: 1
  name: coastal
  resourceVersion: "2983"
  uid: 48d16240-edae-4904-bad8-58137bebcf8a
spec:
  packageName: coastal
  upgradeConstraintPolicy: Enforce
  version: 1.0.x
status:
  conditions:
  - lastTransitionTime: "2023-11-27T20:29:18Z"
    message: installation has not been attempted as resolution failed
    observedGeneration: 1
    reason: InstallationStatusUnknown
    status: Unknown
    type: Installed
  - lastTransitionTime: "2023-11-27T20:29:18Z"
    message: no package "coastal" matching version "1.0.x" found
    observedGeneration: 1
    reason: ResolutionFailed
    status: "False"
    type: Resolved

Note

The above command establishes a watch on the ClusterExtension resource and blocks. Once you are done verifying the resolution status you can exit the command with ctrl+c

Update the FBC Image to contain a bundle for v1.0.0

To highlight both the polling functionality and the version range constraints, let's add the v1.0.0 bundle of our extension to the catalog image we created in the preparation steps and push the changes.

  • Add the new bundle to the catalog YAML file
cat << EOF >> catalog/index.yaml
---
schema: olm.bundle
name: coastal.v1.0.0
package: coastal
image: quay.io/operator-framework/coastal-bundle:v1.0.0
properties:
  - type: olm.package
    value:
      packageName: coastal
      version: 1.0.0
  - type: olm.bundle.mediatype
    value: plain+v0
EOF
  • Using yq, update the channel to include this bundle as an entry
yq eval 'select(.schema=="olm.channel" and .name == "stable").entries += [{"name" : "coastal.v1.0.0"}]' -i catalog/index.yaml
  • Build and push the catalog image
docker build -t quay.io/operator-framework/coastal-catalog:latest -f catalog.Dockerfile . && \
docker push quay.io/operator-framework/coastal-catalog:latest

Shortly, we should see that the Catalog resource updates to have a new resolved reference and the ClusterExtension resource we created previously is successfully installed.

Verify this for the ClusterExtension with:

kubectl get clusterextension/coastal -o yaml -w
Example 
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"coastal"},"spec":{"packageName":"coastal","version":"1.0.x"}}
  creationTimestamp: "2023-11-27T20:29:18Z"
  generation: 1
  name: coastal
  resourceVersion: "3875"
  uid: 48d16240-edae-4904-bad8-58137bebcf8a
spec:
  packageName: coastal
  upgradeConstraintPolicy: Enforce
  version: 1.0.x
status:
  conditions:
  - lastTransitionTime: "2023-11-27T20:34:53Z"
    message: installed from "docker.io/bpalmer/coastal-bundle:v1.0.0"
    observedGeneration: 1
    reason: Success
    status: "True"
    type: Installed
  - lastTransitionTime: "2023-11-27T20:34:49Z"
    message: resolved to "docker.io/bpalmer/coastal-bundle:v1.0.0"
    observedGeneration: 1
    reason: Success
    status: "True"
    type: Resolved
  installedBundleResource: docker.io/bpalmer/coastal-bundle:v1.0.0
  resolvedBundleResource: docker.io/bpalmer/coastal-bundle:v1.0.0

and for the Catalog with:

kubectl get catalog/coastal -o yaml -w
Example 
apiVersion: catalogd.operatorframework.io/v1alpha1
kind: Catalog
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"catalogd.operatorframework.io/v1alpha1","kind":"Catalog","metadata":{"annotations":{},"name":"coastal"},"spec":{"source":{"image":{"pollInterval":"15s","ref":"docker.io/bpalmer/coastal-catalog:latest"},"type":"image"}}}
  creationTimestamp: "2023-11-27T20:23:55Z"
  finalizers:
  - catalogd.operatorframework.io/delete-server-cache
  generation: 1
  name: coastal
  resourceVersion: "4173"
  uid: 0bb0ca54-bdfe-4c55-abeb-03b8e3f32374
spec:
  source:
    image:
      pollInterval: 15s
      ref: docker.io/bpalmer/coastal-catalog:latest
    type: image
status:
  conditions:
  - lastTransitionTime: "2023-11-27T20:23:57Z"
    message: ""
    reason: UnpackSuccessful
    status: "True"
    type: Unpacked
  contentURL: http://catalogd-catalogserver.catalogd-system.svc/catalogs/coastal/all.json
  observedGeneration: 1
  phase: Unpacked
  resolvedSource:
    image:
      lastPollAttempt: "2023-11-27T20:36:22Z"
      ref: docker.io/bpalmer/coastal-catalog:latest
      resolvedRef: index.docker.io/bpalmer/coastal-catalog@sha256:b8cb9a4a61f57b59394047cab94f5b4ef1083493809f8180125faedaab17c71d
    type: image

Once the ClusterExtension has been successfully installed we can verify that all the resources created are healthy by checking the BundleDeployment resource owned by the ClusterExtension we created. Verify the BundleDeployment has a status condition showing whether or not it is healthy with:

kubectl get bundledeployment/coastal -o yaml -w
Example 
apiVersion: core.rukpak.io/v1alpha1
kind: BundleDeployment
metadata:
  creationTimestamp: "2023-11-27T20:34:49Z"
  generation: 2
  name: coastal
  ownerReferences:
  - apiVersion: olm.operatorframework.io/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: ClusterExtension
    name: coastal
    uid: 48d16240-edae-4904-bad8-58137bebcf8a
  resourceVersion: "3935"
  uid: 7e487080-15c3-4e56-8789-9a9b516e98b7
spec:
  provisionerClassName: core-rukpak-io-plain
  template:
    metadata: {}
    spec:
      provisionerClassName: core-rukpak-io-plain
      source:
        image:
          ref: docker.io/bpalmer/coastal-bundle:v1.0.0
        type: image
status:
  activeBundle: coastal-v725xf
  conditions:
  - lastTransitionTime: "2023-11-27T20:34:49Z"
    message: Successfully unpacked the coastal-v725xf Bundle
    reason: UnpackSuccessful
    status: "True"
    type: HasValidBundle
  - lastTransitionTime: "2023-11-27T20:34:53Z"
    message: Instantiated bundle coastal-v725xf successfully
    reason: InstallationSucceeded
    status: "True"
    type: Installed
  - lastTransitionTime: "2023-11-27T20:35:04Z"
    message: BundleDeployment is healthy
    reason: Healthy
    status: "True"
    type: Healthy
  observedGeneration: 2

Update the FBC Image to contain a bundle for v1.1.0

Let's ensure that adding a bundle with a version of v1.1.0 does not trigger an upgrade.

  • Add the new bundle to the catalog YAML file
cat << EOF >> catalog/index.yaml
---
schema: olm.bundle
name: coastal.v1.1.0
package: coastal
image: quay.io/operator-framework/coastal-bundle:v1.1.0
properties:
  - type: olm.package
    value:
      packageName: coastal
      version: 1.1.0
  - type: olm.bundle.mediatype
    value: plain+v0
EOF
  • Using yq, update the channel to include this bundle as an entry
yq eval 'select(.schema=="olm.channel" and .name == "stable").entries += [{"name" : "coastal.v1.1.0"}]' -i catalog/index.yaml
  • Build and push the catalog image
docker build -t quay.io/operator-framework/coastal-catalog:latest -f catalog.Dockerfile . && \
docker push quay.io/operator-framework/coastal-catalog:latest

Similar to the previous procedure, the Catalog updates its resolved reference, but the ClusterExtension resource remains the same and does not automatically upgrade to v1.1.0

Update the FBC Image to contain a bundle for v1.0.1

Lets add the v1.0.1 bundle to our catalog and ensure it automatically upgrades within the z-stream.

  • Add the new bundle to the catalog YAML file
cat << EOF >> catalog/index.yaml
---
schema: olm.bundle
name: coastal.v1.0.1
package: coastal
image: quay.io/operator-framework/coastal-bundle:v1.0.1
properties:
  - type: olm.package
    value:
      packageName: coastal
      version: 1.0.1
  - type: olm.bundle.mediatype
    value: plain+v0
EOF
  • Using yq, update the channel to include this bundle as an entry
yq eval 'select(.schema=="olm.channel" and .name == "stable").entries += [{"name" : "coastal.v1.0.1"}]' -i catalog/index.yaml
  • Build and push the catalog image
docker build -t quay.io/operator-framework/coastal-catalog:latest -f catalog.Dockerfile . && \
docker push quay.io/operator-framework/coastal-catalog:latest

Once again, we should see the Catalog update its resolved reference. This time, we expect that the ClusterExtension resource is automatically upgraded to the new v1.0.1 bundle we added.

Example Catalog 
apiVersion: catalogd.operatorframework.io/v1alpha1
kind: Catalog
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"catalogd.operatorframework.io/v1alpha1","kind":"Catalog","metadata":{"annotations":{},"name":"coastal"},"spec":{"source":{"image":{"pollInterval":"15s","ref":"docker.io/bpalmer/coastal-catalog:latest"},"type":"image"}}}
  creationTimestamp: "2023-11-27T20:23:55Z"
  finalizers:
  - catalogd.operatorframework.io/delete-server-cache
  generation: 1
  name: coastal
  resourceVersion: "4776"
  uid: 0bb0ca54-bdfe-4c55-abeb-03b8e3f32374
spec:
  source:
    image:
      pollInterval: 15s
      ref: docker.io/bpalmer/coastal-catalog:latest
    type: image
status:
  conditions:
  - lastTransitionTime: "2023-11-27T20:23:57Z"
    message: ""
    reason: UnpackSuccessful
    status: "True"
    type: Unpacked
  contentURL: http://catalogd-catalogserver.catalogd-system.svc/catalogs/coastal/all.json
  observedGeneration: 1
  phase: Unpacked
  resolvedSource:
    image:
      lastPollAttempt: "2023-11-27T20:39:45Z"
      ref: docker.io/bpalmer/coastal-catalog:latest
      resolvedRef: index.docker.io/bpalmer/coastal-catalog@sha256:8affa0e6ca81e07bb9d03b934173687f63015d8b36fac3ba3391a942b23cc3ee
    type: image
Example ClusterExtension 
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"coastal"},"spec":{"packageName":"coastal","version":"1.0.x"}}
  creationTimestamp: "2023-11-27T20:29:18Z"
  generation: 1
  name: coastal
  resourceVersion: "4778"
  uid: 48d16240-edae-4904-bad8-58137bebcf8a
spec:
  packageName: coastal
  upgradeConstraintPolicy: Enforce
  version: 1.0.x
status:
  conditions:
  - lastTransitionTime: "2023-11-27T20:34:53Z"
    message: installed from "docker.io/bpalmer/coastal-bundle:v1.0.1"
    observedGeneration: 1
    reason: Success
    status: "True"
    type: Installed
  - lastTransitionTime: "2023-11-27T20:34:49Z"
    message: resolved to "docker.io/bpalmer/coastal-bundle:v1.0.1"
    observedGeneration: 1
    reason: Success
    status: "True"
    type: Resolved
  installedBundleResource: docker.io/bpalmer/coastal-bundle:v1.0.1
  resolvedBundleResource: docker.io/bpalmer/coastal-bundle:v1.0.1

Change version range to pin installs/upgrades to v1.1.z releases

Making changes to the ClusterExtension resource should result in a re-reconciliation of the resource which should result in another resolution loop. To see this, let's update the version range on our ClusterExtension resource to 1.1.x with:

kubectl apply -f - <<EOF
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  name: coastal
spec:
  packageName: coastal
  version: 1.1.x
EOF

After this change has been applied, the ClusterExtension resource is updated and says that we have installed the v1.1.0 bundle.

You can watch this change happen with:

kubectl get clusterextension/coastal -o yaml -w
Example 
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"coastal"},"spec":{"packageName":"coastal","version":"1.1.x"}}
  creationTimestamp: "2023-11-27T20:29:18Z"
  generation: 2
  name: coastal
  resourceVersion: "5251"
  uid: 48d16240-edae-4904-bad8-58137bebcf8a
spec:
  packageName: coastal
  upgradeConstraintPolicy: Enforce
  version: 1.1.x
status:
  conditions:
  - lastTransitionTime: "2023-11-27T20:34:53Z"
    message: installed from "docker.io/bpalmer/coastal-bundle:v1.1.0"
    observedGeneration: 2
    reason: Success
    status: "True"
    type: Installed
  - lastTransitionTime: "2023-11-27T20:34:49Z"
    message: resolved to "docker.io/bpalmer/coastal-bundle:v1.1.0"
    observedGeneration: 2
    reason: Success
    status: "True"
    type: Resolved
  installedBundleResource: docker.io/bpalmer/coastal-bundle:v1.1.0
  resolvedBundleResource: docker.io/bpalmer/coastal-bundle:v1.1.0

Attempting a major version upgrade by changing the version range

The operator-controller follows semver and prevents automatic upgrades to new major versions when a ClusterExtension's spec.upgradeConstraintPolicy is set to Enforce. New major versions might have breaking changes and could cause problems for users. Let's add a new major version of our bundle to the catalog image and update the version range on the ClusterExtension.

Update the FBC Image to contain a bundle for v2.0.0

  • Add the new bundle to the catalog YAML file
cat << EOF >> catalog/index.yaml
---
schema: olm.bundle
name: coastal.v2.0.0
package: coastal
image: quay.io/operator-framework/coastal-bundle:v2.0.0
properties:
  - type: olm.package
    value:
      packageName: coastal
      version: 2.0.0
  - type: olm.bundle.mediatype
    value: plain+v0
EOF
  • Using yq, update the channel to include this bundle as an entry
yq eval 'select(.schema=="olm.channel" and .name == "stable").entries += [{"name" : "coastal.v2.0.0"}]' -i catalog/index.yaml
  • Build and push the catalog image
docker build -t quay.io/operator-framework/coastal-catalog:latest -f catalog.Dockerfile . && \
docker push quay.io/operator-framework/coastal-catalog:latest

The Catalog updates its resolved reference and no changes are applied to the ClusterExtension resource.

Updating the ClusterExtension resource's version range will still result in a resolution failure since the version installed is a lower major version than specified by the version range. Try it by running:

kubectl apply -f - <<EOF
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  name: coastal
spec:
  packageName: coastal
  version: 2.0.x
EOF

Watch for a resolution failure with:

kubectl get clusterextension/coastal -o yaml -w
Example 
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"coastal"},"spec":{"packageName":"coastal","version":"2.0.x"}}
  creationTimestamp: "2023-11-27T20:29:18Z"
  generation: 3
  name: coastal
  resourceVersion: "6883"
  uid: 48d16240-edae-4904-bad8-58137bebcf8a
spec:
  packageName: coastal
  upgradeConstraintPolicy: Enforce
  version: 2.0.x
status:
  conditions:
  - lastTransitionTime: "2023-11-27T20:50:27Z"
    message: installation has not been attempted as resolution is unsatisfiable
    observedGeneration: 3
    reason: InstallationStatusUnknown
    status: Unknown
    type: Installed
  - lastTransitionTime: "2023-11-27T20:50:27Z"
    message: |-
      constraints not satisfiable:
      coastal package uniqueness permits at most 1 of coastal-coastal-coastal.v2.0.0, coastal-coastal-coastal.v1.1.0
      installed package coastal requires at least one of coastal-coastal-coastal.v1.1.0
      installed package coastal is mandatory
      required package coastal requires at least one of coastal-coastal-coastal.v2.0.0
      required package coastal is mandatory
    observedGeneration: 3
    reason: ResolutionFailed
    status: "False"
    type: Resolved

To the escape hatch!

To tell operator-controller to ignore the semver policies and allow upgrades across major versions, set the ClusterExtension's spec.upgradeConstraintPolicy to Ignore with:

kubectl apply -f - <<EOF
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  name: coastal
spec:
  packageName: coastal
  upgradeConstraintPolicy: Ignore
  version: 2.0.x
EOF

We should see that eventually the ClusterExtension will resolve and install the v2.0.0 bundle we added to the catalog image in the previous step. Watch this happen with:

kubectl get clusterextension/coastal -o yaml -w
Example 
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"coastal"},"spec":{"packageName":"coastal","upgradeConstraintPolicy":"Ignore","version":"2.0.x"}}
  creationTimestamp: "2023-11-27T20:29:18Z"
  generation: 4
  name: coastal
  resourceVersion: "7338"
  uid: 48d16240-edae-4904-bad8-58137bebcf8a
spec:
  packageName: coastal
  upgradeConstraintPolicy: Ignore
  version: 2.0.x
status:
  conditions:
  - lastTransitionTime: "2023-11-27T20:52:58Z"
    message: installed from "docker.io/bpalmer/coastal-bundle:v2.0.0"
    observedGeneration: 4
    reason: Success
    status: "True"
    type: Installed
  - lastTransitionTime: "2023-11-27T20:52:58Z"
    message: resolved to "docker.io/bpalmer/coastal-bundle:v2.0.0"
    observedGeneration: 4
    reason: Success
    status: "True"
    type: Resolved
  installedBundleResource: docker.io/bpalmer/coastal-bundle:v2.0.0
  resolvedBundleResource: docker.io/bpalmer/coastal-bundle:v2.0.0

Attempting to downgrade by changing the version range

We can disable downgrades by setting the ClusterExtension resource's spec.UpgradeConstraintPolicy field to Enforce. To see this, run:

kubectl apply -f - <<EOF
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  name: coastal
spec:
  packageName: coastal
  upgradeConstraintPolicy: Enforce
  version: 1.1.x
EOF

We should see resolution fail since it is attempting to downgrade. Watch this happen with:

kubectl get clusterextension/coastal -o yaml -w
Example 
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"coastal"},"spec":{"packageName":"coastal","upgradeConstraintPolicy":"Enforce","version":"1.1.x"}}
  creationTimestamp: "2023-11-27T20:29:18Z"
  generation: 5
  name: coastal
  resourceVersion: "7601"
  uid: 48d16240-edae-4904-bad8-58137bebcf8a
spec:
  packageName: coastal
  upgradeConstraintPolicy: Enforce
  version: 1.1.x
status:
  conditions:
  - lastTransitionTime: "2023-11-27T20:53:55Z"
    message: installation has not been attempted as resolution is unsatisfiable
    observedGeneration: 5
    reason: InstallationStatusUnknown
    status: Unknown
    type: Installed
  - lastTransitionTime: "2023-11-27T20:53:55Z"
    message: |-
      constraints not satisfiable:
      coastal package uniqueness permits at most 1 of coastal-coastal-coastal.v1.1.0, coastal-coastal-coastal.v2.0.0
      installed package coastal requires at least one of coastal-coastal-coastal.v2.0.0
      installed package coastal is mandatory
      required package coastal requires at least one of coastal-coastal-coastal.v1.1.0
      required package coastal is mandatory
    observedGeneration: 5
    reason: ResolutionFailed
    status: "False"
    type: Resolved

Back to the escape hatch!

To tell operator-controller to ignore the safety mechanisms and downgrade the ClusterExtension version, set the ClusterExtension's spec.upgradeConstraintPolicy to Ignore with:

kubectl apply -f - <<EOF
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  name: coastal
spec:
  packageName: coastal
  upgradeConstraintPolicy: Ignore
  version: 1.1.x
EOF

We should see that eventually the ClusterExtension will resolve and install the v1.1.0 bundle we added to the catalog image in a previous step. Watch this happen with:

kubectl get clusterextension/coastal -o yaml -w
Example 
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"coastal"},"spec":{"packageName":"coastal","upgradeConstraintPolicy":"Ignore","version":"1.1.x"}}
  creationTimestamp: "2023-11-27T20:29:18Z"
  generation: 6
  name: coastal
  resourceVersion: "7732"
  uid: 48d16240-edae-4904-bad8-58137bebcf8a
spec:
  packageName: coastal
  upgradeConstraintPolicy: Ignore
  version: 1.1.x
status:
  conditions:
  - lastTransitionTime: "2023-11-27T20:54:38Z"
    message: installed from "docker.io/bpalmer/coastal-bundle:v1.1.0"
    observedGeneration: 6
    reason: Success
    status: "True"
    type: Installed
  - lastTransitionTime: "2023-11-27T20:54:38Z"
    message: resolved to "docker.io/bpalmer/coastal-bundle:v1.1.0"
    observedGeneration: 6
    reason: Success
    status: "True"
    type: Resolved
  installedBundleResource: docker.io/bpalmer/coastal-bundle:v1.1.0
  resolvedBundleResource: docker.io/bpalmer/coastal-bundle:v1.1.0