topology

Documentation

Index

• Constants
• func ComponentRun()
• func ComponentStatusSummarySync()
• func Query(params TopologyParams) (pkg.Components, error)
• func Run(opts TopologyRunOptions, s v1.SystemTemplate) []*pkg.Component
• func SyncComponentRelationships(parentComponentID uuid.UUID, relationships []*pkg.ComponentRelationship) error
• type ComponentContext
  • func NewComponentContext(client *kommons.Client, system v1.SystemTemplate) *ComponentContext
  • func (c *ComponentContext) Clone() *ComponentContext
  • func (c *ComponentContext) WithComponents(components *pkg.Components, current *pkg.Component) *ComponentContext
• type TopologyParams
  • func NewTopologyParams(values url.Values) TopologyParams
  • func (p TopologyParams) GetComponentRelationWhereClause() string
  • func (p TopologyParams) GetComponentWhereClause() string
  • func (p TopologyParams) String() string
• type TopologyRunOptions

Constants

const DefaultDepth = 1

Functions

func ComponentRun

func ComponentRun()

Fetches and updates the selected component for components

func ComponentStatusSummarySync

func ComponentStatusSummarySync()

func Query

func Query(params TopologyParams) (pkg.Components, error)

func Run

func Run(opts TopologyRunOptions, s v1.SystemTemplate) []*pkg.Component

func SyncComponentRelationships

func SyncComponentRelationships(parentComponentID uuid.UUID, relationships []*pkg.ComponentRelationship) error

Types

type ComponentContext

type ComponentContext struct {
	*context.KubernetesContext
	SystemTemplate v1.SystemTemplate
	ComponentAPI   v1.Component
	// Components keep track of the components that properties can apply to,
	// properties can return a map of component names to properties to facilitate
	// queries that are more efficient to perform for all components rather than a component at a time
	Components *pkg.Components
	// Properties can either be looked up on an individual component, or act as a summary across all components
	CurrentComponent *pkg.Component
}

func NewComponentContext

func NewComponentContext(client *kommons.Client, system v1.SystemTemplate) *ComponentContext

func (*ComponentContext) Clone

func (c *ComponentContext) Clone() *ComponentContext

func (*ComponentContext) WithComponents

func (c *ComponentContext) WithComponents(components *pkg.Components, current *pkg.Component) *ComponentContext

type TopologyParams

type TopologyParams struct {
	ID            string   `query:"id"`
	TopologyID    string   `query:"topologyId"`
	ComponentID   string   `query:"componentId"`
	Owner         string   `query:"owner"`
	Labels        string   `query:"labels"`
	Status        []string `query:"status"`
	Types         []string `query:"types"`
	Depth         int      `query:"depth"`
	Flatten       bool     `query:"flatten"`
	IncludeConfig bool     `query:"includeConfig"`
	IncludeHealth bool     `query:"includeHealth"`
}

func NewTopologyParams

func NewTopologyParams(values url.Values) TopologyParams

func (TopologyParams) GetComponentRelationWhereClause

func (p TopologyParams) GetComponentRelationWhereClause() string

func (TopologyParams) GetComponentWhereClause

func (p TopologyParams) GetComponentWhereClause() string

func (TopologyParams) String

func (p TopologyParams) String() string

type TopologyRunOptions

type TopologyRunOptions struct {
	*kommons.Client
	Depth     int
	Namespace string
}