README
¶
k8-operator
// TODO
Description
// TODO
Getting Started
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 -f config/samples/
- Build and push your image to the location specified by
IMG:
make docker-build docker-push IMG=<some-registry>/k8-operator:tag
- Deploy the controller to the cluster with the image specified by
IMG:
make deploy IMG=<some-registry>/k8-operator:tag
Uninstall CRDs
To delete the CRDs from the cluster:
make uninstall
Undeploy controller
UnDeploy the controller to the cluster:
make undeploy
Contributing
// TODO
How it works
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
Test It Out
- Install the CRDs into the cluster:
make install
- Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
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:
make manifests
Also, after editing the API definitions, update the kubectl-install folder:
make kubectl-install
NOTE: Run make --help for more information on all potential make targets
More information can be found via the Kubebuilder Documentation
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1
Package v1 contains API Schema definitions for the secrets v1 API group +kubebuilder:object:generate=true +groupName=kms.hanzo.ai
|
Package v1 contains API Schema definitions for the secrets v1 API group +kubebuilder:object:generate=true +groupName=kms.hanzo.ai |
|
controllers
|
|
|
kmspushsecret
Package controllers/kmspushsecret_helper.go: write-side reconciler.
|
Package controllers/kmspushsecret_helper.go: write-side reconciler. |
|
kmssecret
Package controllers/kmssecret_helper.go: read-side reconciler.
|
Package controllers/kmssecret_helper.go: read-side reconciler. |
|
internal
|
|
|
bootstrap
Package bootstrap maintains the kms-consensus-authority Secret that kmsd (luxfi/kms cmd/kmsd) consumes via KMS_CONSENSUS_FILE.
|
Package bootstrap maintains the kms-consensus-authority Secret that kmsd (luxfi/kms cmd/kmsd) consumes via KMS_CONSENSUS_FILE. |
|
packages
|
|
|
api
Package api holds the cross-controller configuration shared by every reconciler — the canonical luxfi/kms host, an optional custom CA, and the User-Agent string sent on every outbound request.
|
Package api holds the cross-controller configuration shared by every reconciler — the canonical luxfi/kms host, an optional custom CA, and the User-Agent string sent on every outbound request. |
|
kmsapi
Package kmsapi is the in-tree HTTP client for the canonical luxfi/kms surface (~/work/hanzo/kms cmd/kmsd, served at kms.hanzo.ai).
|
Package kmsapi is the in-tree HTTP client for the canonical luxfi/kms surface (~/work/hanzo/kms cmd/kmsd, served at kms.hanzo.ai). |
|
kmszap
Package kmszap is the ZAP-native counterpart to packages/kmsapi.
|
Package kmszap is the ZAP-native counterpart to packages/kmsapi. |
|
util
Package util/auth.go owns the controller-side authentication logic.
|
Package util/auth.go owns the controller-side authentication logic. |