-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Camila Macedo
committed
Feb 3, 2021
1 parent
fbce7e7
commit a214328
Showing
216 changed files
with
1,115 additions
and
736 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # entries is a list of entries to include in | ||
| # release notes and/or the migration guide | ||
| entries: | ||
| - description: > | ||
| For Go-based operators, fix layout of the PROJECT file that stores the resources. More info: [#kubernetes-sigs/kubebuilder#1899](https://github.com/kubernetes-sigs/kubebuilder/pull/1899). | ||
| kind: "bugfix" | ||
| breaking: false | ||
| migration: | ||
| header: Fix data scaffolded in PROJECT file | ||
| body: > | ||
| It is valid only for projects scaffolded with SDK 1.3.0 release or that was upgraded to go/v3 using the changes of this release. | ||
| In the PROJECT file, replace `- crdVersion: <crdVersion>` with `- api.crdVersion: <crdVersion>` and `webhookVersion: <webhookVersion>` with `webhooks.webhookVersion: <webhookVersion>`. Ensure that the resources in your project file results are like: | ||
| ```yml | ||
| resources: | ||
| - api: | ||
| crdVersion: v1 | ||
| group: cache | ||
| kind: Memcached | ||
| version: v1alpha1 | ||
| webhooks: | ||
| webhookVersion: v1 | ||
| ``` | ||
| - description: > | ||
| Remove spaces from maker comments to make them machine-readable. More info: [#kubernetes-sigs/kubebuilder#1868](https://github.com/kubernetes-sigs/kubebuilder/pull/1868). | ||
| kind: "bugfix" | ||
| breaking: false | ||
| migration: | ||
| header: Update the comments makers of your project to make them machibe redable. | ||
| body: > | ||
| Update your project files removing the maker's comments spaces as follows: | ||
| - Replace `# +kubebuilder` with `#+kubebuilder` | ||
| - Replace `// +groupName` with `//+groupName` | ||
| - (For Go-based operators only) Replace `// +operator-sdk` with `//+operator-sdk` | ||
| - description: > | ||
| Add help option for operator projects scaffolded with the tool. | ||
| kind: "addition" | ||
| breaking: false | ||
| migration: | ||
| header: Update your Makefile to have a help command for your project helpers | ||
| body: > | ||
| You can check the Makefile files of the testdata samples in the tag release branch to know how you can update | ||
| your Makefile accordingly to have an help option. See: https://github.com/operator-framework/operator-sdk/tree/v1.4.x/testdata | ||
| - description: > | ||
| Add support for markers for files with the `yml` extension. More info: [#kubernetes-sigs/kubebuilder#1907](https://github.com/kubernetes-sigs/kubebuilder/pull/1907). | ||
| kind: "addition" | ||
| breaking: false | ||
| - description: > | ||
| For Go-based operators using go/v3 plugin only, add the `--force` option to the `create webhook` command. More info: [#kubernetes-sigs/kubebuilder#1903](https://github.com/kubernetes-sigs/kubebuilder/pull/1903). | ||
| kind: "addition" | ||
| breaking: false | ||
| - description: > | ||
| For Go-based operators, fix `--force` option to recreate the files via `create api` command. More info: [#kubernetes-sigs/kubebuilder#1903](https://github.com/kubernetes-sigs/kubebuilder/pull/1903). | ||
| kind: "bugfix" | ||
| breaking: false | ||
| - description: > | ||
| For Go-based operators using go/v3 plugin only, upgrade the sigs.k8s.io/kubebuilder-declarative-pattern dependency (used only to gen api with --pattern=addon). More info: [#kubernetes-sigs/kubebuilder#1946](https://github.com/kubernetes-sigs/kubebuilder/pull/1946). | ||
| kind: "change" | ||
| breaking: false | ||
| - description: > | ||
| For Go-based operators, fix the name of the files to be edit in the comments of `[kind]_types.go` files. More info: [#kubernetes-sigs/kubebuilder#1927](https://github.com/kubernetes-sigs/kubebuilder/pull/1927). | ||
| kind: "bugfix" | ||
| breaking: false | ||
| header: Fix the name of the files in the comments on the `<kind>_types.go` files | ||
| body: > | ||
| When we use `$operator-sdk create api` or `$operator-sdk create webhook`, it generates a file like `[kind]_types.go`. In this file, there is a comment that indicates which file to change when adding a field. | ||
| You can update it with the correct value if you wich by replacing the Kind for lower case, such as replace `Edit Memcached_types.go to remove/update` with `Edit memcached_types.go to remove/update` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| # entries is a list of entries to include in | ||
| # release notes and/or the migration guide | ||
| entries: | ||
| - description: > | ||
| For Go-based operators, fix layout of the PROJECT file that stores the resources. More info: [#kubernetes-sigs/kubebuilder#1899](https://github.com/kubernetes-sigs/kubebuilder/pull/1899). | ||
| kind: "bugfix" | ||
| breaking: false | ||
| migration: | ||
| header: Fix data scaffolded in PROJECT file | ||
| body: > | ||
| It is valid only for projects scaffolded with SDK 1.3.0 release or that was upgraded to go/v3 using the changes of this release. | ||
| In the PROJECT file, replace `- crdVersion: <crdVersion>` with `- api.crdVersion: <crdVersion>` and `webhookVersion: <webhookVersion>` with `webhooks.webhookVersion: <webhookVersion>`. Ensure that the resources in your project file results are like: | ||
| ```yml | ||
| resources: | ||
| - api: | ||
| crdVersion: v1 | ||
| group: cache | ||
| kind: Memcached | ||
| version: v1alpha1 | ||
| webhooks: | ||
| webhookVersion: v1 | ||
| ``` | ||
| - description: > | ||
| Remove spaces from maker comments to make them machine-readable. More info: [#kubernetes-sigs/kubebuilder#1868](https://github.com/kubernetes-sigs/kubebuilder/pull/1868). | ||
| kind: "bugfix" | ||
| breaking: false | ||
| migration: | ||
| header: Update the comments makers of your project to make them machibe redable. | ||
| body: > | ||
| Update your project files removing the maker's comments spaces as follows: | ||
| - Replace `# +kubebuilder` with `#+kubebuilder` | ||
| - Replace `// +groupName` with `//+groupName` | ||
| - (For Go-based operators only) Replace `// +operator-sdk` with `//+operator-sdk` | ||
| - description: > | ||
| Add help option for Makefile targets. | ||
| kind: "addition" | ||
| breaking: false | ||
| migration: | ||
| header: Update your Makefile to have a help command for your project helpers | ||
| body: > | ||
| You can check the Makefile files of the testdata samples in the tag release branch to know how you can update | ||
| your Makefile accordingly to have an help option. See: https://github.com/operator-framework/operator-sdk/tree/v1.4.x/testdata/ | ||
| - description: > | ||
| Add support for markers for files with the `yml` extension. More info: [#kubernetes-sigs/kubebuilder#1907](https://github.com/kubernetes-sigs/kubebuilder/pull/1907). | ||
| kind: "addition" | ||
| breaking: false | ||
| - description: > | ||
| For Go-based operators using go/v3 plugin only, add the `--force` option to the `create webhook` command. More info: [#kubernetes-sigs/kubebuilder#1903](https://github.com/kubernetes-sigs/kubebuilder/pull/1903). | ||
| kind: "addition" | ||
| breaking: false | ||
| - description: > | ||
| For Go-based operators, fix `--force` option to recreate the files via `create api` command. More info: [#kubernetes-sigs/kubebuilder#1903](https://github.com/kubernetes-sigs/kubebuilder/pull/1903). | ||
| kind: "bugfix" | ||
| breaking: false | ||
| - description: > | ||
| For Go-based operators using go/v3 plugin only, upgrade the sigs.k8s.io/kubebuilder-declarative-pattern dependency (used only to gen api with --pattern=addon). More info: [#kubernetes-sigs/kubebuilder#1946](https://github.com/kubernetes-sigs/kubebuilder/pull/1946). | ||
| kind: "change" | ||
| breaking: false | ||
| - description: > | ||
| For Go-based operators, fix the name of the files to be edit in the comments of `[kind]_types.go` files. More info: [#kubernetes-sigs/kubebuilder#1927](https://github.com/kubernetes-sigs/kubebuilder/pull/1927). | ||
| kind: "bugfix" | ||
| breaking: false | ||
| header: Fix the name of the files in the comments on the `<kind>_types.go` files | ||
| body: > | ||
| When we use `$operator-sdk create api` or `$operator-sdk create webhook`, it generates a file like `[kind]_types.go`. In this file, there is a comment that indicates which file to change when adding a field. | ||
| You can update it with the correct value if you wich by replacing the Kind for lower case, such as replace `Edit Memcached_types.go to remove/update` with `Edit memcached_types.go to remove/update` | ||
| - description: > | ||
| Upgrade the `kube-rbac-proxy` image version from 0.5.0 to 0.8.0 to address security concerns. More info [#kubernetes-sigs/kubebuilder#1955](https://github.com/kubernetes-sigs/kubebuilder/pull/1955). | ||
| kind: "bugfix" | ||
| breaking: false | ||
| header: Upgrade the `kube-rbac-proxy` from 0.5.0 to 0.8.0 to solve security concerns | ||
| body: > | ||
| In the `config/default/manager_auth_proxy_patch.yaml` file, replace `gcr.io/kubebuilder/kube-rbac-proxy:v0.5.0` with `gcr.io/kubebuilder/kube-rbac-proxy:v0.8.0`. | ||
| - description: > | ||
| For Go-based operators, fix the endpoint names. More info [#kubernetes-sigs/kubebuilder#1910](https://github.com/kubernetes-sigs/kubebuilder/pull/1910). | ||
| kind: "bugfix" | ||
| breaking: false | ||
| header: For Go-based operators, fix the endpoint names | ||
| body: > | ||
| In the `main.go` file, replace `health` with `healthz` and `ready` with `readyz` then, it would look like: | ||
| ```go | ||
| if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil { | ||
| setupLog.Error(err, "unable to set up health check") | ||
| os.Exit(1) | ||
| } | ||
| if err := mgr.AddReadyzCheck("readyz", healthz.Ping); err != nil { | ||
| setupLog.Error(err, "unable to set up ready check") | ||
| os.Exit(1) | ||
| } | ||
| ``` | ||
| - description: > | ||
| For Go-based operators, add `ErrorIfCRDPathMissing` config by default to the `suite_tests.go`. More info [#kubernetes-sigs/kubebuilder#1910](https://github.com/kubernetes-sigs/kubebuilder/pull/1910). | ||
| kind: "addition" | ||
| breaking: false | ||
| header: For Go-based operators, add `ErrorIfCRDPathMissing` config option if please you. | ||
| body: > | ||
| In the `controllers/<kind>/suite_test.go` file(s), add the option `ErrorIfCRDPathMissing` to raise an issue if the CRDs path be missing which would like: | ||
| ```go | ||
| By("bootstrapping test environment") | ||
| testEnv = &envtest.Environment{ | ||
| CRDDirectoryPaths: []string{filepath.Join("..", "..", "config", "crd", "bases")}, | ||
| ErrorIfCRDPathMissing: true, | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.