Skip to content

Latest commit

 

History

History
85 lines (62 loc) · 3.63 KB

RELEASE.md

File metadata and controls

85 lines (62 loc) · 3.63 KB
Raw

How to release Kuadrant Operator

Process

To release a version “v0.W.Z” of Kuadrant Operator in GitHub and Quay.io, follow these steps:

  1. Kuadrant dependencies need to be released first:

  2. Run the GHA Release operator; make sure to fill all the fields:

    • Branch containing the release workflow file – default: main
    • Commit SHA or branch name of the operator to release – usually: main
    • Operator version to release (without prefix) – i.e. 0.W.Z
    • Kuadrant dependencies (WASM Shim, Console Plugin, Authorino, Limitador and DNS operators) versions (without prefix) – i.e. 0.X.Y
    • If the release is a prerelease

  3. Verify that the build release tag workflow is triggered and completes for the new tag.

  4. Verify the new version can be installed from the catalog image, see Verify OLM Deployment

  5. Release to the community operator index catalogs.

Verify OLM Deployment

  1. Deploy the OLM catalog image following the Deploy kuadrant operator using OLM and providing the generated catalog image. For example:
make deploy-catalog CATALOG_IMG=quay.io/kuadrant/kuadrant-operator-catalog:v1.0.0-rc4
  1. Wait for deployment:
kubectl -n kuadrant-system wait --timeout=60s --for=condition=Available deployments --all

The output should be:

deployment.apps/authorino-operator condition met
deployment.apps/dns-operator-controller-manager condition met
deployment.apps/kuadrant-operator-controller-manager condition met
deployment.apps/limitador-operator-controller-manager condition met
deployment.apps/kuadrant-operator-controller-manager condition met
  1. Check the logs:
kubectl -n kuadrant-system logs -f deployment/kuadrant-operator-controller-manager
  1. Check the version of the components deployed:
kubectl -n kuadrant-system get deployment -o yaml | grep "image:"

The output should be something like:

image: quay.io/kuadrant/authorino-operator:v0.14.0
image: quay.io/kuadrant/dns-operator:v0.8.0
image: quay.io/kuadrant/kuadrant-operator:v1.0.0-rc4
image: quay.io/kuadrant/limitador-operator:v0.12.0

Community Operator Index Catalogs

Open a PR on each index catalog (example | docs).

The usual steps are:

  1. Start a new branch named kuadrant-operator-v0.W.Z

  2. Create a new directory operators/kuadrant-operator/0.W.Z containing:

    • Copy the bundle files from github.com/kuadrant/kuadrant-operator/tree/v0.W.Z/bundle
    • Copy github.com/kuadrant/kuadrant-operator/tree/v0.W.Z/bundle.Dockerfile with the proper fix to the COPY commands (i.e. remove /bundle from the paths)