Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkimuram/k8sviz
Generate Kubernetes architecture diagrams from the actual state in a namespace
https://github.com/mkimuram/k8sviz
Last synced: about 2 months ago
JSON representation
Generate Kubernetes architecture diagrams from the actual state in a namespace
- Host: GitHub
- URL: https://github.com/mkimuram/k8sviz
- Owner: mkimuram
- License: apache-2.0
- Created: 2019-08-13T18:20:33.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-28T12:58:41.000Z (about 1 year ago)
- Last Synced: 2024-06-20T05:11:26.605Z (3 months ago)
- Language: Go
- Size: 905 KB
- Stars: 276
- Watchers: 8
- Forks: 47
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# k8sviz
k8sviz is a tool to generate Kubernetes architecture diagrams from the actual state in a namespace.
Currently, this only generates a diagram similar to https://github.com/kubernetes/community/tree/master/icons#usage-example by using [graphviz](https://www.graphviz.org/).
For examples of the generated diagrams, see [Examples](#examples) below.
## Implementations
There are two implementations, bash script version and go version. Bash script version is just a wrapper to run go version inside container.
## Prerequisites
### Bash script version
`k8sviz.sh` requires:
- bash
- getopt
- docker
To build a container image (optional), it requires:
- make
### Go version
`k8sviz` requires:
- dot (graphviz) command
To build binary, it requires:
- make
- go
## Version compatibility matrix
| k8sviz version | k8s 1.20 or earlier | k8s 1.21 or later |
|-------------------------|---------------------|-------------------|
| k8sviz 0.3.2 or earlier | Yes | No |
| k8sviz 0.3.3 or later | No | Yes |
## Installation
### Bash script version
Just download `k8sviz.sh` file and add execute permission.
```shell
$ curl -LO https://raw.githubusercontent.com/mkimuram/k8sviz/master/k8sviz.sh
$ chmod u+x k8sviz.sh
```
### Go version
Build the binary with below commands:
```shell
$ git clone https://github.com/mkimuram/k8sviz.git
$ cd k8sviz
$ make build
```
`icons` directory needs to be in the same directory to the k8sviz binary.
So, move them to the proper directory (Replace `PATH_TO_INSTALL` as you like).
```shell
$ PATH_TO_INSTALL=$HOME/bin
$ cp bin/k8sviz ${PATH_TO_INSTALL}
$ cp -r icons ${PATH_TO_INSTALL}
```
## Usage
### Bash script version
```shell
$ ./k8sviz.sh --help
USAGE: ./k8sviz.sh [flags] args
flags:
-n,--namespace: The namespace to visualize. (default: 'default')
-o,--outfile: The filename to output. (default: 'k8sviz.out')
-t,--type: The type of output. (default: 'dot')
-k,--kubeconfig: Path to kubeconfig file. (default: '/home/user1/.kube/config')
-i,--image: Image name of the container. (default: 'mkimuram/k8sviz:0.3')
-h,--help: show this help (default: false)
```
- ⚠️ WARNING
If you are using Mac, only short options can be used.
If you would like to use long options, you can install gnu-getopt and enable it by defining
`FLAGS_GETOPT_CMD` environment variable.
```shell
$ brew install gnu-getopt
$ export FLAGS_GETOPT_CMD=/usr/local/opt/gnu-getopt/bin/getopt
$ ./k8sviz.sh -h
```
- 📝NOTE
If you can't pull the container image or need to build it by yourself,
you can do it by `make image-build`. It would be helpful if you specify
`DEVEL_IMAGE` and `DEVEL_TAG` to make the image name the same to the
default one (Below example will set image name like `mkimuram/k8sviz:0.3.4`).
```shell
$ DEVEL_IMAGE=mkimuram/k8sviz DEVEL_TAG=$(cat version.txt) make image-build
```
An example use case of creating custom image is to include AWS SDK or Google Cloud SDK.
To create a custom image that include AWS SDK, run below command:
```shell
$ DEVEL_IMAGE=mkimuram/k8sviz DEVEL_TAG=$(cat version.txt) TARGET=aws make image-build
```
To create a custom image that include Google Cloud SDK, run below command:
```shell
$ DEVEL_IMAGE=mkimuram/k8sviz DEVEL_TAG=$(cat version.txt) TARGET=gcloud make image-build
```
### Go version
```shell
$ ./k8sviz -h
Usage of ./k8sviz:
-kubeconfig string
absolute path to the kubeconfig file (default "/home/user1/.kube/config")
-n string
namespace to visualize (shorthand) (default "default")
-namespace string
namespace to visualize (default "default")
-o string
output filename (shorthand) (default "k8sviz.out")
-outfile string
output filename (default "k8sviz.out")
-t string
type of output (shorthand) (default "dot")
-type string
type of output (default "dot")
```
## Examples
Examples are only shown for old bash script version, but current go version should work in the same way.
### Examples for tutorial deployments in default namespace
- Generate dot file for namespace `default`
```shell
./k8sviz.sh -n default -o default.dot
```
- Generate png file for namespace `default`
```shell
$ ./k8sviz.sh -n default -t png -o default.png
```
- Output for [an example wordpress deployment](https://kubernetes.io/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/) will be like below:
- [default.dot](./examples/wordpress/default.dot)
- [default.png](./examples/wordpress/default.png):
- Output for [an example cassandra deployment with statefulset](https://kubernetes.io/docs/tutorials/stateful-application/cassandra/) will be like below:
- [default.dot](./examples/cassandra/default.dot)
- [default.png](./examples/cassandra/default.png):
### Examples for more complex deployment ([kubeflow](https://www.kubeflow.org/docs/started/k8s/kfctl-k8s-istio/) case)
- Generate dot file for namespace `kubeflow` and `istio-system`
```shell
$ ./k8sviz.sh -n kubeflow -o examples/kubeflow/kubeflow.dot
$ ./k8sviz.sh -n istio-system -o examples/kubeflow/istio-system.dot
```
- Generate png file for namespace `kubeflow` and `istio-system`
```shell
$ ./k8sviz.sh -n kubeflow -t png -o examples/kubeflow/kubeflow.png
$ ./k8sviz.sh -n istio-system -t png -o examples/kubeflow/istio-system.png
```
- Output:
- [kubeflow.dot](./examples/kubeflow/kubeflow.dot)
- [istio-system.dot](./examples/kubeflow/istio-system.dot)
- [kubeflow.png](./examples/kubeflow/kubeflow.png)
- [istio-system.png](./examples/kubeflow/istio-system.png)
## License
This project is licensed under the Apache License - see the [LICENSE file](./LICENSE) for details