initializer

Documentation

Index

• Constants
• func DoInit(out io.Writer, c Config) error
• func IsSkaffoldConfig(file string) bool
• func IsSupportedKubernetesFileExtension(n string) bool
• type Config
• type InitBuilder
• type Initializer

Constants

const NoBuilder = "None (image not built from these sources)"

NoBuilder allows users to specify they don't want to build an image we parse out from a kubernetes manifest

Functions

func DoInit

func DoInit(out io.Writer, c Config) error

DoInit executes the `skaffold init` flow.

func IsSkaffoldConfig

func IsSkaffoldConfig(file string) bool

IsSkaffoldConfig is for determining if a file is skaffold config file.

func IsSupportedKubernetesFileExtension

func IsSupportedKubernetesFileExtension(n string) bool

IsSupportedKubernetesFileExtension is for determining if a file under a glob pattern is deployable file format. It makes no attempt to check whether or not the file is actually deployable or has the correct contents.

Types

type Config

type Config struct {
	ComposeFile   string
	CliArtifacts  []string
	SkipBuild     bool
	Force         bool
	Analyze       bool
	EnableJibInit bool // TODO: Remove this parameter
	Opts          *config.SkaffoldOptions
}

Config defines the Initializer Config for Init API of skaffold.

type InitBuilder

type InitBuilder interface {
	// Name returns the name of the builder
	Name() string
	// Describe returns the initBuilder's string representation, used when prompting the user to choose a builder.
	// Must be unique between artifacts.
	Describe() string
	// CreateArtifact creates an Artifact to be included in the generated Build Config
	CreateArtifact(image string) *latest.Artifact
	// ConfiguredImage returns the target image configured by the builder, or an empty string if no image is configured.
	// This should be a cheap operation.
	ConfiguredImage() string
	// Path returns the path to the build file
	Path() string
}

InitBuilder represents a builder that can be chosen by skaffold init.

type Initializer

type Initializer interface {
	// GenerateDeployConfig generates Deploy Config for skaffold configuration.
	GenerateDeployConfig() latest.DeployConfig
	// GetImages fetches all the images defined in the manifest files.
	GetImages() []string
}

Initializer is the Init API of skaffold and responsible for generating skaffold configuration file.