From 3d4eb4b2de4b68519c8828f2289c2014979ccf2a Mon Sep 17 00:00:00 2001 From: Jesus Rodriguez Date: Sun, 23 Oct 2022 00:56:14 -0400 Subject: [PATCH] Release v1.25.0 (#6104) * Make changelog more consistent. Signed-off-by: jesus m. rodriguez Signed-off-by: jesus m. rodriguez --- Makefile | 2 +- .../ansible-scaffolding-changes.yaml | 20 ----- .../fragments/bump-java-plugin-changes.yaml | 17 ----- .../fragments/component-config-changes.yaml | 15 ---- changelog/fragments/docs-bump-go-version.yaml | 14 ---- .../enable-seccompprofile-run-bundle.yaml | 18 ----- changelog/fragments/envtest-bump.yaml | 18 ----- .../ginkgoV2-go-kb-bump-changes.yaml | 62 ---------------- .../fragments/helm-scaffolding-changes.yaml | 20 ----- changelog/fragments/multi-arch-changes.yaml | 37 ---------- changelog/generated/v1.25.0.md | 21 ++++++ .../ansible/memcached-operator/Dockerfile | 2 +- testdata/ansible/memcached-operator/Makefile | 2 +- .../bundle/tests/scorecard/config.yaml | 12 +-- .../scorecard/patches/basic.config.yaml | 2 +- .../config/scorecard/patches/olm.config.yaml | 10 +-- .../bundle/tests/scorecard/config.yaml | 12 +-- .../scorecard/patches/basic.config.yaml | 2 +- .../config/scorecard/patches/olm.config.yaml | 10 +-- .../bundle/tests/scorecard/config.yaml | 12 +-- .../scorecard/patches/basic.config.yaml | 2 +- .../config/scorecard/patches/olm.config.yaml | 10 +-- testdata/helm/memcached-operator/Dockerfile | 2 +- testdata/helm/memcached-operator/Makefile | 2 +- .../bundle/tests/scorecard/config.yaml | 12 +-- .../scorecard/patches/basic.config.yaml | 2 +- .../config/scorecard/patches/olm.config.yaml | 10 +-- website/config.toml | 4 + .../content/en/docs/installation/_index.md | 2 +- .../en/docs/upgrading-sdk-version/v1.25.0.md | 74 +++++++++++++++++++ 30 files changed, 153 insertions(+), 275 deletions(-) delete mode 100644 changelog/fragments/ansible-scaffolding-changes.yaml delete mode 100644 changelog/fragments/bump-java-plugin-changes.yaml delete mode 100644 changelog/fragments/component-config-changes.yaml delete mode 100644 changelog/fragments/docs-bump-go-version.yaml delete mode 100644 changelog/fragments/enable-seccompprofile-run-bundle.yaml delete mode 100644 changelog/fragments/envtest-bump.yaml delete mode 100644 changelog/fragments/ginkgoV2-go-kb-bump-changes.yaml delete mode 100644 changelog/fragments/helm-scaffolding-changes.yaml delete mode 100644 changelog/fragments/multi-arch-changes.yaml create mode 100644 changelog/generated/v1.25.0.md create mode 100644 website/content/en/docs/upgrading-sdk-version/v1.25.0.md diff --git a/Makefile b/Makefile index 4e796be35f9..1fd5adcec8f 100644 --- a/Makefile +++ b/Makefile @@ -4,7 +4,7 @@ SHELL = /bin/bash # This value must be updated to the release tag of the most recent release, a change that must # occur in the release commit. IMAGE_VERSION will be removed once each subproject that uses this # version is moved to a separate repo and release process. -export IMAGE_VERSION = v1.24.0 +export IMAGE_VERSION = v1.25.0 # Build-time variables to inject into binaries export SIMPLE_VERSION = $(shell (test "$(shell git describe --tags)" = "$(shell git describe --tags --abbrev=0)" && echo $(shell git describe --tags)) || echo $(shell git describe --tags --abbrev=0)+git) export GIT_VERSION = $(shell git describe --dirty --tags --always) diff --git a/changelog/fragments/ansible-scaffolding-changes.yaml b/changelog/fragments/ansible-scaffolding-changes.yaml deleted file mode 100644 index feb07bce09c..00000000000 --- a/changelog/fragments/ansible-scaffolding-changes.yaml +++ /dev/null @@ -1,20 +0,0 @@ -# entries is a list of entries to include in -# release notes and/or the migration guide -entries: - - description: > - (ansible/v1) Modified ansible scaffolding in order to incorporate - changes with Kubebuilder on `--component-config` flag changes. - Previously, the changes with `--component-config` flag were not - considered by default. - - The following are the modifications: - 1. If the `--component-config` flag is passed then look for `- /manager` - in `manager.yaml` in order to add leader election id. If the component - config flag is not passed then check for `--leader-elect` flag. - 2. In `manager_proxy_patch.yaml` file, look for `memory: 64Mi` - if the component flag is passed flag is passed. If not then look - for `--leader-elect`. - 3. Repeat the same logic for replacing the port number from the file. - 4. At the end, update the `manager.yaml` file to avoid lint errors. - kind: "change" - breaking: false \ No newline at end of file diff --git a/changelog/fragments/bump-java-plugin-changes.yaml b/changelog/fragments/bump-java-plugin-changes.yaml deleted file mode 100644 index ed635e4d8c9..00000000000 --- a/changelog/fragments/bump-java-plugin-changes.yaml +++ /dev/null @@ -1,17 +0,0 @@ -# entries is a list of entries to include in -# release notes and/or the migration guide -entries: - - description: > - For Go (go/v3), Helm Hybrid (hybrid.helm/v1-alpha), and Quarkus(quarkus/v1-alpha) language based operators: - Upgrade Kubernetes dependencies from `1.24` to `1.25` - - # kind is one of: - # - addition - # - change - # - deprecation - # - removal - # - bugfix - kind: "change" - - # Is this a breaking change? - breaking: false \ No newline at end of file diff --git a/changelog/fragments/component-config-changes.yaml b/changelog/fragments/component-config-changes.yaml deleted file mode 100644 index 8db302c6ed9..00000000000 --- a/changelog/fragments/component-config-changes.yaml +++ /dev/null @@ -1,15 +0,0 @@ -# entries is a list of entries to include in -# release notes and/or the migration guide -entries: - - description: > - This PR bumped Kubebuilder to 3.7.1, with this version comes the addition of the `--component-config` flag. - - This flag is passed through `operator-sdk init` command. - If this flag is passed through the command line as an argument then only the - `controller_manager_config.yaml` file will be scaffolded in the - manifest. - If it is not passed then it will not scaffold out this file. - The command for passing the flag is: - operator-sdk init --domain example.com --repo github.com/example/memcached-operator --component-config - kind: "change" - breaking: false \ No newline at end of file diff --git a/changelog/fragments/docs-bump-go-version.yaml b/changelog/fragments/docs-bump-go-version.yaml deleted file mode 100644 index 2c88402f8b6..00000000000 --- a/changelog/fragments/docs-bump-go-version.yaml +++ /dev/null @@ -1,14 +0,0 @@ -entries: - - description: > - (docs) Update the go version in the developer guide. The documentation wasn't updated when the go version was bumped to v1.18. - - # kind is one of: - # - addition - # - change - # - deprecation - # - removal - # - bugfix - kind: "bugfix" - - # Is this a breaking change? - breaking: false diff --git a/changelog/fragments/enable-seccompprofile-run-bundle.yaml b/changelog/fragments/enable-seccompprofile-run-bundle.yaml deleted file mode 100644 index 2e47e00dd4c..00000000000 --- a/changelog/fragments/enable-seccompprofile-run-bundle.yaml +++ /dev/null @@ -1,18 +0,0 @@ -# entries is a list of entries to include in -# release notes and/or the migration guide -entries: - - description: > - For operator-sdk run bundle and bundle-upgrade subcommands: Added --security-context-config - flag to enable seccompprofile. It defaults to restricted to support k8s 1.25. You can disable it - with --security-context-config=legacy - - # kind is one of: - # - addition - # - change - # - deprecation - # - removal - # - bugfix - kind: "bugfix" - - # Is this a breaking change? - breaking: false diff --git a/changelog/fragments/envtest-bump.yaml b/changelog/fragments/envtest-bump.yaml deleted file mode 100644 index 32452d06d20..00000000000 --- a/changelog/fragments/envtest-bump.yaml +++ /dev/null @@ -1,18 +0,0 @@ -# entries is a list of entries to include in -# release notes and/or the migration guide -entries: - - description: > - (ansible/v1): updates the base ansible base operator event api, api server, - and proxy to now have a 5 second timeout when reading the request headers. - This is to prevent the possibility of a [Slowloris attack](https://www.cloudflare.com/learning/ddos/ddos-attack-tools/slowloris/). - - # kind is one of: - # - addition - # - change - # - deprecation - # - removal - # - bugfix - kind: "change" - - # Is this a breaking change? - breaking: false diff --git a/changelog/fragments/ginkgoV2-go-kb-bump-changes.yaml b/changelog/fragments/ginkgoV2-go-kb-bump-changes.yaml deleted file mode 100644 index 2d7734b7d6c..00000000000 --- a/changelog/fragments/ginkgoV2-go-kb-bump-changes.yaml +++ /dev/null @@ -1,62 +0,0 @@ -# entries is a list of entries to include in -# release notes and/or the migration guide -entries: - - description: > - Modified go version to 1.19 and Kubebuilder to 3.7.1. The `config-gen` is - completely removed from Kubebuilder. As part of this bump, the - website content of SDK was updated where the doc is referring to - `config-gen`. - kind: "change" - breaking: false - migration: - header: Kubebuilder bump brought changes that modified the `Makefile` scaffolding and also `multiarch` chanegs are also included. - body: | - 1. Makefile content is updated as shown below. - - ```sh - `KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out`, - ``` - - 2. Add support for building binary in multiple platforms. - - Add the below content to the Makefile. - - ```sh - # PLATFORMS defines the target platforms for the manager image be build to provide support to multiple - # architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to: - # - able to use docker buildx . More info: https://docs.docker.com/build/buildx/ - # - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/ - # - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=> than the export will fail) - # To properly provided solutions that supports more than one platform you should use this option. - PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le - .PHONY: docker-buildx - docker-buildx: test ## Build and push docker image for the manager for cross-platform support - # copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile - sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross - - docker buildx create --name project-v3-builder - docker buildx use project-v3-builder - - docker buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross - - docker buildx rm project-v3-builder - rm Dockerfile.cross - ``` - 3. (go/v3) Bump dependencies in go.mod file - - ```go - github.com/onsi/ginkgo/v2 v2.1.4 - github.com/onsi/gomega v1.19.0 - github.com/prometheus/client_golang v1.12.2 - k8s.io/api v0.25.0 - k8s.io/apimachinery v0.25.0 - k8s.io/client-go v0.25.0 - sigs.k8s.io/controller-runtime v0.13.0 - ``` - - description: > - Updated ginkgo to ginkgo/v2 in all of the files. - kind: "change" - breaking: false - - description: > - Updated: - - ginko to `ginko/v2` - - `io/ioutil` packages to either `io` or `os` since its not longer supported in go1.19 - kind: "change" - breaking: false \ No newline at end of file diff --git a/changelog/fragments/helm-scaffolding-changes.yaml b/changelog/fragments/helm-scaffolding-changes.yaml deleted file mode 100644 index a1d55f9c25b..00000000000 --- a/changelog/fragments/helm-scaffolding-changes.yaml +++ /dev/null @@ -1,20 +0,0 @@ -# entries is a list of entries to include in -# release notes and/or the migration guide -entries: - - description: > - (helm/v1) Modified helm scaffolding in order to incorporate changes - with Kubebuilder on `--component-config` flag changes. Previously, - the changes with `--component-config` flag were not considered by - default. - - The following are the modifications: - 1. If the `--component-config` flag is passed then look for `- /manager` - in `manager.yaml` in order to add leader election id. If the component - config flag is not passed then check for `--leader-elect` flag. - 2. In `manager_proxy_patch.yaml` file, look for `memory: 64Mi` - if the component flag is passed flag is passed. If not then look - for `--leader-elect`. - 3. Repeat the same logic for replacing the port number from the file. - 4. At the end, update the `manager.yaml` file to avoid lint errors. - kind: "change" - breaking: false \ No newline at end of file diff --git a/changelog/fragments/multi-arch-changes.yaml b/changelog/fragments/multi-arch-changes.yaml deleted file mode 100644 index b49b284b32d..00000000000 --- a/changelog/fragments/multi-arch-changes.yaml +++ /dev/null @@ -1,37 +0,0 @@ -# entries is a list of entries to include in -# release notes and/or the migration guide -entries: - - description: > - (ansible/v1, helm/v1) Added support to build multi-arch images - from the project Makefile. A docker-buildx target will build - the images for the platforms specified by the PLATFORMS variable. - kind: "change" - breaking: false # entries is a list of entries to include in - - # Migration can be defined to automatically add a section to - # the migration guide. This is required for breaking changes. - migration: - header: For multi-arch build support, add docker-buildx target to project Makefile - body: | - - In the project `Makefile` below the `docker-push` target add the new `docker-buildx` - target. - - ```yaml - # PLATFORMS defines the target platforms for the manager image be build to provide support to multiple - # architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to: - # - able to use docker buildx . More info: https://docs.docker.com/build/buildx/ - # - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/ - # - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=> than the export will fail) - # To properly provided solutions that supports more than one platform you should use this option. - PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le - .PHONY: docker-buildx - docker-buildx: test ## Build and push docker image for the manager for cross-platform support - # copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile - sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross - - docker buildx create --name project-v3-builder - docker buildx use project-v3-builder - - docker buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross - - docker buildx rm project-v3-builder - rm Dockerfile.cross - ``` diff --git a/changelog/generated/v1.25.0.md b/changelog/generated/v1.25.0.md new file mode 100644 index 00000000000..89a1975c83d --- /dev/null +++ b/changelog/generated/v1.25.0.md @@ -0,0 +1,21 @@ +## v1.25.0 + +### Changes + +- (ansible/v1): Modified ansible scaffolding in order to incorporate changes with Kubebuilder on `--component-config` flag changes. Previously, the changes with `--component-config` flag were not considered by default. +The following are the modifications: 1. If the `--component-config` flag is passed then look for `- /manager` in `manager.yaml` in order to add leader election id. If the component config flag is not passed then check for `--leader-elect` flag. 2. In `manager_proxy_patch.yaml` file, look for `memory: 64Mi` if the component flag is passed flag is passed. If not then look for `--leader-elect`. 3. Repeat the same logic for replacing the port number from the file. 4. At the end, update the `manager.yaml` file to avoid lint errors. ([#6047](https://github.com/operator-framework/operator-sdk/pull/6047)) +- (go/v3, hybrid.helm/v1-alpha, and quarkus/v1-alpha): Upgrade Kubernetes dependencies from `1.24` to `1.25`. ([#6044](https://github.com/operator-framework/operator-sdk/pull/6044)) +- This PR bumped Kubebuilder to 3.7.1, with this version comes the addition of the `--component-config` flag. +This flag is passed through `operator-sdk init` command. If this flag is passed through the command line as an argument then only the `controller_manager_config.yaml` file will be scaffolded in the manifest. If it is not passed then it will not scaffold out this file. The command for passing the flag is: operator-sdk init --domain example.com --repo github.com/example/memcached-operator --component-config. ([#6047](https://github.com/operator-framework/operator-sdk/pull/6047)) +- (ansible/v1): updates the base ansible base operator event api, api server, and proxy to now have a 5 second timeout when reading the request headers. This is to prevent the possibility of a [Slowloris attack](https://www.cloudflare.com/learning/ddos/ddos-attack-tools/slowloris/). ([#6088](https://github.com/operator-framework/operator-sdk/pull/6088)) +- Modified go version to 1.19 and Kubebuilder to 3.7.1. The `config-gen` is completely removed from Kubebuilder. As part of this bump, the website content of SDK was updated where the doc is referring to `config-gen`. ([#6047](https://github.com/operator-framework/operator-sdk/pull/6047)) +- Updated ginkgo to ginkgo/v2 in all of the files. ([#6047](https://github.com/operator-framework/operator-sdk/pull/6047)) +- Updated: - ginko to `ginko/v2` - `io/ioutil` packages to either `io` or `os` since its not longer supported in go1.19. ([#6047](https://github.com/operator-framework/operator-sdk/pull/6047)) +- (helm/v1): Modified helm scaffolding in order to incorporate changes with Kubebuilder on `--component-config` flag changes. Previously, the changes with `--component-config` flag were not considered by default. +The following are the modifications: 1. If the `--component-config` flag is passed then look for `- /manager` in `manager.yaml` in order to add leader election id. If the component config flag is not passed then check for `--leader-elect` flag. 2. In `manager_proxy_patch.yaml` file, look for `memory: 64Mi` if the component flag is passed flag is passed. If not then look for `--leader-elect`. 3. Repeat the same logic for replacing the port number from the file. 4. At the end, update the `manager.yaml` file to avoid lint errors. ([#6047](https://github.com/operator-framework/operator-sdk/pull/6047)) +- (ansible/v1, helm/v1): Added support to build multi-arch images from the project Makefile. A docker-buildx target will build the images for the platforms specified by the PLATFORMS variable. ([#6093](https://github.com/operator-framework/operator-sdk/pull/6093)) + +### Bug Fixes + +- (docs) Update the go version in the developer guide. The documentation wasn't updated when the go version was bumped to v1.18. ([#6101](https://github.com/operator-framework/operator-sdk/pull/6101)) +- For operator-sdk run bundle and bundle-upgrade subcommands: Added --security-context-config flag to enable seccompprofile. It defaults to restricted to support k8s 1.25. You can disable it with --security-context-config=legacy. ([#6062](https://github.com/operator-framework/operator-sdk/pull/6062)) diff --git a/testdata/ansible/memcached-operator/Dockerfile b/testdata/ansible/memcached-operator/Dockerfile index 6daf1c53d31..886e54c9073 100644 --- a/testdata/ansible/memcached-operator/Dockerfile +++ b/testdata/ansible/memcached-operator/Dockerfile @@ -1,4 +1,4 @@ -FROM quay.io/operator-framework/ansible-operator:v1.24.0 +FROM quay.io/operator-framework/ansible-operator:v1.25.0 COPY requirements.yml ${HOME}/requirements.yml RUN ansible-galaxy collection install -r ${HOME}/requirements.yml \ diff --git a/testdata/ansible/memcached-operator/Makefile b/testdata/ansible/memcached-operator/Makefile index 0edb913c127..d5e5fe4bac1 100644 --- a/testdata/ansible/memcached-operator/Makefile +++ b/testdata/ansible/memcached-operator/Makefile @@ -146,7 +146,7 @@ ifeq (,$(shell which ansible-operator 2>/dev/null)) @{ \ set -e ;\ mkdir -p $(dir $(ANSIBLE_OPERATOR)) ;\ - curl -sSLo $(ANSIBLE_OPERATOR) https://github.com/operator-framework/operator-sdk/releases/download/v1.24.0/ansible-operator_$(OS)_$(ARCH) ;\ + curl -sSLo $(ANSIBLE_OPERATOR) https://github.com/operator-framework/operator-sdk/releases/download/v1.25.0/ansible-operator_$(OS)_$(ARCH) ;\ chmod +x $(ANSIBLE_OPERATOR) ;\ } else diff --git a/testdata/ansible/memcached-operator/bundle/tests/scorecard/config.yaml b/testdata/ansible/memcached-operator/bundle/tests/scorecard/config.yaml index 3c01e456ba6..74037b4cf51 100644 --- a/testdata/ansible/memcached-operator/bundle/tests/scorecard/config.yaml +++ b/testdata/ansible/memcached-operator/bundle/tests/scorecard/config.yaml @@ -8,7 +8,7 @@ stages: - entrypoint: - scorecard-test - basic-check-spec - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: basic test: basic-check-spec-test @@ -18,7 +18,7 @@ stages: - entrypoint: - scorecard-test - olm-bundle-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-bundle-validation-test @@ -28,7 +28,7 @@ stages: - entrypoint: - scorecard-test - olm-crds-have-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-validation-test @@ -38,7 +38,7 @@ stages: - entrypoint: - scorecard-test - olm-crds-have-resources - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-resources-test @@ -48,7 +48,7 @@ stages: - entrypoint: - scorecard-test - olm-spec-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-spec-descriptors-test @@ -58,7 +58,7 @@ stages: - entrypoint: - scorecard-test - olm-status-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-status-descriptors-test diff --git a/testdata/ansible/memcached-operator/config/scorecard/patches/basic.config.yaml b/testdata/ansible/memcached-operator/config/scorecard/patches/basic.config.yaml index bb8153f6ed4..7d72d8ee12f 100644 --- a/testdata/ansible/memcached-operator/config/scorecard/patches/basic.config.yaml +++ b/testdata/ansible/memcached-operator/config/scorecard/patches/basic.config.yaml @@ -4,7 +4,7 @@ entrypoint: - scorecard-test - basic-check-spec - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: basic test: basic-check-spec-test diff --git a/testdata/ansible/memcached-operator/config/scorecard/patches/olm.config.yaml b/testdata/ansible/memcached-operator/config/scorecard/patches/olm.config.yaml index 4e2f4b8309e..8cfd81c0a11 100644 --- a/testdata/ansible/memcached-operator/config/scorecard/patches/olm.config.yaml +++ b/testdata/ansible/memcached-operator/config/scorecard/patches/olm.config.yaml @@ -4,7 +4,7 @@ entrypoint: - scorecard-test - olm-bundle-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-bundle-validation-test @@ -14,7 +14,7 @@ entrypoint: - scorecard-test - olm-crds-have-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-validation-test @@ -24,7 +24,7 @@ entrypoint: - scorecard-test - olm-crds-have-resources - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-resources-test @@ -34,7 +34,7 @@ entrypoint: - scorecard-test - olm-spec-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-spec-descriptors-test @@ -44,7 +44,7 @@ entrypoint: - scorecard-test - olm-status-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-status-descriptors-test diff --git a/testdata/go/v3/memcached-operator/bundle/tests/scorecard/config.yaml b/testdata/go/v3/memcached-operator/bundle/tests/scorecard/config.yaml index 3c01e456ba6..74037b4cf51 100644 --- a/testdata/go/v3/memcached-operator/bundle/tests/scorecard/config.yaml +++ b/testdata/go/v3/memcached-operator/bundle/tests/scorecard/config.yaml @@ -8,7 +8,7 @@ stages: - entrypoint: - scorecard-test - basic-check-spec - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: basic test: basic-check-spec-test @@ -18,7 +18,7 @@ stages: - entrypoint: - scorecard-test - olm-bundle-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-bundle-validation-test @@ -28,7 +28,7 @@ stages: - entrypoint: - scorecard-test - olm-crds-have-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-validation-test @@ -38,7 +38,7 @@ stages: - entrypoint: - scorecard-test - olm-crds-have-resources - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-resources-test @@ -48,7 +48,7 @@ stages: - entrypoint: - scorecard-test - olm-spec-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-spec-descriptors-test @@ -58,7 +58,7 @@ stages: - entrypoint: - scorecard-test - olm-status-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-status-descriptors-test diff --git a/testdata/go/v3/memcached-operator/config/scorecard/patches/basic.config.yaml b/testdata/go/v3/memcached-operator/config/scorecard/patches/basic.config.yaml index bb8153f6ed4..7d72d8ee12f 100644 --- a/testdata/go/v3/memcached-operator/config/scorecard/patches/basic.config.yaml +++ b/testdata/go/v3/memcached-operator/config/scorecard/patches/basic.config.yaml @@ -4,7 +4,7 @@ entrypoint: - scorecard-test - basic-check-spec - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: basic test: basic-check-spec-test diff --git a/testdata/go/v3/memcached-operator/config/scorecard/patches/olm.config.yaml b/testdata/go/v3/memcached-operator/config/scorecard/patches/olm.config.yaml index 4e2f4b8309e..8cfd81c0a11 100644 --- a/testdata/go/v3/memcached-operator/config/scorecard/patches/olm.config.yaml +++ b/testdata/go/v3/memcached-operator/config/scorecard/patches/olm.config.yaml @@ -4,7 +4,7 @@ entrypoint: - scorecard-test - olm-bundle-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-bundle-validation-test @@ -14,7 +14,7 @@ entrypoint: - scorecard-test - olm-crds-have-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-validation-test @@ -24,7 +24,7 @@ entrypoint: - scorecard-test - olm-crds-have-resources - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-resources-test @@ -34,7 +34,7 @@ entrypoint: - scorecard-test - olm-spec-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-spec-descriptors-test @@ -44,7 +44,7 @@ entrypoint: - scorecard-test - olm-status-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-status-descriptors-test diff --git a/testdata/go/v4-alpha/memcached-operator/bundle/tests/scorecard/config.yaml b/testdata/go/v4-alpha/memcached-operator/bundle/tests/scorecard/config.yaml index 3c01e456ba6..74037b4cf51 100644 --- a/testdata/go/v4-alpha/memcached-operator/bundle/tests/scorecard/config.yaml +++ b/testdata/go/v4-alpha/memcached-operator/bundle/tests/scorecard/config.yaml @@ -8,7 +8,7 @@ stages: - entrypoint: - scorecard-test - basic-check-spec - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: basic test: basic-check-spec-test @@ -18,7 +18,7 @@ stages: - entrypoint: - scorecard-test - olm-bundle-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-bundle-validation-test @@ -28,7 +28,7 @@ stages: - entrypoint: - scorecard-test - olm-crds-have-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-validation-test @@ -38,7 +38,7 @@ stages: - entrypoint: - scorecard-test - olm-crds-have-resources - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-resources-test @@ -48,7 +48,7 @@ stages: - entrypoint: - scorecard-test - olm-spec-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-spec-descriptors-test @@ -58,7 +58,7 @@ stages: - entrypoint: - scorecard-test - olm-status-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-status-descriptors-test diff --git a/testdata/go/v4-alpha/memcached-operator/config/scorecard/patches/basic.config.yaml b/testdata/go/v4-alpha/memcached-operator/config/scorecard/patches/basic.config.yaml index bb8153f6ed4..7d72d8ee12f 100644 --- a/testdata/go/v4-alpha/memcached-operator/config/scorecard/patches/basic.config.yaml +++ b/testdata/go/v4-alpha/memcached-operator/config/scorecard/patches/basic.config.yaml @@ -4,7 +4,7 @@ entrypoint: - scorecard-test - basic-check-spec - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: basic test: basic-check-spec-test diff --git a/testdata/go/v4-alpha/memcached-operator/config/scorecard/patches/olm.config.yaml b/testdata/go/v4-alpha/memcached-operator/config/scorecard/patches/olm.config.yaml index 4e2f4b8309e..8cfd81c0a11 100644 --- a/testdata/go/v4-alpha/memcached-operator/config/scorecard/patches/olm.config.yaml +++ b/testdata/go/v4-alpha/memcached-operator/config/scorecard/patches/olm.config.yaml @@ -4,7 +4,7 @@ entrypoint: - scorecard-test - olm-bundle-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-bundle-validation-test @@ -14,7 +14,7 @@ entrypoint: - scorecard-test - olm-crds-have-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-validation-test @@ -24,7 +24,7 @@ entrypoint: - scorecard-test - olm-crds-have-resources - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-resources-test @@ -34,7 +34,7 @@ entrypoint: - scorecard-test - olm-spec-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-spec-descriptors-test @@ -44,7 +44,7 @@ entrypoint: - scorecard-test - olm-status-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-status-descriptors-test diff --git a/testdata/helm/memcached-operator/Dockerfile b/testdata/helm/memcached-operator/Dockerfile index a8772984d65..8338f6dd4af 100644 --- a/testdata/helm/memcached-operator/Dockerfile +++ b/testdata/helm/memcached-operator/Dockerfile @@ -1,5 +1,5 @@ # Build the manager binary -FROM quay.io/operator-framework/helm-operator:v1.24.0 +FROM quay.io/operator-framework/helm-operator:v1.25.0 ENV HOME=/opt/helm COPY watches.yaml ${HOME}/watches.yaml diff --git a/testdata/helm/memcached-operator/Makefile b/testdata/helm/memcached-operator/Makefile index f642fd37ce3..d5c118af255 100644 --- a/testdata/helm/memcached-operator/Makefile +++ b/testdata/helm/memcached-operator/Makefile @@ -146,7 +146,7 @@ ifeq (,$(shell which helm-operator 2>/dev/null)) @{ \ set -e ;\ mkdir -p $(dir $(HELM_OPERATOR)) ;\ - curl -sSLo $(HELM_OPERATOR) https://github.com/operator-framework/operator-sdk/releases/download/v1.24.0/helm-operator_$(OS)_$(ARCH) ;\ + curl -sSLo $(HELM_OPERATOR) https://github.com/operator-framework/operator-sdk/releases/download/v1.25.0/helm-operator_$(OS)_$(ARCH) ;\ chmod +x $(HELM_OPERATOR) ;\ } else diff --git a/testdata/helm/memcached-operator/bundle/tests/scorecard/config.yaml b/testdata/helm/memcached-operator/bundle/tests/scorecard/config.yaml index 3c01e456ba6..74037b4cf51 100644 --- a/testdata/helm/memcached-operator/bundle/tests/scorecard/config.yaml +++ b/testdata/helm/memcached-operator/bundle/tests/scorecard/config.yaml @@ -8,7 +8,7 @@ stages: - entrypoint: - scorecard-test - basic-check-spec - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: basic test: basic-check-spec-test @@ -18,7 +18,7 @@ stages: - entrypoint: - scorecard-test - olm-bundle-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-bundle-validation-test @@ -28,7 +28,7 @@ stages: - entrypoint: - scorecard-test - olm-crds-have-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-validation-test @@ -38,7 +38,7 @@ stages: - entrypoint: - scorecard-test - olm-crds-have-resources - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-resources-test @@ -48,7 +48,7 @@ stages: - entrypoint: - scorecard-test - olm-spec-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-spec-descriptors-test @@ -58,7 +58,7 @@ stages: - entrypoint: - scorecard-test - olm-status-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-status-descriptors-test diff --git a/testdata/helm/memcached-operator/config/scorecard/patches/basic.config.yaml b/testdata/helm/memcached-operator/config/scorecard/patches/basic.config.yaml index bb8153f6ed4..7d72d8ee12f 100644 --- a/testdata/helm/memcached-operator/config/scorecard/patches/basic.config.yaml +++ b/testdata/helm/memcached-operator/config/scorecard/patches/basic.config.yaml @@ -4,7 +4,7 @@ entrypoint: - scorecard-test - basic-check-spec - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: basic test: basic-check-spec-test diff --git a/testdata/helm/memcached-operator/config/scorecard/patches/olm.config.yaml b/testdata/helm/memcached-operator/config/scorecard/patches/olm.config.yaml index 4e2f4b8309e..8cfd81c0a11 100644 --- a/testdata/helm/memcached-operator/config/scorecard/patches/olm.config.yaml +++ b/testdata/helm/memcached-operator/config/scorecard/patches/olm.config.yaml @@ -4,7 +4,7 @@ entrypoint: - scorecard-test - olm-bundle-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-bundle-validation-test @@ -14,7 +14,7 @@ entrypoint: - scorecard-test - olm-crds-have-validation - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-validation-test @@ -24,7 +24,7 @@ entrypoint: - scorecard-test - olm-crds-have-resources - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-crds-have-resources-test @@ -34,7 +34,7 @@ entrypoint: - scorecard-test - olm-spec-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-spec-descriptors-test @@ -44,7 +44,7 @@ entrypoint: - scorecard-test - olm-status-descriptors - image: quay.io/operator-framework/scorecard-test:v1.24.0 + image: quay.io/operator-framework/scorecard-test:v1.25.0 labels: suite: olm test: olm-status-descriptors-test diff --git a/website/config.toml b/website/config.toml index 7bfa1a7baf6..746499a1dad 100644 --- a/website/config.toml +++ b/website/config.toml @@ -99,6 +99,10 @@ url_latest_version = "https://sdk.operatorframework.io" ##RELEASE_ADDME## +[[params.versions]] + version = "v1.25" + url = "https://v1-25-x.sdk.operatorframework.io" + [[params.versions]] version = "v1.24" url = "https://v1-24-x.sdk.operatorframework.io" diff --git a/website/content/en/docs/installation/_index.md b/website/content/en/docs/installation/_index.md index 9fe44cecec0..1a97b65f14c 100644 --- a/website/content/en/docs/installation/_index.md +++ b/website/content/en/docs/installation/_index.md @@ -36,7 +36,7 @@ export OS=$(uname | awk '{print tolower($0)}') Download the binary for your platform: ```sh -export OPERATOR_SDK_DL_URL=https://github.com/operator-framework/operator-sdk/releases/download/v1.24.0 +export OPERATOR_SDK_DL_URL=https://github.com/operator-framework/operator-sdk/releases/download/v1.25.0 curl -LO ${OPERATOR_SDK_DL_URL}/operator-sdk_${OS}_${ARCH} ``` diff --git a/website/content/en/docs/upgrading-sdk-version/v1.25.0.md b/website/content/en/docs/upgrading-sdk-version/v1.25.0.md new file mode 100644 index 00000000000..0155b5db61d --- /dev/null +++ b/website/content/en/docs/upgrading-sdk-version/v1.25.0.md @@ -0,0 +1,74 @@ +--- +title: v1.25.0 +weight: 998975000 +--- + +## Kubebuilder bump brought changes that modified the `Makefile` scaffolding and also `multiarch` chanegs are also included. + +1. Makefile content is updated as shown below. + + ```sh + `KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out`, + ``` + +2. Add support for building binary in multiple platforms. + + Add the below content to the Makefile. + + ```sh + # PLATFORMS defines the target platforms for the manager image be build to provide support to multiple + # architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to: + # - able to use docker buildx . More info: https://docs.docker.com/build/buildx/ + # - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/ + # - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=> than the export will fail) + # To properly provided solutions that supports more than one platform you should use this option. + PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le + .PHONY: docker-buildx + docker-buildx: test ## Build and push docker image for the manager for cross-platform support + # copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile + sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross + - docker buildx create --name project-v3-builder + docker buildx use project-v3-builder + - docker buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross + - docker buildx rm project-v3-builder + rm Dockerfile.cross + ``` +3. (go/v3) Bump dependencies in go.mod file + + ```go + github.com/onsi/ginkgo/v2 v2.1.4 + github.com/onsi/gomega v1.19.0 + github.com/prometheus/client_golang v1.12.2 + k8s.io/api v0.25.0 + k8s.io/apimachinery v0.25.0 + k8s.io/client-go v0.25.0 + sigs.k8s.io/controller-runtime v0.13.0 + ``` + +_See [#6047](https://github.com/operator-framework/operator-sdk/pull/6047) for more details._ + +## For multi-arch build support, add docker-buildx target to project Makefile + +In the project `Makefile` below the `docker-push` target add the new `docker-buildx` +target. + +```yaml +# PLATFORMS defines the target platforms for the manager image be build to provide support to multiple +# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to: +# - able to use docker buildx . More info: https://docs.docker.com/build/buildx/ +# - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/ +# - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=> than the export will fail) +# To properly provided solutions that supports more than one platform you should use this option. +PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le +.PHONY: docker-buildx +docker-buildx: test ## Build and push docker image for the manager for cross-platform support + # copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile + sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross + - docker buildx create --name project-v3-builder + docker buildx use project-v3-builder + - docker buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross + - docker buildx rm project-v3-builder + rm Dockerfile.cross +``` + +_See [#6093](https://github.com/operator-framework/operator-sdk/pull/6093) for more details._