orchestrator-helm-operator

Meta Operator for deploying the Orchestrator helm charts

Installing the operator

Please visit the README.md page and follow the guide to install the operator in your cluster.

Releasing the operator

Preparing the code for releasing

Follow these steps to release a new version of the operator:

1. Pull a fresh copy of the repository. Alternatively pull the latest from main on your existing repository and ensure that the HEAD matches the upstream's HEAD commit hash.
2. Create a new branch, example release/1.2.0-rc7.
3. Update the Makefile to increment the z-stream value by 1 and commit the change to the Makefile as Release 1.2.0-rc8". Example commit: https://github.com/parodos-dev/orchestrator-helm-operator/commit/0bcedf59d03dd0ace380c342ebdb0187d82ad8d6
4. Push the commit.
5. Create a new PR against main, unless the changes are targeting a specific release.
6. Get the PR reviewed by the owner of the changes to the chart or by another team member. Two more pair of eyes are always welcome for these kind of things.
7. Merge the PR.

At this point releasing the operator can branch into 2 scenarios:

• Manual release for local consumption. This kind of releases are only meant to be used for local development or earlly QE testing, not for general consumption in the RH catalog.
• Konflux managed release for staging and production environments. It uses the Konflux pipelines to bundle the images to the Red Hat Operator Ecosystems Catalog.

Konflux release (for downstream)

Follow the konflux release documentation for staging and production releases using Konflux.

Manual release (for upstream only)

1. Switch to the main branch and pull the changes so that your fork and upstream are in sync and contain the new additions.
2. Run the following commands in an AMD64 environment. These commands will build the controller image, push it to the quay.io/orchestrator/orchestrator-operator repository, build the bundle (update the contents of /bundle based on the information in /config), build the bundle image and push it to the repository, and finally build the catalog container image and push it to it's repository.

make docker-build docker-push bundle bundle-build bundle-push catalog-build catalog-push

3. Navigate to the catalog repository and locate the latest build image. The last modified value should give it away but worth checking just in case the push failed (e.g. podman could not authenticate against quay.io because credentials have expired). In these cases, retry pushing the images manually.
4. Retrieve the SHA256 digest (e.g. sha256:0aff5f6dfdd0eb25ca81f6b6aceee98bff8737b507632733e2d44f1821518e1e ) and create a new catalog source manifest that points to that new image:

apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: orchestrator-operator
  namespace: openshift-marketplace
spec:
  displayName: Orchestrator Operator
  publisher: Red Hat
  sourceType: grpc
  grpcPodConfig:
    securityContextConfig: restricted
  image: quay.io/orchestrator/orchestrator-operator-catalog@sha256:0aff5f6dfdd0eb25ca81f6b6aceee98bff8737b507632733e2d44f1821518e1e
  updateStrategy:
    registryPoll:
      interval: 10m

5. Deploy the catalogsource in your cluster and ensure that the latest version in the OLM menu for the orchestrator operator matches with the new version of the operator.
6. Install the operator and create a sample CR. Validate the CR deploys successfully by checking its status. You can take it further a notch and validate that the related objects also successfully deploy.
7. Share the new manfiest in the development channel to announce the new release. Tag the QE team so that they are aware and can take action as soon as they are able.