pipeline

Documentation

Index

• type Manager
• type Opt
  • func OverrideComponent(c Manager) Opt
• type Pipeline
  • func New(ksApp app.App, envName string, opts ...Opt) *Pipeline
  • func (p *Pipeline) Components(filter []string) ([]component.Component, error)
  • func (p *Pipeline) EnvParameters(nsName string) (string, error)
  • func (p *Pipeline) Namespaces() ([]component.Namespace, error)
  • func (p *Pipeline) Objects(filter []string) ([]*unstructured.Unstructured, error)
  • func (p *Pipeline) YAML(filter []string) (io.Reader, error)

Types

type Manager

type Manager interface {
	Namespaces(ksApp app.App, envName string) ([]component.Namespace, error)
	Namespace(ksApp app.App, nsName string) (component.Namespace, error)
	NSResolveParams(ns component.Namespace) (string, error)
	Components(ns component.Namespace) ([]component.Component, error)

	// EnvParams returns the contents of the params file for an env.
	// TODO: this belongs in app.App
	EnvParams(ksApp app.App, envName string) (string, error)
}

Manager is an interface for interacting with components.

type Opt

type Opt func(p *Pipeline)

Opt is an option for configuring Pipeline.

func OverrideComponent

func OverrideComponent(c Manager) Opt

OverrideComponent overrides the component interface for a pipeline.

type Pipeline

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

Pipeline is the ks build pipeline.

func New

func New(ksApp app.App, envName string, opts ...Opt) *Pipeline

New creates an instance of Pipeline.

func (*Pipeline) Components

func (p *Pipeline) Components(filter []string) ([]component.Component, error)

Components returns the components that belong to this pipeline.

func (*Pipeline) EnvParameters

func (p *Pipeline) EnvParameters(nsName string) (string, error)

EnvParameters creates parameters for a namespace given an environment.

func (*Pipeline) Namespaces

func (p *Pipeline) Namespaces() ([]component.Namespace, error)

Namespaces returns the namespaces that belong to this pipeline.

func (*Pipeline) Objects

func (p *Pipeline) Objects(filter []string) ([]*unstructured.Unstructured, error)

Objects converts components into Kubernetes objects.

func (*Pipeline) YAML

func (p *Pipeline) YAML(filter []string) (io.Reader, error)

YAML converts components into YAML.