v1alpha2

Documentation

Index

• Constants
• Variables
• func GetConfigByKind(kind string) (configtypes.Config, error)
• type ClusterConfig
  • func (c ClusterConfig) GetAPIVersion() string
  • func (c ClusterConfig) GetKind() string
• type ClusterListConfig
  • func (c ClusterListConfig) GetAPIVersion() string
  • func (c ClusterListConfig) GetKind() string
• type EnvVarWithNodeFilters
• type LabelWithNodeFilters
• type PortWithNodeFilters
• type SimpleConfig
  • func (c SimpleConfig) GetAPIVersion() string
  • func (c SimpleConfig) GetKind() string
• type SimpleConfigOptions
• type SimpleConfigOptionsK3d
• type SimpleConfigOptionsK3s
• type SimpleConfigOptionsKubeconfig
• type SimpleConfigOptionsRuntime
• type SimpleExposureOpts
• type VolumeWithNodeFilters

Constants

const ApiVersion = "k3d.io/v1alpha2"

const DefaultConfigTpl = `---
apiVersion: %s
kind: Simple
name: %s
servers: 1
agents: 0
image: %s
`

DefaultConfigTpl for printing

Variables

var DefaultConfig = fmt.Sprintf(
	DefaultConfigTpl,
	ApiVersion,
	k3d.DefaultClusterName,
	fmt.Sprintf("%s:%s", k3d.DefaultK3sImageRepo, version.K3sVersion),
)

DefaultConfig templated DefaultConfigTpl

var JSONSchema string

JSONSchema describes the schema used to validate config files

Functions

func GetConfigByKind

func GetConfigByKind(kind string) (configtypes.Config, error)

Types

type ClusterConfig

type ClusterConfig struct {
	configtypes.TypeMeta `mapstructure:",squash" yaml:",inline"`
	Cluster              k3d.Cluster                   `mapstructure:",squash" yaml:",inline"`
	ClusterCreateOpts    k3d.ClusterCreateOpts         `mapstructure:"options" yaml:"options"`
	KubeconfigOpts       SimpleConfigOptionsKubeconfig `mapstructure:"kubeconfig" yaml:"kubeconfig"`
}

ClusterConfig describes a single cluster config

func (ClusterConfig) GetAPIVersion

func (c ClusterConfig) GetAPIVersion() string

func (ClusterConfig) GetKind

func (c ClusterConfig) GetKind() string

Kind implements Config.Kind

type ClusterListConfig

type ClusterListConfig struct {
	configtypes.TypeMeta `mapstructure:",squash" yaml:",inline"`
	Clusters             []k3d.Cluster `mapstructure:"clusters" yaml:"clusters"`
}

ClusterListConfig describes a list of clusters

func (ClusterListConfig) GetAPIVersion

func (c ClusterListConfig) GetAPIVersion() string

func (ClusterListConfig) GetKind

func (c ClusterListConfig) GetKind() string

type EnvVarWithNodeFilters

type EnvVarWithNodeFilters struct {
	EnvVar      string   `mapstructure:"envVar" yaml:"envVar,omitempty" json:"envVar,omitempty"`
	NodeFilters []string `mapstructure:"nodeFilters" yaml:"nodeFilters,omitempty" json:"nodeFilters,omitempty"`
}

type LabelWithNodeFilters

type LabelWithNodeFilters struct {
	Label       string   `mapstructure:"label" yaml:"label,omitempty" json:"label,omitempty"`
	NodeFilters []string `mapstructure:"nodeFilters" yaml:"nodeFilters,omitempty" json:"nodeFilters,omitempty"`
}

type PortWithNodeFilters

type PortWithNodeFilters struct {
	Port        string   `mapstructure:"port" yaml:"port,omitempty" json:"port,omitempty"`
	NodeFilters []string `mapstructure:"nodeFilters" yaml:"nodeFilters,omitempty" json:"nodeFilters,omitempty"`
}

type SimpleConfig

type SimpleConfig struct {
	configtypes.TypeMeta `mapstructure:",squash" yaml:",inline"`
	Name                 string                  `mapstructure:"name" yaml:"name,omitempty" json:"name,omitempty"`
	Servers              int                     `mapstructure:"servers" yaml:"servers,omitempty" json:"servers,omitempty"` //nolint:lll    // default 1
	Agents               int                     `mapstructure:"agents" yaml:"agents,omitempty" json:"agents,omitempty"`    //nolint:lll    // default 0
	ExposeAPI            SimpleExposureOpts      `mapstructure:"kubeAPI" yaml:"kubeAPI,omitempty" json:"kubeAPI,omitempty"`
	Image                string                  `mapstructure:"image" yaml:"image,omitempty" json:"image,omitempty"`
	Network              string                  `mapstructure:"network" yaml:"network,omitempty" json:"network,omitempty"`
	Subnet               string                  `mapstructure:"subnet" yaml:"subnet,omitempty" json:"subnet,omitempty"`
	ClusterToken         string                  `mapstructure:"token" yaml:"clusterToken,omitempty" json:"clusterToken,omitempty"` // default: auto-generated
	Volumes              []VolumeWithNodeFilters `mapstructure:"volumes" yaml:"volumes,omitempty" json:"volumes,omitempty"`
	Ports                []PortWithNodeFilters   `mapstructure:"ports" yaml:"ports,omitempty" json:"ports,omitempty"`
	Labels               []LabelWithNodeFilters  `mapstructure:"labels" yaml:"labels,omitempty" json:"labels,omitempty"`
	Options              SimpleConfigOptions     `mapstructure:"options" yaml:"options,omitempty" json:"options,omitempty"`
	Env                  []EnvVarWithNodeFilters `mapstructure:"env" yaml:"env,omitempty" json:"env,omitempty"`
	Registries           struct {
		Use    []string `mapstructure:"use" yaml:"use,omitempty" json:"use,omitempty"`
		Create bool     `mapstructure:"create" yaml:"create,omitempty" json:"create,omitempty"`
		Config string   `mapstructure:"config" yaml:"config,omitempty" json:"config,omitempty"` // registries.yaml (k3s config for containerd registry override)
	} `mapstructure:"registries" yaml:"registries,omitempty" json:"registries,omitempty"`
}

SimpleConfig describes the toplevel k3d configuration file.

func (SimpleConfig) GetAPIVersion

func (c SimpleConfig) GetAPIVersion() string

func (SimpleConfig) GetKind

func (c SimpleConfig) GetKind() string

Kind implements Config.Kind

type SimpleConfigOptions

type SimpleConfigOptions struct {
	K3dOptions        SimpleConfigOptionsK3d        `mapstructure:"k3d" yaml:"k3d" json:"k3d"`
	K3sOptions        SimpleConfigOptionsK3s        `mapstructure:"k3s" yaml:"k3s" json:"k3s"`
	KubeconfigOptions SimpleConfigOptionsKubeconfig `mapstructure:"kubeconfig" yaml:"kubeconfig" json:"kubeconfig"`
	Runtime           SimpleConfigOptionsRuntime    `mapstructure:"runtime" yaml:"runtime" json:"runtime"`
}

type SimpleConfigOptionsK3d

type SimpleConfigOptionsK3d struct {
	Wait                       bool                 `mapstructure:"wait" yaml:"wait" json:"wait"`
	Timeout                    time.Duration        `mapstructure:"timeout" yaml:"timeout,omitempty" json:"timeout,omitempty"`
	DisableLoadbalancer        bool                 `mapstructure:"disableLoadbalancer" yaml:"disableLoadbalancer" json:"disableLoadbalancer"`
	DisableImageVolume         bool                 `mapstructure:"disableImageVolume" yaml:"disableImageVolume" json:"disableImageVolume"`
	NoRollback                 bool                 `mapstructure:"disableRollback" yaml:"disableRollback" json:"disableRollback"`
	PrepDisableHostIPInjection bool                 `mapstructure:"disableHostIPInjection" json:"disableHostIPInjection"`
	NodeHookActions            []k3d.NodeHookAction `mapstructure:"nodeHookActions" yaml:"nodeHookActions,omitempty" json:"nodeHookActions,omitempty"`
}

type SimpleConfigOptionsK3s

type SimpleConfigOptionsK3s struct {
	ExtraServerArgs []string `mapstructure:"extraServerArgs,omitempty" yaml:"extraServerArgs,omitempty" json:"extraServerArgs,omitempty"`
	ExtraAgentArgs  []string `mapstructure:"extraAgentArgs,omitempty" yaml:"extraAgentArgs,omitempty" json:"extraAgentArgs,omitempty"`
}

type SimpleConfigOptionsKubeconfig

type SimpleConfigOptionsKubeconfig struct {
	UpdateDefaultKubeconfig bool `mapstructure:"updateDefaultKubeconfig" yaml:"updateDefaultKubeconfig" json:"updateDefaultKubeconfig,omitempty"` // default: true
	SwitchCurrentContext    bool `mapstructure:"switchCurrentContext" yaml:"switchCurrentContext" json:"switchCurrentContext,omitempty"`          //nolint:lll    // default: true
}

SimpleConfigOptionsKubeconfig describes the set of options referring to the kubeconfig during cluster creation.

type SimpleConfigOptionsRuntime

type SimpleConfigOptionsRuntime struct {
	GPURequest    string `mapstructure:"gpuRequest,omitempty" yaml:"gpuRequest,omitempty" json:"gpuRequest,omitempty"`
	ServersMemory string `mapstructure:"serversMemory,omitempty" yaml:"serversMemory,omitempty" json:"serversMemory,omitempty"`
	AgentsMemory  string `mapstructure:"agentsMemory,omitempty" yaml:"agentsMemory,omitempty" json:"agentsMemory,omitempty"`
}

type SimpleExposureOpts

type SimpleExposureOpts struct {
	Host     string `mapstructure:"host" yaml:"host,omitempty" json:"host,omitempty"`
	HostIP   string `mapstructure:"hostIP" yaml:"hostIP,omitempty" json:"hostIP,omitempty"`
	HostPort string `mapstructure:"hostPort" yaml:"hostPort,omitempty" json:"hostPort,omitempty"`
}

SimpleExposureOpts provides a simplified syntax compared to the original k3d.ExposureOpts

type VolumeWithNodeFilters

type VolumeWithNodeFilters struct {
	Volume      string   `mapstructure:"volume" yaml:"volume,omitempty" json:"volume,omitempty"`
	NodeFilters []string `mapstructure:"nodeFilters" yaml:"nodeFilters,omitempty" json:"nodeFilters,omitempty"`
}