groot

README

Ktree A.K.A. Groot

kubernetes helper tool for finding out status of a kubernetes resource with their respective linked resources in a cluster.

Tree Structured Map of K8S resources:

With just one groot command we can find the current relational mapping of the k8s resources deployed in a particular namespace.

Troubleshoot the namespace:

Tired of firing kubectl get/describe pod/deploy/svc commands just to know status of your deployments? why not just groot it! :) To see status of your Services, deployments and pods(and rest of the resources as well, Soon.) We can even check if some Configmap or Secrets are not mapped with any Pods or not.

It will print the following information about the resource queried:

• Status of the resource
• Mappings/relations with other resources. eg:

$ groot --namespace sock-shop

Namespace  -  sock-shop  Status:  
	|-------Service  -  carts  Status:  
		|-------Endpoint  -  carts  Status:  
		|-------Deployment  -  carts  Status:  1/1
			|-------Replicaset  -  carts-54d97c56b6  Status:  
				|-------Pod  -  carts-54d97c56b6-ngfhj  Status:  Running
					|-------Secret  -  default-token-qcjmp  Status:  
	|-------Service  -  carts-db  Status:  
		|-------Endpoint  -  carts-db  Status:  
		|-------Deployment  -  carts-db  Status:  2/2
			|-------Replicaset  -  carts-db-5678cc578f  Status:  
				|-------Pod  -  carts-db-5678cc578f-6jp5w  Status:  Running
					|-------Secret  -  default-token-qcjmp  Status:  
				|-------Pod  -  carts-db-5678cc578f-g7t5r  Status:  Running
					|-------Secret  -  default-token-qcjmp  Status:  

Credits to ksearch:

The groot uses ksearch to get the list of k8s resources. ksearch is a kubectl plugin that will help us list all (literally all) the resources in a namespace and the resources can be searched using names as well. Know more about ksearch (https://github.com/infracloudio/ksearch)

Installation

1. Clone the repo in your $GOPATH

git clone https://github.com/ameydev/groot.git

1. Build the groot

cd groot && go build

1. Copy to bin/

sudo cp groot /usr/local/bin/

Contributions:

Contributions and suggestions are always welcome. Feel free to fork the repo or file issue.

Documentation

Overview

Copyright © 2019 Amey Deshmukh

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.