Cloud Provider Zero
Cloud Provider Zero is a provider tool to get some of the benefits of a cloud provider with kubernetes without the
overhead of the cloud provider.
Cloud Providers are cool, but their operators are not always friendly and tend to make a lot of assumption about your
cluster, this doesn't often work well when you aren't using one of the managed kubernetes flavors.
This tool is designed to help provide some of the benefits of the cloud provider operators without the overhead.
For example AWS is great. EKS sucks. Karpenter is great, but designed to work with EKS. This tool can help bridge the
gap.
Features
- AWS: Set
Node.Spec.ProviderID from Label Information
Kubernetes - Node.Spec.ProviderID
TL;DR - Allow Karpenter to work in AWS with non-EKS clusters. (or other tools that use ProviderID)
The mutating webhook server will set the ProviderID of the node, which is useful for several reasons, to include
but not limited to karpenter based on label information that can be set on the node during
registration time.
If you are using a non-EKS deployment but still want to have the benefits of tooling and providers written for EKS and
other cloud distributions this solution can be helpful.
cpz.ekristen.dev/instance-id=i-000000000000
cpz.ekristen.dev/provider=aws
topology.kubernetes.io/zone=us-east-2a
These labels are used to build a providerID is it is currently empty. This would be the case if you aren't running
an actual cloud provider operator in your cluster.
Building
The following will build binaries in snapshot order.
goreleaser --clean --snapshot
Documentation
The project is built to have the documentation right alongside the code in the docs/ directory leveraging Mkdocs Material.
In the root of the project exists mkdocs.yml which drives the configuration for the documentation.
This README.md is currently copied to docs/index.md and the documentation is automatically published to the GitHub
pages location for this repository using a GitHub Action workflow. It does not use the gh-pages branch.
Running Locally
make docs-serve
OR (if you have docker)
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material