Skip to content

Latest commit

 

History

History
165 lines (109 loc) · 5.97 KB

RELEASE.md

File metadata and controls

165 lines (109 loc) · 5.97 KB
Raw

Releasing process

Sub-components

All components deployed by this operator can be released separatly, at their own pace.

Before releasing, it's a good opportunity to check for image upgrades: Go, node.js and ubi9-minimal.

To release them, a tag in the format "v1.6.0-community" or "v1.6.0-crc0" must be set on the desired clean HEAD state (generally, up-to-date main branch; "crc" stands for "community release candidate"), then pushed. It applies to the console plugin, flowlogs-pipeline and netobserv-ebpf-agent.

E.g:

version="v1.6.1-community"
git tag -a "$version" -m "$version"
git push upstream --tags

The release script should be triggered (check github actions).

When the last release candidate is accepted and the final release tag is pushed (using the same procedure), you can generate the release via the github interface:

Click the "Auto-generate release note" button.

Operator

Once all sub-components are released (or have a release candidate), we can proceed with the operator.

Edit the Makefile to update PREVIOUS_VERSION, BUNDLE_VERSION, PLG_VERSION, FLP_VERSION and BPF_VERSION.

make update-bundle

# Set desired operator version - CAREFUL, no leading "v" here
version="1.6.1-community"
vv=v$version
test_branch=test-$vv

git commit -a -m "Prepare release $vv"
# Push to a test branch, and tag for release
git push upstream HEAD:$test_branch
git tag -a "$version" -m "$version"
git push upstream --tags

The release script should be triggered (check github actions).

At this point, you can test the bundle / catalog on your cluster:

BUNDLE_VERSION="$version" USER=netobserv make catalog-deploy

When everything is ok, push to main and delete the test branch

git push upstream HEAD:main
git push upstream :$test_branch

When the last release candidate is accepted and the final release tag is pushed (using the same procedure), you can generate the release via the github interface:

Click the "Auto-generate release note" button.

Grab related components release notes by running:

make related-release-notes

Then paste content following the auto-generated release note in GitHub.

Check the "Create a discussion for this release" option, in category "Announcements".

Click on "Publish release".

Testing the upgrade path

Before publishing, we should check that upgrading the operator from a previous version isn't broken. We can use operator-sdk for that:

previous=v1.6.0-community
bin/operator-sdk run bundle quay.io/netobserv/network-observability-operator-bundle:$previous --timeout 5m
PORT_FWD=false make deploy-loki deploy-sample-cr
bin/operator-sdk run bundle-upgrade quay.io/netobserv/network-observability-operator-bundle:$vv --timeout 5m

If you need to repeat the operation several times, make sure to cleanup between attempts:

bin/operator-sdk cleanup netobserv-operator

Publishing on OperatorHub

There's a cross-publication on two repos:

The bundle built in the steps above is set up for OpenShift, so we'll start with that one.

Run:

# OPERATORHUB_PATH defaults to "../community-operators-prod"
OPERATORHUB_PATH=/path/to/operatorhub-for-okd make prepare-operatorhub

You should double check eveything is correct by comparing the produced files with their equivalent in the previous release, making sure there's nothing unexpected.

If necessary, update the "com.redhat.openshift.versions" annotation for compatible OpenShift versions.

Then commit and push (commits must be signed):

git add -A
git commit -s -m "operators netobserv-operator ($version)"
git push origin HEAD:bump-$version

For non-OpenShift, we need first to generate a non-OpenShift compliant bundle:

# When BUNDLE_CONFIG is "config/k8s-olm", OPERATORHUB_PATH defaults then to "../community-operators"
OPERATORHUB_PATH=/path/to/operatorhub-for-k8s BUNDLE_CONFIG=config/k8s-olm make update-bundle prepare-operatorhub

Then check, commit push push as above.

Open PRs in GitHub. A bunch of tests will be triggered, if passed the merge should be automatic.

Writing a release summary

Create an announcement on the dedicated page with the main lines of what changed (and links to detailed release notes per component).

As a reference, we can use this template:

## What's Changed

### NetObserv Operator (va.b.c -> vx.y.z)
- Feature 1
- Etc. ([view details](https://github.com/netobserv/network-observability-operator/releases/tag/x.y.z))

### Console Plugin (va.b.c -> vx.y.z)
- Feature 1
- Etc. ([view details](https://github.com/netobserv/network-observability-console-plugin/releases/tag/vx.y.z))

### FlowLogs Pipeline (va.b.c -> vx.y.z)
- Feature 1
- Etc. ([view details](https://github.com/netobserv/flowlogs-pipeline/releases/tag/vx.y.z))

### eBPF Agent (va.b.c -> vx.y.z)
- Feature 1
- Etc. ([view details](https://github.com/netobserv/netobserv-ebpf-agent/releases/tag/vx.y.z))

Don't forget credits involving external contributors!