diff --git a/changelog/fragments/ansible-leader-election.yaml b/changelog/fragments/ansible-leader-election.yaml index ce8b5e82c3..bb5015d68f 100644 --- a/changelog/fragments/ansible-leader-election.yaml +++ b/changelog/fragments/ansible-leader-election.yaml @@ -2,8 +2,8 @@ # release notes and/or the migration guide entries: - description: > - In the Ansible operator, use controller-runtime's lease-based leader - election instead of SDK's leader-for-life mechnism. + The Ansible operator now uses the controller-runtime's lease-based leader + election instead of SDK's leader-for-life mechanism. kind: "change" breaking: false diff --git a/changelog/fragments/ansible-metrics-addr.yml b/changelog/fragments/ansible-metrics-addr.yml index 2c6e49a2cc..9d43cbbe48 100644 --- a/changelog/fragments/ansible-metrics-addr.yml +++ b/changelog/fragments/ansible-metrics-addr.yml @@ -1,15 +1,14 @@ entries: - description: > - Added `--metrics-addr` flag to ansible operator to make it configurable, and - changed the default from `:8383` to `:8080` - + Added `--metrics-addr` flag to the Ansible operator to make it configurable, and + changed the default port from `:8383` to `:8080` + kind: "change" - + # Is this a breaking change? breaking: true - + migration: - header: Default ansible operator metrics port changed + header: Default Ansible operator metrics port has changed body: > To continue using port 8383, specify `--metrics-addr=:8383` when you start the operator. - \ No newline at end of file diff --git a/changelog/fragments/ansible-operator-optional-case.yaml b/changelog/fragments/ansible-operator-optional-case.yaml index 5c36a1c1f0..e87c088dbe 100644 --- a/changelog/fragments/ansible-operator-optional-case.yaml +++ b/changelog/fragments/ansible-operator-optional-case.yaml @@ -2,8 +2,8 @@ entries: - description: > The `snakeCaseParameters` option has been added to the `watches.yaml` for Ansible-based Operators. This allows the user to configure whether parameters - in the resource spec are automatically converted from camelCase to snake_case. - The default is `true`, so there is no behavior change for existing operators, + in the resource spec are automatically converted from `camelCase` to `snake_case`. + The default is `true`, so there is no behavior change for existing operators, but it can now be disabled. kind: "addition" diff --git a/changelog/fragments/cmd-legacy-helm.yaml b/changelog/fragments/cmd-legacy-helm.yaml index 400c96a2da..f41283a241 100644 --- a/changelog/fragments/cmd-legacy-helm.yaml +++ b/changelog/fragments/cmd-legacy-helm.yaml @@ -2,7 +2,7 @@ # release notes and/or the migration guide entries: - description: > - The commands `operator-sdk new --type=helm` and `operator-sdk add api` are no longer supported for Helm-based Operators. + Removed legacy `new` and `add api` commands from Helm-based Operators. # kind is one of: # - addition diff --git a/changelog/fragments/enqueue-object-handler.yaml b/changelog/fragments/enqueue-object-handler.yaml deleted file mode 100644 index 80bc279a1b..0000000000 --- a/changelog/fragments/enqueue-object-handler.yaml +++ /dev/null @@ -1,7 +0,0 @@ -entries: - - description: > - Add new handler for metrics which can be registered with controller-runtime registry, - and wraps existing EnqueueResuestForObject, for both Ansible and Helm controllers. - - kind: "addition" - breaking: false \ No newline at end of file diff --git a/changelog/fragments/fixed-cve.yaml b/changelog/fragments/fixed-cve.yaml new file mode 100644 index 0000000000..13fc421950 --- /dev/null +++ b/changelog/fragments/fixed-cve.yaml @@ -0,0 +1,14 @@ +# entries is a list of entries to include in +# release notes and/or the migration guide +entries: + - description: > + Fixed CVE-2020-14040 by updating to `golang.org/x/text/0.3.3` + + # - bugfix + kind: "bugfix" + + # Is this a breaking change? + breaking: false + + # What is the pull request number (without the "#")? + pull_request_override: 3458 diff --git a/changelog/fragments/helm-leader-election.yaml b/changelog/fragments/helm-leader-election.yaml index 21f56bec23..3615e2a93e 100644 --- a/changelog/fragments/helm-leader-election.yaml +++ b/changelog/fragments/helm-leader-election.yaml @@ -1,6 +1,6 @@ entries: - description: > - In the Helm operator, use controller-runtime's lease-based leader + The Helm operator now uses the controller-runtime's lease-based leader election instead of SDK's leader-for-life mechanism. kind: "change" diff --git a/changelog/fragments/helm-metrics-addr.yaml b/changelog/fragments/helm-metrics-addr.yaml index 6d3589cbf1..55459e535f 100644 --- a/changelog/fragments/helm-metrics-addr.yaml +++ b/changelog/fragments/helm-metrics-addr.yaml @@ -1,7 +1,7 @@ entries: - description: > - Added `--metrics-addr` flag to helm operator to make it configurable, and - changed the default from `:8383` to `:8080` + Added `--metrics-addr` flag to the Helm operator to make it configurable, and + changed the default port from `:8383` to `:8080` kind: "change" @@ -9,6 +9,6 @@ entries: breaking: true migration: - header: Default helm operator metrics port changed + header: Default Helm operator metrics port has changed body: > To continue using port 8383, specify `--metrics-addr=:8383` when you start the operator. diff --git a/changelog/fragments/modify-ansible-flags.yaml b/changelog/fragments/modify-ansible-flags.yaml deleted file mode 100644 index bdf25d1ff2..0000000000 --- a/changelog/fragments/modify-ansible-flags.yaml +++ /dev/null @@ -1,5 +0,0 @@ -entries: - - description: > - Rename "--max-workers" flag to "--max-concurrent-reconciles", and add "MAX_CONCURRENT_RECONCILES__" global variable - to ansible binary. Also include deprecation message for "--max-workers" flag and "WORKERS__" global variable. - kind: "addition" diff --git a/changelog/fragments/mv-EnqueueRequestForAnnotation.yaml b/changelog/fragments/mv-EnqueueRequestForAnnotation.yaml index cff29343b5..e93816e9a1 100644 --- a/changelog/fragments/mv-EnqueueRequestForAnnotation.yaml +++ b/changelog/fragments/mv-EnqueueRequestForAnnotation.yaml @@ -1,9 +1,9 @@ entries: - description: > - Remove the implementation for `EnqueueRequestForAnnotation` handler from sdk repository and - reference it from operator-lib instead. + Removed the implementation for `EnqueueRequestForAnnotation` handler from the SDK repository and + referenced it from [operator-lib](https://github.com/operator-framework/operator-lib/blob/main/handler/enqueue_annotation.go) instead. kind: "change" - + # Is this a breaking change? breaking: true @@ -12,5 +12,5 @@ entries: migration: header: Move the implementation of `EnqueueRequestForAnnotation` handler body: > - The implementation of `EnqueueRequestForAnnotation` handler has been removed from Operator SDK repository - and is now imported from Operator-lib. + Import "github.com/operator-framework/operator-lib/handler" to continue using the + `EnqueueRequestForAnnotation` handler. diff --git a/changelog/fragments/remove-pkg-predicate.yaml b/changelog/fragments/remove-pkg-predicate.yaml index 900315a704..41d47f1ccb 100644 --- a/changelog/fragments/remove-pkg-predicate.yaml +++ b/changelog/fragments/remove-pkg-predicate.yaml @@ -1,6 +1,6 @@ entries: - description: > - Remove `pkg/predicate`: `ResourceFilterPredicate` is now available via + Removed `pkg/predicate`: `ResourceFilterPredicate` is now available via `pkg/ansible/predicate.NewResourceFilterPredicate()`; `GenerationChangedPredicate` has been renamed, modified, and moved (see this [operator-lib PR](https://github.com/operator-framework/operator-lib/pull/11) for details). diff --git a/changelog/fragments/remove-test-framework.yaml b/changelog/fragments/remove-test-framework.yaml index 6048f1a998..ee009e6e35 100644 --- a/changelog/fragments/remove-test-framework.yaml +++ b/changelog/fragments/remove-test-framework.yaml @@ -1,8 +1,8 @@ entries: - - description: Remove `test` subcommand and the test framework `pkg/test`. + - description: Removed `test` subcommand and the test framework `pkg/test`. kind: "removal" pull_request_override: 3409 breaking: true migration: - header: Remove `test` subcommand and the test framework `pkg/test` + header: Removed `test` subcommand and the test framework `pkg/test` body: TBD diff --git a/changelog/fragments/rename-max-workers.yaml b/changelog/fragments/rename-max-workers.yaml index fbdf852ddb..12ece13b13 100644 --- a/changelog/fragments/rename-max-workers.yaml +++ b/changelog/fragments/rename-max-workers.yaml @@ -1,12 +1,14 @@ entries: - description: > - **(Valid only for Ansible/Helm-based Operators)**. The flag `--max-workers` is no longer supported. - Use `--max-concurrent-reconciles` instead. + The Ansible operator's `--max-workers` flag and `WORKERS__` + environment variable have been renamed to `--max-concurrent-reconciles` and + `MAX_CONCURRENT_RECONCILES__` respectively. kind: "change" breaking: true migration: - header: Flag `max-workers` is no longer supported. + header: Flag `max-workers` and `WORKERS__` environment variable are no longer supported. body: | - The flag `--max-workers` is no longer supported with ansible/helm binaries. It has been - renamed to `--max-concurrent-reconciles`. + The `--max-workers` flag and `WORKERS__` environment variable are no longer supported + with the Ansible operator. They have been renamed to `--max-concurrent-reconciles` and + `MAX_CONCURRENT_RECONCILES__` respectively. diff --git a/changelog/fragments/rm-ansible-metrics.yml b/changelog/fragments/rm-ansible-metrics.yml index 59cf0ecacd..73e218a4b3 100644 --- a/changelog/fragments/rm-ansible-metrics.yml +++ b/changelog/fragments/rm-ansible-metrics.yml @@ -2,10 +2,10 @@ # release notes and/or the migration guide entries: - description: > - Remove legacy metrics generation code. + Removed legacy metrics generation code from Ansible-based Operators. kind: "removal" # Is this a breaking change? breaking: true migration: - header: Remove legacy metrics generation code from cmd/ansible-operator/main.go, and tests/e2e-anisble.sh checks for servicemonitor. - body: TBD \ No newline at end of file + header: Removed legacy metrics generation code from cmd/ansible-operator/main.go, and tests/e2e-anisble.sh checks for servicemonitor. + body: TBD diff --git a/changelog/fragments/rm-cmd-legacy-ansible.yaml b/changelog/fragments/rm-cmd-legacy-ansible.yaml index 727f5ce28e..8e8f3b5e1c 100644 --- a/changelog/fragments/rm-cmd-legacy-ansible.yaml +++ b/changelog/fragments/rm-cmd-legacy-ansible.yaml @@ -2,7 +2,7 @@ # release notes and/or the migration guide entries: - description: > - The commands `operator-sdk new --type=ansible` and `operator-sdk add api` are no longer supported for Ansible-based Operators. + Removed legacy `new` and `add api` commands from Ansible-based Operators. # kind is one of: # - addition diff --git a/changelog/fragments/rm-helm-metrics.yaml b/changelog/fragments/rm-helm-metrics.yaml index 539d0f68e4..1cce1ec1cf 100644 --- a/changelog/fragments/rm-helm-metrics.yaml +++ b/changelog/fragments/rm-helm-metrics.yaml @@ -2,10 +2,10 @@ # release notes and/or the migration guide entries: - description: > - Remove legacy metrics generation code. + Removed legacy metrics generation code from Helm-based Operators. kind: "removal" # Is this a breaking change? breaking: true migration: header: Remove legacy metrics generation code from cmd/helm-operator/main.go, and test-e2e-helm.sh checks for servicemonitor. - body: TBD \ No newline at end of file + body: TBD diff --git a/changelog/fragments/rm-legacy-bundle-cmds.yaml b/changelog/fragments/rm-legacy-bundle-cmds.yaml index f18bba17c9..3d1794bb35 100644 --- a/changelog/fragments/rm-legacy-bundle-cmds.yaml +++ b/changelog/fragments/rm-legacy-bundle-cmds.yaml @@ -2,10 +2,10 @@ # release notes and/or the migration guide entries: - description: > - Remove legacy "bundle create/validate" commands + Removed `bundle create` command and `bundle validate` support in legacy projects kind: "removal" # Is this a breaking change? breaking: true migration: - header: Remove legacy "bundle create/validate" commands + header: Remove `bundle create` command and `bundle validate` support in legacy projects body: TBD diff --git a/changelog/fragments/rm-legacy-gen-bundle.yaml b/changelog/fragments/rm-legacy-gen-bundle.yaml index cfac537bea..7e15e96ced 100644 --- a/changelog/fragments/rm-legacy-gen-bundle.yaml +++ b/changelog/fragments/rm-legacy-gen-bundle.yaml @@ -2,7 +2,7 @@ # release notes and/or the migration guide entries: - description: > - Remove legacy generate bundle command + Removed `generate bundle` command support in legacy projects. kind: "removal" # Is this a breaking change? breaking: true diff --git a/changelog/fragments/rm-legacy-gen-csv.yaml b/changelog/fragments/rm-legacy-gen-csv.yaml index df7724a00f..1f57d8ed2c 100644 --- a/changelog/fragments/rm-legacy-gen-csv.yaml +++ b/changelog/fragments/rm-legacy-gen-csv.yaml @@ -2,7 +2,7 @@ # release notes and/or the migration guide entries: - description: > - Remove legacy generate csv command + Removed legacy `generate csv` command kind: "removal" # Is this a breaking change? breaking: true diff --git a/changelog/fragments/rm-legacy-gen-packagemanifests.yaml b/changelog/fragments/rm-legacy-gen-packagemanifests.yaml index 9b1f9b7984..c6d9e1e80b 100644 --- a/changelog/fragments/rm-legacy-gen-packagemanifests.yaml +++ b/changelog/fragments/rm-legacy-gen-packagemanifests.yaml @@ -2,10 +2,10 @@ # release notes and/or the migration guide entries: - description: > - Remove legacy generate packagemanifests command + Removed `generate packagemanifests` command support in legacy projects kind: "removal" # Is this a breaking change? breaking: true migration: - header: Remove legacy generate packagemanifests command + header: Remove generate packagemanifests command support in legacy projects body: TBD diff --git a/changelog/fragments/rm-legacy-go.yaml b/changelog/fragments/rm-legacy-go.yaml index ea3fa6ad06..8496eb43d4 100644 --- a/changelog/fragments/rm-legacy-go.yaml +++ b/changelog/fragments/rm-legacy-go.yaml @@ -1,6 +1,6 @@ entries: - description: > - Removed legacy go CLI subcommands and features: `add`, `migrate` + Removed support in legacy Go projects for CLI subcommands and features: `add`, `migrate` `print-deps`, `generate k8s`, `generate crds`, and `scorecard`. kind: removal breaking: true diff --git a/changelog/fragments/rm-legacy-run.yaml b/changelog/fragments/rm-legacy-run.yaml index 049988e333..a345d52fb0 100644 --- a/changelog/fragments/rm-legacy-run.yaml +++ b/changelog/fragments/rm-legacy-run.yaml @@ -2,7 +2,7 @@ # release notes and/or the migration guide entries: - description: > - Remove legacy `run` and `cleanup` subcommands + Removed `run` and `cleanup` subcommands support in legacy projects kind: "removal" diff --git a/changelog/fragments/rm-pkg-metrics.yaml b/changelog/fragments/rm-pkg-metrics.yaml index ca93320a16..48104e71aa 100644 --- a/changelog/fragments/rm-pkg-metrics.yaml +++ b/changelog/fragments/rm-pkg-metrics.yaml @@ -2,8 +2,8 @@ # release notes and/or the migration guide entries: - description: > - Removed `pkg/metrics` and its helpers "GenerateAndServeCRMetrics()" and - "GetNamespacesForMetrics()". + Removed `pkg/metrics` and its helpers `GenerateAndServeCRMetrics()` and + `GetNamespacesForMetrics()`. kind: "removal" diff --git a/changelog/fragments/scorecard-bundle-metadata.yaml b/changelog/fragments/scorecard-bundle-metadata.yaml index 01a525470c..69984c84d2 100644 --- a/changelog/fragments/scorecard-bundle-metadata.yaml +++ b/changelog/fragments/scorecard-bundle-metadata.yaml @@ -1,6 +1,6 @@ entries: - description: > - `generate bundle` now adds scorecard bundle metadata to bundle.Dockerfile and annotations.yaml + `generate bundle` now adds scorecard bundle metadata to `bundle.Dockerfile` and `annotations.yaml` if `--overwrite` is set (the default in a project's `Makefile`) or both files do not exist. kind: addition breaking: false diff --git a/changelog/fragments/scorecard-default-ns.yaml b/changelog/fragments/scorecard-default-ns.yaml index f63cd158a8..f09e9d9486 100644 --- a/changelog/fragments/scorecard-default-ns.yaml +++ b/changelog/fragments/scorecard-default-ns.yaml @@ -1,9 +1,8 @@ entries: - description: > - Changes the scorecard command to look for a namespace in the - kubeconfig instead of defaulting to 'default' when the - namespace is not defined on the command line flag. If a namespace - can not be found in the kubeconfig file, then 'default' is used. + When a namespace is not provided on the command line, the scorecard command + now looks for a namespace in the kubeconfig. If a namespace can not be found + in the kubeconfig file, then 'default' is used. kind: "change" diff --git a/changelog/fragments/scorecard-move-alpha.yaml b/changelog/fragments/scorecard-move-alpha.yaml index 38dc322a4e..3babe4b467 100644 --- a/changelog/fragments/scorecard-move-alpha.yaml +++ b/changelog/fragments/scorecard-move-alpha.yaml @@ -1,7 +1,6 @@ entries: - description: > - Changes the alpha scorecard command to become the standard scorecard - command. + The `alpha scorecard` command has been promoted to the standard scorecard command. kind: "change" diff --git a/changelog/fragments/scorecard-parallel.yaml b/changelog/fragments/scorecard-parallel.yaml index 862e3dd4cb..de51921a26 100644 --- a/changelog/fragments/scorecard-parallel.yaml +++ b/changelog/fragments/scorecard-parallel.yaml @@ -1,6 +1,6 @@ entries: - description: > - Changes the scorecard configuration format to include a new top-level + Changed the scorecard configuration format to include a new top-level `stages` field, which allows users to define stages of tests and to enable parallelism within each stage. @@ -28,7 +28,7 @@ entries: stages field, and move your test definitions under one or more stages. **Example** - + ```yaml tests: - image: quay.io/operator-framework/scorecard-test:dev diff --git a/changelog/fragments/use-operator-lib-metrics.yaml b/changelog/fragments/use-operator-lib-metrics.yaml index f8a96987a8..5585f22eca 100644 --- a/changelog/fragments/use-operator-lib-metrics.yaml +++ b/changelog/fragments/use-operator-lib-metrics.yaml @@ -2,18 +2,11 @@ # release notes and/or the migration guide entries: - description: > - Remove the implementation for `InstrumentedEnqueueRequestForObject` - handler from SDK repository and reference it from operator-lib instead. + Ansible & Helm-based Operators switched to using the `InstrumentedEnqueueRequestForObject` from + [operator-lib](https://github.com/operator-framework/operator-lib/blob/main/handler/instrumented_enqueue_object.go) + instead of controller-runtime's `EnqueueRequestForObject`. kind: "change" # Is this a breaking change? - breaking: true - - # Migration can be defined to automatically add a section to - # the migration guide. This is required for breaking changes. - migration: - header: Move the implementation of `InstrumentedEnqueueRequestForObject` handler - body: > - The implementation of `InstrumentedEnqueueRequestForObject` handler has been - removed from Operator SDK repository and is now imported from operator-lib. + breaking: false