|Henning Jacobs 7fca7fbdaf||2 months ago|
|deploy||3 months ago|
|examples/sidecar||9 months ago|
|kube_janitor||3 months ago|
|tests||3 months ago|
|unsupported/helm||7 months ago|
|.flake8||1 year ago|
|.gitignore||1 year ago|
|.pre-commit-config.yaml||8 months ago|
|.travis.yml||1 year ago|
|Dockerfile||1 year ago|
|LICENSE||1 year ago|
|Makefile||9 months ago|
|README.md||2 months ago|
|poetry.lock||3 months ago|
|pyproject.toml||1 year ago|
Kubernetes Janitor cleans up (deletes) Kubernetes resources on (1) a configured TTL (time to live) or (2) a configured expiry date (absolute timestamp).
It processes all namespaces and all namespaced resources including
custom resource definitions (CRDs) and will delete them (1) if the
janitor/ttl annotation or a TTL rule indicates the resource as
expired, or (2) if the
janitor/expires annotation marks the resource
janitor/ttl: 7don the namespace object) for prototyping
kubectl annotate deploy nginx janitor/ttl=24hto automatically delete it after 24 hours
janitor/ttlon resources created by your CI/CD pipeline for pull requests (so PR tests can run and resources are cleaned up later)
janitor/expires: 2020-01-17T15:14:38Zon the namespace object)
kubectl annotate deploy nginx janitor/expires=2020-01-01to automatically delete it at midnight (UTC) of 1st of January 2020.
jmespath: "_context.pvc_is_not_mounted && _context.pvc_is_not_referenced")
Deploy the janitor into your cluster via (also works with Minikube):
Warning: if you want to deploy janitor to namespace other than
default, you need to edit
$ kubectl apply -k deploy/
The example configuration uses the
--dry-run as a safety flag to
prevent any deletion --- remove it to enable the janitor, e.g. by
editing the deployment:
$ kubectl edit deploy kube-janitor
To see the janitor in action, deploy a simple nginx and annotate it accordingly:
$ kubectl run temp-nginx --image=nginx $ kubectl annotate deploy temp-nginx janitor/ttl=5m
You should see the
temp-nginx deployment being deleted after 5
Edit the example rules file via
kubectl edit configmap kube-janitor to
try out generic TTL rules (needs a pod restart to reload rules).
The janitor is configured via command line args, environment variables, Kubernetes annotations, and an optional YAML rules file.
Supported Kubernetes annotations:
Maximum time to live (TTL) for the annotated resource. Annotation
value must be a string composed of a integer value and a unit suffix
120s (120 seconds),
8h (8 hours),
7d (7 days), or
2w (2 weeks). In
the case that the resource should not be deleted by Janitor, the
forever can be specified as TTL. Note that the
actual time of deletion depends on the Janitor's clean up interval.
The resource will be deleted if its age (delta between now and the
resource creation time) is greater than the specified TTL.
Absolute timestamp in the format
YYYY-MM-DD to mark the resource for deletion
after the specified date/time. The date format
YYYY-MM-DD is short
YYYY-MM-DDT00:00:00Z, i.e. the resource will expire at
midnight UTC of the specified date. Example annotation values:
Available command line options:
Dry run mode: do not change anything, just print what would be done
Debug mode: print more information
Run only once and exit. This is useful if you run the Kubernetes
Janitor as a
Loop interval (default: 30s). This option only makes sense when the
--once flag is not set.
How long to wait after issuing a delete (default: 0s). This option does not take effect for dry runs.
Include resources for clean up (default: all resources), can also be
configured via environment variable
INCLUDE_RESOURCES. This option
can be used if you want to clean up only certain resource types,
Exclude resources from clean up (default:
events,controllerrevisions), can also be configured via environment
EXCLUDE_RESOURCES. This option takes precedence over
--include-resources=foos,bars would make
kube-janitor only process
Include namespaces for clean up (default: all namespaces), can also
be configured via environment variable
Exclude namespaces from clean up (default: kube-system), can also be
configured via environment variable
option takes precedence over
--exclude-namespaces=ns1 in combination with
--include-namespaces=ns1,ns2 would only process resources in the
Optional: filename pointing to a YAML file with a list of rules to apply TTL values to arbitrary Kubernetes objects, e.g. to delete all deployments without a certain label automatically after N days. See Rules File configuration section below.
Optional: name of the annotation that would be used instead of the creation timestamp of the resource. This option should be used if you want the resources to not be cleaned up if they've been recently redeployed, and your deployment tooling can set this annotation.
Optional: string pointing to a Python function to populate the
_context object with additional information, e.g. by calling
external services. Built-in example to set
a random dice value (1-6):
When using the
--rules-file option, the path needs to point to a valid
YAML file with the following format:
rules: # remove deployments and statefulsets without a label "application" - id: require-application-label resources: - deployments - statefulsets jmespath: "!(spec.template.metadata.labels.application)" ttl: 4d # delete all deployments with a name starting with "pr-*" - id: temporary-pr-deployments resources: - deployments jmespath: "starts_with(metadata.name, 'pr-')" ttl: 4h # delete all resources within the "temp" namespace after 3 days - id: temp-namespace-cleanup resources: - "*" jmespath: "metadata.namespace == 'temp'" ttl: 3d # require the "foo" pod label for all new deployments starting April 2019 - id: require-foo-label-april-2019 resources: - deployments - statefulsets jmespath: "!(spec.template.metadata.labels.foo) && metadata.creationTimestamp > '2019-04-01'" ttl: 7d # delete all PVCs which are not mounted and not referenced by StatefulSets - id: remove-unused-pvcs resources: - persistentvolumeclaims jmespath: "_context.pvc_is_not_mounted && _context.pvc_is_not_referenced" ttl: 4d
The first matching rule will define the TTL (
ttl field). Kubernetes
objects with a
janitor/ttl annotation will not be matched against any
A rule matches for a given Kubernetes object if all of the following criteria is true:
janitor/ttlannotation (otherwise the TTL value from the annotation is applied)
resourceslist of the rule or the special value
*is part of the
resourceslist (similar to Kubernetes RBAC)
true, non-empty list, non-empty object, or non-empty string)
The first matching rule will define the TTL for the object (as if the
object would have a
janitor/ttl annotation with the same value).
Each rule has the following attributes:
Some string identifying the rule (e.g. for log output), must be
lowercase and match the regex
^[a-z][a-z0-9-]*$. The ID has no
special meaning and is only used to refer to the rule in log
List of resources (e.g.
namespaces, ..) this rule
should be applied to. The special value
* will match all resource
JMESPath expression to evaluate on the
resource object. The rule will only match if the expression
evaluates to true. The expression will get the Kubernetes object as
input. The expression
metadata.labels.foo would evaluate to true
if the object has the label
foo and it has a non-empty string as
value. Additional context for PersistentVolumeClaim objects is
available in the
evaluates to true if the PVC is not mounted by any Pod.
_context.pvc_is_not_referenced is true if the PVC does not match
any StatefulSet volumeClaimTemplate.
TTL value (e.g.
15m) to apply to the object if the rule matches.
Easiest way to contribute is to provide feedback! We would love to hear what you like and what you think is missing. Create an issue or ping try_except_ on Twitter.
PRs are welcome.
You can run Kubernetes Janitor against your current kubeconfig context, e.g. local Minikube:
$ poetry install $ poetry shell $ python3 -m kube_janitor --dry-run --debug --once
To run PEP8 (flake8) checks and unit tests including coverage report:
$ make test
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.