kube-pod-terminator

Kube Pod Terminator

On some Kubernetes versions, there is a problem that pods stuck in Terminating state on some circumstances. This tool connects to the kube-apiserver, discovers Terminating pods which are in Terminating status more than --terminatingStateMinutes minutes, which is defaults to 30 minutes.

This tool also discovers pods which are at Evicted state if --terminateEvicted passed(enabled by default) and clears them all.

Please note that kube-pod-terminator can work in below modes:

• Outside of Kubernetes cluster as a CLI (--oneShot should be passed, default behavior)
• Inside Kubernetes cluster as Deployment (--inCluster=true should be passed)
• Outside of Kubernetes cluster as binary (--inCluster=false --oneShot=false should be passed)

Please refer to Installation section for more information.

Notable Features

• All namespaces support
• Multi clusters support
• Ability to run in Kubernetes as Deployment
• Ability to run outside of Kubernetes as binary (Linux, Darwin)
• Ability to run outside of Kubernetes as CLI (oneshot app, not scheduled)
• Homebrew

Configuration

Kube-pod-terminator can be customized with several command line arguments. You can pass arguments via sample deployment file or directly to the binary. Here is the list of arguments you can pass:

Usage:
  kube-pod-terminator [flags]

Flags:
      --gracePeriodSeconds int          grace period to delete target pods (default 30)
  -h, --help                            help for kube-pod-terminator
      --inCluster                       specify if kube-pod-terminator is running in cluster
      --kubeConfigPaths string          comma separated list of kubeconfig file paths to access with the cluster (default "/home/joshsagredo/.kube/config")
      --namespace string                target namespace to run on (default "all")
      --oneShot                         specifier to run kube-pod-terminator only one time instead of continuously running in the background. should be true if you are using app as CLI. (default true)
      --terminateEvicted                terminate evicted pods in specified namespaces (default true)
      --terminatingStateMinutes int32   terminate stucked pods in terminating state which are more than that value (default 30)
      --tickerIntervalMinutes int32     interval of scheduled job to run (default 5)
  -v, --verbose                         verbose output of the logging library (default false)
      --version                         version for kube-pod-terminator

Installation

Kube-pod-terminator can be deployed as Kubernetes deployment or standalone installation

Kubernetes

You can use sample deployment file to deploy your Kubernetes cluster. This file also creates required Role and RoleBindings to take actions on problematic pods.

$ kubectl create -f deployment/sample_single_namespace.yaml

All namespaces support

By default, kube-pod-terminator runs to terminate pods in default namespace. But that behavior can be changed with namespace flag. You can see the example Kubernetes manifest file deployment/sample_all_namespaces.yaml. Keep in mind that this file creates necessary ClusterRole and ClusterRoleBinding to be able to take proper actions on all namespaces.

--namespace=all

Multi Cluster support

kube-pod-terminator can terminate the pods of multiple clusters if multiple kubeconfig file path is provided to --kubeConfigPath flag.

If you run the kube-pod-terminator inside a Kubernetes cluster, it manages the terminating pods of that current cluster by default. But keep in mind that if you want to manage terminating pods on multiple clusters and run kube-pod-terminator inside a Kubernetes cluster, you should mount multiple kubeconfig files as configmap or secret into pod and pass below arguments in your Deployment config:

--inCluster=false
--kubeConfigPath=/tmp/kubeconfig1,/tmp/kubeconfig2,/tmp/kubeconfig3

You can check deployment/sample_external_clusters.yaml as example.

But before creating deployment file, you should create configmaps from your desired kubeconfigs like below:

$ kubectl create configmap cluster1-config --from-file=${YOUR_CLUSTER1_CONFIG_PATH}
$ kubectl create configmap cluster2-config --from-file=${YOUR_CLUSTER2_CONFIG_PATH}
$ kubectl create configmap cluster3-config --from-file=${YOUR_CLUSTER3_CONFIG_PATH}

Homebrew

This project can be installed with Homebrew:

brew tap bilalcaliskan/tap
brew install bilalcaliskan/tap/kube-pod-terminator

Binary

Binary can be downloaded from Releases page. You can use that method to run kube-pod-terminator outside of a Kubernetes cluster.

After then, you can simply run binary by providing required command line arguments:

$ ./kube-pod-terminator --inCluster false --kubeConfigPaths ~/.kube/config

Critical command line arguments while running kube-pod-terminator as standalone application are --inCluster, --kubeConfigPaths

Development

This project requires below tools while developing:

• Golang 1.19
• pre-commit
• golangci-lint - required by pre-commit
• gocyclo - required by pre-commit

After you installed pre-commit, simply run below command to prepare your development environment:

$ pre-commit install -c build/ci/.pre-commit-config.yaml

License

Apache License 2.0