openshift-topology-exporter

openshift-topology-exporter

Simple tool to export the topology configuration and visualize it in GraphViz or other managed diagram visualizers.

Resources exported and connected in the diagrams are:

• Namespace [core/v1]
• Route [route.openshift.io/v1]
• Service [core/v1]
• Deployment [apps/v1]
• DeploymentConfig [apps.openshift.io/v1]
• Pod [core/v1]
• ServiceAccount [core/v1]
• RoleBinding [rbac.authorization.k8s.io/v1]

This tool is based on the OpenShift Client in Go and requires Golang.

Options

The runtime configuration is defined in config.yaml:

Instructions

Note: You must be logged in to the OpenShift console to successfully run the tool

Configure the target namespaces in config.yaml, then run as:

go run exporter.go

Install Graphviz and visualize it as:

dot -Tpng diagram.dot > diagram.png

The resulting diagram is in the generated diagram.png image file.

An example diagram is given, captured from a real deployment of the Red Hat Single Sign-On.

In alternative, you can paste the content of the generated diagram.dot file in an online visualizer like https://dreampuf.github.io/GraphvizOnline and enjoy the result.

Alternative formatter

You can configure a different formatterclass in config.yaml, these are the supported values:

• graphviz (default): compatible with Graphviz, you can use the online visualizer https://dreampuf.github.io/GraphvizOnline
• mermaid: compatible with Mermaid, you can view the output file diagram.mermaid with the Mermaid Live Editor
  • See a Knative example diagram