From 78d9fe61c4e171d832fb00f50f915bd1c5b82fd8 Mon Sep 17 00:00:00 2001 From: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com> Date: Tue, 6 Dec 2022 07:23:00 +0000 Subject: [PATCH] :book: Update docs for release 3.8.0 (#3109) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Fix nil pointer in Finalizer example * :book: fix link for platform support * update kubebuilder core dependencies for k8s 1.25 Signed-off-by: Bryce Palmer * docs: notify deps install to build book * Update controller-tools version (v0.9.2->v0.10.0) * :bug: remove duplicate words and fix spelling mistakes * :sparkles: update kubebuilder kubernetes version * Update the export path of webhook * :book: fix broken links * fixing the kubebuilder install locally curl request * add dependency bot updates * :seedling: Bump actions/checkout from 2 to 3 Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v2...v3) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] * :seedling: Bump actions/setup-go from 2 to 3 Bumps [actions/setup-go](https://github.com/actions/setup-go) from 2 to 3. - [Release notes](https://github.com/actions/setup-go/releases) - [Commits](https://github.com/actions/setup-go/compare/v2...v3) --- updated-dependencies: - dependency-name: actions/setup-go dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] * :seedling: Bump goreleaser/goreleaser-action from 2 to 3 Bumps [goreleaser/goreleaser-action](https://github.com/goreleaser/goreleaser-action) from 2 to 3. - [Release notes](https://github.com/goreleaser/goreleaser-action/releases) - [Commits](https://github.com/goreleaser/goreleaser-action/compare/v2...v3) --- updated-dependencies: - dependency-name: goreleaser/goreleaser-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] * Bump github.com/spf13/afero from 1.6.0 to 1.9.2 Bumps [github.com/spf13/afero](https://github.com/spf13/afero) from 1.6.0 to 1.9.2. - [Release notes](https://github.com/spf13/afero/releases) - [Commits](https://github.com/spf13/afero/compare/v1.6.0...v1.9.2) --- updated-dependencies: - dependency-name: github.com/spf13/afero dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump github.com/onsi/gomega from 1.19.0 to 1.20.2 Bumps [github.com/onsi/gomega](https://github.com/onsi/gomega) from 1.19.0 to 1.20.2. - [Release notes](https://github.com/onsi/gomega/releases) - [Changelog](https://github.com/onsi/gomega/blob/master/CHANGELOG.md) - [Commits](https://github.com/onsi/gomega/compare/v1.19.0...v1.20.2) --- updated-dependencies: - dependency-name: github.com/onsi/gomega dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump github.com/sirupsen/logrus from 1.8.1 to 1.9.0 Bumps [github.com/sirupsen/logrus](https://github.com/sirupsen/logrus) from 1.8.1 to 1.9.0. - [Release notes](https://github.com/sirupsen/logrus/releases) - [Changelog](https://github.com/sirupsen/logrus/blob/master/CHANGELOG.md) - [Commits](https://github.com/sirupsen/logrus/compare/v1.8.1...v1.9.0) --- updated-dependencies: - dependency-name: github.com/sirupsen/logrus dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump k8s.io/apimachinery from 0.25.0 to 0.25.2 Bumps [k8s.io/apimachinery](https://github.com/kubernetes/apimachinery) from 0.25.0 to 0.25.2. - [Release notes](https://github.com/kubernetes/apimachinery/releases) - [Commits](https://github.com/kubernetes/apimachinery/compare/v0.25.0...v0.25.2) --- updated-dependencies: - dependency-name: k8s.io/apimachinery dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] * Bump github.com/gobuffalo/flect from 0.2.5 to 0.3.0 Bumps [github.com/gobuffalo/flect](https://github.com/gobuffalo/flect) from 0.2.5 to 0.3.0. - [Release notes](https://github.com/gobuffalo/flect/releases) - [Commits](https://github.com/gobuffalo/flect/compare/v0.2.5...v0.3.0) --- updated-dependencies: - dependency-name: github.com/gobuffalo/flect dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * docs: describe e2e test towards plugin Co-authored-by: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com> * :seedling: remove WORKSPACE file commited by mistake * remove unused value * Bump github.com/spf13/cobra from 1.4.0 to 1.5.0 Bumps [github.com/spf13/cobra](https://github.com/spf13/cobra) from 1.4.0 to 1.5.0. - [Release notes](https://github.com/spf13/cobra/releases) - [Commits](https://github.com/spf13/cobra/compare/v1.4.0...v1.5.0) --- updated-dependencies: - dependency-name: github.com/spf13/cobra dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump github.com/onsi/ginkgo/v2 from 2.1.6 to 2.2.0 Bumps [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) from 2.1.6 to 2.2.0. - [Release notes](https://github.com/onsi/ginkgo/releases) - [Changelog](https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md) - [Commits](https://github.com/onsi/ginkgo/compare/v2.1.6...v2.2.0) --- updated-dependencies: - dependency-name: github.com/onsi/ginkgo/v2 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump github.com/cloudflare/cfssl from 1.5.0 to 1.6.3 Bumps [github.com/cloudflare/cfssl](https://github.com/cloudflare/cfssl) from 1.5.0 to 1.6.3. - [Release notes](https://github.com/cloudflare/cfssl/releases) - [Changelog](https://github.com/cloudflare/cfssl/blob/master/CHANGELOG) - [Commits](https://github.com/cloudflare/cfssl/compare/v1.5.0...v1.6.3) --- updated-dependencies: - dependency-name: github.com/cloudflare/cfssl dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * update simple-external-plugin-tutorial * update mdbook * :warning: remove config-gen alpha option * :book: clarifies plugins available and its usage * :book: update doc samples * :sparkles: (go/v4-alpha) : update kustomize version from 4.5.5 to 4.5.7 * :sparkles: (grafana/v1-alpha) : add custom units for custom grafana dashboards (#2965) :sparkles: add custom units for custom grafana dashboards Signed-off-by: Jirka Kremser Signed-off-by: Jirka Kremser * cleanup: cert-manager and prometheus installs into e2e tests * Apply suggestions from code review * fixed bug for component-config flag updated testdata * Make jmrodri and varsha admins Signed-off-by: jesus m. rodriguez * Bump github.com/onsi/gomega from 1.20.2 to 1.21.1 Bumps [github.com/onsi/gomega](https://github.com/onsi/gomega) from 1.20.2 to 1.21.1. - [Release notes](https://github.com/onsi/gomega/releases) - [Changelog](https://github.com/onsi/gomega/blob/master/CHANGELOG.md) - [Commits](https://github.com/onsi/gomega/compare/v1.20.2...v1.21.1) --- updated-dependencies: - dependency-name: github.com/onsi/gomega dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * :book: Updating doc with Installation steps of cert-manager and prometheus (#2982) * Adding installing steps for testing webhooks Adding installing steps for testing webhooks Adding installing steps for testing webhooks Adding installing steps for testing webhooks Adding installing steps for testing webhooks Adding installing steps for testing webhooks Adding installing steps for testing webhooks Adding installing steps for testing webhooks Adding installing steps for testing webhooks Adding installing steps for testing webhooks Adding installing steps for testing webhooks Adding installing steps for testing webhooks * Adding installing steps for testing webhooks * Adding installing steps for testing webhooks * Adding installing steps for testing webhooks * 🐛 : leader-elect arg scaffolded should be scaffolded when component config option is not used (#3013) * updated templates for component config * updates * update * update revert main.go * update revert main.go * revert changes and go thru docs once * Update make build cmd with manifests * Bump github.com/spf13/cobra from 1.5.0 to 1.6.0 Bumps [github.com/spf13/cobra](https://github.com/spf13/cobra) from 1.5.0 to 1.6.0. - [Release notes](https://github.com/spf13/cobra/releases) - [Commits](https://github.com/spf13/cobra/compare/v1.5.0...v1.6.0) --- updated-dependencies: - dependency-name: github.com/spf13/cobra dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump golang.org/x/text from 0.3.7 to 0.4.0 Bumps [golang.org/x/text](https://github.com/golang/text) from 0.3.7 to 0.4.0. - [Release notes](https://github.com/golang/text/releases) - [Commits](https://github.com/golang/text/compare/v0.3.7...v0.4.0) --- updated-dependencies: - dependency-name: golang.org/x/text dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * :seeding: update CLI deps * golangci-lint: add recommended revive checks to linter-settings but disable checks with to many findings. Fix findings * Improve rendering of the documentation This fixes various rendering issues: * Wrong or uninterpreted formatting * Some missing links * Incorrect markup * Missing documentation pages This doesn't fix all the links but at least the initial ones. * update cronjob to use batchv1 api * Fix grammar in comment Change `these is` to `these are` * Enable revive unused-parameter check and fix findings * Bump github.com/onsi/ginkgo/v2 from 2.3.1 to 2.4.0 Bumps [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) from 2.3.1 to 2.4.0. - [Release notes](https://github.com/onsi/ginkgo/releases) - [Changelog](https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md) - [Commits](https://github.com/onsi/ginkgo/compare/v2.3.1...v2.4.0) --- updated-dependencies: - dependency-name: github.com/onsi/ginkgo/v2 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump github.com/spf13/cobra from 1.6.0 to 1.6.1 Bumps [github.com/spf13/cobra](https://github.com/spf13/cobra) from 1.6.0 to 1.6.1. - [Release notes](https://github.com/spf13/cobra/releases) - [Commits](https://github.com/spf13/cobra/compare/v1.6.0...v1.6.1) --- updated-dependencies: - dependency-name: github.com/spf13/cobra dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] * Update github workflow to use same golangci-lint minor version as Makefile * fix docker buildx args Signed-off-by: Mikhail Sidorov * 🐛 (kustomize/v2-alpha): Fix typo issue in the labels added to the manifests (#3047) * Fix typo in kubernets (missing 'e') * make generate * Add KB project git-repo and edit icons * Add doc FAQ section * docs: supplement plugin creation * Update joelanford/go-apidiff (v0.4.0 -> v0.5.0) * Bump github.com/onsi/gomega from 1.22.1 to 1.23.0 Bumps [github.com/onsi/gomega](https://github.com/onsi/gomega) from 1.22.1 to 1.23.0. - [Release notes](https://github.com/onsi/gomega/releases) - [Changelog](https://github.com/onsi/gomega/blob/master/CHANGELOG.md) - [Commits](https://github.com/onsi/gomega/compare/v1.22.1...v1.23.0) --- updated-dependencies: - dependency-name: github.com/onsi/gomega dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump github.com/onsi/gomega from 1.23.0 to 1.24.0 Bumps [github.com/onsi/gomega](https://github.com/onsi/gomega) from 1.23.0 to 1.24.0. - [Release notes](https://github.com/onsi/gomega/releases) - [Changelog](https://github.com/onsi/gomega/blob/master/CHANGELOG.md) - [Commits](https://github.com/onsi/gomega/compare/v1.23.0...v1.24.0) --- updated-dependencies: - dependency-name: github.com/onsi/gomega dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump github.com/onsi/ginkgo/v2 from 2.4.0 to 2.5.0 Bumps [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) from 2.4.0 to 2.5.0. - [Release notes](https://github.com/onsi/ginkgo/releases) - [Changelog](https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md) - [Commits](https://github.com/onsi/ginkgo/compare/v2.4.0...v2.5.0) --- updated-dependencies: - dependency-name: github.com/onsi/ginkgo/v2 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump github.com/spf13/afero from 1.9.2 to 1.9.3 Bumps [github.com/spf13/afero](https://github.com/spf13/afero) from 1.9.2 to 1.9.3. - [Release notes](https://github.com/spf13/afero/releases) - [Commits](https://github.com/spf13/afero/compare/v1.9.2...v1.9.3) --- updated-dependencies: - dependency-name: github.com/spf13/afero dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] * Bump golang.org/x/tools from 0.2.0 to 0.3.0 Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.2.0 to 0.3.0. - [Release notes](https://github.com/golang/tools/releases) - [Commits](https://github.com/golang/tools/compare/v0.2.0...v0.3.0) --- updated-dependencies: - dependency-name: golang.org/x/tools dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump github.com/onsi/gomega from 1.24.0 to 1.24.1 Bumps [github.com/onsi/gomega](https://github.com/onsi/gomega) from 1.24.0 to 1.24.1. - [Release notes](https://github.com/onsi/gomega/releases) - [Changelog](https://github.com/onsi/gomega/blob/master/CHANGELOG.md) - [Commits](https://github.com/onsi/gomega/compare/v1.24.0...v1.24.1) --- updated-dependencies: - dependency-name: github.com/onsi/gomega dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] * fix typo in Makefile * :sparkles: add version check for makefile template tools (#3077) * add version check for makefile template tools Prevent running controller-gen and kustomize commands with a version that does not match the one specified in the corresponding CONTROLLER_TOOLS_VERSION or KUSTOMIZE_VERSION vars Addresses https://github.com/kubernetes-sigs/kubebuilder/issues/3068 * Update makefile target descriptions * Updated descriptions for `kustomize` and `controller-gen` targets. * Reformatted `controller-gen` recipe to reduce line length Signed-off-by: Eduardo Coria * update makefile samples Signed-off-by: Eduardo Coria Signed-off-by: Eduardo Coria * fix unexpected end of file error in makefiles Signed-off-by: Eduardo Coria * :sparkles: Add go/v4 base and migration guide Co-authored-by: Varsha * Update docs/book/src/plugins/go-v4-plugin.md Co-authored-by: Varsha * Update docs/book/src/migration/legacy.md Co-authored-by: Varsha * Update docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md Co-authored-by: Varsha * Update docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md Co-authored-by: Varsha * Update docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md Co-authored-by: Varsha * (go/v3,go/v4-alpha): Upgrade controller-runtime version from 1.13.0 to 1.13.1 * 📖 : suggest specify plugin for pr * Bump github.com/onsi/ginkgo/v2 from 2.5.0 to 2.5.1 Bumps [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) from 2.5.0 to 2.5.1. - [Release notes](https://github.com/onsi/ginkgo/releases) - [Changelog](https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md) - [Commits](https://github.com/onsi/ginkgo/compare/v2.5.0...v2.5.1) --- updated-dependencies: - dependency-name: github.com/onsi/ginkgo/v2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] * docs: fix typo in the component config tutorial Signed-off-by: Andreas Gerstmayr * 🌱: refact testdata * ✨ (kustomize/v2-alpha): add kustomize file to track crd sample info * add action to lint yaml and fix existing yamllint failures Signed-off-by: Bryce Palmer * update yamllint to now be run via Makefile Signed-off-by: Bryce Palmer * run yamllint target as part of lint target Signed-off-by: Bryce Palmer * add yamllint job back as the lint job only runs golangci-lint Signed-off-by: Bryce Palmer * bump proxy image * fix: Remove trailing space making yamllint fail on new project * (kustomize/v2-alpha): change kustomization file to track samples to use marker instead of overwritting * (deployimage/v1-alpha): fix error to scaffold go/v4-alpha projects * Replace restricted-access ComponentConfig design doc link with the public one Signed-off-by: Michail Resvanis Signed-off-by: Bryce Palmer Signed-off-by: dependabot[bot] Signed-off-by: Jirka Kremser Signed-off-by: jesus m. rodriguez Signed-off-by: Mikhail Sidorov Signed-off-by: Eduardo Coria Signed-off-by: Andreas Gerstmayr Signed-off-by: Michail Resvanis Co-authored-by: Simon Jürgensmeyer <6493966+sj14@users.noreply.github.com> Co-authored-by: Kubernetes Prow Robot Co-authored-by: Camila Macedo Co-authored-by: Bryce Palmer Co-authored-by: Tony Co-authored-by: Oscar Utbult Co-authored-by: Yash Singh Co-authored-by: Abhishek koserwal Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jirka Kremser <535866+jkremser@users.noreply.github.com> Co-authored-by: laxmikantbpandhare Co-authored-by: jesus m. rodriguez Co-authored-by: Phillip Wittrock Co-authored-by: Yash Singh <99066083+yashsingh74@users.noreply.github.com> Co-authored-by: Laxmikant Bhaskar Pandhare <47066536+laxmikantbpandhare@users.noreply.github.com> Co-authored-by: astraw99 Co-authored-by: Jonathan Ballet Co-authored-by: Krishna Indani Co-authored-by: Nicholas Seemiller Co-authored-by: Mikhail Sidorov Co-authored-by: Marc Villacorta Co-authored-by: Shunsuke Ise Co-authored-by: Eduardo M Coria Co-authored-by: Eduardo Coria Co-authored-by: Varsha Co-authored-by: Andreas Gerstmayr Co-authored-by: Erik Godding Boye Co-authored-by: Michail Resvanis --- docs/book/src/SUMMARY.md | 2 +- .../manually_migration_guide_gov3_to_gov4.md | 18 +++++++++--------- docs/book/src/migration/v3vsv4.md | 4 ++-- docs/book/src/plugins/creating-plugins.md | 12 ++++++------ docs/book/src/plugins/go-v4-plugin.md | 14 +++++++------- 5 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index a2eb8a02ae0..d664e6bdf2f 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -69,7 +69,7 @@ - [Migration by updating the files](migration/legacy/manually_migration_guide_v2_v3.md) - [From v3.0.0 with plugins](./migration/v3-plugins.md) - [go/v3 vs go/v4-alpha](migration/v3vsv4.md) - + - [Migration Guide](migration/migration_guide_gov3_to_gov4.md) - [Migration by updating the files](migration/manually_migration_guide_gov3_to_gov4.md) - [Single Group to Multi-Group](./migration/multi-group.md) diff --git a/docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md b/docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md index e776bb5beb9..87172effcf2 100644 --- a/docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md +++ b/docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md @@ -16,14 +16,14 @@ The recommended upgrade approach is to follow the [Migration Guide go/v3 to go/v ## Migration from project config version "go/v3" to "go/v4" -Update the `PROJECT` file layout which stores information about the resources that are used to enable plugins make +Update the `PROJECT` file layout which stores information about the resources that are used to enable plugins make useful decisions while scaffolding. The `layout` field indicates the scaffolding and the primary plugin version in use. ### Steps to migrate #### Migrate the layout version into the PROJECT file -The following steps describe the manual changes required to bring the project configuration file (`PROJECT`). +The following steps describe the manual changes required to bring the project configuration file (`PROJECT`). These change will add the information that Kubebuilder would add when generating the file. This file can be found in the root directory. Update the PROJECT file by replacing: @@ -64,7 +64,7 @@ Therefore, you can check the changes in the layout results into: - Create a new directory `cmd` and move the `main.go` under it. - If your project support multi-group the APIs are scaffold under a directory called `apis`. Rename this directory to `api` -- Move the `controllers` directory under the `internal` and rename it for `controller` +- Move the `controllers` directory under the `internal` and rename it for `controller` - Now ensure that the imports will be updated accordingly by: - Update the `main.go` imports to look for the new path of your controllers under the `pkg` directory @@ -136,17 +136,17 @@ Note that if your project has multiple groups (`multigroup:true`) then the above The PROJECT tracks the paths of all APIs used in your project. Ensure that they now point to `api/...` as the following example: Before update: - group: crew - kind: Captain - path: sigs.k8s.io/kubebuilder/testdata/project-v4/apis/crew/v1 +group: crew +kind: Captain +path: sigs.k8s.io/kubebuilder/testdata/project-v4/apis/crew/v1 ``` After Update: ``` - group: crew - kind: Captain - path: sigs.k8s.io/kubebuilder/testdata/project-v4/api/crew/v1 +group: crew +kind: Captain +path: sigs.k8s.io/kubebuilder/testdata/project-v4/api/crew/v1 ``` ### Update kustomize manifests with the changes made so far diff --git a/docs/book/src/migration/v3vsv4.md b/docs/book/src/migration/v3vsv4.md index 403b21411ac..9c97674a75a 100644 --- a/docs/book/src/migration/v3vsv4.md +++ b/docs/book/src/migration/v3vsv4.md @@ -20,8 +20,8 @@ The details of all changes (breaking or otherwise) can be found in: - no longer scaffold webhook test files with `"k8s.io/api/admission/v1beta1"` the k8s API which is no longer served since k8s `1.25`. By default webhooks test files are scaffolding using `"k8s.io/api/admission/v1"` which is support from k8s `1.20` - no longer provide backwards compatible support with k8s versions < `1.16` -- change the layout to accommodate the community request to follow the [Standard Go Project Layout][standard-go-project] -by moving the api(s) under a new directory called `api`, controller(s) under a new directory called `internal` and the `main.go` under a new directory named `cmd` +- change the layout to accommodate the community request to follow the [Standard Go Project Layout][standard-go-project] + by moving the api(s) under a new directory called `api`, controller(s) under a new directory called `internal` and the `main.go` under a new directory named `cmd`