kubegraph

Documentation

Index

• type KubeGraph
  • func New() (kubegraph *KubeGraph, err error)
  • func (kgraph *KubeGraph) AddStyledNode(resourceType reflect.Type, resourceObject runtime.Object, nodeName string, ...) (adapter.Node, error)
  • func (kgraph *KubeGraph) ConnectNodes()
  • func (kgraph *KubeGraph) GetNode(nodeType reflect.Type, nodeName string) (adapter.Node, error)
  • func (kgraph *KubeGraph) GetObjects(objectType reflect.Type) (map[string]runtime.Object, error)
  • func (kgraph *KubeGraph) LinkNode(node adapter.Node, targetNodeType reflect.Type, targetNodeName string) (edge adapter.Edge, err error)
  • func (kgraph *KubeGraph) Transform(obj runtime.Object) (adapter.Node, error)
  • func (kgraph *KubeGraph) WriteTo(target io.Writer) (int64, error)

Types

type KubeGraph

type KubeGraph struct {
	// contains filtered or unexported fields
}

KubeGraph graphviz wrapper that creates kubernetes resource graphs

func New

func New() (kubegraph *KubeGraph, err error)

New creates an instance of KubeGraph

func (*KubeGraph) AddStyledNode

func (kgraph *KubeGraph) AddStyledNode(resourceType reflect.Type, resourceObject runtime.Object, nodeName string, resourceName string, icon string) (adapter.Node, error)

AddStyledNode creates a new styled node with the given resource

func (*KubeGraph) ConnectNodes

func (kgraph *KubeGraph) ConnectNodes()

ConnectNodes creates edges between the nodes

func (*KubeGraph) GetNode

func (kgraph *KubeGraph) GetNode(nodeType reflect.Type, nodeName string) (adapter.Node, error)

GetNode gets a node by type/name

func (*KubeGraph) GetObjects

func (kgraph *KubeGraph) GetObjects(objectType reflect.Type) (map[string]runtime.Object, error)

GetObjects gets all objects in store

func (*KubeGraph) LinkNode

func (kgraph *KubeGraph) LinkNode(node adapter.Node, targetNodeType reflect.Type, targetNodeName string) (edge adapter.Edge, err error)

LinkNode links the node to the target node type/name, if it exists

func (*KubeGraph) Transform

func (kgraph *KubeGraph) Transform(obj runtime.Object) (adapter.Node, error)

Transform creates a node on the graph for the resource

func (*KubeGraph) WriteTo

func (kgraph *KubeGraph) WriteTo(target io.Writer) (int64, error)

Write write the graph contents to a writer using simple TAB indentation