|Nikolai Rodionov cc1e446f83|
// TODO(user): Add simple overview of use/purpose
// TODO(user): An in-depth paragraph about your project and overview of use
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).
Running on the cluster
- Install Instances of Custom Resources:
kubectl apply -k config/samples/
- Build and push your image to the location specified by
make docker-build docker-push IMG=<some-registry>/woody-operator:tag
- Deploy the controller to the cluster with the image specified by
make deploy IMG=<some-registry>/woody-operator:tag
To delete the CRDs from the cluster:
UnDeploy the controller from the cluster:
// TODO(user): Add detailed information on how you would like others to contribute to this project
How it works
This project aims to follow the Kubernetes Operator pattern.
It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.
Test It Out
- Install the CRDs into the cluster:
- Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
NOTE: You can also run this in one step by running:
make install run
Modifying the API definitions
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
make --help for more information on all potential
More information can be found via the Kubebuilder Documentation
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
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.