Skip to content

Commit

Permalink
Release PR for v1.0.0-alpha.2 (#3628)
Browse files Browse the repository at this point in the history
  • Loading branch information
varshaprasad96 authored Aug 1, 2020
1 parent 3270033 commit 182f021
Show file tree
Hide file tree
Showing 13 changed files with 111 additions and 145 deletions.
30 changes: 30 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
38 changes: 0 additions & 38 deletions changelog/fragments/ansible-helm-cobra.yaml

This file was deleted.

10 changes: 0 additions & 10 deletions changelog/fragments/arbitraryArgs.yaml

This file was deleted.

10 changes: 0 additions & 10 deletions changelog/fragments/bundle-validate-default-channel.yaml

This file was deleted.

19 changes: 0 additions & 19 deletions changelog/fragments/fix-csv-role-names.yaml

This file was deleted.

12 changes: 0 additions & 12 deletions changelog/fragments/move-scorecard-apis.yaml

This file was deleted.

9 changes: 0 additions & 9 deletions changelog/fragments/mv-version.yaml

This file was deleted.

14 changes: 0 additions & 14 deletions changelog/fragments/operator-name-config.yaml

This file was deleted.

16 changes: 0 additions & 16 deletions changelog/fragments/run-packagemanifests-flags-1.yaml

This file was deleted.

15 changes: 0 additions & 15 deletions changelog/fragments/run-packagemanifests-flags-2.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion internal/version/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
79 changes: 79 additions & 0 deletions website/content/en/docs/upgrading-sdk-version/v1.0.0-alpha.2.md
Original file line number Diff line number Diff line change
@@ -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 <paths>` 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._

0 comments on commit 182f021

Please sign in to comment.