v1

Documentation

Overview

Copyright 2021 The Skaffold Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type SkaffoldRunner
  • func NewForConfig(ctx context.Context, runCtx *runcontext.RunContext) (*SkaffoldRunner, error)
  • func (r *SkaffoldRunner) Apply(ctx context.Context, out io.Writer) error
  • func (r *SkaffoldRunner) Cleanup(ctx context.Context, out io.Writer, dryRun bool) error
  • func (r *SkaffoldRunner) Deploy(ctx context.Context, out io.Writer, artifacts []graph.Artifact) error
  • func (r *SkaffoldRunner) DeployAndLog(ctx context.Context, out io.Writer, artifacts []graph.Artifact) error
  • func (r *SkaffoldRunner) Dev(ctx context.Context, out io.Writer, artifacts []*latestV1.Artifact) error
  • func (r *SkaffoldRunner) GeneratePipeline(ctx context.Context, out io.Writer, configs []util.VersionedConfig, ...) error
  • func (r *SkaffoldRunner) HasDeployed() bool
  • func (r *SkaffoldRunner) Render(ctx context.Context, out io.Writer, builds []graph.Artifact, offline bool, ...) error
  • func (r *SkaffoldRunner) Test(ctx context.Context, out io.Writer, artifacts []graph.Artifact) error

Types

type SkaffoldRunner

type SkaffoldRunner struct {
	runner.Builder
	runner.Pruner
	// contains filtered or unexported fields
}

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

func NewForConfig

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

NewForConfig returns a new SkaffoldRunner for a SkaffoldConfig

func (*SkaffoldRunner) Apply

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

Apply sends Kubernetes manifests to the cluster.

func (*SkaffoldRunner) Cleanup

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

func (*SkaffoldRunner) Deploy

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

func (*SkaffoldRunner) DeployAndLog

func (r *SkaffoldRunner) DeployAndLog(ctx context.Context, out io.Writer, artifacts []graph.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 []*latestV1.Artifact) error

Dev watches for changes and runs the skaffold build, test and deploy config until interrupted by the user.

func (*SkaffoldRunner) GeneratePipeline

func (r *SkaffoldRunner) GeneratePipeline(ctx context.Context, out io.Writer, configs []util.VersionedConfig, configPaths []string, fileOut string) error

func (*SkaffoldRunner) HasDeployed

func (r *SkaffoldRunner) HasDeployed() bool

HasDeployed returns true if this runner has deployed something.

func (*SkaffoldRunner) Render

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

func (*SkaffoldRunner) Test

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