https://github.com/viralpoetry/kubesurveyor

Good enough Kubernetes namespace visualization tool
https://github.com/viralpoetry/kubesurveyor

dot graphviz kubernetes namespace visualization yaml

Last synced: 2 months ago
JSON representation

Good enough Kubernetes namespace visualization tool

• Host: GitHub
• URL: https://github.com/viralpoetry/kubesurveyor
• Owner: viralpoetry
• Created: 2021-05-21T13:07:33.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-10T12:27:57.000Z (6 months ago)
• Last Synced: 2024-07-15T14:40:37.120Z (4 months ago)
• Topics: dot, graphviz, kubernetes, namespace, visualization, yaml
• Language: Python
• Homepage: https://pypi.org/project/kubesurveyor/
• Size: 508 KB
• Stars: 86
• Watchers: 3
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Kubesurveyor  

Good enough Kubernetes namespace visualization tool.  

No provisioning to a cluster required, only Kubernetes API is scrapped.  



## Installation    

```

sudo apt-get install graphviz

pip install kubesurveyor

```

## Usage

Export path to a custom certification authority, if you use one for your Kubernetes cluster API

```

export REQUESTS_CA_BUNDLE=/etc/ssl/certs/ca-certificates.crt

```

Alternatively, ignore K8S API certificate errors using `--insecure` or `-k`

```

kubesurveyor  --insecure

```

Show `` namespace as a `dot` language graph, using currently active K8S config context  

```

kubesurveyor 

```

Specify context to be used, if there are multiple in the K8S config file  

```

kubesurveyor  --context 

```

Dump crawled namespace data to a `YAML` format for later processing

```

kubesurveyor  --context  --save > namespace.yaml

```

Load from `YAML` file, show as `dot` language graph

```

cat namespace.yaml | kubesurveyor  --load

```

Load from `YAML` file and render as `png` visualization to a current working directory

```

cat namespace.yaml | kubesurveyor  --load --out png

```

If you want to generate architecture image from `dot` definition by hand, use `dot` directly

```

dot -Tpng k8s.dot > k8s.png

```

Limitations:  

 - unconnected pods, services are not shown  

 - could have problems with deployments created by Tiller  

 - number of replicas is not tracked