providerconfig

Documentation

Index

• Variables
• type CloudProvider
• type Config
  • func GetConfig(r clusterv1alpha1.ProviderSpec) (*Config, error)
• type ConfigVarBool
  • func (configVarBool ConfigVarBool) MarshalJSON() ([]byte, error)
  • func (configVarBool *ConfigVarBool) UnmarshalJSON(b []byte) error
• type ConfigVarResolver
  • func NewConfigVarResolver(ctx context.Context, client ctrlruntimeclient.Client) *ConfigVarResolver
  • func (cvr *ConfigVarResolver) GetConfigVarBoolValue(configVar ConfigVarBool) (bool, error)
  • func (cvr *ConfigVarResolver) GetConfigVarBoolValueOrEnv(configVar ConfigVarBool, envVarName string) (bool, error)
  • func (cvr *ConfigVarResolver) GetConfigVarStringValue(configVar ConfigVarString) (string, error)
  • func (cvr *ConfigVarResolver) GetConfigVarStringValueOrEnv(configVar ConfigVarString, envVarName string) (string, error)
• type ConfigVarString
  • func (configVarString ConfigVarString) MarshalJSON() ([]byte, error)
  • func (configVarString *ConfigVarString) UnmarshalJSON(b []byte) error
• type DNSConfig
• type GlobalConfigMapKeySelector
• type GlobalObjectKeySelector
• type GlobalSecretKeySelector
• type NetworkConfig
• type OperatingSystem

Variables

var (
	ErrOSNotSupported = errors.New("os not supported")
)

Types

type CloudProvider

type CloudProvider string

const (
	CloudProviderAWS          CloudProvider = "aws"
	CloudProviderAzure        CloudProvider = "azure"
	CloudProviderDigitalocean CloudProvider = "digitalocean"
	CloudProviderOpenstack    CloudProvider = "openstack"
	CloudProviderGoogle       CloudProvider = "gce"
	CloudProviderPacket       CloudProvider = "packet"
	CloudProviderHetzner      CloudProvider = "hetzner"
	CloudProviderLinode       CloudProvider = "linode"
	CloudProviderVsphere      CloudProvider = "vsphere"
	CloudProviderFake         CloudProvider = "fake"
	CloudProviderKubeVirt     CloudProvider = "kubevirt"
)

type Config

type Config struct {
	SSHPublicKeys []string `json:"sshPublicKeys"`

	CloudProvider     CloudProvider        `json:"cloudProvider"`
	CloudProviderSpec runtime.RawExtension `json:"cloudProviderSpec"`

	OperatingSystem     OperatingSystem      `json:"operatingSystem"`
	OperatingSystemSpec runtime.RawExtension `json:"operatingSystemSpec"`

	// +optional
	Network *NetworkConfig `json:"network,omitempty"`

	// +optional
	OverwriteCloudConfig *string `json:"overwriteCloudConfig,omitempty"`
}

func GetConfig

func GetConfig(r clusterv1alpha1.ProviderSpec) (*Config, error)

type ConfigVarBool

type ConfigVarBool struct {
	Value           bool                       `json:"value,omitempty"`
	SecretKeyRef    GlobalSecretKeySelector    `json:"secretKeyRef,omitempty"`
	ConfigMapKeyRef GlobalConfigMapKeySelector `json:"configMapKeyRef,omitempty"`
}

func (ConfigVarBool) MarshalJSON

func (configVarBool ConfigVarBool) MarshalJSON() ([]byte, error)

MarshalJSON encodes the configVarBool, omitting empty strings This is done to not have the json object cluttered with empty strings This will eventually hopefully be resolved within golang itself https://github.com/golang/go/issues/11939

func (*ConfigVarBool) UnmarshalJSON

func (configVarBool *ConfigVarBool) UnmarshalJSON(b []byte) error

type ConfigVarResolver

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

func NewConfigVarResolver

func NewConfigVarResolver(ctx context.Context, client ctrlruntimeclient.Client) *ConfigVarResolver

func (*ConfigVarResolver) GetConfigVarBoolValue

func (cvr *ConfigVarResolver) GetConfigVarBoolValue(configVar ConfigVarBool) (bool, error)

func (*ConfigVarResolver) GetConfigVarBoolValueOrEnv

func (cvr *ConfigVarResolver) GetConfigVarBoolValueOrEnv(configVar ConfigVarBool, envVarName string) (bool, error)

func (*ConfigVarResolver) GetConfigVarStringValue

func (cvr *ConfigVarResolver) GetConfigVarStringValue(configVar ConfigVarString) (string, error)

func (*ConfigVarResolver) GetConfigVarStringValueOrEnv

func (cvr *ConfigVarResolver) GetConfigVarStringValueOrEnv(configVar ConfigVarString, envVarName string) (string, error)

GetConfigVarStringValueOrEnv tries to get the value from ConfigVarString, when it fails, it falls back to getting the value from an environment variable specified by envVarName parameter

type ConfigVarString

type ConfigVarString struct {
	Value           string                     `json:"value,omitempty"`
	SecretKeyRef    GlobalSecretKeySelector    `json:"secretKeyRef,omitempty"`
	ConfigMapKeyRef GlobalConfigMapKeySelector `json:"configMapKeyRef,omitempty"`
}

func (ConfigVarString) MarshalJSON

func (configVarString ConfigVarString) MarshalJSON() ([]byte, error)

MarshalJSON converts a configVarString to its JSON form, ompitting empty strings. This is done to not have the json object cluttered with empty strings This will eventually hopefully be resolved within golang itself https://github.com/golang/go/issues/11939

func (*ConfigVarString) UnmarshalJSON

func (configVarString *ConfigVarString) UnmarshalJSON(b []byte) error

type DNSConfig

type DNSConfig struct {
	Servers []string `json:"servers"`
}

DNSConfig contains a machine's DNS configuration

type GlobalConfigMapKeySelector

type GlobalConfigMapKeySelector GlobalObjectKeySelector

type GlobalObjectKeySelector

type GlobalObjectKeySelector struct {
	corev1.ObjectReference `json:",inline"`
	Key                    string `json:"key,omitempty"`
}

GlobalObjectKeySelector is needed as we can not use v1.SecretKeySelector because it is not cross namespace

type GlobalSecretKeySelector

type GlobalSecretKeySelector GlobalObjectKeySelector

type NetworkConfig

type NetworkConfig struct {
	CIDR    string    `json:"cidr"`
	Gateway string    `json:"gateway"`
	DNS     DNSConfig `json:"dns"`
}

NetworkConfig contains a machine's static network configuration

type OperatingSystem

type OperatingSystem string

const (
	OperatingSystemCoreos OperatingSystem = "coreos"
	OperatingSystemUbuntu OperatingSystem = "ubuntu"
	OperatingSystemCentOS OperatingSystem = "centos"
)