runner

Documentation

Index

• Variables
• func WithNotification(d deploy.Deployer) deploy.Deployer
• func WithTimings(b build.Builder, t test.Tester, d deploy.Deployer, cacheArtifacts bool) (build.Builder, test.Tester, deploy.Deployer)
• type Listener
• type Runner
• type SkaffoldListener
  • func (l *SkaffoldListener) LogWatchToUser(out io.Writer)
  • func (l *SkaffoldListener) WatchForChanges(ctx context.Context, out io.Writer, ...) error
• type SkaffoldRunner
  • func NewForConfig(runCtx *runcontext.RunContext) (*SkaffoldRunner, error)
  • func (r *SkaffoldRunner) BuildAndTest(ctx context.Context, out io.Writer, artifacts []*latest.Artifact) ([]build.Artifact, error)
  • func (r *SkaffoldRunner) Cleanup(ctx context.Context, out io.Writer) error
  • func (r *SkaffoldRunner) Deploy(ctx context.Context, out io.Writer, artifacts []build.Artifact) error
  • func (r *SkaffoldRunner) DeployAndLog(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) DiagnoseArtifacts(ctx context.Context, out io.Writer) error
  • func (r *SkaffoldRunner) GeneratePipeline(ctx context.Context, out io.Writer, config *latest.SkaffoldConfig, ...) error
  • func (r *SkaffoldRunner) HasBuilt() bool
  • func (r *SkaffoldRunner) HasDeployed() bool
  • func (r *SkaffoldRunner) Prune(ctx context.Context, out io.Writer) error
  • func (r *SkaffoldRunner) Render(ctx context.Context, out io.Writer, builds []build.Artifact, filepath string) 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, cacheArtifacts bool) (build.Builder, test.Tester, deploy.Deployer)

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

Types

type Listener

type Listener interface {
	WatchForChanges(context.Context, io.Writer, func(context.Context, io.Writer) error) error
	LogWatchToUser(io.Writer)
}

type Runner

type Runner interface {
	DiagnoseArtifacts(context.Context, io.Writer) error
	Dev(context.Context, io.Writer, []*latest.Artifact) error
	BuildAndTest(context.Context, io.Writer, []*latest.Artifact) ([]build.Artifact, error)
	DeployAndLog(context.Context, io.Writer, []build.Artifact) error
	GeneratePipeline(context.Context, io.Writer, *latest.SkaffoldConfig, []string, string) error
	Render(context.Context, io.Writer, []build.Artifact, string) error
	Cleanup(context.Context, io.Writer) error
	Prune(context.Context, io.Writer) error
	HasDeployed() bool
	HasBuilt() bool
}

Runner is responsible for running the skaffold build, test and deploy config.

type SkaffoldListener

type SkaffoldListener struct {
	Monitor filemon.Monitor
	Trigger trigger.Trigger
	// contains filtered or unexported fields
}

func (*SkaffoldListener) LogWatchToUser

func (l *SkaffoldListener) LogWatchToUser(out io.Writer)

func (*SkaffoldListener) WatchForChanges

func (l *SkaffoldListener) WatchForChanges(ctx context.Context, out io.Writer, devLoop func(context.Context, io.Writer) error) error

WatchForChanges listens to a trigger, and when one is received, computes file changes and conditionally runs the dev loop.

type SkaffoldRunner

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

SkaffoldRunner is responsible for running the skaffold build, test and deploy config.

func NewForConfig

func NewForConfig(runCtx *runcontext.RunContext) (*SkaffoldRunner, error)

NewForConfig returns a new SkaffoldRunner for a SkaffoldConfig

func (*SkaffoldRunner) BuildAndTest

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

BuildAndTest builds and tests a list of artifacts.

func (*SkaffoldRunner) Cleanup

func (r *SkaffoldRunner) Cleanup(ctx context.Context, out io.Writer) error

func (*SkaffoldRunner) Deploy

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

func (*SkaffoldRunner) DeployAndLog

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

DeployAndLog deploys a list of already built artifacts and optionally show the logs.

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 config until interrupted by the user.

func (*SkaffoldRunner) DiagnoseArtifacts

func (r *SkaffoldRunner) DiagnoseArtifacts(ctx context.Context, out io.Writer) error

func (*SkaffoldRunner) GeneratePipeline

func (r *SkaffoldRunner) GeneratePipeline(ctx context.Context, out io.Writer, config *latest.SkaffoldConfig, configPaths []string, fileOut string) error

func (*SkaffoldRunner) HasBuilt

func (r *SkaffoldRunner) HasBuilt() bool

HasBuilt returns true if this runner has built something.

func (*SkaffoldRunner) HasDeployed

func (r *SkaffoldRunner) HasDeployed() bool

HasDeployed returns true if this runner has deployed something.

func (*SkaffoldRunner) Prune

func (r *SkaffoldRunner) Prune(ctx context.Context, out io.Writer) error

func (*SkaffoldRunner) Render

func (r *SkaffoldRunner) Render(ctx context.Context, out io.Writer, builds []build.Artifact, filepath string) error