diff --git a/CHANGELOG.md b/CHANGELOG.md index 7a761524e3b..ca906397c24 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,33 @@ +## v1.0.0-alpha.2 + +### Additions + +- The Ansible and Helm operators have a `version` subcommand that prints the version information for the `ansible-operator` and `helm-operator` binaries. ([#3596](https://github.com/operator-framework/operator-sdk/pull/3596)) +- Added `--ansible-args` command-line flag that allows users to specify arbitrary CLI arguments for Ansible-based operators that are passed through ansible-runner. For example, passing `--ansible-vault` as an arbitrary argument allows user to store sensitive data in encrypted files. ([#3374](https://github.com/operator-framework/operator-sdk/pull/3374)) +- `generate bundle` and `generate packagemanifests` will write RBAC objects (Roles, RoleBindings, their Cluster equivalents, and ServiceAccounts) not bound to CSV deployment service accounts to the resulting manifests directory. ([#3610](https://github.com/operator-framework/operator-sdk/pull/3610)) + +### Changes + +- **Breaking change**: The Ansible and Helm operators now use controller-runtime's zap package to define logging flags. ([#3596](https://github.com/operator-framework/operator-sdk/pull/3596)) +- **Breaking change**: The Ansible and Helm operators now use a `run` subcommand to run the operator. ([#3596](https://github.com/operator-framework/operator-sdk/pull/3596)) +- The `generate bundle` subcommand no longer requires a default channel be set nor defaults to the first channel provided to `--channels`. ([#3602](https://github.com/operator-framework/operator-sdk/pull/3602)) +- The `bundle validate` subcommand no longer returns an error if a bundle does not have a default channel. ([#3602](https://github.com/operator-framework/operator-sdk/pull/3602)) +- **Breaking change**: The `--update-crds` flag has been renamed to `--update-objects` for the `generate packagemanifests` subcommand. ([#3610](https://github.com/operator-framework/operator-sdk/pull/3610)) +- **Breaking change**: Changed `--operator-version` flag to `--version` in `run packagemanifests`. ([#3599](https://github.com/operator-framework/operator-sdk/pull/3599)) +- **Breaking change**: Changed `--operator-namespace` flag to `--namespace` in `run packagemanifests`. ([#3601](https://github.com/operator-framework/operator-sdk/pull/3601)) + +### Removals + +- **Breaking change**: Moved scorecard API v1alpha3 to the [api repo](https://github.com/operator-framework/api) under `pkg/apis/scorecard/v1alpha3`. All future scorecard APIs will be released in this repo. ([#3622](https://github.com/operator-framework/operator-sdk/pull/3622)) +- **Breaking change**: Removed package `version`. ([#3617](https://github.com/operator-framework/operator-sdk/pull/3617)) +- **Breaking change**: Removed `--operator-name` from `generate` subcommands in favor of using `project-name` from the PROJECT config file (v3-alpha+). ([#3530](https://github.com/operator-framework/operator-sdk/pull/3530)) +- **Breaking change**: Removed `--include-paths` flag from `run packagemanifests`. ([#3599](https://github.com/operator-framework/operator-sdk/pull/3599)) +- **Breaking change**: Removed `--olm-namespace` flag from `run packagemanifests`. ([#3601](https://github.com/operator-framework/operator-sdk/pull/3601)) + +### Bug Fixes + +- Fixed incorrect (cluster) role name assignments in generated CSVs [#3600](https://github.com/operator-framework/operator-sdk/issues/3600). ([#3610](https://github.com/operator-framework/operator-sdk/pull/3610)) + ## v1.0.0-alpha.1 ### Additions diff --git a/changelog/fragments/ansible-helm-cobra.yaml b/changelog/fragments/ansible-helm-cobra.yaml deleted file mode 100644 index 5a3cb94f8cf..00000000000 --- a/changelog/fragments/ansible-helm-cobra.yaml +++ /dev/null @@ -1,38 +0,0 @@ -entries: - - description: > - The Ansible and Helm operators now use controller-runtime's zap package - to define logging flags. - kind: change - breaking: true - migration: - header: Use new logging flags when running the Ansible and Helm operators - body: | - The Ansible and Helm operators now use controller-runtime's zap package - to define logging flags. - - The `--zap-sample` and `--zap-time-encoding` flag have been removed since - they are not present in controller-runtime's flagset. These flags are no - longer supported. - - The `--zap-level` flag is called `--zap-log-level` now. Rename any usage of - `--zap-level` to `--zap-log-level` - - - description: > - The Ansible and Helm operators have a `version` subcommand that prints the - version information for the `ansible-operator` and `helm-operator` binaries. - kind: addition - - - description: > - The Ansible and Helm operators now use a `run` subcommand to run the operator - kind: change - breaking: true - migration: - header: Core Ansible and Helm operator logic moved to `run` subcommand - body: | - If you are using the `ansible-operator` and `helm-operator` binaries - directly, update your usage to call `ansible-operator run` and - `helm-operator run` (e.g. in your Makefile's `make run` target). - - If you are using the base image and you are not overriding the operator - entrypoint, no change is necessary because the base image has been updated - to call the `run` subcommand by default. diff --git a/changelog/fragments/arbitraryArgs.yaml b/changelog/fragments/arbitraryArgs.yaml deleted file mode 100644 index 52295672816..00000000000 --- a/changelog/fragments/arbitraryArgs.yaml +++ /dev/null @@ -1,10 +0,0 @@ -entries: - - description: > - Added the "--ansible-args" command-line flag that allows users to specify arbitrary - CLI arguments for ansible-based operators that are passed through ansible-runner. - For example, passing --ansible-vault as an arbitrary argument allows the user to store - sensitive data in encrypted files. - - kind: "addition" - - breaking: false diff --git a/changelog/fragments/bundle-validate-default-channel.yaml b/changelog/fragments/bundle-validate-default-channel.yaml deleted file mode 100644 index f6d8ca2a14d..00000000000 --- a/changelog/fragments/bundle-validate-default-channel.yaml +++ /dev/null @@ -1,10 +0,0 @@ -entries: - - description: > - The `generate bundle` subcommand no longer requires a default channel be set nor defaults - to the first channel provided to `--channels`. - kind: change - breaking: false - - description: > - The `bundle validate` subcommand no longer returns an error if a bundle does not have a default channel. - kind: change - breaking: false diff --git a/changelog/fragments/fix-csv-role-names.yaml b/changelog/fragments/fix-csv-role-names.yaml deleted file mode 100644 index 7f03f2874de..00000000000 --- a/changelog/fragments/fix-csv-role-names.yaml +++ /dev/null @@ -1,19 +0,0 @@ -entries: - - description: > - `generate ` will write RBAC objects (Roles, RoleBindings, their Cluster equivalents, - and ServiceAccounts) not bound to CSV deployment service accounts - to the resulting manifests directory. - kind: addition - - description: > - The `--update-crds` flag has been renamed to `--update-objects` for the `generate packagemanifests` subcommand. - kind: change - breaking: true - migration: - header: Rename `--update-crds` flag to `--update-objects` in `generate packagemanifests` invocations - body: > - This flag has been renamed to account for all objects that can be written to the package directory, - ex. Roles. - - description: > - Fixed incorrect (cluster) role name assignments in generated CSVs - [#3600](https://github.com/operator-framework/operator-sdk/issues/3600). - kind: bugfix diff --git a/changelog/fragments/move-scorecard-apis.yaml b/changelog/fragments/move-scorecard-apis.yaml deleted file mode 100644 index e8a58dbc050..00000000000 --- a/changelog/fragments/move-scorecard-apis.yaml +++ /dev/null @@ -1,12 +0,0 @@ -entries: - - description: > - Moved scorecard API v1alpha3 to the [api repo](https://github.com/operator-framework/api) - under `pkg/apis/scorecard/v1alpha3`. All future scorecard APIs will be released in this repo. - kind: removal - breaking: true - migration: - header: Update scorecard API Go import paths - body: > - The scorecard v1alpha3 API has been moved to a separate repo. Update your Go import paths: - From: `github.com/operator-framework/operator-framework/pkg/apis/scorecard/v1alpha3` - To: `github.com/operator-framework/api/pkg/apis/scorecard/v1alpha3` diff --git a/changelog/fragments/mv-version.yaml b/changelog/fragments/mv-version.yaml deleted file mode 100644 index a037f72868e..00000000000 --- a/changelog/fragments/mv-version.yaml +++ /dev/null @@ -1,9 +0,0 @@ -entries: - - description: Removed package `version` - kind: removal - breaking: true - migration: - header: Package `version` is no longer public - body: | - It is no longer possible to import package `version`. To - determine the version of operator-sdk, run `operator-sdk version`. diff --git a/changelog/fragments/operator-name-config.yaml b/changelog/fragments/operator-name-config.yaml deleted file mode 100644 index 21f103cd949..00000000000 --- a/changelog/fragments/operator-name-config.yaml +++ /dev/null @@ -1,14 +0,0 @@ -# entries is a list of entries to include in -# release notes and/or the migration guide -entries: - - description: > - Remove `--operator-name` from `generate` subcommands in favor of using `project-name` - from the PROJECT config file (v3-alpha+). - kind: removal - breaking: true - migration: - header: Remove `--operator-name` from scripts - body: > - The `--operator-name` flag has been removed from `generate bundle` and `generate packagemanifests` - subcommands. Remove this flag from your scripts, and make sure the `project-name` key is set in - your PROJECT file. If this key is not set, the current working directory's base name will be used. diff --git a/changelog/fragments/run-packagemanifests-flags-1.yaml b/changelog/fragments/run-packagemanifests-flags-1.yaml deleted file mode 100644 index ef532a35458..00000000000 --- a/changelog/fragments/run-packagemanifests-flags-1.yaml +++ /dev/null @@ -1,16 +0,0 @@ -entries: - - description: Removed the `--include-paths` flag from `run packagemanifests`. - kind: removal - breaking: true - migration: - header: Create resources manually that were passed to `run packagemanifests --include-paths` - body: > - The `run packagemanifests` subcommand no longer has the `--include-paths` flag to create - additional resources. Instead, use `kubectl apply -f ` before invoking `run packagemanifests`. - - description: Changed the `--operator-version` flag to `--version` in `run packagemanifests`. - kind: change - breaking: true - migration: - header: Change the `run packagemanifests` flag `--operator-version` to `--version` - body: > - `--operator-version` is now `--version`. diff --git a/changelog/fragments/run-packagemanifests-flags-2.yaml b/changelog/fragments/run-packagemanifests-flags-2.yaml deleted file mode 100644 index 6cd765db659..00000000000 --- a/changelog/fragments/run-packagemanifests-flags-2.yaml +++ /dev/null @@ -1,15 +0,0 @@ -entries: - - description: Removed the `--olm-namespace` flag from `run packagemanifests`. - kind: removal - breaking: true - migration: - header: Remove `--olm-namespace` from `run packagemanifests` invocations - body: > - OLM namespace is no longer required by this command. - - description: Changed the `--operator-namespace` flag to `--namespace` in `run packagemanifests`. - kind: change - breaking: true - migration: - header: Change the `run packagemanifests` flag `--operator-namespace` to `--namespace` - body: > - `--operator-namespace` is now `--namespace`. diff --git a/internal/version/version.go b/internal/version/version.go index d7ad3167fb7..94a9432e248 100644 --- a/internal/version/version.go +++ b/internal/version/version.go @@ -21,7 +21,7 @@ import ( //var needs to be used instead of const for ldflags var ( - Version = "v1.0.0-alpha.1+git" + Version = "v1.0.0-alpha.2" GitVersion = "unknown" GitCommit = "unknown" KubernetesVersion = "unknown" diff --git a/website/content/en/docs/installation/install-operator-sdk.md b/website/content/en/docs/installation/install-operator-sdk.md index b399e4ecf61..69f81770106 100644 --- a/website/content/en/docs/installation/install-operator-sdk.md +++ b/website/content/en/docs/installation/install-operator-sdk.md @@ -33,7 +33,7 @@ $ brew install operator-sdk ```sh # Set the release version variable -$ RELEASE_VERSION=v1.0.0-alpha.1 +$ RELEASE_VERSION=v1.0.0-alpha.2 # Linux $ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/operator-sdk-${RELEASE_VERSION}-x86_64-linux-gnu $ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/ansible-operator-${RELEASE_VERSION}-x86_64-linux-gnu diff --git a/website/content/en/docs/upgrading-sdk-version/v1.0.0-alpha.2.md b/website/content/en/docs/upgrading-sdk-version/v1.0.0-alpha.2.md new file mode 100644 index 00000000000..005c2042fa5 --- /dev/null +++ b/website/content/en/docs/upgrading-sdk-version/v1.0.0-alpha.2.md @@ -0,0 +1,79 @@ +--- +title: v1.0.0-alpha.2 +weight: 999000000 +--- + +## Use new logging flags when running the Ansible and Helm operators + +The Ansible and Helm operators now use controller-runtime's zap package +to define logging flags. + +The `--zap-sample` and `--zap-time-encoding` flag have been removed since +they are not present in controller-runtime's flagset. These flags are no +longer supported. + +The `--zap-level` flag is called `--zap-log-level` now. Rename any usage of +`--zap-level` to `--zap-log-level` + +_See [#3596](https://github.com/operator-framework/operator-sdk/pull/3596) for more details._ + +## Core Ansible and Helm operator logic moved to `run` subcommand + +If you are using the `ansible-operator` and `helm-operator` binaries +directly, update your usage to call `ansible-operator run` and +`helm-operator run` (e.g. in your Makefile's `make run` target). + +If you are using the base image and you are not overriding the operator +entrypoint, no change is necessary because the base image has been updated +to call the `run` subcommand by default. + +_See [#3596](https://github.com/operator-framework/operator-sdk/pull/3596) for more details._ + +## Rename `--update-crds` flag to `--update-objects` in `generate packagemanifests` invocations + +This flag has been renamed to account for all objects that can be written to the package directory, ex. Roles. + +_See [#3610](https://github.com/operator-framework/operator-sdk/pull/3610) for more details._ + +## Update scorecard API Go import paths + +The scorecard v1alpha3 API has been moved to a separate repo. Update your Go import paths: From: `github.com/operator-framework/operator-framework/pkg/apis/scorecard/v1alpha3` To: `github.com/operator-framework/api/pkg/apis/scorecard/v1alpha3` + +_See [#3622](https://github.com/operator-framework/operator-sdk/pull/3622) for more details._ + +## Package `version` is no longer public + +It is no longer possible to import package `version`. To +determine the version of operator-sdk, run `operator-sdk version`. + +_See [#3617](https://github.com/operator-framework/operator-sdk/pull/3617) for more details._ + +## Remove `--operator-name` from scripts + +The `--operator-name` flag has been removed from `generate bundle` and `generate packagemanifests` subcommands. Remove this flag from your scripts, and make sure the `project-name` key is set in your PROJECT file. If this key is not set, the current working directory's base name will be used. + +_See [#3530](https://github.com/operator-framework/operator-sdk/pull/3530) for more details._ + +## Create resources manually that were passed to `run packagemanifests --include-paths` + +The `run packagemanifests` subcommand no longer has the `--include-paths` flag to create additional resources. Instead, use `kubectl apply -f ` before invoking `run packagemanifests`. + +_See [#3599](https://github.com/operator-framework/operator-sdk/pull/3599) for more details._ + +## Change the `run packagemanifests` flag `--operator-version` to `--version` + +`--operator-version` is now `--version`. + +_See [#3599](https://github.com/operator-framework/operator-sdk/pull/3599) for more details._ + +## Remove `--olm-namespace` from `run packagemanifests` invocations + +OLM namespace is no longer required by this command. + +_See [#3601](https://github.com/operator-framework/operator-sdk/pull/3601) for more details._ + +## Change the `run packagemanifests` flag `--operator-namespace` to `--namespace` + +`--operator-namespace` is now `--namespace`. + +_See [#3601](https://github.com/operator-framework/operator-sdk/pull/3601) for more details._