https://github.com/squaremo/comprehension-controller
Experiment in Kubernetes API design
https://github.com/squaremo/comprehension-controller
Last synced: about 1 month ago
JSON representation
Experiment in Kubernetes API design
- Host: GitHub
- URL: https://github.com/squaremo/comprehension-controller
- Owner: squaremo
- Created: 2023-06-10T22:27:52.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-02T21:45:00.000Z (almost 3 years ago)
- Last Synced: 2025-01-25T05:25:02.757Z (over 1 year ago)
- Language: Go
- Size: 189 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Comprehension controller
```yaml
for: v
in:
list:
- prod
- dev
- staging
do:
generate:
apiVersion: v1
kind: ConfigMap
metadata:
name: env-${v}
data:
env: ${v}
```
## Description
This controller works from specifications given in `Comprehension`
objects, which give a (possibly nested) list of values. Each
combination of values is used to instantiate a template.
## Getting Started
You’ll need a Kubernetes cluster to run against. You can use
[KIND](https://sigs.k8s.io/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
1. Install Instances of Custom Resources:
```sh
kubectl apply -f config/samples/
```
2. Build and push your image to the location specified by `IMG`:
```sh
make docker-build docker-push IMG=/comprehension-controller:tag
```
3. Deploy the controller to the cluster with the image specified by `IMG`:
```sh
make deploy IMG=/comprehension-controller:tag
```
### Uninstall CRDs
To delete the CRDs from the cluster:
```sh
make uninstall
```
### Undeploy controller
UnDeploy the controller from the cluster:
```sh
make undeploy
```
### How it works
This project aims to follow the Kubernetes [Operator
pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).
It uses
[Controllers](https://kubernetes.io/docs/concepts/architecture/controller/),
which provide a reconcile function responsible for synchronizing
resources until the desired state is reached on the cluster.
### Test It Out
1. Install the CRDs into the cluster:
```sh
make install
```
2. Run your controller (this will run in the foreground, so switch to
a new terminal if you want to leave it running):
```sh
make run
```
**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:
```sh
make manifests
```
**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 2023 Michael Bridgen.
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.