Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 3.57 KB

RELEASING.md

File metadata and controls

85 lines (52 loc) · 3.57 KB
Raw

Releasing the operator

Preparing for a release

Checkout the branch from which you want to release. For a major or minor release, you will need to create a new release-vX.Y branch based on the target minor version.

Make sure the appropriate versions have been updated in config/calico_versions.yaml or config/enterprise_versions.yaml, make sure both the images have been updated and the title field has been updated with the release (the format should be v<Major>.<Minor>.<Patch>). Then ensure make gen-versions has been ran and the resulting updates have been committed. When updating versions for enterprise, if necessary also update the TigeraRegistry field in pkg/components/images.go.

Make sure the branch is in a good state, e.g. Update any pins in go.mod, create PR, ensure tests pass and merge.

You should have no local changes and tests should be passing.

Creating release

  1. Review the milestone for this release and ensure it is accurate. https://github.com/tigera/operator/milestones

  2. Choose a version e.g. v1.0.1

  3. Ensure the title: field in both config/calico_versions.yaml and config/enterprise_versions.yaml match appropriate product release that the operator should install, if not see Preparing for a release.

  4. Create a tag in git

    git tag <version>

  5. Push the git tag.

  6. Log in to semaphore and trigger a build on the tagged commit. Semaphore will build, test, and publish the release.

  7. Run the following command to generate release notes for the release

    GITHUB_TOKEN=<access-token> VERSION=<TAG> ./generate-release-notes.py

  8. Go to https://github.com/tigera/operator/releases and edit the release tag to include the generated release notes, and update the title.

  9. Close the milestone for this release. https://github.com/tigera/operator/milestones

  10. Go to https://github.com/tigera/operator/milestones and create any new milestones that should exist (e.g., next patch release)

Updates for new Calico CRDs

If the release includes new Calico CRDs, add the new CRDs to hack/gen-csv/get-manifests.sh and hack/gen-csv/clusterserviceversion.template.

Publishing a release on RH Catalog

We currently only publish operator releases targeting Calico. If the release targets Calico, continue onto the following steps to generate the ClusterServiceVersion for it, and publish the release on the RH Catalog.

  1. After the semaphore job in the releasing steps is complete, and images have been tagged and pushed, checkout the tag you released.

  2. Create the ClusterServiceVersion (CSV), using the tag version for VERSION and the version that this replaces in PREV_VERSION. The versions are semver strings. For example:

    make gen-csv VERSION=1.3.1 PREV_VERSION=1.3.0

    This step will create the CSV and copy over its crds into build/_output/bundle/tigera-operator/$VERSION which will be used in the next step, on master.

  3. Checkout master and create a new branch.

  4. Create the CSV bundle:

    make gen-bundle

    This step will add the CSV we generated earlier to deploy/olm-catalog and create a zip file in build/_output/bundle/bundle.zip.

  5. git add deploy/olm-catalog, commit the changes, and have the PR reviewed and merged into master.

  6. Login to our operator project metadata submission page and upload the bundle.zip

  7. The metadata validation job takes 1-2 hours if it runs successfully. When it passes, go back to the same submission page and publish the new operator version.