Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uswitch/nidhogg
Kubernetes Node taints based on Daemonset Pods
https://github.com/uswitch/nidhogg
kubernetes
Last synced: 2 months ago
JSON representation
Kubernetes Node taints based on Daemonset Pods
- Host: GitHub
- URL: https://github.com/uswitch/nidhogg
- Owner: uswitch
- License: apache-2.0
- Archived: true
- Created: 2019-03-20T08:56:54.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-20T20:42:59.000Z (11 months ago)
- Last Synced: 2024-11-14T16:06:01.560Z (2 months ago)
- Topics: kubernetes
- Language: Go
- Homepage:
- Size: 27.7 MB
- Stars: 76
- Watchers: 11
- Forks: 15
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-devops - nidhogg - Kubernetes Node taints based on Daemonset Pods (Kubernetes)
README
🚨 THIS REPO IS NOW BEING ABANDONED 🚨
⚠️⚠️⚠️⚠️⚠️⚠️ Please read ⚠️⚠️⚠️⚠️⚠️⚠️
If you are interested in using a maintened fork of this repo, please use [pelotech-nidhogg](https://github.com/pelotech/nidhogg), the fork that the engineering team at Pelotech have kindly agreed to maintain.
See [this issue for more details](https://github.com/uswitch/nidhogg/issues/43)
⚠️⚠️⚠️⚠️⚠️⚠️ END of please read ⚠️⚠️⚠️⚠️⚠️⚠️
We are only a small team and we don't have the capacity to maintain a tool we don't use anymore, so from now on we will be moving this repo to Abandoned but we are happy that a team like the one at Pelotech is investing in this solution and giving back to the open source community by maintaining an active fork.
# Nidhogg
Nidhogg is a controller that taints nodes based on whether a Pod from a specific Daemonset is running on them.
Sometimes you have a Daemonset that is so important that you don't want other pods to run on your node until that Daemonset is up and running on the node. Nidhogg solves this problem by tainting the node until your Daemonset pod is ready, preventing pods that don't tolerate the taint from scheduling there.
Nidhogg annotate the node when all the required taints are removed: `nidhogg.uswitch.com/first-time-ready: 2006-01-02T15:04:05Z`
Nidhogg was built using [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder)
## Usage
Nidhogg requires a yaml/json config file to tell it what Daemonsets to watch and what nodes to act on.
`nodeSelector` is a map of keys/values corresponding to node labels. `daemonsets` is an array of Daemonsets to watch, each containing two fields `name` and `namespace`. Nodes are tainted with taint that follows the format of `nidhogg.uswitch.com/namespace.name:NoSchedule`.
Example:
YAML:
```yaml
nodeSelector:
node-role.kubernetes.io/node
daemonsets:
- name: kiam
namespace: kube-system
```
JSON:
```json
{
"nodeSelector": [
"node-role.kubernetes.io/node",
"!node-role.kubernetes.io/master",
"aws.amazon.com/ec2.asg.name in (standard, special)"
],
"daemonsets": [
{
"name": "kiam",
"namespace": "kube-system"
}
]
}
```
This example will select any nodes in AWS ASGs named "standard" or "special" that have the label
`node-role.kubernetes.io/node` present, and no nodes with label `node-role.kubernetes.io/master`. If the matching nodes
do not have a running and ready pod from the `kiam` daemonset in the `kube-system` namespace. It will add a taint of
`nidhogg.uswitch.com/kube-system.kiam:NoSchedule` until there is a ready kiam pod on the node.
If you want pods to be able to run on the nidhogg tainted nodes you can add a toleration:
```yaml
spec:
tolerations:
- key: nidhogg.uswitch.com/kube-system.kiam
operator: "Exists"
effect: NoSchedule
```
## Deploying
Docker images can be found at https://quay.io/uswitch/nidhogg
Example [Kustomize](https://github.com/kubernetes-sigs/kustomize) manifests can be found [here](/config) to quickly deploy this to a cluster.
## Flags
```
-config-file string
Path to config file (default "config.json")
-kubeconfig string
Paths to a kubeconfig. Only required if out-of-cluster.
-leader-configmap string
Name of configmap to use for leader election
-leader-election
enable leader election
-leader-namespace string
Namespace where leader configmap located
-master string
The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster.
-metrics-addr string
The address the metric endpoint binds to. (default ":8080")
```