Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twin/k8s-ttl-controller
Kubernetes controller that enables timed resource deletion using TTL annotation
https://github.com/twin/k8s-ttl-controller
annotations controller delete expiration golang janitor kubernetes kubernetes-controller temporary timed ttl
Last synced: 12 days ago
JSON representation
Kubernetes controller that enables timed resource deletion using TTL annotation
- Host: GitHub
- URL: https://github.com/twin/k8s-ttl-controller
- Owner: TwiN
- License: mit
- Created: 2022-07-06T23:13:27.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-10T03:19:44.000Z (about 2 months ago)
- Last Synced: 2024-10-11T16:11:20.652Z (28 days ago)
- Topics: annotations, controller, delete, expiration, golang, janitor, kubernetes, kubernetes-controller, temporary, timed, ttl
- Language: Go
- Homepage:
- Size: 6.36 MB
- Stars: 44
- Watchers: 5
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# k8s-ttl-controller
This application allow you to specify a TTL (time to live) on your Kubernetes resources. Once the TTL is reached,
the resource will be automatically deleted.
To configure the TTL, all you have to do is annotate the relevant resource(s) with `k8s-ttl-controller.twin.sh/ttl` and
a value such as `30m`, `24h` and `7d`.
The resource is deleted after the current timestamp surpasses the sum of the resource's `metadata.creationTimestamp` and
the duration specified by the `k8s-ttl-controller.twin.sh/ttl` annotation.
## Usage
### Setting a TTL on a resource
To set a TTL on a resource, all you have to do is add the annotation `k8s-ttl-controller.twin.sh/ttl` on the resource
you want to eventually expire with a duration from the creation of the resource as value.
In other words, if you had a pod named `hello-world` that was created 20 minutes ago, and you annotated it with:
```console
kubectl annotate pod hello-world k8s-ttl-controller.twin.sh/ttl=1h
```
The pod `hello-world` would be deleted in approximately 40 minutes, because 20 minutes have already elapsed, leaving
40 minutes until the target TTL of 1h is reached.
Alternatively, you can create resources with the annotation already present:
```yaml
apiVersion: v1
kind: Pod
metadata:
name: nginx
annotations:
k8s-ttl-controller.twin.sh/ttl: "1h"
spec:
containers:
- name: web
image: nginx
```
The above would cause the pod to be deleted 1 hour after its creation.
This is especially useful if you want to create temporary resources without having to worry about unnecessary
resources accumulating over time.
## Deploying on Kubernetes
### Using Helm
For the chart associated to this project, see [TwiN/helm-charts](https://github.com/TwiN/helm-charts):
```console
helm repo add twin https://twin.github.io/helm-charts
helm repo update
helm install k8s-ttl-controller twin/k8s-ttl-controller -n kube-system
```
### Using a YAML file
```yaml
apiVersion: v1
kind: ServiceAccount
metadata:
name: k8s-ttl-controller
namespace: kube-system
labels:
app: k8s-ttl-controller
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
name: k8s-ttl-controller
labels:
app: k8s-ttl-controller
rules:
- apiGroups:
- "*"
resources:
- "*"
verbs:
- "get"
- "list"
- "delete"
- apiGroups:
- ""
- "events.k8s.io"
resources:
- "events"
verbs:
- "create"
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: k8s-ttl-controller
labels:
app: k8s-ttl-controller
roleRef:
kind: ClusterRole
name: k8s-ttl-controller
apiGroup: rbac.authorization.k8s.io
subjects:
- kind: ServiceAccount
name: k8s-ttl-controller
namespace: kube-system
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: k8s-ttl-controller
namespace: kube-system
labels:
app: k8s-ttl-controller
spec:
replicas: 1
selector:
matchLabels:
app: k8s-ttl-controller
template:
metadata:
labels:
app: k8s-ttl-controller
spec:
automountServiceAccountToken: true
serviceAccountName: k8s-ttl-controller
restartPolicy: Always
dnsPolicy: Default
containers:
- name: k8s-ttl-controller
image: ghcr.io/twin/k8s-ttl-controller
imagePullPolicy: Always
```
### Docker
```console
docker pull ghcr.io/twin/k8s-ttl-controller
```
## Development
First, you need to configure your kubeconfig to point to an existing, accessible cluster from your machine so that `kubectl` can be used.
If you don't have one or wish to use a different cluster, you can create a kind cluster using the following command:
```console
make kind-create-cluster
```
Next, you must start k8s-ttl-controller locally:
```console
make run
```
To test the application, you can create any resource and annotate it with the `k8s-ttl-controller.twin.sh/ttl` annotation:
```console
kubectl run nginx --image=nginx
kubectl annotate pod nginx k8s-ttl-controller.twin.sh/ttl=1h
```
You should then see something like this in the logs:
```console
2022/07/10 13:31:40 [pods/nginx] is configured with a TTL of 1h, which means it will expire in 57m10s
```
If you want to ensure that expired resources are properly deleted, you can simply set a very low TTL, such as:
```console
kubectl annotate pod nginx k8s-ttl-controller.twin.sh/ttl=1s
```
You would then see something like this in the logs:
```console
2022/07/10 13:36:53 [pods/nginx2] is configured with a TTL of 1s, which means it has expired 2m3s ago
2022/07/10 13:36:53 [pods/nginx2] deleted
```
To clean up the kind cluster:
```console
make kind-clean
```
## Debugging
To enable debugging logs, you may set the `DEBUG` environment variable to `true`