skaffold

Documentation

Index

• Constants
• type RunBuilder
  • func Apply(args ...string) *RunBuilder
  • func Build(args ...string) *RunBuilder
  • func Config(args ...string) *RunBuilder
  • func Credits(args ...string) *RunBuilder
  • func Debug(args ...string) *RunBuilder
  • func Delete(args ...string) *RunBuilder
  • func Deploy(args ...string) *RunBuilder
  • func Dev(args ...string) *RunBuilder
  • func Diagnose(args ...string) *RunBuilder
  • func Exec(args ...string) *RunBuilder
  • func Filter(args ...string) *RunBuilder
  • func Fix(args ...string) *RunBuilder
  • func GeneratePipeline(args ...string) *RunBuilder
  • func Init(args ...string) *RunBuilder
  • func Inspect(args ...string) *RunBuilder
  • func Render(args ...string) *RunBuilder
  • func Run(args ...string) *RunBuilder
  • func Schema(args ...string) *RunBuilder
  • func Test(args ...string) *RunBuilder
  • func Verify(args ...string) *RunBuilder
  • func (b *RunBuilder) InDir(dir string) *RunBuilder
  • func (b *RunBuilder) InNs(ns string) *RunBuilder
  • func (b *RunBuilder) Run(t *testing.T) error
  • func (b *RunBuilder) RunBackground(t *testing.T)
  • func (b *RunBuilder) RunInBackgroundWithOutput(t *testing.T, out io.Writer)
  • func (b *RunBuilder) RunLive(t *testing.T) io.ReadCloser
  • func (b *RunBuilder) RunOrFail(t *testing.T)
  • func (b *RunBuilder) RunOrFailOutput(t *testing.T) []byte
  • func (b *RunBuilder) RunWithCombinedOutput(t *testing.T) ([]byte, error)
  • func (b *RunBuilder) RunWithStdoutAndStderrOrFail(t *testing.T, stdout, stderr io.Writer)
  • func (b *RunBuilder) StartWithProcess(t *testing.T) (*os.Process, error)
  • func (b *RunBuilder) WithConfig(configFile string) *RunBuilder
  • func (b *RunBuilder) WithEnv(env []string) *RunBuilder
  • func (b *RunBuilder) WithProfiles(profiles []string) *RunBuilder
  • func (b *RunBuilder) WithRepo(repo string) *RunBuilder
  • func (b *RunBuilder) WithStdin(input []byte) *RunBuilder

Constants

const DefaultRepo = "us-central1-docker.pkg.dev/k8s-skaffold/testing"

Types

type RunBuilder

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

RunBuilder is used to build a command line to run `skaffold`.

func Apply

func Apply(args ...string) *RunBuilder

Apply runs `skaffold apply` with the given arguments.

func Build

func Build(args ...string) *RunBuilder

Build runs `skaffold build` with the given arguments.

func Config

func Config(args ...string) *RunBuilder

Config runs `skaffold config` with the given arguments.

func Credits

func Credits(args ...string) *RunBuilder

Credits runs `skaffold credits` with the given arguments.

func Debug

func Debug(args ...string) *RunBuilder

Debug runs `skaffold debug` with the given arguments.

func Delete

func Delete(args ...string) *RunBuilder

Delete runs `skaffold delete` with the given arguments.

func Deploy

func Deploy(args ...string) *RunBuilder

Deploy runs `skaffold deploy` with the given arguments.

func Dev

func Dev(args ...string) *RunBuilder

Dev runs `skaffold dev` with the given arguments.

func Diagnose

func Diagnose(args ...string) *RunBuilder

Diagnose runs `skaffold diagnose` with the given arguments.

func Exec

func Exec(args ...string) *RunBuilder

Exec runs `skaffold exec` with the given arguments.

func Filter

func Filter(args ...string) *RunBuilder

Filter runs `skaffold filter` with the given arguments.

func Fix

func Fix(args ...string) *RunBuilder

Fix runs `skaffold fix` with the given arguments.

func GeneratePipeline

func GeneratePipeline(args ...string) *RunBuilder

func Init

func Init(args ...string) *RunBuilder

Init runs `skaffold init` with the given arguments.

func Inspect

func Inspect(args ...string) *RunBuilder

Inspect runs `skaffold inspect` with the given arguments.

func Render

func Render(args ...string) *RunBuilder

Render runs `skaffold render` with the given arguments.

func Run

func Run(args ...string) *RunBuilder

Run runs `skaffold run` with the given arguments.

func Schema

func Schema(args ...string) *RunBuilder

Schema runs `skaffold schema` with the given arguments.

func Test

func Test(args ...string) *RunBuilder

Test runs `skaffold test` with the given arguments.

func Verify

func Verify(args ...string) *RunBuilder

Verify runs `skaffold verify` with the given arguments.

func (*RunBuilder) InDir

func (b *RunBuilder) InDir(dir string) *RunBuilder

InDir sets the directory in which skaffold is running.

func (*RunBuilder) InNs

func (b *RunBuilder) InNs(ns string) *RunBuilder

InNs sets the Kubernetes namespace in which skaffold deploys.

func (*RunBuilder) Run

func (b *RunBuilder) Run(t *testing.T) error

Run runs the skaffold command.

func (*RunBuilder) RunBackground

func (b *RunBuilder) RunBackground(t *testing.T)

RunBackground runs the skaffold command in the background. The Skaffold output is accumulated and logged on test failure.

func (*RunBuilder) RunInBackgroundWithOutput

func (b *RunBuilder) RunInBackgroundWithOutput(t *testing.T, out io.Writer)

RunInBackgroundWithOutput runs the skaffold command in the background.

func (*RunBuilder) RunLive

func (b *RunBuilder) RunLive(t *testing.T) io.ReadCloser

RunLive runs the skaffold command in the background with live output. !!Warning!! RunLive blocks the skaffold command until the caller reads from the returned `PipeReader`. Please use `WaitForLogs` or similar to read continuously from the returned `PipeReader`.

func (*RunBuilder) RunOrFail

func (b *RunBuilder) RunOrFail(t *testing.T)

RunOrFail runs the skaffold command and fails the test if the command returns an error.

func (*RunBuilder) RunOrFailOutput

func (b *RunBuilder) RunOrFailOutput(t *testing.T) []byte

RunOrFailOutput runs the skaffold command and fails the test if the command returns an error. It only returns the standard output.

func (*RunBuilder) RunWithCombinedOutput

func (b *RunBuilder) RunWithCombinedOutput(t *testing.T) ([]byte, error)

RunWithCombinedOutput runs the skaffold command and returns the combined standard output and error.

func (*RunBuilder) RunWithStdoutAndStderrOrFail

func (b *RunBuilder) RunWithStdoutAndStderrOrFail(t *testing.T, stdout, stderr io.Writer)

RunWithStdoutAndStderrOrFail runs the Skaffold command copying the stdout and stderr to the given writers. Fails if there is an error.

func (*RunBuilder) StartWithProcess

func (b *RunBuilder) StartWithProcess(t *testing.T) (*os.Process, error)

StartWithProcess starts the skaffold command and returns the process id and error.

func (*RunBuilder) WithConfig

func (b *RunBuilder) WithConfig(configFile string) *RunBuilder

WithConfig sets the config file to be used by skaffold.

func (*RunBuilder) WithEnv

func (b *RunBuilder) WithEnv(env []string) *RunBuilder

WithEnv sets environment variables.

func (*RunBuilder) WithProfiles

func (b *RunBuilder) WithProfiles(profiles []string) *RunBuilder

WithProfiles sets profiles.

func (*RunBuilder) WithRepo

func (b *RunBuilder) WithRepo(repo string) *RunBuilder

WithRepo sets the default repository to be used by skaffold.

func (*RunBuilder) WithStdin

func (b *RunBuilder) WithStdin(input []byte) *RunBuilder

WithStdin sets the stdin.