Example Kubernetes Operator project created with kubebuilder, which manages a CRD Password
and generates a configurable password.
- Docker Engine: 24.0.2
- go: go1.20
- kubebuilder: v3.13.0
- Kubernetes: v1.27.3
- kind: v0.20.0
- kustomize: (devel)
- cert-manager: v1.8.0
You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster.
Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info
shows).
- Install Instances of Custom Resources:
kubectl apply -f config/samples/
- Build and push your image to the location specified by
IMG
:
make docker-build docker-push IMG=<some-registry>/password-operator:tag
- Deploy the controller to the cluster with the image specified by
IMG
:
make deploy IMG=<some-registry>/password-operator:tag
To delete the CRDs from the cluster:
make uninstall
UnDeploy the controller to the cluster:
make undeploy
// TODO(user): Add detailed information on how you would like others to contribute to this project
This project aims to follow the Kubernetes Operator pattern
It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster
-
Start kind cluster
kind create cluster
-
Install the CRDs into the cluster:
make install
-
Run cert manager
CERT_MANAGER_VERSION=v1.8.0 kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/$CERT_MANAGER_VERSION/cert-manager.yaml
-
Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
IMG=password-operator:webhook make docker-build IMG=$IMG kind load docker-image $IMG make deploy IMG=$IMG
-
Create
Password
CRkubectl apply -f config/samples/secret_v1alpha1_password.yaml
-
Check Secret
kubectl get secret NAME TYPE DATA AGE password-sample Opaque 1 5s
-
Check invalid CR (denied by admission webhook)
apiVersion: secret.example.com/v1alpha1 kind: Password metadata: labels: app.kubernetes.io/name: password app.kubernetes.io/instance: password-sample app.kubernetes.io/part-of: password-operator app.kubernetes.io/managed-by: kustomize app.kubernetes.io/created-by: password-operator name: password-sample spec: length: 20 digit: 10 symbol: 15
kubectl apply -f config/samples/secret_v1alpha1_password.yaml Error from server (Forbidden): error when creating "config/samples/secret_v1alpha1_password.yaml": admission webhook "vpassword.kb.io" denied the request: Number of digits and symbols must be less than total length
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
make manifests
NOTE: Run make --help
for more information on all potential make
targets
More information can be found via the Kubebuilder Documentation
Example:
echo yes | SED=gsed ./.upgrade-version.sh v3.12.0
Copyright 2022.
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.