veneers

Documentation

Index

• func CompareImagePipeline(a, b *ImagePipeline) bool
• func CompareObjectMeta(a, b *kapi.ObjectMeta) bool
• func UncoveredDeploymentFlowEdges(covered osgraph.NodeSet) osgraph.EdgeFunc
• func UncoveredDeploymentFlowNodes(covered osgraph.NodeSet) osgraph.NodeFunc
• type DeploymentFlow
• type DeploymentPipelineMap
  • func DeploymentPipelines(g osgraph.Graph) (DeploymentPipelineMap, osgraph.NodeSet)
• type ImagePipeline
  • func ImagePipelineFromNode(g osgraph.Graph, n graph.Node, covered osgraph.NodeSet) (ImagePipeline, bool)
• type ImageTagLocation
• type ServiceGroup
  • func ServiceAndDeploymentGroups(g osgraph.Graph) []ServiceGroup
• type ServiceReference
• type SortedDeploymentPipelines
  • func (m SortedDeploymentPipelines) Len() int
  • func (m SortedDeploymentPipelines) Less(i, j int) bool
  • func (m SortedDeploymentPipelines) Swap(i, j int)
• type SortedImagePipelines
  • func (m SortedImagePipelines) Len() int
  • func (m SortedImagePipelines) Less(i, j int) bool
  • func (m SortedImagePipelines) Swap(i, j int)
• type SortedServiceGroups
  • func (m SortedServiceGroups) Len() int
  • func (m SortedServiceGroups) Less(i, j int) bool
  • func (m SortedServiceGroups) Swap(i, j int)
• type SortedServiceReferences
  • func (m SortedServiceReferences) Len() int
  • func (m SortedServiceReferences) Less(i, j int) bool
  • func (m SortedServiceReferences) Swap(i, j int)
• type SourceLocation

Functions

func CompareImagePipeline

func CompareImagePipeline(a, b *ImagePipeline) bool

func CompareObjectMeta

func CompareObjectMeta(a, b *kapi.ObjectMeta) bool

func UncoveredDeploymentFlowEdges

func UncoveredDeploymentFlowEdges(covered osgraph.NodeSet) osgraph.EdgeFunc

UncoveredDeploymentFlowEdges preserves (and duplicates) edges that were not covered by a deployment flow. As a special case, it preserves edges between Services and DeploymentConfigs.

func UncoveredDeploymentFlowNodes

func UncoveredDeploymentFlowNodes(covered osgraph.NodeSet) osgraph.NodeFunc

UncoveredDeploymentFlowNodes includes nodes that either services or deployment configs, or which haven't previously been covered.

Types

type DeploymentFlow

type DeploymentFlow struct {
	Deployment *deploygraph.DeploymentConfigNode
	Images     []ImagePipeline
}

type DeploymentPipelineMap

type DeploymentPipelineMap map[*deploygraph.DeploymentConfigNode][]ImagePipeline

DeploymentPipelineMap describes a single deployment config and the objects that contributed to that deployment.

func DeploymentPipelines

func DeploymentPipelines(g osgraph.Graph) (DeploymentPipelineMap, osgraph.NodeSet)

DeploymentPipelines returns a map of DeploymentConfigs to the deployment flows that create them, extracted from the provided Graph.

type ImagePipeline

type ImagePipeline struct {
	Image ImageTagLocation
	Build *buildgraph.BuildConfigNode
	// If set, the base image used by the build
	BaseImage ImageTagLocation
	// If set, the source repository that inputs to the build
	Source SourceLocation
}

ImagePipeline represents a build, its output, and any inputs. The input to a build may be another ImagePipeline.

func ImagePipelineFromNode

func ImagePipelineFromNode(g osgraph.Graph, n graph.Node, covered osgraph.NodeSet) (ImagePipeline, bool)

ImagePipelineFromNode attempts to locate a build flow from the provided node. If no such build flow can be located, false is returned.

type ImageTagLocation

type ImageTagLocation interface {
	ID() int
	ImageSpec() string
	ImageTag() string
}

ImageTagLocation identifies the source or destination of an image. Represents both a tag in a Docker image repository, as well as a tag in an OpenShift image stream.

type ServiceGroup

type ServiceGroup struct {
	Services    []ServiceReference
	Deployments []DeploymentFlow
	Builds      []ImagePipeline
}

ServiceGroup is a related set of resources that should be displayed together logically. They are usually sorted internally.

func ServiceAndDeploymentGroups

func ServiceAndDeploymentGroups(g osgraph.Graph) []ServiceGroup

ServiceAndDeploymentGroups breaks the provided graph of API relationships into ServiceGroup objects, ordered consistently. Groups are organized so that overlapping Services and DeploymentConfigs are part of the same group, Deployment Configs are each in their own group, and then BuildConfigs are part of the last service group.

type ServiceReference

type ServiceReference struct {
	Service     *kubegraph.ServiceNode
	CoveredDCs  []*deploygraph.DeploymentConfigNode
	CoveredRCs  []*kubegraph.ReplicationControllerNode
	CoveredPods []*kubegraph.PodNode
}

ServiceReference is a service and the DeploymentConfigs it covers

type SortedDeploymentPipelines

type SortedDeploymentPipelines []DeploymentFlow

func (SortedDeploymentPipelines) Len

func (m SortedDeploymentPipelines) Len() int

func (SortedDeploymentPipelines) Less

func (m SortedDeploymentPipelines) Less(i, j int) bool

func (SortedDeploymentPipelines) Swap

func (m SortedDeploymentPipelines) Swap(i, j int)

type SortedImagePipelines

type SortedImagePipelines []ImagePipeline

func (SortedImagePipelines) Len

func (m SortedImagePipelines) Len() int

func (SortedImagePipelines) Less

func (m SortedImagePipelines) Less(i, j int) bool

func (SortedImagePipelines) Swap

func (m SortedImagePipelines) Swap(i, j int)

type SortedServiceGroups

type SortedServiceGroups []ServiceGroup

func (SortedServiceGroups) Len

func (m SortedServiceGroups) Len() int

func (SortedServiceGroups) Less

func (m SortedServiceGroups) Less(i, j int) bool

func (SortedServiceGroups) Swap

func (m SortedServiceGroups) Swap(i, j int)

type SortedServiceReferences

type SortedServiceReferences []ServiceReference

func (SortedServiceReferences) Len

func (m SortedServiceReferences) Len() int

func (SortedServiceReferences) Less

func (m SortedServiceReferences) Less(i, j int) bool

func (SortedServiceReferences) Swap

func (m SortedServiceReferences) Swap(i, j int)

type SourceLocation

type SourceLocation interface {
	ID() int
}

SourceLocation identifies a repository that is an input to a build.