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 <namespace> --insecure
Show <namespace> namespace as a dot language graph, using currently active K8S config context
kubesurveyor <namespace>
Specify context to be used, if there are multiple in the K8S config file
kubesurveyor <namespace> --context <context>
Dump crawled namespace data to a YAML format for later processing
kubesurveyor <namespace> --context <context> --save > namespace.yaml
Load from YAML file, show as dot language graph
cat namespace.yaml | kubesurveyor <namespace> --load
Load from YAML file and render as png visualization to a current working directory
cat namespace.yaml | kubesurveyor <namespace> --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
Metadata
Release files for kubesurveyor 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| kubesurveyor-2.0.0.tar.gz | 6.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kubesurveyor-2.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.9 kB
Release files / kubesurveyor-2.0.0.tar.gz
| Download URL | kubesurveyor-2.0.0.tar.gz |
|---|---|
| Size | 6.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cf28003d720343ae2c7f393693198f29e17314811402eadc24c16e6b3317d7c3
|
|
BLAKE2b-256 checksum How to use checksums |
9fab3eee69e562eea305ad1c69d55e6700f55bdaf3765d842724f83648be21fc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.10.12 Linux/6.8.0-40-generic
|
Release files / kubesurveyor-2.0.0-py3-none-any.whl
| Download URL | kubesurveyor-2.0.0-py3-none-any.whl |
|---|---|
| Size | 6.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7a32dec5f1d9904f5d2d0ea6b7582195ca1f392c8c613bb067d3b6194f1b66f7
|
|
BLAKE2b-256 checksum How to use checksums |
4ad6b99303716c0ec0eb4fab41c0ceb2c50c2f50963b3090c2b4ae1508092748
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.10.12 Linux/6.8.0-40-generic
|