https://github.com/kairen/controller101
An example of Kubernetes custom controller that shows you how to manage VMs.
https://github.com/kairen/controller101
Last synced: 6 months ago
JSON representation
An example of Kubernetes custom controller that shows you how to manage VMs.
- Host: GitHub
- URL: https://github.com/kairen/controller101
- Owner: kairen
- License: apache-2.0
- Created: 2019-10-07T08:16:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-11T20:43:00.000Z (over 2 years ago)
- Last Synced: 2025-03-24T06:11:22.115Z (7 months ago)
- Language: Go
- Size: 245 KB
- Stars: 14
- Watchers: 7
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Controller 101
This repository implements a simple controller for watching `VM` resources as defined with a [CRD](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/).
This example will show you how to perform basic operations such as:
* [x] How to create a custom resource of type `VM` using CRD API.
* [x] How to operate instances of type `VM`.
* [x] How to implement a controller for handling an instance of type `VM` to move the current state towards the desired state.
* [x] How to use Finalizer on instances of type `VM`.
* [x] How to implement LeaseLock for multiple controllers.
* [ ] How to expose metrics of the controller.
## Building from Source
Clone the repo in whatever working directory you like, and run the following commands:
```sh
$ export GO111MODULE=on
$ git clone https://github.com/cloud-native-taiwan/controller101
$ cd controller101
$ make
```
## Running
Run the following command to debug:
```sh
$ minikube start --kubernetes-version=v1.15.4
$ eval $(minikube docker-env)
$ POD_NAME=test1 go run cmd/main.go --kubeconfig=$HOME/.kube/config \
-v=3 --logtostderr \
--lease-lock-namespace=default \
--vm-driver=docker
...
I1015 02:16:08.067269 53517 leaderelection.go:242] attempting to acquire leader lease default/controller101...
I1015 02:16:08.083723 53517 leaderelection.go:252] successfully acquired lease default/controller101
I1015 02:16:08.083830 53517 controller.go:77] Starting the controller
I1015 02:16:08.083846 53517 controller.go:78] Waiting for the informer caches to sync
I1015 02:16:08.185334 53517 controller.go:86] Started workers
I1015 02:16:08.185379 53517 main.go:144] test1: leading
```
## Deploy in the cluster
Run the following command to deploy the controller:
```sh
$ minikube start --kubernetes-version=v1.15.4
$ minikube docker-env
$ kubectl -n kube-system create secret generic docker-certs \
--from-file=$HOME/.minikube/certs/ca.pem \
--from-file=$HOME/.minikube/certs/cert.pem \
--from-file=$HOME/.minikube/certs/key.pem
# Modify envs in `deploy/deployment.yml` to reflect you need values:
$ kubectl apply -f deploy/
```