pipeline

Documentation

Index

• Variables
• func GetKubernetesConfig() (*rest.Config, error)
• func TailLogs(ctx context.Context, c kubernetes.Interface, pod *v1.Pod, container string)
• func Watch(ctx context.Context, c kubernetes.Interface, watchPod *v1.Pod) (<-chan WatchEvent, error)
• type PipelineDefinition
  • func ParsePipeline(data []byte) *PipelineDefinition
• type PipelineDefinitionStep
  • func (p *PipelineDefinitionStep) OverrideBranch(branch string, overrideInputs bool)
  • func (p *PipelineDefinitionStep) OverrideTag(tag string)
  • func (p *PipelineDefinitionStep) OverrideVersion(version string, overrideInputs bool)
• type PodDefinition
  • func NewPodDefinition(pipelineDefinition *PipelineDefinition, ...) *PodDefinition
• type PodEnvVariable
• type PodSecret
• type WatchEvent
• type WatchEventType

Variables

var PipelineCmd = &cobra.Command{
	Use:   "pipeline",
	Short: "Manage Canoe pipelines",
	Long:  "Run and control Canoe pipelines",
}

Functions

func GetKubernetesConfig

func GetKubernetesConfig() (*rest.Config, error)

func TailLogs

func TailLogs(ctx context.Context, c kubernetes.Interface, pod *v1.Pod, container string)

func Watch

func Watch(ctx context.Context, c kubernetes.Interface, watchPod *v1.Pod) (<-chan WatchEvent, error)

Types

type PipelineDefinition

type PipelineDefinition struct {
	Pipeline  string                   `yaml:"pipeline"`
	Bucket    string                   `yaml:"bucket"`
	Namespace string                   `yaml:"namespace"`
	Steps     []PipelineDefinitionStep `yaml:"steps"`
	Secrets   []string
}

func ParsePipeline

func ParsePipeline(data []byte) *PipelineDefinition

type PipelineDefinitionStep

type PipelineDefinitionStep struct {
	Step    string `yaml:"step" json:"step"`
	Version string `yaml:"version" json:"version"`
	Branch  string `yaml:"branch" json:"branch"`
	Image   string `yaml:"image" json:"image"`
	Inputs  []struct {
		Step    string   `yaml:"step" json:"step"`
		Version string   `yaml:"version" json:"version"`
		Branch  string   `yaml:"branch" json:"branch"`
		Path    string   `yaml:"path" json:"path"`
		Bucket  string   `yaml:"bucket" json:"bucket"`
		Keys    []string `yaml:"keys" json:"keys"`
		Subdir  string   `yaml:"subdir" json:"subdir"`
	} `yaml:"inputs" json:"inputs"`
	Commands  []string `yaml:"commands" json:"commands"`
	Resources struct {
		CPU     int    `yaml:"cpu" json:"cpu"`
		Memory  string `yaml:"memory" json:"memory"`
		Storage int    `yaml:"storage-mb" json:"storage-mb"`
	} `yaml:"resources" json:"resources"`
}

func (*PipelineDefinitionStep) OverrideBranch

func (p *PipelineDefinitionStep) OverrideBranch(branch string, overrideInputs bool)

func (*PipelineDefinitionStep) OverrideTag

func (p *PipelineDefinitionStep) OverrideTag(tag string)

func (*PipelineDefinitionStep) OverrideVersion

func (p *PipelineDefinitionStep) OverrideVersion(version string, overrideInputs bool)

type PodDefinition

type PodDefinition struct {
	PodName         string
	StepName        string
	StepVersion     string
	BranchName      string
	Namespace       string
	Bucket          string
	Secrets         []PodSecret
	Env             []PodEnvVariable
	BucketOverrides map[string]string

	Step PipelineDefinitionStep
}

func NewPodDefinition

func NewPodDefinition(pipelineDefinition *PipelineDefinition, pipelineDefinitionStep *PipelineDefinitionStep) *PodDefinition

type PodEnvVariable

type PodEnvVariable struct {
	Name  string
	Value string
}

type PodSecret

type PodSecret struct {
	Name  string
	Store string
	Key   string
}

type WatchEvent

type WatchEvent struct {
	Type      WatchEventType
	Pod       *v1.Pod
	Container string
	Message   string
}

type WatchEventType

type WatchEventType string

const (
	Added     WatchEventType = "ADDED"
	Deleted   WatchEventType = "DELETED"
	Removed   WatchEventType = "REMOVED"
	Completed WatchEventType = "COMPLETED"
	Failed    WatchEventType = "FAILED"
)