config

Documentation

Index

• Variables
• func GetDefaultRepo(configFile, cliValue string) (string, error)
• func GetInsecureRegistries(configFile string) ([]string, error)
• func GetLocalCluster(configFile string) (bool, error)
• func IsKindCluster(kubeContext string) (bool, string)
• func IsUpdateCheckEnabled(configfile string) bool
• func ResolveConfigFile(configFile string) (string, error)
• type ContextConfig
• type GlobalConfig
  • func ReadConfigFileNoCache(configFile string) (*GlobalConfig, error)
• type PortForwardOptions
• type SkaffoldOptions
  • func (opts *SkaffoldOptions) IsTargetImage(artifact *latest.Artifact) bool
  • func (opts *SkaffoldOptions) Labels() map[string]string
  • func (opts *SkaffoldOptions) Prune() bool

Variables

var (
	ReadConfigFile             = readConfigFileCached
	GetConfigForCurrentKubectx = getConfigForCurrentKubectx
)

Functions

func GetDefaultRepo

func GetDefaultRepo(configFile, cliValue string) (string, error)

func GetInsecureRegistries

func GetInsecureRegistries(configFile string) ([]string, error)

func GetLocalCluster

func GetLocalCluster(configFile string) (bool, error)

func IsKindCluster

func IsKindCluster(kubeContext string) (bool, string)

IsKindCluster checks that the given `kubeContext` is talking to `kind`. It also returns the name of the `kind` cluster.

func IsUpdateCheckEnabled

func IsUpdateCheckEnabled(configfile string) bool

func ResolveConfigFile

func ResolveConfigFile(configFile string) (string, error)

ResolveConfigFile determines the default config location, if the configFile argument is empty.

Types

type ContextConfig

type ContextConfig struct {
	Kubecontext        string   `yaml:"kube-context,omitempty"`
	DefaultRepo        string   `yaml:"default-repo,omitempty"`
	LocalCluster       *bool    `yaml:"local-cluster,omitempty"`
	InsecureRegistries []string `yaml:"insecure-registries,omitempty"`
	UpdateCheck        *bool    `yaml:"update-check,omitempty"`
}

ContextConfig is the context-specific config information provided in the global Skaffold config.

type GlobalConfig

type GlobalConfig struct {
	Global         *ContextConfig   `yaml:"global,omitempty"`
	ContextConfigs []*ContextConfig `yaml:"kubeContexts"`
}

GlobalConfig is the top level struct for the global Skaffold config It is unrelated to the SkaffoldConfig object (parsed from the skaffold.yaml)

func ReadConfigFileNoCache

func ReadConfigFileNoCache(configFile string) (*GlobalConfig, error)

ReadConfigFileNoCache reads the given config yaml file and unmarshals the contents. Only visible for testing, use ReadConfigFile instead.

type PortForwardOptions

type PortForwardOptions struct {
	Enabled     bool
	ForwardPods bool
}

PortForwardOptions are options set by the command line for port forwarding with additional configuration information as well

type SkaffoldOptions

type SkaffoldOptions struct {
	ConfigurationFile  string
	GlobalConfig       string
	Cleanup            bool
	Notification       bool
	Tail               bool
	TailDev            bool
	SkipTests          bool
	CacheArtifacts     bool
	EnableRPC          bool
	Force              bool
	NoPrune            bool
	NoPruneChildren    bool
	StatusCheck        bool
	AutoBuild          bool
	AutoSync           bool
	AutoDeploy         bool
	RenderOnly         bool
	PortForward        PortForwardOptions
	CustomTag          string
	Namespace          string
	CacheFile          string
	Trigger            string
	KubeContext        string
	KubeConfig         string
	WatchPollInterval  int
	DefaultRepo        string
	CustomLabels       []string
	TargetImages       []string
	Profiles           []string
	InsecureRegistries []string
	Command            string
	RPCPort            int
	RPCHTTPPort        int
}

SkaffoldOptions are options that are set by command line arguments not included in the config file itself

func (*SkaffoldOptions) IsTargetImage

func (opts *SkaffoldOptions) IsTargetImage(artifact *latest.Artifact) bool

func (*SkaffoldOptions) Labels

func (opts *SkaffoldOptions) Labels() map[string]string

Labels returns a map of labels to be applied to all deployed k8s objects during the duration of the run

func (*SkaffoldOptions) Prune

func (opts *SkaffoldOptions) Prune() bool

Prune returns true iff the user did NOT specify the --no-prune flag, and the user did NOT specify the --cache-artifacts flag.