deploy

Documentation

Index

• type Deployer
  • func NewDeployerMux(deployers []Deployer, iterativeStatusCheck bool) Deployer
• type DeployerMux
  • func (m DeployerMux) Cleanup(ctx context.Context, w io.Writer, dryRun bool) error
  • func (m DeployerMux) Dependencies() ([]string, error)
  • func (m DeployerMux) Deploy(ctx context.Context, w io.Writer, as []graph.Artifact) error
  • func (m DeployerMux) GetAccessor() access.Accessor
  • func (m DeployerMux) GetDebugger() debug.Debugger
  • func (m DeployerMux) GetDeployers() []Deployer
  • func (m DeployerMux) GetLogger() log.Logger
  • func (m DeployerMux) GetStatusMonitor() status.Monitor
  • func (m DeployerMux) GetSyncer() sync.Syncer
  • func (m DeployerMux) RegisterLocalImages(images []graph.Artifact)
  • func (m DeployerMux) Render(ctx context.Context, w io.Writer, as []graph.Artifact, offline bool, ...) error
  • func (m DeployerMux) TrackBuildArtifacts(_ []graph.Artifact)

Types

type Deployer

type Deployer interface {
	// Deploy should ensure that the build results are deployed to the Kubernetes
	// cluster.
	Deploy(context.Context, io.Writer, []graph.Artifact) error

	// Dependencies returns a list of files that the deployer depends on.
	// In dev mode, a redeploy will be triggered
	Dependencies() ([]string, error)

	// Cleanup deletes what was deployed by calling Deploy.
	Cleanup(context.Context, io.Writer, bool) error

	// Render generates the Kubernetes manifests replacing the build results and
	// writes them to the given file path
	Render(context.Context, io.Writer, []graph.Artifact, bool, string) error

	// GetDebugger returns a Deployer's implementation of a Debugger
	GetDebugger() debug.Debugger

	// GetLogger returns a Deployer's implementation of a Logger
	GetLogger() log.Logger

	// GetAccessor returns a Deployer's implementation of an Accessor
	GetAccessor() access.Accessor

	// GetSyncer returns a Deployer's implementation of a Syncer
	GetSyncer() sync.Syncer

	// TrackBuildArtifacts registers build artifacts to be tracked by a Deployer
	TrackBuildArtifacts([]graph.Artifact)

	// RegisterLocalImages tracks all local images to be loaded by the Deployer
	RegisterLocalImages([]graph.Artifact)

	// GetStatusMonitor returns a Deployer's implementation of a StatusMonitor
	GetStatusMonitor() status.Monitor
}

Deployer is the Deploy API of skaffold and responsible for deploying the build results to a Kubernetes cluster

func NewDeployerMux

func NewDeployerMux(deployers []Deployer, iterativeStatusCheck bool) Deployer

type DeployerMux

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

DeployerMux forwards all method calls to the deployers it contains. When encountering an error, it aborts and returns the error. Otherwise, it collects the results and returns it in bulk.

func (DeployerMux) Cleanup

func (m DeployerMux) Cleanup(ctx context.Context, w io.Writer, dryRun bool) error

func (DeployerMux) Dependencies

func (m DeployerMux) Dependencies() ([]string, error)

func (DeployerMux) Deploy

func (m DeployerMux) Deploy(ctx context.Context, w io.Writer, as []graph.Artifact) error

func (DeployerMux) GetAccessor

func (m DeployerMux) GetAccessor() access.Accessor

func (DeployerMux) GetDebugger

func (m DeployerMux) GetDebugger() debug.Debugger

func (DeployerMux) GetDeployers

func (m DeployerMux) GetDeployers() []Deployer

func (DeployerMux) GetLogger

func (m DeployerMux) GetLogger() log.Logger

func (DeployerMux) GetStatusMonitor

func (m DeployerMux) GetStatusMonitor() status.Monitor

func (DeployerMux) GetSyncer

func (m DeployerMux) GetSyncer() sync.Syncer

func (DeployerMux) RegisterLocalImages

func (m DeployerMux) RegisterLocalImages(images []graph.Artifact)

func (DeployerMux) Render

func (m DeployerMux) Render(ctx context.Context, w io.Writer, as []graph.Artifact, offline bool, filepath string) error

func (DeployerMux) TrackBuildArtifacts

func (m DeployerMux) TrackBuildArtifacts(_ []graph.Artifact)

TrackBuildArtifacts should *only* be called on individual deployers. This is a noop.