From 6ba647f193268941b6a2659ed68ae9f7267f0e82 Mon Sep 17 00:00:00 2001 From: Camila Macedo Date: Tue, 30 Jan 2024 16:31:37 +0000 Subject: [PATCH] :warning: remove component config since it is no longer supported by controller-runtime and is deprecated --- Makefile | 1 - docs/book/src/SUMMARY.md | 11 - .../component-config-tutorial/api-changes.md | 148 ------------ .../component-config-tutorial/config-type.md | 39 ---- .../component-config-tutorial/custom-type.md | 31 --- .../define-config.md | 24 -- .../define-custom-config.md | 23 -- .../testdata/controller_manager_config.yaml | 9 - .../testdata/project/.dockerignore | 3 - .../testdata/project/.gitignore | 27 --- .../testdata/project/Dockerfile | 33 --- .../testdata/project/PROJECT | 20 -- .../testdata/project/README.md | 114 --------- .../project/api/v2/groupversion_info.go | 36 --- .../project/api/v2/projectconfig_types.go | 69 ------ .../project/api/v2/zz_generated.deepcopy.go | 115 --------- .../testdata/project/cmd/main.go | 97 -------- ...utorial.kubebuilder.io_projectconfigs.yaml | 218 ------------------ .../project/config/crd/kustomizeconfig.yaml | 19 -- .../config/default/manager_config_patch.yaml | 20 -- .../manager/controller_manager_config.yaml | 20 -- .../project/config/manager/kustomization.yaml | 10 - .../config/prometheus/kustomization.yaml | 2 - .../project/config/rbac/service_account.yaml | 8 - .../samples/config_v2_projectconfig.yaml | 9 - .../project/config/samples/kustomization.yaml | 4 - .../testdata/project/hack/boilerplate.go.txt | 15 -- .../testdata/projectconfig_types.go | 53 ----- .../src/component-config-tutorial/tutorial.md | 47 ---- .../updating-main.md | 56 ----- docs/book/src/migration/legacy/v2vsv3.md | 108 --------- docs/book/src/plugins/testing-plugins.md | 1 - hack/docs/generate.sh | 1 - hack/docs/generate_samples.go | 12 +- pkg/config/interface.go | 10 - pkg/config/v2/config.go | 21 -- pkg/config/v2/config_test.go | 14 -- pkg/config/v3/config.go | 20 +- pkg/config/v3/config_test.go | 39 +--- pkg/machinery/injector.go | 3 - pkg/machinery/injector_test.go | 34 --- pkg/machinery/interfaces.go | 14 -- pkg/machinery/mixins.go | 19 -- pkg/machinery/mixins_test.go | 12 - pkg/plugins/common/kustomize/v1/init.go | 13 +- .../common/kustomize/v1/scaffolds/init.go | 4 - .../config/kdefault/kustomization.go | 6 - .../kdefault/manager_auth_proxy_patch.go | 3 - .../config/kdefault/manager_config_patch.go | 13 -- .../templates/config/manager/config.go | 3 - .../manager/controller_manager_config.go | 77 ------- .../templates/config/manager/kustomization.go | 12 - pkg/plugins/common/kustomize/v2/init.go | 18 +- .../common/kustomize/v2/scaffolds/init.go | 4 - .../config/kdefault/enable_matrics_patch.go | 1 - .../config/kdefault/kustomization.go | 8 - .../config/kdefault/manager_config_patch.go | 13 -- .../templates/config/manager/config.go | 3 - .../templates/config/manager/kustomization.go | 12 - .../v3/scaffolds/internal/templates/main.go | 23 -- .../scaffolds/internal/templates/makefile.go | 1 - .../v4/scaffolds/internal/templates/main.go | 23 -- .../scaffolds/internal/templates/makefile.go | 1 - .../config/default/kustomization.yaml | 2 - 64 files changed, 14 insertions(+), 1815 deletions(-) delete mode 100644 docs/book/src/component-config-tutorial/api-changes.md delete mode 100644 docs/book/src/component-config-tutorial/config-type.md delete mode 100644 docs/book/src/component-config-tutorial/custom-type.md delete mode 100644 docs/book/src/component-config-tutorial/define-config.md delete mode 100644 docs/book/src/component-config-tutorial/define-custom-config.md delete mode 100644 docs/book/src/component-config-tutorial/testdata/controller_manager_config.yaml delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/.dockerignore delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/.gitignore delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/Dockerfile delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/PROJECT delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/README.md delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/api/v2/groupversion_info.go delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/api/v2/projectconfig_types.go delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/api/v2/zz_generated.deepcopy.go delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/cmd/main.go delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/config/crd/bases/config.tutorial.kubebuilder.io_projectconfigs.yaml delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/config/crd/kustomizeconfig.yaml delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/config/default/manager_config_patch.yaml delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/config/manager/controller_manager_config.yaml delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/config/manager/kustomization.yaml delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/config/prometheus/kustomization.yaml delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/config/rbac/service_account.yaml delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/config/samples/config_v2_projectconfig.yaml delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/config/samples/kustomization.yaml delete mode 100644 docs/book/src/component-config-tutorial/testdata/project/hack/boilerplate.go.txt delete mode 100644 docs/book/src/component-config-tutorial/testdata/projectconfig_types.go delete mode 100644 docs/book/src/component-config-tutorial/tutorial.md delete mode 100644 docs/book/src/component-config-tutorial/updating-main.md delete mode 100644 docs/book/src/migration/legacy/v2vsv3.md delete mode 100644 pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/controller_manager_config.go diff --git a/Makefile b/Makefile index 054060cce6..e17b1f839e 100644 --- a/Makefile +++ b/Makefile @@ -160,7 +160,6 @@ test-e2e-ci: ## Run the end-to-end tests (used in the CI)` .PHONY: test-book test-book: ## Run the cronjob tutorial's unit tests to make sure we don't break it cd ./docs/book/src/cronjob-tutorial/testdata/project && make test - cd ./docs/book/src/component-config-tutorial/testdata/project && make test cd ./docs/book/src/multiversion-tutorial/testdata/project && make test .PHONY: test-license diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 4806de043f..d4495ce770 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -45,17 +45,6 @@ - [Deployment and Testing](./multiversion-tutorial/deployment.md) -- [Tutorial: Component Config](./component-config-tutorial/tutorial.md) - - - [Changing things up](./component-config-tutorial/api-changes.md) - - [Defining your Config](./component-config-tutorial/define-config.md) - - - [Using a custom type](./component-config-tutorial/custom-type.md) - - - [Adding a new Config Type](./component-config-tutorial/config-type.md) - - [Updating main](./component-config-tutorial/updating-main.md) - - [Defining your Custom Config](./component-config-tutorial/define-custom-config.md) - --- - [Migrations](./migrations.md) diff --git a/docs/book/src/component-config-tutorial/api-changes.md b/docs/book/src/component-config-tutorial/api-changes.md deleted file mode 100644 index cc01863346..0000000000 --- a/docs/book/src/component-config-tutorial/api-changes.md +++ /dev/null @@ -1,148 +0,0 @@ -# Changing things up - - - -This tutorial will show you how to create a custom configuration file for your -project by modifying a project generated with the `--component-config` flag -passed to the `init` command. The full tutorial's source can be found -[here][tutorial-source]. Make sure you've gone through the [installation -steps](/quick-start.md#installation) before continuing. - -## New project: - -```bash -# we'll use a domain of tutorial.kubebuilder.io, -# so all API groups will be .tutorial.kubebuilder.io. -kubebuilder init --domain tutorial.kubebuilder.io --component-config -``` - -## Setting up an existing project - -If you've previously generated a project we can add support for parsing the -config file by making the following changes to `main.go`. - -First, add a new `flag` to specify the path that the component config file -should be loaded from. - -```go -var configFile string -flag.StringVar(&configFile, "config", "", - "The controller will load its initial configuration from this file. "+ - "Omit this flag to use the default configuration values. "+ - "Command-line flags override configuration from this file.") -``` - -Now, we can setup the `Options` struct and check if the `configFile` is set, -this allows backwards compatibility, if it's set we'll then use the `AndFrom` -function on `Options` to parse and populate the `Options` from the config. - - -```go -var err error -options := ctrl.Options{Scheme: scheme} -if configFile != "" { - options, err = options.AndFrom(ctrl.ConfigFile().AtPath(configFile)) - if err != nil { - setupLog.Error(err, "unable to load the config file") - os.Exit(1) - } -} -``` - - - -Lastly, we'll change the `NewManager` call to use the `options` variable we -defined above. - -```go -mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), options) -``` - -With that out of the way, we can get on to defining our new config! - -[tutorial-source]: https://github.com/kubernetes-sigs/kubebuilder/tree/master/docs/book/src/component-config-tutorial/testdata/project - -Create the file `/config/manager/controller_manager_config.yaml` with the following content: - -```yaml -apiVersion: controller-runtime.sigs.k8s.io/v1alpha1 -kind: ControllerManagerConfig -health: - healthProbeBindAddress: :8081 -metrics: - bindAddress: 127.0.0.1:8080 -webhook: - port: 9443 -leaderElection: - leaderElect: true - resourceName: ecaf1259.tutorial.kubebuilder.io -# leaderElectionReleaseOnCancel defines if the leader should step down volume -# when the Manager ends. This requires the binary to immediately end when the -# Manager is stopped, otherwise, this setting is unsafe. Setting this significantly -# speeds up voluntary leader transitions as the new leader don't have to wait -# LeaseDuration time first. -# In the default scaffold provided, the program ends immediately after -# the manager stops, so would be fine to enable this option. However, -# if you are doing or is intended to do any operation such as perform cleanups -# after the manager stops then its usage might be unsafe. -# leaderElectionReleaseOnCancel: true -``` - -Update the file `/config/manager/kustomization.yaml` by adding at the bottom the following content: - -```yaml -generatorOptions: - disableNameSuffixHash: true - -configMapGenerator: -- name: manager-config - files: - - controller_manager_config.yaml -``` - -Update the file `default/kustomization.yaml` by adding under the [`patchesStrategicMerge:` key](https://kubectl.docs.kubernetes.io/references/kustomize/builtins/#_patchesstrategicmerge_) the following patch: - -```yaml -patchesStrategicMerge: -# Mount the controller config file for loading manager configurations -# through a ComponentConfig type -- manager_config_patch.yaml -``` - -Update the file `default/manager_config_patch.yaml` by adding under the `spec:` key the following patch: - -```yaml -spec: - template: - spec: - containers: - - name: manager - args: - - "--config=controller_manager_config.yaml" - volumeMounts: - - name: manager-config - mountPath: /controller_manager_config.yaml - subPath: controller_manager_config.yaml - volumes: - - name: manager-config - configMap: - name: manager-config -``` diff --git a/docs/book/src/component-config-tutorial/config-type.md b/docs/book/src/component-config-tutorial/config-type.md deleted file mode 100644 index 518f360ed8..0000000000 --- a/docs/book/src/component-config-tutorial/config-type.md +++ /dev/null @@ -1,39 +0,0 @@ -# Adding a new Config Type - - - -To scaffold out a new config Kind, we can use `kubebuilder create api`. - -```bash -kubebuilder create api --group config --version v2 --kind ProjectConfig --resource --controller=false --make=false -``` - -Then, run `make build` to implement the interface for your API type, which would generate the file `zz_generated.deepcopy.go`. - - - -This will create a new type file in `api/config/v2/` for the `ProjectConfig` -kind. We'll need to change this file to embed the -[v1alpha1.ControllerManagerConfigurationSpec](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/config/v1alpha1/#ControllerManagerConfigurationSpec) - -{{#literatego ./testdata/projectconfig_types.go}} - -Lastly, we'll change the `main.go` to reference this type for parsing the file. diff --git a/docs/book/src/component-config-tutorial/custom-type.md b/docs/book/src/component-config-tutorial/custom-type.md deleted file mode 100644 index a147b4f96a..0000000000 --- a/docs/book/src/component-config-tutorial/custom-type.md +++ /dev/null @@ -1,31 +0,0 @@ -# Using a Custom Type - - - - - -If your project needs to accept additional non-controller runtime specific -configurations, e.g. `ClusterName`, `Region` or anything serializable into -`yaml` you can do this by using `kubebuilder` to create a new type and then -updating your `main.go` to setup the new type for parsing. - -The rest of this tutorial will walk through implementing a custom component -config type. \ No newline at end of file diff --git a/docs/book/src/component-config-tutorial/define-config.md b/docs/book/src/component-config-tutorial/define-config.md deleted file mode 100644 index c337954d9b..0000000000 --- a/docs/book/src/component-config-tutorial/define-config.md +++ /dev/null @@ -1,24 +0,0 @@ -# Defining your Config - - - -Now that you have a component config base project we need to customize the -values that are passed into the controller, to do this we can take a look at -`config/manager/controller_manager_config.yaml`. - -{{#literatego ./testdata/controller_manager_config.yaml}} - -To see all the available fields you can look at the `v1alpha` Controller -Runtime config [ControllerManagerConfiguration][configtype] - -[configtype]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/config/v1alpha1#ControllerManagerConfigurationSpec \ No newline at end of file diff --git a/docs/book/src/component-config-tutorial/define-custom-config.md b/docs/book/src/component-config-tutorial/define-custom-config.md deleted file mode 100644 index 13a65f2f4c..0000000000 --- a/docs/book/src/component-config-tutorial/define-custom-config.md +++ /dev/null @@ -1,23 +0,0 @@ -# Defining your Custom Config - - - -Now that you have a custom component config we change the -`config/manager/controller_manager_config.yaml` to use the new GVK you defined. - -{{#literatego ./testdata/project/config/manager/controller_manager_config.yaml}} - -This type uses the new `ProjectConfig` kind under the GVK -`config.tutorial.kubebuilder.io/v2`, with these custom configs we can add any -`yaml` serializable fields that your controller needs and begin to reduce the -reliance on `flags` to configure your project. \ No newline at end of file diff --git a/docs/book/src/component-config-tutorial/testdata/controller_manager_config.yaml b/docs/book/src/component-config-tutorial/testdata/controller_manager_config.yaml deleted file mode 100644 index cb5e0786bd..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/controller_manager_config.yaml +++ /dev/null @@ -1,9 +0,0 @@ -apiVersion: controller-runtime.sigs.k8s.io/v1alpha1 -kind: ControllerManagerConfig -metrics: - bindAddress: 127.0.0.1:8080 -webhook: - port: 9443 -leaderElection: - leaderElect: true - resourceName: 80807133.tutorial.kubebuilder.io diff --git a/docs/book/src/component-config-tutorial/testdata/project/.dockerignore b/docs/book/src/component-config-tutorial/testdata/project/.dockerignore deleted file mode 100644 index a3aab7af70..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/.dockerignore +++ /dev/null @@ -1,3 +0,0 @@ -# More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file -# Ignore build and test binaries. -bin/ diff --git a/docs/book/src/component-config-tutorial/testdata/project/.gitignore b/docs/book/src/component-config-tutorial/testdata/project/.gitignore deleted file mode 100644 index ada68ff086..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/.gitignore +++ /dev/null @@ -1,27 +0,0 @@ -# Binaries for programs and plugins -*.exe -*.exe~ -*.dll -*.so -*.dylib -bin/* -Dockerfile.cross - -# Test binary, built with `go test -c` -*.test - -# Output of the go coverage tool, specifically when used with LiteIDE -*.out - -# Go workspace file -go.work - -# Kubernetes Generated files - skip generated files, except for vendored files -!vendor/**/zz_generated.* - -# editor and IDE paraphernalia -.idea -.vscode -*.swp -*.swo -*~ diff --git a/docs/book/src/component-config-tutorial/testdata/project/Dockerfile b/docs/book/src/component-config-tutorial/testdata/project/Dockerfile deleted file mode 100644 index aca26f9229..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/Dockerfile +++ /dev/null @@ -1,33 +0,0 @@ -# Build the manager binary -FROM golang:1.21 AS builder -ARG TARGETOS -ARG TARGETARCH - -WORKDIR /workspace -# Copy the Go Modules manifests -COPY go.mod go.mod -COPY go.sum go.sum -# cache deps before building and copying source so that we don't need to re-download as much -# and so that source changes don't invalidate our downloaded layer -RUN go mod download - -# Copy the go source -COPY cmd/main.go cmd/main.go -COPY api/ api/ -COPY internal/controller/ internal/controller/ - -# Build -# the GOARCH has not a default value to allow the binary be built according to the host where the command -# was called. For example, if we call make docker-build in a local env which has the Apple Silicon M1 SO -# the docker BUILDPLATFORM arg will be linux/arm64 when for Apple x86 it will be linux/amd64. Therefore, -# by leaving it empty we can ensure that the container and binary shipped on it will have the same platform. -RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager cmd/main.go - -# Use distroless as minimal base image to package the manager binary -# Refer to https://github.com/GoogleContainerTools/distroless for more details -FROM gcr.io/distroless/static:nonroot -WORKDIR / -COPY --from=builder /workspace/manager . -USER 65532:65532 - -ENTRYPOINT ["/manager"] diff --git a/docs/book/src/component-config-tutorial/testdata/project/PROJECT b/docs/book/src/component-config-tutorial/testdata/project/PROJECT deleted file mode 100644 index cd75b7877e..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/PROJECT +++ /dev/null @@ -1,20 +0,0 @@ -# Code generated by tool. DO NOT EDIT. -# This file is used to track the info used to scaffold your project -# and allow the plugins properly work. -# More info: https://book.kubebuilder.io/reference/project-config.html -componentConfig: true -domain: tutorial.kubebuilder.io -layout: -- go.kubebuilder.io/v4 -projectName: project -repo: tutorial.kubebuilder.io/project -resources: -- api: - crdVersion: v1 - namespaced: true - domain: tutorial.kubebuilder.io - group: config - kind: ProjectConfig - path: tutorial.kubebuilder.io/project/api/v2 - version: v2 -version: "3" diff --git a/docs/book/src/component-config-tutorial/testdata/project/README.md b/docs/book/src/component-config-tutorial/testdata/project/README.md deleted file mode 100644 index a1c7ff7c3b..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/README.md +++ /dev/null @@ -1,114 +0,0 @@ -# project -// TODO(user): Add simple overview of use/purpose - -## Description -// TODO(user): An in-depth paragraph about your project and overview of use - -## Getting Started - -### Prerequisites -- go version v1.21.0+ -- docker version 17.03+. -- kubectl version v1.11.3+. -- Access to a Kubernetes v1.11.3+ cluster. - -### To Deploy on the cluster -**Build and push your image to the location specified by `IMG`:** - -```sh -make docker-build docker-push IMG=/project:tag -``` - -**NOTE:** This image ought to be published in the personal registry you specified. -And it is required to have access to pull the image from the working environment. -Make sure you have the proper permission to the registry if the above commands don’t work. - -**Install the CRDs into the cluster:** - -```sh -make install -``` - -**Deploy the Manager to the cluster with the image specified by `IMG`:** - -```sh -make deploy IMG=/project:tag -``` - -> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin -privileges or be logged in as admin. - -**Create instances of your solution** -You can apply the samples (examples) from the config/sample: - -```sh -kubectl apply -k config/samples/ -``` - ->**NOTE**: Ensure that the samples has default values to test it out. - -### To Uninstall -**Delete the instances (CRs) from the cluster:** - -```sh -kubectl delete -k config/samples/ -``` - -**Delete the APIs(CRDs) from the cluster:** - -```sh -make uninstall -``` - -**UnDeploy the controller from the cluster:** - -```sh -make undeploy -``` - -## Project Distribution - -Following are the steps to build the installer and distribute this project to users. - -1. Build the installer for the image built and published in the registry: - -```sh -make build-installer IMG=/project:tag -``` - -NOTE: The makefile target mentioned above generates an 'install.yaml' -file in the dist directory. This file contains all the resources built -with Kustomize, which are necessary to install this project without -its dependencies. - -2. Using the installer - -Users can just run kubectl apply -f to install the project, i.e.: - -```sh -kubectl apply -f https://raw.githubusercontent.com//project//dist/install.yaml -``` - -## Contributing -// TODO(user): Add detailed information on how you would like others to contribute to this project - -**NOTE:** Run `make help` for more information on all potential `make` targets - -More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html) - -## License - -Copyright 2024 The Kubernetes authors. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - diff --git a/docs/book/src/component-config-tutorial/testdata/project/api/v2/groupversion_info.go b/docs/book/src/component-config-tutorial/testdata/project/api/v2/groupversion_info.go deleted file mode 100644 index 0efc6df799..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/api/v2/groupversion_info.go +++ /dev/null @@ -1,36 +0,0 @@ -/* -Copyright 2024 The Kubernetes authors. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -// Package v2 contains API Schema definitions for the config v2 API group -// +kubebuilder:object:generate=true -// +groupName=config.tutorial.kubebuilder.io -package v2 - -import ( - "k8s.io/apimachinery/pkg/runtime/schema" - "sigs.k8s.io/controller-runtime/pkg/scheme" -) - -var ( - // GroupVersion is group version used to register these objects - GroupVersion = schema.GroupVersion{Group: "config.tutorial.kubebuilder.io", Version: "v2"} - - // SchemeBuilder is used to add go types to the GroupVersionKind scheme - SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} - - // AddToScheme adds the types in this group-version to the given scheme. - AddToScheme = SchemeBuilder.AddToScheme -) diff --git a/docs/book/src/component-config-tutorial/testdata/project/api/v2/projectconfig_types.go b/docs/book/src/component-config-tutorial/testdata/project/api/v2/projectconfig_types.go deleted file mode 100644 index 230f06d521..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/api/v2/projectconfig_types.go +++ /dev/null @@ -1,69 +0,0 @@ -/* -Copyright 2024 The Kubernetes authors. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -package v2 - -import ( - metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" - cfg "sigs.k8s.io/controller-runtime/pkg/config/v1alpha1" -) - -// EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN! -// NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized. - -// ProjectConfigSpec defines the desired state of ProjectConfig -type ProjectConfigSpec struct { - // INSERT ADDITIONAL SPEC FIELDS - desired state of cluster - // Important: Run "make" to regenerate code after modifying this file - - // Foo is an example field of ProjectConfig. Edit projectconfig_types.go to remove/update - Foo string `json:"foo,omitempty"` -} - -// ProjectConfigStatus defines the observed state of ProjectConfig -type ProjectConfigStatus struct { - // INSERT ADDITIONAL STATUS FIELD - define observed state of cluster - // Important: Run "make" to regenerate code after modifying this file -} - -//+kubebuilder:object:root=true -//+kubebuilder:subresource:status - -// ProjectConfig is the Schema for the projectconfigs API -type ProjectConfig struct { - metav1.TypeMeta `json:",inline"` - metav1.ObjectMeta `json:"metadata,omitempty"` - - Spec ProjectConfigSpec `json:"spec,omitempty"` - Status ProjectConfigStatus `json:"status,omitempty"` - // ControllerManagerConfigurationSpec returns the configurations for controllers - cfg.ControllerManagerConfigurationSpec `json:",inline"` - - ClusterName string `json:"clusterName,omitempty"` -} - -//+kubebuilder:object:root=true - -// ProjectConfigList contains a list of ProjectConfig -type ProjectConfigList struct { - metav1.TypeMeta `json:",inline"` - metav1.ListMeta `json:"metadata,omitempty"` - Items []ProjectConfig `json:"items"` -} - -func init() { - SchemeBuilder.Register(&ProjectConfig{}, &ProjectConfigList{}) -} diff --git a/docs/book/src/component-config-tutorial/testdata/project/api/v2/zz_generated.deepcopy.go b/docs/book/src/component-config-tutorial/testdata/project/api/v2/zz_generated.deepcopy.go deleted file mode 100644 index 50259cae65..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/api/v2/zz_generated.deepcopy.go +++ /dev/null @@ -1,115 +0,0 @@ -//go:build !ignore_autogenerated - -/* -Copyright 2024 The Kubernetes authors. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -// Code generated by controller-gen. DO NOT EDIT. - -package v2 - -import ( - runtime "k8s.io/apimachinery/pkg/runtime" -) - -// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *ProjectConfig) DeepCopyInto(out *ProjectConfig) { - *out = *in - out.TypeMeta = in.TypeMeta - in.ObjectMeta.DeepCopyInto(&out.ObjectMeta) - out.Spec = in.Spec - out.Status = in.Status - in.ControllerManagerConfigurationSpec.DeepCopyInto(&out.ControllerManagerConfigurationSpec) -} - -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectConfig. -func (in *ProjectConfig) DeepCopy() *ProjectConfig { - if in == nil { - return nil - } - out := new(ProjectConfig) - in.DeepCopyInto(out) - return out -} - -// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. -func (in *ProjectConfig) DeepCopyObject() runtime.Object { - if c := in.DeepCopy(); c != nil { - return c - } - return nil -} - -// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *ProjectConfigList) DeepCopyInto(out *ProjectConfigList) { - *out = *in - out.TypeMeta = in.TypeMeta - in.ListMeta.DeepCopyInto(&out.ListMeta) - if in.Items != nil { - in, out := &in.Items, &out.Items - *out = make([]ProjectConfig, len(*in)) - for i := range *in { - (*in)[i].DeepCopyInto(&(*out)[i]) - } - } -} - -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectConfigList. -func (in *ProjectConfigList) DeepCopy() *ProjectConfigList { - if in == nil { - return nil - } - out := new(ProjectConfigList) - in.DeepCopyInto(out) - return out -} - -// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. -func (in *ProjectConfigList) DeepCopyObject() runtime.Object { - if c := in.DeepCopy(); c != nil { - return c - } - return nil -} - -// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *ProjectConfigSpec) DeepCopyInto(out *ProjectConfigSpec) { - *out = *in -} - -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectConfigSpec. -func (in *ProjectConfigSpec) DeepCopy() *ProjectConfigSpec { - if in == nil { - return nil - } - out := new(ProjectConfigSpec) - in.DeepCopyInto(out) - return out -} - -// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *ProjectConfigStatus) DeepCopyInto(out *ProjectConfigStatus) { - *out = *in -} - -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectConfigStatus. -func (in *ProjectConfigStatus) DeepCopy() *ProjectConfigStatus { - if in == nil { - return nil - } - out := new(ProjectConfigStatus) - in.DeepCopyInto(out) - return out -} diff --git a/docs/book/src/component-config-tutorial/testdata/project/cmd/main.go b/docs/book/src/component-config-tutorial/testdata/project/cmd/main.go deleted file mode 100644 index 271dd39d46..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/cmd/main.go +++ /dev/null @@ -1,97 +0,0 @@ -/* -Copyright 2024 The Kubernetes authors. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -package main - -import ( - "flag" - "os" - - // Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.) - // to ensure that exec-entrypoint and run can make use of them. - _ "k8s.io/client-go/plugin/pkg/client/auth" - - "k8s.io/apimachinery/pkg/runtime" - utilruntime "k8s.io/apimachinery/pkg/util/runtime" - clientgoscheme "k8s.io/client-go/kubernetes/scheme" - ctrl "sigs.k8s.io/controller-runtime" - "sigs.k8s.io/controller-runtime/pkg/healthz" - "sigs.k8s.io/controller-runtime/pkg/log/zap" - - configv2 "tutorial.kubebuilder.io/project/api/v2" - //+kubebuilder:scaffold:imports -) - -var ( - scheme = runtime.NewScheme() - setupLog = ctrl.Log.WithName("setup") -) - -func init() { - utilruntime.Must(clientgoscheme.AddToScheme(scheme)) - - utilruntime.Must(configv2.AddToScheme(scheme)) - //+kubebuilder:scaffold:scheme -} - -func main() { - var configFile string - flag.StringVar(&configFile, "config", "", - "The controller will load its initial configuration from this file. "+ - "Omit this flag to use the default configuration values. "+ - "Command-line flags override configuration from this file.") - opts := zap.Options{ - Development: true, - } - opts.BindFlags(flag.CommandLine) - flag.Parse() - - ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts))) - - var err error - ctrlConfig := configv2.ProjectConfig{} - options := ctrl.Options{Scheme: scheme} - if configFile != "" { - options, err = options.AndFrom(ctrl.ConfigFile().AtPath(configFile).OfKind(&ctrlConfig)) - if err != nil { - setupLog.Error(err, "unable to load the config file") - os.Exit(1) - } - } - - mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), options) - if err != nil { - setupLog.Error(err, "unable to start manager") - os.Exit(1) - } - - //+kubebuilder:scaffold:builder - - 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) - } - - setupLog.Info("starting manager") - if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil { - setupLog.Error(err, "problem running manager") - os.Exit(1) - } -} diff --git a/docs/book/src/component-config-tutorial/testdata/project/config/crd/bases/config.tutorial.kubebuilder.io_projectconfigs.yaml b/docs/book/src/component-config-tutorial/testdata/project/config/crd/bases/config.tutorial.kubebuilder.io_projectconfigs.yaml deleted file mode 100644 index ec857ee139..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/config/crd/bases/config.tutorial.kubebuilder.io_projectconfigs.yaml +++ /dev/null @@ -1,218 +0,0 @@ ---- -apiVersion: apiextensions.k8s.io/v1 -kind: CustomResourceDefinition -metadata: - annotations: - controller-gen.kubebuilder.io/version: v0.14.0 - name: projectconfigs.config.tutorial.kubebuilder.io -spec: - group: config.tutorial.kubebuilder.io - names: - kind: ProjectConfig - listKind: ProjectConfigList - plural: projectconfigs - singular: projectconfig - scope: Namespaced - versions: - - name: v2 - schema: - openAPIV3Schema: - description: ProjectConfig is the Schema for the projectconfigs API - properties: - apiVersion: - description: |- - APIVersion defines the versioned schema of this representation of an object. - Servers should convert recognized schemas to the latest internal value, and - may reject unrecognized values. - More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - type: string - cacheNamespace: - description: |- - CacheNamespace if specified restricts the manager's cache to watch objects in - the desired namespace Defaults to all namespaces - - - Note: If a namespace is specified, controllers can still Watch for a - cluster-scoped resource (e.g Node). For namespaced resources the cache - will only hold objects from the desired namespace. - type: string - clusterName: - type: string - controller: - description: |- - Controller contains global configuration options for controllers - registered within this manager. - properties: - cacheSyncTimeout: - description: |- - CacheSyncTimeout refers to the time limit set to wait for syncing caches. - Defaults to 2 minutes if not set. - format: int64 - type: integer - groupKindConcurrency: - additionalProperties: - type: integer - description: |- - GroupKindConcurrency is a map from a Kind to the number of concurrent reconciliation - allowed for that controller. - - - When a controller is registered within this manager using the builder utilities, - users have to specify the type the controller reconciles in the For(...) call. - If the object's kind passed matches one of the keys in this map, the concurrency - for that controller is set to the number specified. - - - The key is expected to be consistent in form with GroupKind.String(), - e.g. ReplicaSet in apps group (regardless of version) would be `ReplicaSet.apps`. - type: object - recoverPanic: - description: RecoverPanic indicates if panics should be recovered. - type: boolean - type: object - gracefulShutDown: - description: |- - GracefulShutdownTimeout is the duration given to runnable to stop before the manager actually returns on stop. - To disable graceful shutdown, set to time.Duration(0) - To use graceful shutdown without timeout, set to a negative duration, e.G. time.Duration(-1) - The graceful shutdown is skipped for safety reasons in case the leader election lease is lost. - type: string - health: - description: Health contains the controller health configuration - properties: - healthProbeBindAddress: - description: |- - HealthProbeBindAddress is the TCP address that the controller should bind to - for serving health probes - It can be set to "0" or "" to disable serving the health probe. - type: string - livenessEndpointName: - description: LivenessEndpointName, defaults to "healthz" - type: string - readinessEndpointName: - description: ReadinessEndpointName, defaults to "readyz" - type: string - type: object - kind: - description: |- - Kind is a string value representing the REST resource this object represents. - Servers may infer this from the endpoint the client submits requests to. - Cannot be updated. - In CamelCase. - More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - type: string - leaderElection: - description: |- - LeaderElection is the LeaderElection config to be used when configuring - the manager.Manager leader election - properties: - leaderElect: - description: |- - leaderElect enables a leader election client to gain leadership - before executing the main loop. Enable this when running replicated - components for high availability. - type: boolean - leaseDuration: - description: |- - leaseDuration is the duration that non-leader candidates will wait - after observing a leadership renewal until attempting to acquire - leadership of a led but unrenewed leader slot. This is effectively the - maximum duration that a leader can be stopped before it is replaced - by another candidate. This is only applicable if leader election is - enabled. - type: string - renewDeadline: - description: |- - renewDeadline is the interval between attempts by the acting master to - renew a leadership slot before it stops leading. This must be less - than or equal to the lease duration. This is only applicable if leader - election is enabled. - type: string - resourceLock: - description: |- - resourceLock indicates the resource object type that will be used to lock - during leader election cycles. - type: string - resourceName: - description: |- - resourceName indicates the name of resource object that will be used to lock - during leader election cycles. - type: string - resourceNamespace: - description: |- - resourceName indicates the namespace of resource object that will be used to lock - during leader election cycles. - type: string - retryPeriod: - description: |- - retryPeriod is the duration the clients should wait between attempting - acquisition and renewal of a leadership. This is only applicable if - leader election is enabled. - type: string - required: - - leaderElect - - leaseDuration - - renewDeadline - - resourceLock - - resourceName - - resourceNamespace - - retryPeriod - type: object - metadata: - type: object - metrics: - description: Metrics contains the controller metrics configuration - properties: - bindAddress: - description: |- - BindAddress is the TCP address that the controller should bind to - for serving prometheus metrics. - It can be set to "0" to disable the metrics serving. - type: string - type: object - spec: - description: ProjectConfigSpec defines the desired state of ProjectConfig - properties: - foo: - description: Foo is an example field of ProjectConfig. Edit projectconfig_types.go - to remove/update - type: string - type: object - status: - description: ProjectConfigStatus defines the observed state of ProjectConfig - type: object - syncPeriod: - description: |- - SyncPeriod determines the minimum frequency at which watched resources are - reconciled. A lower period will correct entropy more quickly, but reduce - responsiveness to change if there are many watched resources. Change this - value only if you know what you are doing. Defaults to 10 hours if unset. - there will a 10 percent jitter between the SyncPeriod of all controllers - so that all controllers will not send list requests simultaneously. - type: string - webhook: - description: Webhook contains the controllers webhook configuration - properties: - certDir: - description: |- - CertDir is the directory that contains the server key and certificate. - if not set, webhook server would look up the server key and certificate in - {TempDir}/k8s-webhook-server/serving-certs. The server key and certificate - must be named tls.key and tls.crt, respectively. - type: string - host: - description: |- - Host is the hostname that the webhook server binds to. - It is used to set webhook.Server.Host. - type: string - port: - description: |- - Port is the port that the webhook server serves at. - It is used to set webhook.Server.Port. - type: integer - type: object - type: object - served: true - storage: true - subresources: - status: {} diff --git a/docs/book/src/component-config-tutorial/testdata/project/config/crd/kustomizeconfig.yaml b/docs/book/src/component-config-tutorial/testdata/project/config/crd/kustomizeconfig.yaml deleted file mode 100644 index ec5c150a9d..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/config/crd/kustomizeconfig.yaml +++ /dev/null @@ -1,19 +0,0 @@ -# This file is for teaching kustomize how to substitute name and namespace reference in CRD -nameReference: -- kind: Service - version: v1 - fieldSpecs: - - kind: CustomResourceDefinition - version: v1 - group: apiextensions.k8s.io - path: spec/conversion/webhook/clientConfig/service/name - -namespace: -- kind: CustomResourceDefinition - version: v1 - group: apiextensions.k8s.io - path: spec/conversion/webhook/clientConfig/service/namespace - create: false - -varReference: -- path: metadata/annotations diff --git a/docs/book/src/component-config-tutorial/testdata/project/config/default/manager_config_patch.yaml b/docs/book/src/component-config-tutorial/testdata/project/config/default/manager_config_patch.yaml deleted file mode 100644 index 6c400155cf..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/config/default/manager_config_patch.yaml +++ /dev/null @@ -1,20 +0,0 @@ -apiVersion: apps/v1 -kind: Deployment -metadata: - name: controller-manager - namespace: system -spec: - template: - spec: - containers: - - name: manager - args: - - "--config=controller_manager_config.yaml" - volumeMounts: - - name: manager-config - mountPath: /controller_manager_config.yaml - subPath: controller_manager_config.yaml - volumes: - - name: manager-config - configMap: - name: manager-config diff --git a/docs/book/src/component-config-tutorial/testdata/project/config/manager/controller_manager_config.yaml b/docs/book/src/component-config-tutorial/testdata/project/config/manager/controller_manager_config.yaml deleted file mode 100644 index 1391a7ad49..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/config/manager/controller_manager_config.yaml +++ /dev/null @@ -1,20 +0,0 @@ -apiVersion: controller-runtime.sigs.k8s.io/v1alpha1 -kind: ControllerManagerConfig -metadata: - labels: - app.kubernetes.io/name: controllermanagerconfig - app.kubernetes.io/instance: controller-manager-configuration - app.kubernetes.io/component: manager - app.kubernetes.io/created-by: project - app.kubernetes.io/part-of: project - app.kubernetes.io/managed-by: kustomize -health: - healthProbeBindAddress: :8081 -metrics: - bindAddress: 127.0.0.1:8080 -webhook: - port: 9443 -leaderElection: - leaderElect: true - resourceName: 80807133.tutorial.kubebuilder.io -clusterName: example-test diff --git a/docs/book/src/component-config-tutorial/testdata/project/config/manager/kustomization.yaml b/docs/book/src/component-config-tutorial/testdata/project/config/manager/kustomization.yaml deleted file mode 100644 index 2bcd3eeaa9..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/config/manager/kustomization.yaml +++ /dev/null @@ -1,10 +0,0 @@ -resources: -- manager.yaml - -generatorOptions: - disableNameSuffixHash: true - -configMapGenerator: -- name: manager-config - files: - - controller_manager_config.yaml diff --git a/docs/book/src/component-config-tutorial/testdata/project/config/prometheus/kustomization.yaml b/docs/book/src/component-config-tutorial/testdata/project/config/prometheus/kustomization.yaml deleted file mode 100644 index ed137168a1..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/config/prometheus/kustomization.yaml +++ /dev/null @@ -1,2 +0,0 @@ -resources: -- monitor.yaml diff --git a/docs/book/src/component-config-tutorial/testdata/project/config/rbac/service_account.yaml b/docs/book/src/component-config-tutorial/testdata/project/config/rbac/service_account.yaml deleted file mode 100644 index 7733e7fc66..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/config/rbac/service_account.yaml +++ /dev/null @@ -1,8 +0,0 @@ -apiVersion: v1 -kind: ServiceAccount -metadata: - labels: - app.kubernetes.io/name: project - app.kubernetes.io/managed-by: kustomize - name: controller-manager - namespace: system diff --git a/docs/book/src/component-config-tutorial/testdata/project/config/samples/config_v2_projectconfig.yaml b/docs/book/src/component-config-tutorial/testdata/project/config/samples/config_v2_projectconfig.yaml deleted file mode 100644 index 4f38be2fc6..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/config/samples/config_v2_projectconfig.yaml +++ /dev/null @@ -1,9 +0,0 @@ -apiVersion: config.tutorial.kubebuilder.io/v2 -kind: ProjectConfig -metadata: - labels: - app.kubernetes.io/name: project - app.kubernetes.io/managed-by: kustomize - name: projectconfig-sample -spec: - # TODO(user): Add fields here diff --git a/docs/book/src/component-config-tutorial/testdata/project/config/samples/kustomization.yaml b/docs/book/src/component-config-tutorial/testdata/project/config/samples/kustomization.yaml deleted file mode 100644 index efa08b7bdb..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/config/samples/kustomization.yaml +++ /dev/null @@ -1,4 +0,0 @@ -## Append samples of your project ## -resources: -- config_v2_projectconfig.yaml -#+kubebuilder:scaffold:manifestskustomizesamples diff --git a/docs/book/src/component-config-tutorial/testdata/project/hack/boilerplate.go.txt b/docs/book/src/component-config-tutorial/testdata/project/hack/boilerplate.go.txt deleted file mode 100644 index 0d32012672..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/project/hack/boilerplate.go.txt +++ /dev/null @@ -1,15 +0,0 @@ -/* -Copyright 2024 The Kubernetes authors. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ \ No newline at end of file diff --git a/docs/book/src/component-config-tutorial/testdata/projectconfig_types.go b/docs/book/src/component-config-tutorial/testdata/projectconfig_types.go deleted file mode 100644 index 6a4eb9bf50..0000000000 --- a/docs/book/src/component-config-tutorial/testdata/projectconfig_types.go +++ /dev/null @@ -1,53 +0,0 @@ -/* -Copyright 2020 The Kubernetes authors. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -// +kubebuilder:docs-gen:collapse=Apache License - -/* -We start out simply enough: we import the `config/v1alpha1` API group, which is -exposed through ControllerRuntime. -*/ -package v2 - -import ( - metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" - cfg "sigs.k8s.io/controller-runtime/pkg/config/v1alpha1" -) - -// +kubebuilder:object:root=true - -/* -Next, we'll remove the default `ProjectConfigSpec` and `ProjectConfigList` then -we'll embed `cfg.ControllerManagerConfigurationSpec` in `ProjectConfig`. -*/ - -// ProjectConfig is the Schema for the projectconfigs API -type ProjectConfig struct { - metav1.TypeMeta `json:",inline"` - - // ControllerManagerConfigurationSpec returns the configurations for controllers - cfg.ControllerManagerConfigurationSpec `json:",inline"` - - ClusterName string `json:"clusterName,omitempty"` -} - -/* -If you haven't, you'll also need to remove the `ProjectConfigList` from the -`SchemeBuilder.Register`. -*/ -func init() { - SchemeBuilder.Register(&ProjectConfig{}) -} diff --git a/docs/book/src/component-config-tutorial/tutorial.md b/docs/book/src/component-config-tutorial/tutorial.md deleted file mode 100644 index b388f653c4..0000000000 --- a/docs/book/src/component-config-tutorial/tutorial.md +++ /dev/null @@ -1,47 +0,0 @@ -# Tutorial: ComponentConfig - - - -Nearly every project that is built for Kubernetes will eventually need to -support passing in additional configurations into the controller. These could -be to enable better logging, turn on/off specific feature gates, set the sync -period, or a myriad of other controls. Previously this was commonly done using -cli `flags` that your `main.go` would parse to make them accessible within your -program. While this _works_ it's not a future forward design and the Kubernetes -community has been migrating the core components away from this and toward -using versioned config files, referred to as "component configs". - -The rest of this tutorial will show you how to configure your kubebuilder -project with the component config type then moves on to implementing a custom -type so that you can extend this capability. - - - - -## Resources - -* [Versioned Component Configuration File Design](https://github.com/kubernetes/community/blob/master/archive/wg-component-standard/component-config/README.md) - -* [Config v1alpha1 Go Docs](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/config/v1alpha1/) diff --git a/docs/book/src/component-config-tutorial/updating-main.md b/docs/book/src/component-config-tutorial/updating-main.md deleted file mode 100644 index 64518b1f0a..0000000000 --- a/docs/book/src/component-config-tutorial/updating-main.md +++ /dev/null @@ -1,56 +0,0 @@ -# Updating main - - - -Once you have defined your new custom component config type we need to make -sure our new config type has been imported and the types are registered with -the scheme. _If you used `kubebuilder create api` this should have been -automated._ - -```go -import ( - // ... other imports - configv2 "tutorial.kubebuilder.io/project/apis/config/v2" - // +kubebuilder:scaffold:imports -) -``` -With the package imported we can confirm the types have been added. - -```go -func init() { - // ... other scheme registrations - utilruntime.Must(configv2.AddToScheme(scheme)) - // +kubebuilder:scaffold:scheme -} -``` - -Lastly, we need to change the options parsing in -`main.go` to use this new type. To do this we'll chain `OfKind` onto -`ctrl.ConfigFile()` and pass in a pointer to the config kind. - -```go -var err error -ctrlConfig := configv2.ProjectConfig{} -options := ctrl.Options{Scheme: scheme} -if configFile != "" { - options, err = options.AndFrom(ctrl.ConfigFile().AtPath(configFile).OfKind(&ctrlConfig)) - if err != nil { - setupLog.Error(err, "unable to load the config file") - os.Exit(1) - } -} -``` - -Now if you need to use the `.clusterName` field we defined in our custom kind -you can call `ctrlConfig.ClusterName` which will be populated from the config -file supplied. \ No newline at end of file diff --git a/docs/book/src/migration/legacy/v2vsv3.md b/docs/book/src/migration/legacy/v2vsv3.md deleted file mode 100644 index ff6f891500..0000000000 --- a/docs/book/src/migration/legacy/v2vsv3.md +++ /dev/null @@ -1,108 +0,0 @@ -# Kubebuilder v2 vs v3 (Legacy Kubebuilder v2.0.0+ layout to 3.0.0+) - -This document covers all breaking changes when migrating from v2 to v3. - -The details of all changes (breaking or otherwise) can be found in -[controller-runtime][controller-runtime], -[controller-tools][controller-tools] -and [kb-releases][kb-releases] release notes. - -## Common changes - -v3 projects use Go modules and request Go 1.18+. Dep is no longer supported for dependency management. - -## Kubebuilder - -- Preliminary support for plugins was added. For more info see the [Extensible CLI and Scaffolding Plugins: phase 1][plugins-phase1-design-doc], - the [Extensible CLI and Scaffolding Plugins: phase 1.5][plugins-phase1-design-doc-1.5] and the [Extensible CLI and Scaffolding Plugins - Phase 2][plugins-phase2-design-doc] - design docs. Also, you can check the [Plugins section][plugins-section]. - -- The `PROJECT` file now has a new layout. It stores more information about what resources are in use, to better enable plugins to make useful decisions when scaffolding. - - Furthermore, the PROJECT file itself is now versioned: the `version` field corresponds to the version of the PROJECT file itself, while the `layout` field indicates the scaffolding & primary plugin version in use. - -- The version of the image `gcr.io/kubebuilder/kube-rbac-proxy`, which is an optional component enabled by default to secure the request made against the manager, was updated from `0.5.0` to `0.11.0` to address security concerns. The details of all changes can be found in [kube-rbac-proxy][kube-rbac-proxy]. - -## TL;DR of the New `go/v3` Plugin - -***More details on this can be found at [here][kb-releases], but for the highlights, check below*** - - - -- Scaffolded/Generated API version changes: - * Use `apiextensions/v1` for generated CRDs (`apiextensions/v1beta1` was deprecated in Kubernetes `1.16`) - * Use `admissionregistration.k8s.io/v1` for generated webhooks (`admissionregistration.k8s.io/v1beta1` was deprecated in Kubernetes `1.16`) - * Use `cert-manager.io/v1` for the certificate manager when webhooks are used (`cert-manager.io/v1alpha2` was deprecated in `Cert-Manager 0.14`. More info: [CertManager v1.0 docs][cert-manager-docs]) - -- Code changes: - * The manager flags `--metrics-addr` and `enable-leader-election` now are named `--metrics-bind-address` and `--leader-elect` to be more aligned with core Kubernetes Components. More info: [#1839][issue-1893] - * Liveness and Readiness probes are now added by default using [`healthz.Ping`][healthz-ping]. - * A new option to create the projects using ComponentConfig is introduced. For more info see its [enhancement proposal][enhancement proposal] and the [Component config tutorial][component-config-tutorial] - * Manager manifests now use `SecurityContext` to address security concerns. More info: [#1637][issue-1637] -- Misc: - * Support for [controller-tools][controller-tools] `v0.9.0` (for `go/v2` it is `v0.3.0` and previously it was `v0.2.5`) - * Support for [controller-runtime][controller-runtime] `v0.12.1` (for `go/v2` it is `v0.6.4` and previously it was `v0.5.0`) - * Support for [kustomize][kustomize] `v3.8.7` (for `go/v2` it is `v3.5.4` and previously it was `v3.1.0`) - * Required Envtest binaries are automatically downloaded - * The minimum Go version is now `1.18` (previously it was `1.13`). - - - -## Migrating to Kubebuilder v3 - -So you want to upgrade your scaffolding to use the latest and greatest features then, follow up the following guide which will cover the steps in the most straightforward way to allow you to upgrade your project to get all latest changes and improvements. - - - -- [Migration Guide v2 to V3][migration-guide-v2-to-v3] **(Recommended)** - -### By updating the files manually - -So you want to use the latest version of Kubebuilder CLI without changing your scaffolding then, check the following guide which will describe the manually steps required for you to upgrade only your PROJECT version and starts to use the plugins versions. - -This way is more complex, susceptible to errors, and success cannot be assured. Also, by following these steps you will not get the improvements and bug fixes in the default generated project files. - -You will check that you can still using the previous layout by using the `go/v2` plugin which will not upgrade the [controller-runtime][controller-runtime] and [controller-tools][controller-tools] to the latest version used with `go/v3` becuase of its breaking changes. By checking this guide you know also how to manually change the files to use the `go/v3` plugin and its dependencies versions. - -- [Migrating to Kubebuilder v3 by updating the files manually][manually-upgrade] - -[plugins-phase1-design-doc]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/extensible-cli-and-scaffolding-plugins-phase-1.md -[plugins-phase1-design-doc-1.5]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/extensible-cli-and-scaffolding-plugins-phase-1-5.md -[plugins-phase2-design-doc]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/extensible-cli-and-scaffolding-plugins-phase-2.md -[plugins-section]: ./../../plugins/plugins.md -[manually-upgrade]: manually_migration_guide_v2_v3.md -[component-config-tutorial]: ../../component-config-tutorial/tutorial.md -[issue-1893]: https://github.com/kubernetes-sigs/kubebuilder/issues/1839 -[migration-guide-v2-to-v3]: migration_guide_v2tov3.md -[healthz-ping]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/healthz#CheckHandler -[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime/releases -[controller-tools]: https://github.com/kubernetes-sigs/controller-tools/releases -[kustomize]: https://github.com/kubernetes-sigs/kustomize/releases -[issue-1637]: https://github.com/kubernetes-sigs/kubebuilder/issues/1637 -[enhancement proposal]: https://github.com/kubernetes/enhancements/tree/master/keps/sig-cluster-lifecycle/wgs -[cert-manager-docs]: https://cert-manager.io/docs/installation/upgrading/ -[kb-releases]: https://github.com/kubernetes-sigs/kubebuilder/releases -[kube-rbac-proxy]: https://github.com/brancz/kube-rbac-proxy/releases -[basic-project-doc]: ../../cronjob-tutorial/basic-project.md -[kustomize]: https://github.com/kubernetes-sigs/kustomize \ No newline at end of file diff --git a/docs/book/src/plugins/testing-plugins.md b/docs/book/src/plugins/testing-plugins.md index 904039e985..0758146f1e 100644 --- a/docs/book/src/plugins/testing-plugins.md +++ b/docs/book/src/plugins/testing-plugins.md @@ -52,7 +52,6 @@ Following is a general workflow to create a sample by the plugin `go/v3`: (`kbc` "--project-version", "3", "--domain", kbc.Domain, "--fetch-deps=false", - "--component-config=true", ) ExpectWithOffset(1, err).NotTo(HaveOccurred()) ``` diff --git a/hack/docs/generate.sh b/hack/docs/generate.sh index 0ae953f673..1f37f83069 100755 --- a/hack/docs/generate.sh +++ b/hack/docs/generate.sh @@ -19,7 +19,6 @@ source "$(dirname "$0")/../../test/common.sh" build_kb # ensure that destroy succeed -chmod -R +w docs/book/src/component-config-tutorial/testdata/project/ chmod -R +w docs/book/src/cronjob-tutorial/testdata/project/ chmod -R +w docs/book/src/getting-started/testdata/project/ diff --git a/hack/docs/generate_samples.go b/hack/docs/generate_samples.go index 39d1c6c04d..720a5b9f94 100644 --- a/hack/docs/generate_samples.go +++ b/hack/docs/generate_samples.go @@ -19,7 +19,6 @@ package main import ( log "github.com/sirupsen/logrus" - componentconfig "sigs.k8s.io/kubebuilder/v3/hack/docs/internal/component-config-tutorial" cronjob "sigs.k8s.io/kubebuilder/v3/hack/docs/internal/cronjob-tutorial" gettingstarted "sigs.k8s.io/kubebuilder/v3/hack/docs/internal/getting-started" ) @@ -39,9 +38,8 @@ func main() { // TODO: Generate multiversion-tutorial tutorials := map[string]generator{ - "component-config": UpdateComponentConfigTutorial, - "cronjob": UpdateCronjobTutorial, - "getting-started": UpdateGettingStarted, + "cronjob": UpdateCronjobTutorial, + "getting-started": UpdateGettingStarted, } log.SetFormatter(&log.TextFormatter{DisableTimestamp: true}) @@ -60,12 +58,6 @@ func updateTutorial(generator tutorial_generator) { generator.CodeGen() } -func UpdateComponentConfigTutorial() { - samplePath := "docs/book/src/component-config-tutorial/testdata/project/" - sp := componentconfig.NewSample(KubebuilderBinName, samplePath) - updateTutorial(&sp) -} - func UpdateCronjobTutorial() { samplePath := "docs/book/src/cronjob-tutorial/testdata/project/" sp := cronjob.NewSample(KubebuilderBinName, samplePath) diff --git a/pkg/config/interface.go b/pkg/config/interface.go index e7659e80a1..8d14d8d3d3 100644 --- a/pkg/config/interface.go +++ b/pkg/config/interface.go @@ -62,16 +62,6 @@ type Config interface { // ClearMultiGroup disables multi-group. ClearMultiGroup() error - // IsComponentConfig checks if component config is enabled. - // This method was introduced in project version 3. - IsComponentConfig() bool - // SetComponentConfig enables component config. - // This method was introduced in project version 3. - SetComponentConfig() error - // ClearComponentConfig disables component config. - // This method was introduced in project version 3. - ClearComponentConfig() error - /* Resources */ // ResourcesLength returns the number of tracked resources. diff --git a/pkg/config/v2/config.go b/pkg/config/v2/config.go index f00e5fa643..09e61e35e2 100644 --- a/pkg/config/v2/config.go +++ b/pkg/config/v2/config.go @@ -123,27 +123,6 @@ func (c *cfg) ClearMultiGroup() error { return nil } -// IsComponentConfig implements config.Config -func (c cfg) IsComponentConfig() bool { - return false -} - -// SetComponentConfig implements config.Config -func (c *cfg) SetComponentConfig() error { - return config.UnsupportedFieldError{ - Version: Version, - Field: "component config", - } -} - -// ClearComponentConfig implements config.Config -func (c *cfg) ClearComponentConfig() error { - return config.UnsupportedFieldError{ - Version: Version, - Field: "component config", - } -} - // ResourcesLength implements config.Config func (c cfg) ResourcesLength() int { return len(c.Gvks) diff --git a/pkg/config/v2/config_test.go b/pkg/config/v2/config_test.go index 57d65a6b4f..16b5cd5332 100644 --- a/pkg/config/v2/config_test.go +++ b/pkg/config/v2/config_test.go @@ -120,20 +120,6 @@ var _ = Describe("cfg", func() { }) }) - Context("Component config", func() { - It("IsComponentConfig should return false", func() { - Expect(c.IsComponentConfig()).To(BeFalse()) - }) - - It("SetComponentConfig should fail to enable component config support", func() { - Expect(c.SetComponentConfig()).NotTo(Succeed()) - }) - - It("ClearComponentConfig should fail to disable component config support", func() { - Expect(c.ClearComponentConfig()).NotTo(Succeed()) - }) - }) - Context("Resources", func() { res := resource.Resource{ GVK: resource.GVK{ diff --git a/pkg/config/v3/config.go b/pkg/config/v3/config.go index 58f2eda3d4..77c416a5a7 100644 --- a/pkg/config/v3/config.go +++ b/pkg/config/v3/config.go @@ -63,8 +63,7 @@ type Cfg struct { PluginChain stringSlice `json:"layout,omitempty"` // Boolean fields - MultiGroup bool `json:"multigroup,omitempty"` - ComponentConfig bool `json:"componentConfig,omitempty"` + MultiGroup bool `json:"multigroup,omitempty"` // Resources Resources []resource.Resource `json:"resources,omitempty"` @@ -154,23 +153,6 @@ func (c *Cfg) ClearMultiGroup() error { return nil } -// IsComponentConfig implements config.Config -func (c Cfg) IsComponentConfig() bool { - return c.ComponentConfig -} - -// SetComponentConfig implements config.Config -func (c *Cfg) SetComponentConfig() error { - c.ComponentConfig = true - return nil -} - -// ClearComponentConfig implements config.Config -func (c *Cfg) ClearComponentConfig() error { - c.ComponentConfig = false - return nil -} - // ResourcesLength implements config.Config func (c Cfg) ResourcesLength() int { return len(c.Resources) diff --git a/pkg/config/v3/config_test.go b/pkg/config/v3/config_test.go index fc08295597..48528e80f3 100644 --- a/pkg/config/v3/config_test.go +++ b/pkg/config/v3/config_test.go @@ -134,28 +134,6 @@ var _ = Describe("Cfg", func() { }) }) - Context("Component config", func() { - It("IsComponentConfig should return false if not set", func() { - Expect(c.IsComponentConfig()).To(BeFalse()) - }) - - It("IsComponentConfig should return true if set", func() { - c.ComponentConfig = true - Expect(c.IsComponentConfig()).To(BeTrue()) - }) - - It("SetComponentConfig should fail to enable component config support", func() { - Expect(c.SetComponentConfig()).To(Succeed()) - Expect(c.ComponentConfig).To(BeTrue()) - }) - - It("ClearComponentConfig should fail to disable component config support", func() { - c.ComponentConfig = false - Expect(c.ClearComponentConfig()).To(Succeed()) - Expect(c.ComponentConfig).To(BeFalse()) - }) - }) - Context("Resources", func() { var ( res = resource.Resource{ @@ -463,13 +441,12 @@ var _ = Describe("Cfg", func() { PluginChain: pluginChain, } c2 = Cfg{ - Version: Version, - Domain: otherDomain, - Repository: otherRepo, - Name: otherName, - PluginChain: otherPluginChain, - MultiGroup: true, - ComponentConfig: true, + Version: Version, + Domain: otherDomain, + Repository: otherRepo, + Name: otherName, + PluginChain: otherPluginChain, + MultiGroup: true, Resources: []resource.Resource{ { GVK: resource.GVK{ @@ -542,8 +519,7 @@ projectName: ProjectName repo: myrepo version: "3" ` - s2 = `componentConfig: true -domain: other.domain + s2 = `domain: other.domain layout: - go.kubebuilder.io/v3 multigroup: true @@ -610,7 +586,6 @@ version: "3" Expect(unmarshalled.Name).To(Equal(c.Name)) Expect(unmarshalled.PluginChain).To(Equal(c.PluginChain)) Expect(unmarshalled.MultiGroup).To(Equal(c.MultiGroup)) - Expect(unmarshalled.ComponentConfig).To(Equal(c.ComponentConfig)) Expect(unmarshalled.Resources).To(Equal(c.Resources)) Expect(unmarshalled.Plugins).To(HaveLen(len(c.Plugins))) // TODO: fully test Plugins field and not on its length diff --git a/pkg/machinery/injector.go b/pkg/machinery/injector.go index cbce1a05cf..9fedfa13fc 100644 --- a/pkg/machinery/injector.go +++ b/pkg/machinery/injector.go @@ -49,9 +49,6 @@ func (i injector) injectInto(builder Builder) { if builderWithMultiGroup, hasMultiGroup := builder.(HasMultiGroup); hasMultiGroup { builderWithMultiGroup.InjectMultiGroup(i.config.IsMultiGroup()) } - if builderWithComponentConfig, hasComponentConfig := builder.(HasComponentConfig); hasComponentConfig { - builderWithComponentConfig.InjectComponentConfig(i.config.IsComponentConfig()) - } } // Inject boilerplate if builderWithBoilerplate, hasBoilerplate := builder.(HasBoilerplate); hasBoilerplate { diff --git a/pkg/machinery/injector_test.go b/pkg/machinery/injector_test.go index c9c2b76e6e..525fe26633 100644 --- a/pkg/machinery/injector_test.go +++ b/pkg/machinery/injector_test.go @@ -74,15 +74,6 @@ func (t *templateWithMultiGroup) InjectMultiGroup(multiGroup bool) { t.multiGroup = multiGroup } -type templateWithComponentConfig struct { - templateBase - componentConfig bool -} - -func (t *templateWithComponentConfig) InjectComponentConfig(componentConfig bool) { - t.componentConfig = componentConfig -} - type templateWithBoilerplate struct { templateBase boilerplate string @@ -217,31 +208,6 @@ var _ = Describe("injector", func() { Expect(template.multiGroup).To(BeTrue()) }) }) - - Context("Component config", func() { - var template *templateWithComponentConfig - - BeforeEach(func() { - template = &templateWithComponentConfig{templateBase: tmp} - }) - - It("should not inject anything if the config is nil", func() { - injector{}.injectInto(template) - Expect(template.componentConfig).To(BeFalse()) - }) - - It("should not set the flag if the config doesn't have the component config flag set", func() { - injector{config: c}.injectInto(template) - Expect(template.componentConfig).To(BeFalse()) - }) - - It("should set the flag if the config has the component config flag set", func() { - Expect(c.SetComponentConfig()).To(Succeed()) - - injector{config: c}.injectInto(template) - Expect(template.componentConfig).To(BeTrue()) - }) - }) }) Context("Boilerplate", func() { diff --git a/pkg/machinery/interfaces.go b/pkg/machinery/interfaces.go index cf28d9c8fb..5659757980 100644 --- a/pkg/machinery/interfaces.go +++ b/pkg/machinery/interfaces.go @@ -83,20 +83,6 @@ type HasMultiGroup interface { InjectMultiGroup(bool) } -// Deprecated: The ComponentConfig has been deprecated in the Controller-Runtime since its version 0.15.0. -// Fur further information see: https://github.com/kubernetes-sigs/controller-runtime/issues/895 -// Moreover, it has undergone breaking changes and is no longer functioning as intended. -// As a result, Kubebuilder, which heavily relies on the Controller Runtime, has also deprecated this feature, -// no longer guaranteeing its functionality from version 3.11.0 onwards. -// -// Please, be aware that it will force Kubebuilder remove this option soon in future release. -// -// HasComponentConfig allows the component-config flag to be used on a template -type HasComponentConfig interface { - // InjectComponentConfig sets the template component-config flag - InjectComponentConfig(bool) -} - // HasBoilerplate allows a boilerplate to be used on a template type HasBoilerplate interface { // InjectBoilerplate sets the template boilerplate diff --git a/pkg/machinery/mixins.go b/pkg/machinery/mixins.go index a4045f56e5..cd1339a2f4 100644 --- a/pkg/machinery/mixins.go +++ b/pkg/machinery/mixins.go @@ -129,25 +129,6 @@ func (m *MultiGroupMixin) InjectMultiGroup(flag bool) { m.MultiGroup = flag } -// Deprecated: The ComponentConfig has been deprecated in the Controller-Runtime since its version 0.15.0. -// Fur further information see: https://github.com/kubernetes-sigs/controller-runtime/issues/895 -// Moreover, it has undergone breaking changes and is no longer functioning as intended. -// As a result, Kubebuilder, which heavily relies on the Controller Runtime, has also deprecated this feature, -// no longer guaranteeing its functionality from version 3.11.0 onwards. -// -// Please, be aware that it will force Kubebuilder remove this option soon in future release. -// -// ComponentConfigMixin provides templates with a injectable component-config flag field -type ComponentConfigMixin struct { - // ComponentConfig is the component-config flag - ComponentConfig bool -} - -// InjectComponentConfig implements HasComponentConfig -func (m *ComponentConfigMixin) InjectComponentConfig(flag bool) { - m.ComponentConfig = flag -} - // BoilerplateMixin provides templates with a injectable boilerplate field type BoilerplateMixin struct { // Boilerplate is the contents of a Boilerplate go header file diff --git a/pkg/machinery/mixins_test.go b/pkg/machinery/mixins_test.go index df43f3a5c0..eb4de6eab3 100644 --- a/pkg/machinery/mixins_test.go +++ b/pkg/machinery/mixins_test.go @@ -29,7 +29,6 @@ type mockTemplate struct { RepositoryMixin ProjectNameMixin MultiGroupMixin - ComponentConfigMixin BoilerplateMixin ResourceMixin } @@ -145,17 +144,6 @@ var _ = Describe("MultiGroupMixin", func() { }) }) -var _ = Describe("ComponentConfigMixin", func() { - tmp := mockTemplate{} - - Context("InjectComponentConfig", func() { - It("should inject the provided component config flag", func() { - tmp.InjectComponentConfig(true) - Expect(tmp.ComponentConfig).To(BeTrue()) - }) - }) -}) - var _ = Describe("BoilerplateMixin", func() { const boilerplate = "Copyright" diff --git a/pkg/plugins/common/kustomize/v1/init.go b/pkg/plugins/common/kustomize/v1/init.go index 825d32e158..251a756137 100644 --- a/pkg/plugins/common/kustomize/v1/init.go +++ b/pkg/plugins/common/kustomize/v1/init.go @@ -45,9 +45,8 @@ type initSubcommand struct { config config.Config // config options - domain string - name string - componentConfig bool + domain string + name string } func (p *initSubcommand) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *plugin.SubcommandMetadata) { @@ -73,8 +72,6 @@ More info: https://github.com/kubernetes-sigs/kustomize/issues/4612. func (p *initSubcommand) BindFlags(fs *pflag.FlagSet) { fs.StringVar(&p.domain, "domain", "my.domain", "domain for groups") fs.StringVar(&p.name, "project-name", "", "name of this project") - fs.BoolVar(&p.componentConfig, "component-config", false, - "create a versioned ComponentConfig file, may be 'true' or 'false'") } func (p *initSubcommand) InjectConfig(c config.Config) error { @@ -100,12 +97,6 @@ func (p *initSubcommand) InjectConfig(c config.Config) error { return err } - if p.componentConfig { - if err := p.config.SetComponentConfig(); err != nil { - return err - } - } - return nil } diff --git a/pkg/plugins/common/kustomize/v1/scaffolds/init.go b/pkg/plugins/common/kustomize/v1/scaffolds/init.go index c4c0227fcc..2a160fc148 100644 --- a/pkg/plugins/common/kustomize/v1/scaffolds/init.go +++ b/pkg/plugins/common/kustomize/v1/scaffolds/init.go @@ -81,9 +81,5 @@ func (s *initScaffolder) Scaffold() error { &prometheus.Monitor{}, } - if s.config.IsComponentConfig() { - templates = append(templates, &manager.ControllerManagerConfig{}) - } - return scaffold.Execute(templates...) } diff --git a/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/kustomization.go b/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/kustomization.go index dac2814a2e..d27fd978e0 100644 --- a/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/kustomization.go +++ b/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/kustomization.go @@ -28,7 +28,6 @@ var _ machinery.Template = &Kustomization{} type Kustomization struct { machinery.TemplateMixin machinery.ProjectNameMixin - machinery.ComponentConfigMixin } // SetTemplateDefaults implements file.Template @@ -76,11 +75,6 @@ patchesStrategicMerge: # endpoint w/o any authn/z, please comment the following line. - manager_auth_proxy_patch.yaml -{{ if .ComponentConfig }} -# Mount the controller config file for loading manager configurations -# through a ComponentConfig type -- manager_config_patch.yaml{{ end }} - # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in # crd/kustomization.yaml #- manager_webhook_patch.yaml diff --git a/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/manager_auth_proxy_patch.go b/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/manager_auth_proxy_patch.go index 4e28d35772..921499e214 100644 --- a/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/manager_auth_proxy_patch.go +++ b/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/manager_auth_proxy_patch.go @@ -27,7 +27,6 @@ var _ machinery.Template = &ManagerAuthProxyPatch{} // ManagerAuthProxyPatch scaffolds a file that defines the patch that enables prometheus metrics for the manager type ManagerAuthProxyPatch struct { machinery.TemplateMixin - machinery.ComponentConfigMixin } // SetTemplateDefaults implements file.Template @@ -77,11 +76,9 @@ spec: requests: cpu: 5m memory: 64Mi -{{- if not .ComponentConfig }} - name: manager args: - "--health-probe-bind-address=:8081" - "--metrics-bind-address=127.0.0.1:8080" - "--leader-elect" -{{- end }} ` diff --git a/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/manager_config_patch.go b/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/manager_config_patch.go index bf7fce47d9..34395fdffc 100644 --- a/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/manager_config_patch.go +++ b/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/manager_config_patch.go @@ -27,7 +27,6 @@ var _ machinery.Template = &ManagerConfigPatch{} // ManagerConfigPatch scaffolds a ManagerConfigPatch for a Resource type ManagerConfigPatch struct { machinery.TemplateMixin - machinery.ComponentConfigMixin } // SetTemplateDefaults implements input.Template @@ -51,16 +50,4 @@ spec: spec: containers: - name: manager -{{- if .ComponentConfig }} - args: - - "--config=controller_manager_config.yaml" - volumeMounts: - - name: manager-config - mountPath: /controller_manager_config.yaml - subPath: controller_manager_config.yaml - volumes: - - name: manager-config - configMap: - name: manager-config -{{- end }} ` diff --git a/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/config.go b/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/config.go index 0a471835d6..e200440fe5 100644 --- a/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/config.go +++ b/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/config.go @@ -27,7 +27,6 @@ var _ machinery.Template = &Config{} // Config scaffolds a file that defines the namespace and the manager deployment type Config struct { machinery.TemplateMixin - machinery.ComponentConfigMixin machinery.ProjectNameMixin // Image is controller manager image name @@ -115,10 +114,8 @@ spec: containers: - command: - /manager -{{- if not .ComponentConfig }} args: - --leader-elect -{{- end }} image: {{ .Image }} name: manager securityContext: diff --git a/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/controller_manager_config.go b/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/controller_manager_config.go deleted file mode 100644 index 3173525600..0000000000 --- a/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/controller_manager_config.go +++ /dev/null @@ -1,77 +0,0 @@ -/* -Copyright 2020 The Kubernetes Authors. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -package manager - -import ( - "path/filepath" - - "sigs.k8s.io/kubebuilder/v3/pkg/machinery" -) - -var _ machinery.Template = &ControllerManagerConfig{} - -// ControllerManagerConfig scaffolds the config file in config/manager folder. -type ControllerManagerConfig struct { - machinery.TemplateMixin - machinery.DomainMixin - machinery.RepositoryMixin - machinery.ProjectNameMixin -} - -// SetTemplateDefaults implements input.Template -func (f *ControllerManagerConfig) SetTemplateDefaults() error { - if f.Path == "" { - f.Path = filepath.Join("config", "manager", "controller_manager_config.yaml") - } - - f.TemplateBody = controllerManagerConfigTemplate - - f.IfExistsAction = machinery.Error - - return nil -} - -const controllerManagerConfigTemplate = `apiVersion: controller-runtime.sigs.k8s.io/v1alpha1 -kind: ControllerManagerConfig -metadata: - labels: - app.kubernetes.io/name: controllermanagerconfig - app.kubernetes.io/instance: controller-manager-configuration - app.kubernetes.io/component: manager - app.kubernetes.io/created-by: {{ .ProjectName }} - app.kubernetes.io/part-of: {{ .ProjectName }} - app.kubernetes.io/managed-by: kustomize -health: - healthProbeBindAddress: :8081 -metrics: - bindAddress: 127.0.0.1:8080 -webhook: - port: 9443 -leaderElection: - leaderElect: true - resourceName: {{ hashFNV .Repo }}.{{ .Domain }} -# leaderElectionReleaseOnCancel defines if the leader should step down volume -# when the Manager ends. This requires the binary to immediately end when the -# Manager is stopped, otherwise, this setting is unsafe. Setting this significantly -# speeds up voluntary leader transitions as the new leader don't have to wait -# LeaseDuration time first. -# In the default scaffold provided, the program ends immediately after -# the manager stops, so would be fine to enable this option. However, -# if you are doing or is intended to do any operation such as perform cleanups -# after the manager stops then its usage might be unsafe. -# leaderElectionReleaseOnCancel: true -` diff --git a/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/kustomization.go b/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/kustomization.go index 1faa0750c3..dcc5157905 100644 --- a/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/kustomization.go +++ b/pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/kustomization.go @@ -27,7 +27,6 @@ var _ machinery.Template = &Kustomization{} // Kustomization scaffolds a file that defines the kustomization scheme for the manager folder type Kustomization struct { machinery.TemplateMixin - machinery.ComponentConfigMixin } // SetTemplateDefaults implements file.Template @@ -45,15 +44,4 @@ func (f *Kustomization) SetTemplateDefaults() error { const kustomizeManagerTemplate = `resources: - manager.yaml - -{{- if .ComponentConfig }} - -generatorOptions: - disableNameSuffixHash: true - -configMapGenerator: -- name: manager-config - files: - - controller_manager_config.yaml -{{- end }} ` diff --git a/pkg/plugins/common/kustomize/v2/init.go b/pkg/plugins/common/kustomize/v2/init.go index fbe022ce01..297fb36e37 100644 --- a/pkg/plugins/common/kustomize/v2/init.go +++ b/pkg/plugins/common/kustomize/v2/init.go @@ -37,9 +37,8 @@ type initSubcommand struct { config config.Config // config options - domain string - name string - componentConfig bool + domain string + name string } func (p *initSubcommand) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *plugin.SubcommandMetadata) { @@ -60,13 +59,6 @@ NOTE: This plugin requires kustomize version v5 and kubectl >= 1.22. func (p *initSubcommand) BindFlags(fs *pflag.FlagSet) { fs.StringVar(&p.domain, "domain", "my.domain", "domain for groups") fs.StringVar(&p.name, "project-name", "", "name of this project") - fs.BoolVar(&p.componentConfig, "component-config", false, - "create a versioned ComponentConfig file, may be 'true' or 'false'") - _ = fs.MarkDeprecated("component-config", "the ComponentConfig has been deprecated in the "+ - "Controller-Runtime since its version 0.15.0. Moreover, it has undergone breaking changes and is no longer "+ - "functioning as intended. As a result, this tool, which heavily relies on the Controller Runtime, "+ - "has also deprecated this feature, no longer guaranteeing its functionality from version 3.11.0 onwards. "+ - "You can find additional details on https://github.com/kubernetes-sigs/controller-runtime/issues/895.") } func (p *initSubcommand) InjectConfig(c config.Config) error { @@ -92,12 +84,6 @@ func (p *initSubcommand) InjectConfig(c config.Config) error { return err } - if p.componentConfig { - if err := p.config.SetComponentConfig(); err != nil { - return err - } - } - return nil } diff --git a/pkg/plugins/common/kustomize/v2/scaffolds/init.go b/pkg/plugins/common/kustomize/v2/scaffolds/init.go index cc034727e1..47f52a4d2f 100644 --- a/pkg/plugins/common/kustomize/v2/scaffolds/init.go +++ b/pkg/plugins/common/kustomize/v2/scaffolds/init.go @@ -81,9 +81,5 @@ func (s *initScaffolder) Scaffold() error { &prometheus.Monitor{}, } - if s.config.IsComponentConfig() { - templates = append(templates, &manager.ControllerManagerConfig{}) - } - return scaffold.Execute(templates...) } diff --git a/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/enable_matrics_patch.go b/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/enable_matrics_patch.go index d403c55776..56caa76980 100644 --- a/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/enable_matrics_patch.go +++ b/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/enable_matrics_patch.go @@ -27,7 +27,6 @@ var _ machinery.Template = &ManagerMetricsPatch{} // ManagerMetricsPatch scaffolds a file that defines the patch that enables prometheus metrics for the manager type ManagerMetricsPatch struct { machinery.TemplateMixin - machinery.ComponentConfigMixin } // SetTemplateDefaults implements file.Template diff --git a/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/kustomization.go b/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/kustomization.go index c676a35701..d85781b75d 100644 --- a/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/kustomization.go +++ b/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/kustomization.go @@ -28,7 +28,6 @@ var _ machinery.Template = &Kustomization{} type Kustomization struct { machinery.TemplateMixin machinery.ProjectNameMixin - machinery.ComponentConfigMixin } // SetTemplateDefaults implements file.Template @@ -78,13 +77,6 @@ patches: # If you want to expose the metric endpoint of your controller-manager uncomment the following line. #- path: manager_metrics_patch.yaml -{{ if .ComponentConfig -}} -# Mount the controller config file for loading manager configurations -# through a ComponentConfig type -- path: manager_config_patch.yaml - -{{ end -}} - # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in # crd/kustomization.yaml #- path: manager_webhook_patch.yaml diff --git a/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/manager_config_patch.go b/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/manager_config_patch.go index bf7fce47d9..34395fdffc 100644 --- a/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/manager_config_patch.go +++ b/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/manager_config_patch.go @@ -27,7 +27,6 @@ var _ machinery.Template = &ManagerConfigPatch{} // ManagerConfigPatch scaffolds a ManagerConfigPatch for a Resource type ManagerConfigPatch struct { machinery.TemplateMixin - machinery.ComponentConfigMixin } // SetTemplateDefaults implements input.Template @@ -51,16 +50,4 @@ spec: spec: containers: - name: manager -{{- if .ComponentConfig }} - args: - - "--config=controller_manager_config.yaml" - volumeMounts: - - name: manager-config - mountPath: /controller_manager_config.yaml - subPath: controller_manager_config.yaml - volumes: - - name: manager-config - configMap: - name: manager-config -{{- end }} ` diff --git a/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/manager/config.go b/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/manager/config.go index cf8b603679..d010423e58 100644 --- a/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/manager/config.go +++ b/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/manager/config.go @@ -27,7 +27,6 @@ var _ machinery.Template = &Config{} // Config scaffolds a file that defines the namespace and the manager deployment type Config struct { machinery.TemplateMixin - machinery.ComponentConfigMixin machinery.ProjectNameMixin // Image is controller manager image name @@ -107,12 +106,10 @@ spec: containers: - command: - /manager -{{- if not .ComponentConfig }} args: - --leader-elect - --health-probe-bind-address=:8081 - --metrics-bind-address=0 -{{- end }} image: {{ .Image }} name: manager securityContext: diff --git a/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/manager/kustomization.go b/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/manager/kustomization.go index 1faa0750c3..dcc5157905 100644 --- a/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/manager/kustomization.go +++ b/pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/manager/kustomization.go @@ -27,7 +27,6 @@ var _ machinery.Template = &Kustomization{} // Kustomization scaffolds a file that defines the kustomization scheme for the manager folder type Kustomization struct { machinery.TemplateMixin - machinery.ComponentConfigMixin } // SetTemplateDefaults implements file.Template @@ -45,15 +44,4 @@ func (f *Kustomization) SetTemplateDefaults() error { const kustomizeManagerTemplate = `resources: - manager.yaml - -{{- if .ComponentConfig }} - -generatorOptions: - disableNameSuffixHash: true - -configMapGenerator: -- name: manager-config - files: - - controller_manager_config.yaml -{{- end }} ` diff --git a/pkg/plugins/golang/v3/scaffolds/internal/templates/main.go b/pkg/plugins/golang/v3/scaffolds/internal/templates/main.go index 496fbfbd43..8960a28050 100644 --- a/pkg/plugins/golang/v3/scaffolds/internal/templates/main.go +++ b/pkg/plugins/golang/v3/scaffolds/internal/templates/main.go @@ -33,7 +33,6 @@ type Main struct { machinery.BoilerplateMixin machinery.DomainMixin machinery.RepositoryMixin - machinery.ComponentConfigMixin } // SetTemplateDefaults implements file.Template @@ -215,7 +214,6 @@ func init() { } func main() { -{{- if not .ComponentConfig }} var metricsAddr string var enableLeaderElection bool var probeAddr string @@ -227,13 +225,6 @@ func main() { "Enabling this will ensure there is only one active controller manager.") flag.BoolVar(&enableHTTP2, "enable-http2", false, "If set, HTTP/2 will be enabled for the metrics and webhook servers") -{{- else }} - var configFile string - flag.StringVar(&configFile, "config", "", - "The controller will load its initial configuration from this file. " + - "Omit this flag to use the default configuration values. " + - "Command-line flags override configuration from this file.") -{{- end }} opts := zap.Options{ Development: true, } @@ -242,7 +233,6 @@ func main() { ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts))) -{{ if not .ComponentConfig }} // if the enable-http2 flag is false (the default), http/2 should be disabled // due to its vulnerabilities. More specifically, disabling http/2 will // prevent from being vulnerable to the HTTP/2 Stream Cancellation and @@ -281,19 +271,6 @@ func main() { // after the manager stops then its usage might be unsafe. // LeaderElectionReleaseOnCancel: true, }) -{{- else }} - var err error - options := ctrl.Options{Scheme: scheme} - if configFile != "" { - options, err = options.AndFrom(ctrl.ConfigFile().AtPath(configFile)) - if err != nil { - setupLog.Error(err, "unable to load the config file") - os.Exit(1) - } - } - - mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), options) -{{- end }} if err != nil { setupLog.Error(err, "unable to start manager") os.Exit(1) diff --git a/pkg/plugins/golang/v3/scaffolds/internal/templates/makefile.go b/pkg/plugins/golang/v3/scaffolds/internal/templates/makefile.go index 6b5d7dfc47..114c3e2a30 100644 --- a/pkg/plugins/golang/v3/scaffolds/internal/templates/makefile.go +++ b/pkg/plugins/golang/v3/scaffolds/internal/templates/makefile.go @@ -25,7 +25,6 @@ var _ machinery.Template = &Makefile{} // Makefile scaffolds a file that defines project management CLI commands type Makefile struct { machinery.TemplateMixin - machinery.ComponentConfigMixin machinery.ProjectNameMixin // Image is controller manager image name diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/main.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/main.go index 308bd92c76..9da4fdea4f 100644 --- a/pkg/plugins/golang/v4/scaffolds/internal/templates/main.go +++ b/pkg/plugins/golang/v4/scaffolds/internal/templates/main.go @@ -33,7 +33,6 @@ type Main struct { machinery.BoilerplateMixin machinery.DomainMixin machinery.RepositoryMixin - machinery.ComponentConfigMixin } // SetTemplateDefaults implements file.Template @@ -218,7 +217,6 @@ func init() { } func main() { -{{- if not .ComponentConfig }} var metricsAddr string var enableLeaderElection bool var probeAddr string @@ -233,13 +231,6 @@ func main() { "If set the metrics endpoint is served securely") flag.BoolVar(&enableHTTP2, "enable-http2", false, "If set, HTTP/2 will be enabled for the metrics and webhook servers") -{{- else }} - var configFile string - flag.StringVar(&configFile, "config", "", - "The controller will load its initial configuration from this file. " + - "Omit this flag to use the default configuration values. " + - "Command-line flags override configuration from this file.") -{{- end }} opts := zap.Options{ Development: true, } @@ -248,7 +239,6 @@ func main() { ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts))) -{{ if not .ComponentConfig }} // if the enable-http2 flag is false (the default), http/2 should be disabled // due to its vulnerabilities. More specifically, disabling http/2 will // prevent from being vulnerable to the HTTP/2 Stream Cancellation and @@ -296,19 +286,6 @@ func main() { // after the manager stops then its usage might be unsafe. // LeaderElectionReleaseOnCancel: true, }) -{{- else }} - var err error - options := ctrl.Options{Scheme: scheme} - if configFile != "" { - options, err = options.AndFrom(ctrl.ConfigFile().AtPath(configFile)) - if err != nil { - setupLog.Error(err, "unable to load the config file") - os.Exit(1) - } - } - - mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), options) -{{- end }} if err != nil { setupLog.Error(err, "unable to start manager") os.Exit(1) diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/makefile.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/makefile.go index f041315e04..d2eb76cf7a 100644 --- a/pkg/plugins/golang/v4/scaffolds/internal/templates/makefile.go +++ b/pkg/plugins/golang/v4/scaffolds/internal/templates/makefile.go @@ -25,7 +25,6 @@ var _ machinery.Template = &Makefile{} // Makefile scaffolds a file that defines project management CLI commands type Makefile struct { machinery.TemplateMixin - machinery.ComponentConfigMixin machinery.ProjectNameMixin // Image is controller manager image name diff --git a/testdata/project-v3/config/default/kustomization.yaml b/testdata/project-v3/config/default/kustomization.yaml index 9f11a640f6..f8b3884950 100644 --- a/testdata/project-v3/config/default/kustomization.yaml +++ b/testdata/project-v3/config/default/kustomization.yaml @@ -30,8 +30,6 @@ patchesStrategicMerge: # endpoint w/o any authn/z, please comment the following line. - manager_auth_proxy_patch.yaml - - # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in # crd/kustomization.yaml #- manager_webhook_patch.yaml