Skip to content

Commit

Permalink
Merge pull request #13 from XenitAB/update/docs
Browse files Browse the repository at this point in the history
Update documentation
  • Loading branch information
phillebaba authored Jun 1, 2022
2 parents ab7be59 + 7f40150 commit a77f0cb
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Easiest method to install Node TTL is with the [Helm Chart](./charts/node-ttl).

```shell
kubectl create namespace node-ttl
helm upgrade --install --version v0.0.1 node-ttl oci://ghcr.io/xenitab/helm-charts/node-ttl
helm upgrade --install --version <version> node-ttl oci://ghcr.io/xenitab/helm-charts/node-ttl
```

## Usage
Expand Down Expand Up @@ -56,6 +56,19 @@ metadata:
cluster-autoscaler.kubernetes.io/scale-down-disabled: true
```
### Safe To Evict
A Node with a Pod annotated that it is [not safe to evict](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-types-of-pods-can-prevent-ca-from-removing-a-node) will not be considered for eviction due to TTL. This is useful in situations where long running Jobs need to run much longer than the TTL set on any Node. This way the Node will be kept running until the Job completes and then it can be evicted. Be careful using this feature as setting this annotation on all Pods will stop any TTL evictions.
```yaml
apiVersion: v1
kind: Pod
metadata:
name: no-evict
annotations:
cluster-autoscaler.kubernetes.io/safe-to-evict: false
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 comments on commit a77f0cb

Please sign in to comment.