Releases: operator-framework/operator-sdk
Releases · operator-framework/operator-sdk
v1.20.1
v1.20.0
v1.20.0
Additions
- New check to warning authors when the CRD description is empty was added to the Good Practices validator. You are able to check it by running
operator-sdk bundle validate ./bundle --select-optional name=good-practices
or$ operator-sdk bundle validate ./bundle --select-optional suite=operatorframework
(More info). (#5552) - For ansible-based operators, proxy server port can be changed with the new
proxy-port
flag, which still defaults to 8888. (#5669) - Previously we added this error to show the user that the Path component is part of proxy server. Now, kubectl made this fix that handles this case and there is no need to throw this error anymore. (#5648)
Changes
- Update the supported OLM versions to 0.18.3, 0.19.1, 0.20.0. (#5684)
Bug Fixes
- Fix: channel naming validator check and move it for the Good Practices validator. You are able to check it by running
operator-sdk bundle validate ./bundle --select-optional name=good-practices
or$ operator-sdk bundle validate ./bundle --select-optional suite=operatorframework
(More info). (#5552) - For ansible-based operators, this change fixes an issue that caused finalizers to fail to run if the watched resource (CR) is deleted during reconciliation. (#5678)
- The related image discovery feature currently only reads environment variables from the manager container. This was causing an error when the deployment labels or container name that was expected were not present. This fixes that by collecting related images from all containers across all deployments.
This change also enables users to use related images in other containers since related images from everywhere will be considered. (#5639)
v1.19.1
v1.19.1
Bug Fixes
- The related image discovery feature currently only reads environment variables from the manager container. This was causing an error when the deployment labels or container name that was expected were not present. This fixes that by collecting related images from all containers across all deployments.
This change also enables users to use related images in other containers since related images from everywhere will be considered. (#5656)
v1.19.0
v1.19.0
Additions
- Add official binary builds for
darwin/arm64
. (#5581) - User is not able to run the
operator-sdk run bundle
in local kind-registry as--skip-tls
flag is deprecated. OPM introduced new flags--skip-tls-verify and --use-http
. This fix will enable the newly introduced flags. (#5617) - For the helm/v1 plugin, parsed the "helm.sdk.operatorframework.io/reconcile-period" value from the custom resource annotations for helm operators. This value is then set to the 'ReconcilePeriod' field of the reconciler to reconcile the cluster in the specified intervals of time. (#5585)
- Added log so that URL verification errors when starting the ansible-operator are not silently swallowed. (#5595)
- Reverted removal of
--skip-tls
flag and mark the flag as deprecated. (#5633)
Changes
- scorecard will now printout test results, if any, even when there is a context timeout. This will allow underlying errors from a test to be shown helping users address the issues. (#5628)
Bug Fixes
- (java/v1alpha) bumped the java-operator-plugins dependency to v0.3.0. (#5588)
- Add the labels defined in the Manager (Operator Deployment) to the ClusterServiceVersions
DeploymentSpecs
to ensure that they will also be provided to the integration with OLM (CSV). (#5533)
v1.18.1
v1.18.0
v1.18.0
Additions
- Add bundle size validator check for the command
operator-sdk bundle validate
check if the bundle is not bigger than ~4MB and warning the authors if the bundle size is closer to this amount. More info. (#5552) - Add warning check for properties defined in the CSV for the command
operator-sdk bundle validate
warning when found properties annotations in the CSV recommending define these properties inmetadata/properties.yaml
instead. More info. (#5552) - Add support to check for the manifests using the APIs which will be removed in 1.25 and 1.26 Kubernetes versions in the bundle manifests via the commands
operator-sdk bundle validate ./bundle --select-optional name=alpha-deprecated-apis
and consequently tooperator-sdk bundle validate ./bundle --select-optional suite=operatorframework
. Note that is unlike these APIs be present on the bundle. More info. (#5552) - Adds support to bundle operators using image digests instead of tags. (#5567)
Changes
- (java/v1alpha) bumping the java-operator-plugins dependency to v0.2.0.
Bug Fixes
v1.17.0
v1.17.0
Additions
- Now operator-sdk bundle validate also ensures that the
alm-examples
annotation has a valid JSON (More info) Introduction done by upgrading operator-framework/api from the commit54878ea280f7c7402549dae568916dfb330b9262
to the releasev0.11.1
. (#5495) - Added the
hybrid.helm.sdk.operatorframework.io/v1-alpha
plugin, which scaffolds a hybrid helm based operator. For more details on the plugin, please refer https://github.com/operator-framework/helm-operator-plugins/blob/main/docs/tutorial.md. This plugin is alpha and subject to breaking changes. (#5504) - Add resource requests and limits to kube-rbac-proxy. (#5505)
Changes
v1.16.0
v1.16.0
Additions
- For Ansible-based operators, add default resource limits for the manager. (#5274)
- Add annotation to specify the default container. More info here. (#5330)
- Add PHONY targets to Makefile. (#5330)
- Add
# TODO(user): Configure the resources accordingly based on the project requirements.
into the fileconfig/manager/manager.yaml
to make this requirement clear for users. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/. (#5330) - For Golang-based projects, added
ignore-not-found
flag to theuninstall
andundeploy
Makefile targets. This change allowsmake undeploy
andmake install
to continue if Kustomize encounters a missing resource. You can invoke this feature by callingmake undeploy ignore-not-found=true
. (#5330) - Add new optional validator Good Practices. You are able to test your bundle against good practices defined under operator framework solutions by running:
$ operator-sdk bundle validate ./bundle --select-optional name=good-practices OR $ operator-sdk bundle validate ./bundle --select-optional suite=operatorframework
(#5448)
- Add the deprecated APIs optional checker,
alpha-deprecated-apis
, to theoperatorframework
suite. (#5407)
Changes
- Upgrade OPM version that is used by default to 1.19.1 in the generated Makefile so
make catalog-build
also works on OSX. (#5099) - For Ansible-based operators, bumped the
operator_sdk.util
ansible module to 0.3.1. (#5462) - For a more consistent user experience, ensure that all areas that require to be changed are marked by
TODO(user)
. (#5330) - For Helm-based Operators, adopted the same default resource limit values used to scaffold Golang-based projects. (#5330)
- For Golang-based Operators, increase the values used in the default scaffold to define the resource limits usage and make clear the need to optimize its values based on the Operator requirements. (#5330)
Deprecations
- Deprecation of the Optional(stage: alpha) Community Operator bundle validation. Its checks were moved to the external validator. (#5414)
Bug Fixes
- Optional
OperatorHub.io
validator called byoperator-sdk bundle validate ./bundle --select-optional name=operatorhub
now includes a previously missing categoryModernization & Migration
. (#5375) - Improves the validate bundle spec error message to provide a better explanation when invalid service accounts are found. (#5375)
- Improve scaffolding to filter existing multiline code fragments. More info kubernetes-sigs/kubebuilder#2343. (#5330)
v1.15.0
v1.15.0
Additions
- Added preview base image for Ansible 2.11, which can be found here: https://quay.io/repository/operator-framework/ansible-operator-2.11-preview-base
Changes
- Bumped community.kubernetes to kubernetes.core >= 2.2.0. Added the kubernetes.core collection to requirements. (#5249)
- Bumped Helm and Ansible Operator base images from UBI 8.4 to 8.5
Bug Fixes
- For Ansible operators, if an API endpoint has a "/" in server path component the ansible binary will no longer throw error. (#5308)
v1.14.0
v1.14.0
Additions
- Added new flag options
--storage-image
and--untar-image
to the Scorecard command to allow overwrite its default values. These options are useful for disconnect environments and to prevent an impact of the external registry's pull limits. (#5306) - Added information to the errors raised by scorecard basic tests to allow easily identify the scenarios. (#5273)
Changes
-
- Upgrade the Kubernetes dependencies from
1.21
to1.22
. - Upgrade the controller-gen dependency fromv0.6.2
tov0.7.0
. More info: https://github.com/kubernetes-sigs/controller-tools/releases - Upgrade the sigs.k8s.io/controller-runtime dependency fromv0.9.2
tov0.10.0
. More info: https://github.com/kubernetes-sigs/controller-runtime/releases - Upgrade the Env Test used from1.21
to1.22
. (#5228)
- Upgrade the Kubernetes dependencies from
- Bumped community.kubernetes to kubernetes.core >= 2.2.0. Added the kubernetes.core collection to requirements. (#5249)
- Reformat xml output to support in-line attributes. (#5241)
Removals
- Helm operator reconciliation diffs are now logged only at the zap debug level. (#5307)
Bug Fixes
- scorecard will now print out the failed CR when the basic test fails. (#5255)
- For Ansible-based Operators, adds documented
Successful
condition, and no longer removes conditions from the status in updates. Users can now wait for a successful reconciliation by waiting for theSuccessful
type condition to beTrue
. (#5262) - Fixed an error where
bundle validate
would return a "duplicate service account" error when an object and service account have the same.metadata.name
in a bundle. (#5282) - The list of webhooks in
webhookdescription
was previously sorted based onwebhookType
. It is now being sorted based on webhook names. (#5301)