v1alpha1

Documentation

Index

• Constants
• func NewSkaffoldPipeline() util.VersionedConfig
• type Artifact
• type BuildConfig
• type BuildType
• type DeployConfig
• type DeployType
• type GoogleCloudBuild
• type HelmDeploy
• type HelmRelease
• type KubectlDeploy
• type LocalBuild
• type Manifest
• type SkaffoldPipeline
  • func (config *SkaffoldPipeline) GetVersion() string
  • func (config *SkaffoldPipeline) Parse(contents []byte, useDefault bool) error
  • func (config *SkaffoldPipeline) Upgrade() (util.VersionedConfig, error)

Constants

const Version string = "skaffold/v1alpha1"

Functions

func NewSkaffoldPipeline

func NewSkaffoldPipeline() util.VersionedConfig

NewSkaffoldPipeline creates a SkaffoldPipeline

Types

type Artifact

type Artifact struct {
	ImageName      string             `yaml:"imageName"`
	DockerfilePath string             `yaml:"dockerfilePath,omitempty"`
	Workspace      string             `yaml:"workspace"`
	BuildArgs      map[string]*string `yaml:"buildArgs,omitempty"`
}

Artifact represents items that need should be built, along with the context in which they should be built.

type BuildConfig

type BuildConfig struct {
	Artifacts []*Artifact `yaml:"artifacts"`
	TagPolicy string      `yaml:"tagPolicy,omitempty"`
	BuildType `yaml:",inline"`
}

BuildConfig contains all the configuration for the build steps

type BuildType

type BuildType struct {
	LocalBuild       *LocalBuild       `yaml:"local,omitempty"`
	GoogleCloudBuild *GoogleCloudBuild `yaml:"googleCloudBuild,omitempty"`
}

BuildType contains the specific implementation and parameters needed for the build step. Only one field should be populated.

type DeployConfig

type DeployConfig struct {
	Name       string `yaml:"name,omitempty"`
	DeployType `yaml:",inline"`
}

DeployConfig contains all the configuration needed by the deploy steps

type DeployType

type DeployType struct {
	HelmDeploy    *HelmDeploy    `yaml:"helm,omitempty"`
	KubectlDeploy *KubectlDeploy `yaml:"kubectl,omitempty"`
}

DeployType contains the specific implementation and parameters needed for the deploy step. Only one field should be populated.

type GoogleCloudBuild

type GoogleCloudBuild struct {
	ProjectID string `yaml:"projectId"`
}

type HelmDeploy

type HelmDeploy struct {
	Releases []HelmRelease `yaml:"releases"`
}

type HelmRelease

type HelmRelease struct {
	Name           string            `yaml:"name"`
	ChartPath      string            `yaml:"chartPath"`
	ValuesFilePath string            `yaml:"valuesFilePath"`
	Values         map[string]string `yaml:"values"`
	Namespace      string            `yaml:"namespace"`
	Version        string            `yaml:"version"`
}

type KubectlDeploy

type KubectlDeploy struct {
	Manifests []Manifest `yaml:"manifests"`
}

KubectlDeploy contains the configuration needed for deploying with `kubectl apply`

type LocalBuild

type LocalBuild struct {
	SkipPush *bool `yaml:"skipPush,omitempty"`
}

LocalBuild contains the fields needed to do a build on the local docker daemon and optionally push to a repository.

type Manifest

type Manifest struct {
	Paths      []string          `yaml:"paths"`
	Parameters map[string]string `yaml:"parameters,omitempty"`
}

type SkaffoldPipeline

type SkaffoldPipeline struct {
	APIVersion string `yaml:"apiVersion"`
	Kind       string `yaml:"kind"`

	Build  BuildConfig  `yaml:"build"`
	Deploy DeployConfig `yaml:"deploy"`
}

SkaffoldPipeline is the top level config object that is parsed from a skaffold.yaml

func (*SkaffoldPipeline) GetVersion

func (config *SkaffoldPipeline) GetVersion() string

func (*SkaffoldPipeline) Parse

func (config *SkaffoldPipeline) Parse(contents []byte, useDefault bool) error

Parse reads from an io.Reader and unmarshals the result into a SkaffoldPipeline. The default config argument provides default values for the config, which can be overridden if present in the config file.

func (*SkaffoldPipeline) Upgrade

func (config *SkaffoldPipeline) Upgrade() (util.VersionedConfig, error)

Upgrade upgrades a configuration to the next version.