Updating Hybrid <strong>helm</strong>-based projects - Developing Operators | Operators

Updating Hybrid helm-based Operator projects for Operator SDK 1.22.2
Additional resources

OpenShift Container Platform 4.11 supports Operator SDK 1.22.2. If you already have the 1.16.0 CLI installed on your workstation, you can update the CLI to 1.22.2 by installing the latest version.

However, to ensure your existing Operator projects maintain compatibility with Operator SDK 1.22.2, update steps are required for the associated breaking changes introduced since 1.16.0. You must perform the update steps manually in any of your Operator projects that were previously created or maintained with 1.16.0.

Updating Hybrid helm-based Operator projects for Operator SDK 1.22.2

The following procedure updates an existing Hybrid helm-based Operator project for compatibility with 1.22.2.

Prerequisites

Operator SDK 1.22.2 installed.
An Operator project created or maintained with Operator SDK 1.16.0.

Procedure

Make the following changes to the config/default/manager_auth_proxy_patch.yaml file:

...
spec:
  template:
    spec:
      containers:
      - name: kube-rbac-proxy
        image: registry.redhat.io/openshift4/ose-kube-rbac-proxy:v4.11 (1)
        args:
        - "--secure-listen-address=0.0.0.0:8443"
        - "--upstream=http://127.0.0.1:8080/"
        - "--logtostderr=true"
        - "--v=0" (2)
...
resources:
  limits:
    cpu: 500m
    memory: 128Mi
  requests:
    cpu: 5m
    memory: 64Mi (3)

1	Update the tag version from `v4.10` to `v4.11`.
2	Reduce the debugging log level from `--v=10` to `--v=0`.
3	Add resource requests and limits.

Make the following changes to your Makefile:

Enable support for image digests by adding the following environment variables to your Makefile:

Old Makefile

BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION)
...

New Makefile

BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION)

# BUNDLE_GEN_FLAGS are the flags passed to the operator-sdk generate bundle command
BUNDLE_GEN_FLAGS ?= -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)

# USE_IMAGE_DIGESTS defines if images are resolved via tags or digests
# You can enable this value if you would like to use SHA Based Digests
# To enable set flag to true
USE_IMAGE_DIGESTS ?= false
ifeq ($(USE_IMAGE_DIGESTS), true)
	BUNDLE_GEN_FLAGS += --use-image-digests
endif

Edit your Makefile to replace the bundle target with the BUNDLE_GEN_FLAGS environment variable:

Old Makefile

$(KUSTOMIZE) build config/manifests | operator-sdk generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)

New Makefile

$(KUSTOMIZE) build config/manifests | operator-sdk generate bundle $(BUNDLE_GEN_FLAGS)

Edit your Makefile to update opm to version 1.23.0:

.PHONY: opm
OPM = ./bin/opm
opm: ## Download opm locally if necessary.
ifeq (,$(wildcard $(OPM)))
ifeq (,$(shell which opm 2>/dev/null))
	@{ \
	set -e ;\
	mkdir -p $(dir $(OPM)) ;\
	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
	curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/v1.23.0/$${OS}-$${ARCH}-opm ;\ (1)
	chmod +x $(OPM) ;\
	}
else
OPM = $(shell which opm)
endif
endif

1	Replace `v1.19.1` with `v1.23.0`.

Update ENVTEST_K8S_VERSION and controller-gen fields in your Makefile to support Kubernetes 1.24:
```
...
ENVTEST_K8S_VERSION = 1.24 (1)
...
sigs.k8s.io/controller-tools/cmd/controller-gen@v0.9.0 (2)
```
1 Update version 1.22 to 1.24.

2 Update version 0.7.0 to 0.9.0.
Apply the changes to your Makefile and rebuild your Operator by entering the following command:
```
$ make
```

Make the following changes to the go.mod file to update Go and its dependencies:

go 1.18 (1)

require (
  github.com/onsi/ginkgo v1.16.5 (2)
  github.com/onsi/gomega v1.18.1 (3)
  k8s.io/api v0.24.0 (4)
  k8s.io/apimachinery v0.24.0 (4)
  k8s.io/client-go v0.24.0 (4)
  sigs.k8s.io/controller-runtime v0.12.1 (5)
)

1	Update version `1.16` to `1.18`.
2	Update version `v1.16.4` to `v1.16.5`.
3	Update version `v1.15.0` to `v1.18.1`.
4	Update version `v0.22.1` to `v0.24.0`.
5	Update version `v0.10.0` to `v0.12.1`.

Edit your go.mod file to update the helm Operator plugins:
```
github.com/operator-framework/helm-operator-plugins v0.0.11 (1)
```
1 Update version v0.0.8 to v0.0.11.

Make the following changes to your Dockerfile to update Go to version 1.18:

Old dockerfile.go file

const dockerfileTemplate = `# Build the manager binary
FROM golang:1.17 as builder

New dockerfile.go file

const dockerfileTemplate = `# Build the manager binary
FROM golang:1.18 as builder

Download and clean up the dependencies by entering the following command:
```
$ go mod tidy
```

1	Update version `1.22` to `1.24`.
2	Update version `0.7.0` to `0.9.0`.

Updating Hybrid helm-based projects for newer Operator SDK versions

Updating Hybrid helm-based Operator projects for Operator SDK 1.22.2

Additional resources