runner

Documentation

Index

• Variables
• func WithNotification(d deploy.Deployer) deploy.Deployer
• func WithTimings(b build.Builder, t test.Tester, d deploy.Deployer) (build.Builder, test.Tester, deploy.Deployer)
• type SkaffoldRunner
  • func NewForConfig(opts *config.SkaffoldOptions, cfg *latest.SkaffoldPipeline) (*SkaffoldRunner, error)
  • func (r *SkaffoldRunner) BuildAndTest(ctx context.Context, out io.Writer, artifacts []*latest.Artifact) ([]build.Artifact, error)
  • func (r *SkaffoldRunner) Deploy(ctx context.Context, out io.Writer, artifacts []build.Artifact) error
  • func (r *SkaffoldRunner) Dev(ctx context.Context, out io.Writer, artifacts []*latest.Artifact) error
  • func (r *SkaffoldRunner) HasDeployed() bool
  • func (r *SkaffoldRunner) Run(ctx context.Context, out io.Writer, artifacts []*latest.Artifact) error
  • func (r *SkaffoldRunner) TailLogs(ctx context.Context, out io.Writer, artifacts []*latest.Artifact, ...) error

Variables

var ErrorConfigurationChanged = errors.New("configuration changed")

ErrorConfigurationChanged is a special error that's returned when the skaffold configuration was changed.

Functions

func WithNotification

func WithNotification(d deploy.Deployer) deploy.Deployer

WithNotification creates a deployer that bips each time a deploy is done.

func WithTimings

func WithTimings(b build.Builder, t test.Tester, d deploy.Deployer) (build.Builder, test.Tester, deploy.Deployer)

WithTimings creates a deployer that logs the duration of each phase.

Types

type SkaffoldRunner

type SkaffoldRunner struct {
	build.Builder
	deploy.Deployer
	test.Tester
	tag.Tagger
	sync.Syncer
	watch.Watcher
	// contains filtered or unexported fields
}

SkaffoldRunner is responsible for running the skaffold build and deploy pipeline.

func NewForConfig

func NewForConfig(opts *config.SkaffoldOptions, cfg *latest.SkaffoldPipeline) (*SkaffoldRunner, error)

NewForConfig returns a new SkaffoldRunner for a SkaffoldPipeline

func (*SkaffoldRunner) BuildAndTest

func (r *SkaffoldRunner) BuildAndTest(ctx context.Context, out io.Writer, artifacts []*latest.Artifact) ([]build.Artifact, error)

BuildAndTest builds artifacts and runs tests on built artifacts

func (*SkaffoldRunner) Deploy

func (r *SkaffoldRunner) Deploy(ctx context.Context, out io.Writer, artifacts []build.Artifact) error

Deploy deploys the given artifacts

func (*SkaffoldRunner) Dev

func (r *SkaffoldRunner) Dev(ctx context.Context, out io.Writer, artifacts []*latest.Artifact) error

Dev watches for changes and runs the skaffold build and deploy pipeline until interrupted by the user.

func (*SkaffoldRunner) HasDeployed

func (r *SkaffoldRunner) HasDeployed() bool

HasDeployed returns true if this runner has deployed something.

func (*SkaffoldRunner) Run

func (r *SkaffoldRunner) Run(ctx context.Context, out io.Writer, artifacts []*latest.Artifact) error

Run builds artifacts, runs tests on built artifacts, and then deploys them.

func (*SkaffoldRunner) TailLogs

func (r *SkaffoldRunner) TailLogs(ctx context.Context, out io.Writer, artifacts []*latest.Artifact, bRes []build.Artifact) error

TailLogs prints the logs for deployed artifacts.