Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/banzaicloud/nodepool-labels-operator
Nodepool Labels operator for Kubernetes
https://github.com/banzaicloud/nodepool-labels-operator
banzai-cloud kubernetes labeling operator
Last synced: 2 months ago
JSON representation
Nodepool Labels operator for Kubernetes
- Host: GitHub
- URL: https://github.com/banzaicloud/nodepool-labels-operator
- Owner: banzaicloud
- License: apache-2.0
- Created: 2019-02-10T16:23:16.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T06:06:09.000Z (over 1 year ago)
- Last Synced: 2024-01-20T21:51:12.262Z (5 months ago)
- Topics: banzai-cloud, kubernetes, labeling, operator
- Language: Go
- Homepage: https://banzaicloud.com
- Size: 220 KB
- Stars: 69
- Watchers: 4
- Forks: 10
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Lists
- awesome-cloud-native - nodepool-labels-operator - Nodepool Labels operator for Kubernetes. (Operator)
README
# Nodepool Labels Operator
>A **node pool** is a subset of node instances within a cluster with the same configuration, however, the overall cluster can contain multiple node pools as well as heterogeneous nodes/configurations. The Pipeline platform can manage any number of node pools on a Kubernetes cluster, each with different configurations - e.g. node pool 1 is local SSD, node pool 2 is spot or preemptible-based, node pool 3 contains GPUs - these configurations are turned into actual cloud-specific instances.
This operator watches node events to catch when a node joins the cluster. It uses a [Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) to keep track of the desired list of node labels for the nodes of a node pool. There is one such CR per node pool.
[Pipeline](https://beta.banzaicloud.io/) creates the CRs with the list of desired labels for each node pool and updates these when the user updates the node pool labels. The operator takes care of placing the labels listed in the CR to all the nodes that belong to the corresponding node pool. Since the concept of a node pool doesn't exists in Kubernetes, [Pipeline](https://beta.banzaicloud.io/) tracks what node pool a node belongs to via the `node.banzaicloud.io/nodepool: ` node label. The `operator` relies on this label to identify the nodes of a node pool. If `node.banzaicloud.io/nodepool` label is not available than it falls back to cloud specific node labels to identify the node pool a node belongs to:
* AKS: `agent: `
* GKE: `cloud.google.com/gke-nodepool: `
As the desired labels descibred in the CR for a nodepool only contains labels which should be set on the related nodes the operator uses an annotation (`nodepool.banzaicloud.io/managed-labels`) on each node to keep track of the managed labels and it will removed those managed labels which are not present in the desired state.
## Installing the operator
```bash
helm repo add banzai-stable http://kubernetes-charts.banzaicloud.com/branch/master
helm install banzai-stable/nodepool-labels-operator
```
## Example
```bash
cat <
Labels: environment=testing
team=rnd
Annotations: nodepool.banzaicloud.io/managed-labels: ["environment","team"]
```
## Contributing
If you find this project useful here's how you can help:
* Send a pull request with your new features and bug fixes
* Help new users with issues they may encounter
* Support the development of this project and star this repo!