Skip to content
A simple kubectl plugin to show deployments along with their pods
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
__pycache__
.gitignore
LICENSE
README.md
kubectl-lsdeploy.py
requirements.txt
setup.py
tests.py

README.md

kubectl-lsdeploy

-> Good news, someone made a real project for this use case. Have a look at tree which looks awesome

Summary

Plugin for kubectl written in Python. Queries the kubernetes API and prints an overview of

  • namespaces
  • deployment
  • replica sets
  • pods
  • nodes

Based on Issue #72794 I didn't find a built-in function.

Mostly PEP-8 compliant but otherwise "way to go" when it comes to code quality.

References

Kubernetes Core V1 API Kubernetes APP V1 API

Installation

Clone the repo and install the requirements:

git clone https://github.com/dominikzorgnotti/kubectl-lsdeploy
cd kubectl-lsdeploy
pip3 install -r requirements.txt

Move the main script to an place that is in your path, e.g.:

mv kubectl-lsdeploy.py /usr/local/bin

Verify that kubectl recognizes the plugin

kubectl plugin list

Tested with

  • Python 3.8.0 on Windows 10 (see Issues)
  • Python 3.5.2 on Ubuntu 16.04.06 LTS (x64)
  • Python modules:
    • kubernetes: 10.0.1
    • PrettyTable: 0.7.2
  • Kubernetes:
    • 1.17
    • 1.16

Usage

Once in your path can run the script directly with

kubectl-lsdeploy.py

or as subcommand of kubectl

kubectl lsdeploy.py

Example output

+----------------------+---------------------------+--------------------------------------+--------------------------------------------+-----------------+
|      Namespace       |         Deployment        |              ReplicaSet              |                    Pod                     |   Hosting node  |
+----------------------+---------------------------+--------------------------------------+--------------------------------------------+-----------------+
|       default        |            demo           |           demo-7cbf698c44            |           demo-7cbf698c44-6z68g            | 192.168.113.131 |
|       default        |           demo2           |           demo2-5657dc98db           |           demo2-5657dc98db-4jwbk           | 192.168.113.131 |
|     kube-system      |          coredns          |          coredns-6955765f44          |          coredns-6955765f44-bp7zl          | 192.168.113.131 |
|     kube-system      |          coredns          |          coredns-6955765f44          |          coredns-6955765f44-k4swp          | 192.168.113.131 |
|     kube-system      |          coredns          |          coredns-6955765f44          |               etcd-minikube                | 192.168.113.131 |
|     kube-system      |          coredns          |          coredns-6955765f44          |        kube-addon-manager-minikube         | 192.168.113.131 |
|     kube-system      |          coredns          |          coredns-6955765f44          |          kube-apiserver-minikube           | 192.168.113.131 |
|     kube-system      |          coredns          |          coredns-6955765f44          |      kube-controller-manager-minikube      | 192.168.113.131 |
|     kube-system      |          coredns          |          coredns-6955765f44          |              kube-proxy-mzzd7              | 192.168.113.131 |
|     kube-system      |          coredns          |          coredns-6955765f44          |          kube-scheduler-minikube           | 192.168.113.131 |
|     kube-system      |          coredns          |          coredns-6955765f44          |            storage-provisioner             | 192.168.113.131 |
| kubernetes-dashboard | dashboard-metrics-scraper | dashboard-metrics-scraper-7b64584c5c | dashboard-metrics-scraper-7b64584c5c-6nxks | 192.168.113.131 |
| kubernetes-dashboard |    kubernetes-dashboard   |    kubernetes-dashboard-79d9cd965    |    kubernetes-dashboard-79d9cd965-fj6lj    | 192.168.113.131 |
+----------------------+---------------------------+--------------------------------------+--------------------------------------------+-----------------+
You can’t perform that action at this time.