kor

Kor - Kubernetes Orphaned Resources Finder

Kor is a tool to discover unused Kubernetes resources. Currently, Kor can identify and list unused:

• ConfigMaps
• Secrets
• Services
• ServiceAccounts
• Deployments
• StatefulSets
• Roles
• ClusterRoles
• ClusterRoleBindings
• HPAs
• PVCs
• Ingresses
• PDBs
• CRDs
• PVs
• Pods
• Jobs
• ReplicaSets
• DaemonSets
• StorageClasses
• NetworkPolicies
• RoleBindings
• VolumeAttachments
• PriorityClasses

Looking for cost analysis and multi-cluster management? Check out KorPro, our cloud-based platform built on top of Kor.

Installation

Download the binary for your operating system from the releases page and add it to your system's PATH.

Homebrew

For macOS users, you can install Kor using Homebrew:

brew install kor

Build from development branch

Install the binary to your $GOBIN or $GOPATH/bin:

go install github.com/yonahd/kor@latest

Build from source

Build the locally cloned source code:

go build main.go

Docker

Run a container with your kubeconfig mounted:

docker run --rm -i yonahdissen/kor

docker run --rm -i -v "/path/to/.kube/config:/root/.kube/config" yonahdissen/kor all

Kubectl plugin ()

kubectl krew install kor

Helm

helm repo add kor https://yonahd.github.io/kor

Run as a cronjob in your Cluster (with an option for sending slack updates)

helm upgrade -i kor \
    --namespace kor \
    --create-namespace \
    --set cronJob.enabled=true
    ./charts/kor

Run as a deployment in your Cluster exposing prometheus metrics

helm upgrade -i kor \
    --namespace kor \
    --create-namespace \
    ./charts/kor

For more information see in cluster usage

Usage

Kor provides various subcommands to identify and list unused resources. The available commands are:

• all - Gets all unused resources for the specified namespace or all namespaces.
• configmap - Gets unused ConfigMaps for the specified namespace or all namespaces.
• secret - Gets unused Secrets for the specified namespace or all namespaces.
• service - Gets unused Services for the specified namespace or all namespaces.
• serviceaccount - Gets unused ServiceAccounts for the specified namespace or all namespaces.
• deployment - Gets unused Deployments for the specified namespace or all namespaces.
• statefulset - Gets unused StatefulSets for the specified namespace or all namespaces.
• role - Gets unused Roles for the specified namespace or all namespaces.
• clusterrole - Gets unused ClusterRoles for the specified namespace or all namespaces (namespace refers to RoleBinding).
• clusterrolebinding - Gets unused ClusterRoleBindings in the cluster (non namespaced resource).
• rolebinding - Gets unused RoleBindings for the specified namespace or all namespaces.
• hpa - Gets unused HPAs for the specified namespace or all namespaces.
• pod - Gets unused Pods for the specified namespace or all namespaces.
• pvc - Gets unused PVCs for the specified namespace or all namespaces.
• pv - Gets unused PVs in the cluster (non namespaced resource).
• storageclass - Gets unused StorageClasses in the cluster (non namespaced resource).
• ingress - Gets unused Ingresses for the specified namespace or all namespaces.
• pdb - Gets unused PDBs for the specified namespace or all namespaces.
• crd - Gets unused CRDs in the cluster (non namespaced resource).
• job - Gets unused jobs for the specified namespace or all namespaces.
• replicaset - Gets unused replicaSets for the specified namespace or all namespaces.
• daemonset- Gets unused DaemonSets for the specified namespace or all namespaces.
• volumeattachment - Gets unused VolumeAttachments in the cluster (non-namespaced resource).
• priorityclass - Gets unused PriorityClasses in the cluster (non-namespaced resource).
• finalizer - Gets unused pending deletion resources for the specified namespace or all namespaces.
• networkpolicy - Gets unused NetworkPolicies for the specified namespace or all namespaces.
• exporter - Export Prometheus metrics.
• version - Print kor version information.

Supported Flags

…

To use a specific subcommand, run kor [subcommand] [flags].

kor all --include-namespaces my-namespace

For more information about each subcommand and its available flags, you can use the --help flag.

kor [subcommand] --help

Supported resources and limitations