pipeline

Documentation

Index

• func GetSteps() []string
• type ComponentImage
• type ComponentImageSource
• type ComponentImageSourceBuilder
  • func NewComponentImageSourceBuilder() ComponentImageSourceBuilder
• type Definition
  • func GetPipelineFromName(name string) (*Definition, error)
  • func GetSupportedPipelines() []Definition
• type SourceFunc
  • func RadixComponentSource(c v1.RadixComponent) SourceFunc
  • func RadixJobComponentSource(c v1.RadixJobComponent) SourceFunc
• type StepType
  • func GetStepFromName(name string) (StepType, error)
  • func (p StepType) String() string

Functions

func GetSteps

func GetSteps() []string

GetSteps Enumerated list of steps

Types

type ComponentImage

type ComponentImage struct {
	ContainerName string
	Context       string
	Dockerfile    string
	ImageName     string
	ImagePath     string
	Build         bool
	Scan          bool
}

ComponentImage Holds info about the image associated with a component

type ComponentImageSource

type ComponentImageSource struct {
	Name           string
	SourceFolder   string
	DockerfileName string
	Image          string
}

ComponentImageSource holds information about the container image source for a Radix component or job

type ComponentImageSourceBuilder

type ComponentImageSourceBuilder interface {
	WithName(name string) ComponentImageSourceBuilder
	WithSourceFolder(sourceFolder string) ComponentImageSourceBuilder
	WithDockerfileName(dockerfileName string) ComponentImageSourceBuilder
	WithImage(image string) ComponentImageSourceBuilder
	WithSourceFunc(f SourceFunc) ComponentImageSourceBuilder
	Build() ComponentImageSource
}

ComponentImageSourceBuilder handles construction of ComponentImageSource

func NewComponentImageSourceBuilder

func NewComponentImageSourceBuilder() ComponentImageSourceBuilder

NewComponentImageSourceBuilder Constructor for the ComponentImageSourceBuilder

type Definition

type Definition struct {
	Type  v1.RadixPipelineType
	Steps []StepType
}

Definition Holds pipeline definition

func GetPipelineFromName

func GetPipelineFromName(name string) (*Definition, error)

GetPipelineFromName Gets pipeline from string

func GetSupportedPipelines

func GetSupportedPipelines() []Definition

GetSupportedPipelines Lists supported pipelines

type SourceFunc

type SourceFunc func(*componentImageSourceBuilder)

SourceFunc defines a function that can be used as input argument to WithSourceFunc

func RadixComponentSource

func RadixComponentSource(c v1.RadixComponent) SourceFunc

RadixComponentSource returns a SourceFunc that sets properties from the RadixComponent

func RadixJobComponentSource

func RadixJobComponentSource(c v1.RadixJobComponent) SourceFunc

RadixJobComponentSource returns a SourceFunc that sets properties from the RadixJobComponent

type StepType

type StepType int

StepType Enumeration of the different steps a pipeline could contain

const (
	// CopyConfigToMapStep Step type to copy cloned radix config to configmap
	CopyConfigToMapStep StepType = iota

	// ApplyConfigStep Step type to apply radix config
	ApplyConfigStep

	// BuildStep Step to build the docker image
	BuildStep

	// ScanImageStep Step to scan the docker image for vulnerabilities
	ScanImageStep

	// DeployStep Step to deploy the RD
	DeployStep

	// PromoteStep Will promote a deployment from one environment to another,
	// or an older deployment to an active
	PromoteStep
)

func GetStepFromName

func GetStepFromName(name string) (StepType, error)

GetStepFromName Gets Step from string

func (StepType) String

func (p StepType) String() string