config

Documentation

Index

• Variables
• func GetDefaultRepo(configFile string, cliValue *string) (string, error)
• func GetInsecureRegistries(configFile string) ([]string, error)
• func GetLocalCluster(configFile string, minikubeProfile string) (bool, error)
• func IsKindCluster(kubeContext string) (bool, string)
• func IsUpdateCheckEnabled(configfile string) bool
• func ResolveConfigFile(configFile string) (string, error)
• func ShouldDisplayPrompt(configfile string) bool
• func UpdateGlobalSurveyTaken(configFile string) error
• func WriteFullConfig(configFile string, cfg *GlobalConfig) error
• type ContextConfig
• type GlobalConfig
  • func ReadConfigFileNoCache(configFile string) (*GlobalConfig, error)
• type PortForwardOptions
• type SkaffoldOptions
  • func (opts *SkaffoldOptions) IsDebugMode() bool
  • func (opts *SkaffoldOptions) IsDevMode() bool
  • func (opts *SkaffoldOptions) IsTargetImage(artifact *latest.Artifact) bool
  • func (opts *SkaffoldOptions) Prune() bool
• type StringOrUndefined
  • func (s *StringOrUndefined) Set(v string) error
  • func (s *StringOrUndefined) String() string
  • func (s *StringOrUndefined) Type() string
  • func (s *StringOrUndefined) Value() *string
• type SurveyConfig

Variables

var (
	ReadConfigFile             = readConfigFileCached
	GetConfigForCurrentKubectx = getConfigForCurrentKubectx
)

Functions

func GetDefaultRepo

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

func GetInsecureRegistries

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

func GetLocalCluster

func GetLocalCluster(configFile string, minikubeProfile 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.

func ShouldDisplayPrompt

func ShouldDisplayPrompt(configfile string) bool

func UpdateGlobalSurveyTaken

func UpdateGlobalSurveyTaken(configFile string) error

func WriteFullConfig

func WriteFullConfig(configFile string, cfg *GlobalConfig) error

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"`
	Survey             *SurveyConfig `yaml:"survey,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
	ProfileAutoActivation bool
	DryRun                bool
	PortForward           PortForwardOptions
	CustomTag             string
	Namespace             string
	CacheFile             string
	Trigger               string
	KubeContext           string
	KubeConfig            string
	WatchPollInterval     int
	DefaultRepo           StringOrUndefined
	CustomLabels          []string
	TargetImages          []string
	Profiles              []string
	InsecureRegistries    []string
	Command               string
	RPCPort               int
	RPCHTTPPort           int

	// TODO(https://github.com/GoogleContainerTools/skaffold/issues/3668):
	// remove minikubeProfile from here and instead detect it by matching the
	// kubecontext API Server to minikube profiles
	MinikubeProfile string
}

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

func (*SkaffoldOptions) IsDebugMode

func (opts *SkaffoldOptions) IsDebugMode() bool

func (*SkaffoldOptions) IsDevMode

func (opts *SkaffoldOptions) IsDevMode() bool

func (*SkaffoldOptions) IsTargetImage

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

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.

type StringOrUndefined

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

StringOrUndefined holds the value of a flag of type `string`, that's by default `undefined`. We use this instead of just `string` to differentiate `undefined` and `empty string` values.

func (*StringOrUndefined) Set

func (s *StringOrUndefined) Set(v string) error

func (*StringOrUndefined) String

func (s *StringOrUndefined) String() string

func (*StringOrUndefined) Type

func (s *StringOrUndefined) Type() string

func (*StringOrUndefined) Value

func (s *StringOrUndefined) Value() *string

type SurveyConfig

type SurveyConfig struct {
	DisablePrompt *bool  `yaml:"disable-prompt,omitempty"`
	LastTaken     string `yaml:"last-taken,omitempty"`
	LastPrompted  string `yaml:"last-prompted,omitempty"`
}

SurveyConfig is the survey config information