https://github.com/ahmetb/kubectl-tree

kubectl plugin to browse Kubernetes object hierarchies as a tree 🎄 (star the repo if you are using)
https://github.com/ahmetb/kubectl-tree

kubectl kubectl-plugin kubectl-plugins

Last synced: 2 days ago
JSON representation

kubectl plugin to browse Kubernetes object hierarchies as a tree 🎄 (star the repo if you are using)

• Host: GitHub
• URL: https://github.com/ahmetb/kubectl-tree
• Owner: ahmetb
• License: apache-2.0
• Created: 2019-12-23T21:46:55.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-23T05:39:44.000Z (about 2 months ago)
• Last Synced: 2025-01-02T17:00:58.697Z (9 days ago)
• Topics: kubectl, kubectl-plugin, kubectl-plugins
• Language: Go
• Homepage:
• Size: 2.59 MB
• Stars: 3,030
• Watchers: 23
• Forks: 129
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-kubectl-plugins - kubectl-tree
• awesome-ccamel - ahmetb/kubectl-tree - kubectl plugin to browse Kubernetes object hierarchies as a tree 🎄 (star the repo if you are using) (Go)
• awesome-github-star - kubectl-tree
• awesome-eks - kubectl tree
• awesome-k8s-resources - kubectl tree - A kubectl plugin to explore ownership relationships between Kubernetes objects through owners. (Tools and Libraries / Command Line Tools)
• awesome-repositories - ahmetb/kubectl-tree - kubectl plugin to browse Kubernetes object hierarchies as a tree 🎄 (star the repo if you are using) (Go)

README

        


  

    

  



# kubectl tree

A kubectl plugin to explore ownership relationships between Kubernetes objects

through `ownersReferences` on the objects.

The [`kubectl lineage`](https://github.com/tohjustin/kube-lineage) plugin is very similar to `kubectl tree`, but it 

[understands](https://github.com/tohjustin/kube-lineage#supported-relationships)

logical relationships between some API objects without needing ownerReferences.

## Installation

Use [krew](https://krew.sigs.k8s.io/) plugin manager to install:

    kubectl krew install tree

    kubectl tree --help

## Demo

Example (Deployment):

![example Kubernetes deployment object hierarchy](assets/example-1.png)

Example (Knative Service):

![example Kubernetes object hierarchy with Knative Service](assets/example-2.png)

Example (Agones Fleet):

![example Kubernetes object hierarchy with Agones Fleet](assets/example-3.png)

## Flags

By default, the plugin will only search "namespaced" objects in the same

namespace as the specified object.

You can use the `-A` or `--all-namespaces` flag to search namespaced and

non-namespaced objects in all namespaces.

## Author

Ahmet Alp Balkan [@ahmetb](https://twitter.com/ahmetb).

**Special acknowledgement:** This tool is heavily inspired by @nimakaviani's

[knative-inspect](https://github.com/nimakaviani/knative-inspect/) as it's a

generalized version of it.

## License

Apache 2.0. See [LICENSE](./LICENSE).

---

This is not an official Google project.