Skip to content

Commit 88abadb

Browse files
committed
migration: add breaking change to migration guide
1 parent 633e1b9 commit 88abadb

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/migration/version-upgrade-guide.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -984,21 +984,21 @@ func serveCRMetrics(cfg *rest.Config, operatorNs string) error {
984984
### Breaking changes
985985

986986
#### `TestCtx` in `pkg/test` has been deprecated
987-
987+
988988
The type name `TestCtx` in `pkg/test` has been deprecated and renamed to `Context`. Users of the e2e framework should do the following:
989-
989+
990990
- Replace `TestCtx` with `Context`
991991
- Replace `NewTestCtx` with `NewContext`
992992

993993
#### Scorecard only supports YAML config files
994-
994+
995995
The scorecard feature now only supports YAML config files. Config files with other extensions are no longer supported and should be changed to the YAML format. For further information see [`scorecard config file`](https://github.com/operator-framework/operator-sdk/blob/v0.16.x/doc/test-framework/scorecard.md#config-file)
996-
997-
### Breaking Changes for Ansible
998996

999-
#### Remove Ansible container sidecar
997+
### Breaking Changes for Ansible
998+
999+
#### Remove Ansible container sidecar
10001000

1001-
The Ansible logs are now output in the operator container, so there is no longer a need for the Ansible container sidecar. To reflect this change, update the `deploy/operator.yaml` file as follows.
1001+
The Ansible logs are now output in the operator container, so there is no longer a need for the Ansible container sidecar. To reflect this change, update the `deploy/operator.yaml` file as follows.
10021002

10031003
Remove:
10041004

@@ -1068,13 +1068,13 @@ The methods `ctx.GetOperatorNamespace()` and `ctx.GetWatchNamespace()` was added
10681068

10691069
This release contains breaking changes in some commands.
10701070

1071-
- The --namespace flag from `operator-sdk run --local` command, `operator-sdk test --local` command and `operator-sdk cleanup` command was deprecated and was replaced by --watch-namespace and --operator-namespace .
1071+
- The --namespace flag from `operator-sdk run --local` command, `operator-sdk test --local` command and `operator-sdk cleanup` command was deprecated and was replaced by --watch-namespace and --operator-namespace. [#2617](https://github.com/operator-framework/operator-sdk/pull/2617)
10721072

10731073
Note that --watch-namespace can be used to set the namespace(s) which the operator will watch for changes. It will set the environment variable WATCH_NAMESPACE. Use explicitly an empty string to watch all namespaces or inform a List of namespaces such as "ns1,ns2" when the operator is cluster-scoped. If you use a List, then it needs contains the namespace where the operator is "deployed" in since the default metrics implementation will manage resources in the Operator's namespace. By default, it will be the Operator Namespace.
10741074

10751075
Then, use the flag --operator-namespace to inform the namespace where the Operator will be "deployed" in and then, it will set the environment variable OPERATOR_NAMESPACE. If this value is not set, then it will be the namespace defined as default in the Kubeconfig.
10761076

1077-
NOTE: For more information check the PRs which are responsible for the above changes [#2617](https://github.com/operator-framework/operator-sdk/pull/2617).
1077+
- If you've run `operator-sdk bundle create --generate-only`, move your bundle Dockerfile at `<project-root>/deploy/olm-catalog/<operator-name>/Dockerfile` to `<project-root>/bundle.Dockerfile` and update the first `COPY` from `COPY /*.yaml manifests/` to `COPY deploy/olm-catalog/<operator-name>/<bundle-dir> manifests/`. [#2715](https://github.com/operator-framework/operator-sdk/pull/2715)
10781078

10791079
[legacy-kubebuilder-doc-crd]: https://book-v1.book.kubebuilder.io/beyond_basics/generating_crd.html
10801080
[v0.8.2-go-mod]: https://github.com/operator-framework/operator-sdk/blob/28bd2b0d4fd25aa68e15d928ae09d3c18c3b51da/internal/pkg/scaffold/go_mod.go#L40-L94

0 commit comments

Comments
 (0)