https://github.com/sonalys/dummy-k8s-operator
Just a dummy kubernetes controller, for learning purpose.
https://github.com/sonalys/dummy-k8s-operator
Last synced: 12 months ago
JSON representation
Just a dummy kubernetes controller, for learning purpose.
- Host: GitHub
- URL: https://github.com/sonalys/dummy-k8s-operator
- Owner: sonalys
- Created: 2024-01-14T10:04:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-15T10:16:22.000Z (over 2 years ago)
- Last Synced: 2025-02-21T11:50:21.222Z (over 1 year ago)
- Language: Go
- Homepage:
- Size: 42 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# dummy-k8s-operator
This operator manages a nginx instance, keeping the Dummy object updated with it's status, and a echoMessage.
## 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
make install
```
2. Deploy the controller to the cluster with the image specified by `IMG`:
```sh
make deploy IMG=ghcr.io/sonalys/dummy-k8s-operator:latest
```
### 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. Running it:
You can run it locally via:
```sh
make run
```
Or use the docker image through:
```sh
make deploy IMG=ghcr.io/sonalys/dummy-k8s-operator:latest
```
**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 2024.
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.