This project exists to help developers take some of the guesswork out of deploying Kubernetes definitions by providing a preview of what will actually be deployed with a set of YAML definitions.

Run pip install k8s-diagram

You may also need to install graphviz.

This script takes one argument, a path to a folder containing K8s YAML definitions and outputs a PNG diagram at kubernetes.png representing those definitions, as well as a python file at create_diagram.py if you would like to extend the diagram with other infrastructure surrounding your project. To automatically open the image upon completion, add the --show flag.

k8s-diagram <path_to_folder>

To try out the example, run k8s-diagram ./examples/yaml

For Helm Charts, simply run with the --helm flag and your chart will be templated and placed into /tmp/helm_preview_yaml/chart.yaml before the script runs.

You can also pass in a context from kubeconfig with the --cluster-context flag to pull in all supported resources from the target context prior to diagram generation. The resources found at the context will be copied into the target folder prior to chart generation.

Run k8s-diagram --help to see other available options.

You can alternatively run this project by running the docker image and mounting the yaml you want to use to /target. The image will be saved into the folder mounted to /target.

Ex: docker run -v "$(pwd)/k8s_yaml:/target" jimmymills/k8s-diagram /target

For Helm: docker run -v "$(pwd):/target" -v "$(pwd)/example_helm:/helm" diagram /helm --helm

This tool currently supports the following Kubernetes resource types:

• Deployment
• Service
• Ingress
• Pod
• CronJob
• Job
• DaemonSet
• StatefulSet
• ConfigMap
• Secret
• PersistentVolumeClaim

There is partial support for all node types listed at https://diagrams.mingrammer.com/docs/nodes/k8s but links will not be formed.