common

Documentation

Index

• func ClusterProvisioner(name string) (interface{}, error)
• func RegisterClusterProvisioner(name string, provisioner interface{})
• type ClusterStatusError
• type MachineDeploymentStrategyType
• type MachineRole
• type MachineSetStatusError
• type MachineStatusError

Functions

func ClusterProvisioner

func ClusterProvisioner(name string) (interface{}, error)

func RegisterClusterProvisioner

func RegisterClusterProvisioner(name string, provisioner interface{})

RegisterClusterProvisioner registers a ClusterProvisioner by name. This is expected to happen during app startup.

Types

type ClusterStatusError

type ClusterStatusError string

const (
	// InvalidConfigurationClusterError indicates that the cluster
	// configuration is invalid.
	InvalidConfigurationClusterError ClusterStatusError = "InvalidConfiguration"

	// UnsupportedChangeClusterError indicates that the cluster
	// spec has been updated in an unsupported way. That cannot be
	// reconciled.
	UnsupportedChangeClusterError ClusterStatusError = "UnsupportedChange"

	// CreateClusterError indicates that an error was encountered
	// when trying to create the cluster.
	CreateClusterError ClusterStatusError = "CreateError"

	// UpdateClusterError indicates that an error was encountered
	// when trying to update the cluster.
	UpdateClusterError ClusterStatusError = "UpdateError"

	// DeleteClusterError indicates that an error was encountered
	// when trying to delete the cluster.
	DeleteClusterError ClusterStatusError = "DeleteError"
)

type MachineDeploymentStrategyType

type MachineDeploymentStrategyType string

const (
	// Replace the old MachineSet by new one using rolling update
	// i.e gradually scale down the old MachineSet and scale up the new one.
	RollingUpdateMachineDeploymentStrategyType MachineDeploymentStrategyType = "RollingUpdate"
)

type MachineRole

type MachineRole string

The MachineRole indicates the purpose of the Machine, and will determine what software and configuration will be used when provisioning and managing the Machine. A single Machine may have more than one role, and the list and definitions of supported roles is expected to evolve over time.

Currently, only two roles are supported: Master and Node. In the future, we expect user needs to drive the evolution and granularity of these roles, with new additions accommodating common cluster patterns, like dedicated etcd Machines.

+-----------------------+------------------------+
| Master present        | Master absent          |

+---------------+-----------------------+------------------------| | Node present: | Install control plane | Join the cluster as | | | and be schedulable | just a node | |---------------+-----------------------+------------------------| | Node absent: | Install control plane | Invalid configuration | | | and be unscheduleable | | +---------------+-----------------------+------------------------+

const (
	MasterRole MachineRole = "Master"
	NodeRole   MachineRole = "Node"
)

type MachineSetStatusError

type MachineSetStatusError string

const (
	// Represents that the combination of configuration in the MachineTemplateSpec
	// is not supported by this cluster. This is not a transient error, but
	// indicates a state that must be fixed before progress can be made.
	//
	// Example: the ProviderConfig specifies an instance type that doesn't exist.
	InvalidConfigurationMachineSetError MachineSetStatusError = "InvalidConfiguration"
)

type MachineStatusError

type MachineStatusError string

Constants aren't automatically generated for unversioned packages. Instead share the same constant for all versioned packages

const (
	// Represents that the combination of configuration in the MachineSpec
	// is not supported by this cluster. This is not a transient error, but
	// indicates a state that must be fixed before progress can be made.
	//
	// Example: the ProviderConfig specifies an instance type that doesn't exist,
	InvalidConfigurationMachineError MachineStatusError = "InvalidConfiguration"

	// This indicates that the MachineSpec has been updated in a way that
	// is not supported for reconciliation on this cluster. The spec may be
	// completely valid from a configuration standpoint, but the controller
	// does not support changing the real world state to match the new
	// spec.
	//
	// Example: the responsible controller is not capable of changing the
	// container runtime from docker to rkt.
	UnsupportedChangeMachineError MachineStatusError = "UnsupportedChange"

	// This generally refers to exceeding one's quota in a cloud provider,
	// or running out of physical machines in an on-premise environment.
	InsufficientResourcesMachineError MachineStatusError = "InsufficientResources"

	// There was an error while trying to create a Node to match this
	// Machine. This may indicate a transient problem that will be fixed
	// automatically with time, such as a service outage, or a terminal
	// error during creation that doesn't match a more specific
	// MachineStatusError value.
	//
	// Example: timeout trying to connect to GCE.
	CreateMachineError MachineStatusError = "CreateError"

	// An error was encountered while trying to delete the Node that this
	// Machine represents. This could be a transient or terminal error, but
	// will only be observable if the provider's Machine controller has
	// added a finalizer to the object to more gracefully handle deletions.
	//
	// Example: cannot resolve EC2 IP address.
	DeleteMachineError MachineStatusError = "DeleteError"
)