errors

package
Version: v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 6, 2021 License: Apache-2.0 Imports: 1 Imported by: 104

Documentation

Overview

Package errors makes a set of error message handlers available for use by Cluster API Providers.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClusterError

type ClusterError struct {
	Reason  ClusterStatusError
	Message string
}

ClusterError is a more descriptive kind of error that represents an error condition that should be set in the Cluster.Status. The "Reason" field is meant for short, enum-style constants meant to be interpreted by clusters. The "Message" field is meant to be read by humans.

func CreateCluster

func CreateCluster(format string, args ...interface{}) *ClusterError

CreateCluster creates a new error for when creating a cluster.

func DeleteCluster

func DeleteCluster(format string, args ...interface{}) *ClusterError

DeleteCluster creates a new error for when deleting a cluster.

func InvalidClusterConfiguration

func InvalidClusterConfiguration(format string, args ...interface{}) *ClusterError

InvalidClusterConfiguration creates a new error for when the cluster configuration is invalid.

func (*ClusterError) Error

func (e *ClusterError) Error() string

type ClusterStatusError

type ClusterStatusError string

ClusterStatusError defines errors states for Cluster objects.

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"
)

func ClusterStatusErrorPtr

func ClusterStatusErrorPtr(v ClusterStatusError) *ClusterStatusError

ClusterStatusErrorPtr converts a MachineStatusError to a pointer.

type KubeadmControlPlaneError added in v0.3.0

type KubeadmControlPlaneError struct {
	Reason  KubeadmControlPlaneStatusError
	Message string
}

KubeadmControlPlaneError is a more descriptive kind of error that represents an error condition that should be set in the KubeadmControlPlane.Status. The "Reason" field is meant for short, enum-style constants meant to be interpreted by control planes. The "Message" field is meant to be read by humans.

func (*KubeadmControlPlaneError) Error added in v0.3.0

func (e *KubeadmControlPlaneError) Error() string

Error satisfies the error interface.

type KubeadmControlPlaneStatusError added in v0.3.0

type KubeadmControlPlaneStatusError string

KubeadmControlPlaneStatusError defines errors states for KubeadmControlPlane objects.

const (
	// InvalidConfigurationKubeadmControlPlaneError indicates that the kubeadm control plane
	// configuration is invalid.
	InvalidConfigurationKubeadmControlPlaneError KubeadmControlPlaneStatusError = "InvalidConfiguration"

	// UnsupportedChangeKubeadmControlPlaneError indicates that the kubeadm control plane
	// spec has been updated in an unsupported way that cannot be
	// reconciled.
	UnsupportedChangeKubeadmControlPlaneError KubeadmControlPlaneStatusError = "UnsupportedChange"

	// CreateKubeadmControlPlaneError indicates that an error was encountered
	// when trying to create the kubeadm control plane.
	CreateKubeadmControlPlaneError KubeadmControlPlaneStatusError = "CreateError"

	// UpdateKubeadmControlPlaneError indicates that an error was encountered
	// when trying to update the kubeadm control plane.
	UpdateKubeadmControlPlaneError KubeadmControlPlaneStatusError = "UpdateError"

	// DeleteKubeadmControlPlaneError indicates that an error was encountered
	// when trying to delete the kubeadm control plane.
	DeleteKubeadmControlPlaneError KubeadmControlPlaneStatusError = "DeleteError"
)

type MachineError

type MachineError struct {
	Reason  MachineStatusError
	Message string
}

MachineError is a more descriptive kind of error that represents an error condition that should be set in the Machine.Status. The "Reason" field is meant for short, enum-style constants meant to be interpreted by machines. The "Message" field is meant to be read by humans.

func CreateMachine

func CreateMachine(msg string, args ...interface{}) *MachineError

CreateMachine creates a new error for when creating a Machine.

func DeleteMachine

func DeleteMachine(msg string, args ...interface{}) *MachineError

DeleteMachine creates a new error for when deleting a Machine.

func InvalidMachineConfiguration

func InvalidMachineConfiguration(msg string, args ...interface{}) *MachineError

InvalidMachineConfiguration creates a new error when a Machine has invalid configuration.

func UpdateMachine

func UpdateMachine(msg string, args ...interface{}) *MachineError

UpdateMachine creates a new error for when updating a Machine.

func (*MachineError) Error

func (e *MachineError) Error() string

type MachinePoolStatusFailure added in v0.3.0

type MachinePoolStatusFailure string

MachinePoolStatusFailure defines errors states for MachinePool objects.

const (
	// InvalidConfigurationMachinePoolError represemts
	// 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 ProviderSpec specifies an instance type that doesn't exist.
	InvalidConfigurationMachinePoolError MachinePoolStatusFailure = "InvalidConfiguration"
)

func MachinePoolStatusErrorPtr added in v0.3.0

func MachinePoolStatusErrorPtr(v MachinePoolStatusFailure) *MachinePoolStatusFailure

MachinePoolStatusErrorPtr converts a MachinePoolStatusError to a pointer.

type MachineSetStatusError

type MachineSetStatusError string

MachineSetStatusError defines errors states for MachineSet objects.

const (
	// InvalidConfigurationMachineSetError represents
	// 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 ProviderSpec specifies an instance type that doesn't exist.
	InvalidConfigurationMachineSetError MachineSetStatusError = "InvalidConfiguration"
)

type MachineStatusError

type MachineStatusError string

MachineStatusError defines errors states for Machine objects.

const (
	// InvalidConfigurationMachineError 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 ProviderSpec specifies an instance type that doesn't exist,.
	InvalidConfigurationMachineError MachineStatusError = "InvalidConfiguration"

	// UnsupportedChangeMachineError 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"

	// InsufficientResourcesMachineError 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"

	// CreateMachineError indicates 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"

	// UpdateMachineError indicates an error while trying to update a Node that this
	// Machine represents. This may indicate a transient problem that will be
	// fixed automatically with time, such as a service outage,
	//
	// Example: error updating load balancers.
	UpdateMachineError MachineStatusError = "UpdateError"

	// DeleteMachineError indicates 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"

	// JoinClusterTimeoutMachineError indicates that the machine did not join the cluster
	// as a new node within the expected timeframe after instance
	// creation at the provider succeeded
	//
	// Example use case: A controller that deletes Machines which do
	// not result in a Node joining the cluster within a given timeout
	// and that are managed by a MachineSet.
	JoinClusterTimeoutMachineError = "JoinClusterTimeoutError"
)

func MachineStatusErrorPtr

func MachineStatusErrorPtr(v MachineStatusError) *MachineStatusError

MachineStatusErrorPtr converts a MachineStatusError to a pointer.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL