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

• ConfigMaps
• Secrets.
• Services
• ServiceAccounts
• Deployments
• StatefulSets
• Roles
• Hpas
• Pvcs
• Ingresses
• Pdbs

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

For MacOS users, you can install Kor using Homebrew:

brew install kor

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.
• services: Gets unused services for the specified namespace or all namespaces.
• serviceaccount: Gets unused service accounts for the specified namespace or all namespaces.
• deployments: Gets unused service accounts for the specified namespace or all namespaces.
• statefulsets: Gets unused service accounts for the specified namespace or all namespaces.
• role: Gets unused roles for the specified namespace or all namespaces.
• hpa: Gets unused hpa for the specified namespace or all namespaces.
• pvc: Gets unused pvcs for the specified namespace or all namespaces.
• ingress: Gets unused ingresses for the specified namespace or all namespaces.
• pdb: Gets unused pdbs for the specified namespace or all namespaces.

-e, --exclude-namespaces string   Namespaces to be excluded, splited by comma. Example: --exclude-namespace ns1,ns2,ns3. If --include-namespace is set, --exclude-namespaces will be ignored.
-h, --help                        help for kor
-n, --include-namespaces string   Namespaces to run on, splited by comma. Example: --include-namespace ns1,ns2,ns3. 
-k, --kubeconfig string           Path to kubeconfig file (optional)
    --output string               Output format (table or json) (default "table")

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

kor all --namespace my-namespace

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

kor [subcommand] --help

The resources labeled with "kor/used = true" will be ignored by kor even if they are unused. You can add this label to resources you want to ignore.

You can also use kor as a Go library to programmatically discover unused resources. By importing the github.com/yonahd/kor/pkg/kor package, you can call the relevant functions to retrieve unused resources. The library provides the option to get the results in JSON format by specifying the outputFormat parameter.

import (
    "github.com/yonahd/kor/pkg/kor"
)



func main() {
    myNamespaces := kor.IncludeExcludeLists{
        IncludeListStr: "my-namespace1, my-namespace2",
    }
    outputFormat := "json" // Set to "json" for JSON output

    if outputFormat == "json" {
        jsonResponse, err := kor.GetUnusedDeploymentsStructured(myNamespaces, kubeconfig, "json")
        if err != nil {
            // Handle error
        }
        // Process the JSON response
        // ...
    } else {
        kor.GetUnusedDeployments(namespace)
    }
}

Contributions are welcome! If you encounter any bugs or have suggestions for improvements, please open an issue in the issue tracker.

This project is open-source and available under the MIT License. Feel free to use, modify, and distribute it as per the terms of the license.