inspect

Documentation

Index

• type Edge
• type Graph
  • func New(bp blueprint.Blueprint) (Graph, error)
  • func (g Graph) GetConnections() []Edge
• type Inspect
  • func (iCmd *Inspect) AfterRun() error
  • func (iCmd *Inspect) BeforeRun() error
  • func (iCmd *Inspect) InstallFlags(flags *flag.FlagSet)
  • func (iCmd *Inspect) Parse(args []string) error
  • func (iCmd *Inspect) Run() int
• type Node

Types

type Edge

type Edge struct {
	From string
	To   string
}

An Edge in the communication Graph.

type Graph

type Graph struct {
	Nodes map[string]Node
}

A Graph represents permission to communicate across a series of Nodes. Each Node is a container and each edge is permissions to initiate a connection.

func New

func New(bp blueprint.Blueprint) (Graph, error)

New queries the Blueprint to create a Graph structure.

func (Graph) GetConnections

func (g Graph) GetConnections() []Edge

GetConnections returns a list of the edges in the Graph.

type Inspect

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

Inspect contains the options for inspecting Blueprints.

func (*Inspect) AfterRun

func (iCmd *Inspect) AfterRun() error

AfterRun performs any necessary post-run cleanup.

func (*Inspect) BeforeRun

func (iCmd *Inspect) BeforeRun() error

BeforeRun makes any necessary post-parsing transformations.

func (*Inspect) InstallFlags

func (iCmd *Inspect) InstallFlags(flags *flag.FlagSet)

InstallFlags sets up parsing for command line flags.

func (*Inspect) Parse

func (iCmd *Inspect) Parse(args []string) error

Parse parses the command line arguments for the inspect command.

func (*Inspect) Run

func (iCmd *Inspect) Run() int

Run inspects the provided Blueprint.

type Node

type Node struct {
	Name        string
	Connections map[string]Node
}

A Node in the communication Graph.