cloud

Documentation

Overview

Package cloud implement cloud resources lifecycle.

Index

• Constants
• type Client
• type Cloud
• type Cluster
• type ClusterGetter
• type ClusterSetter
• type Machine
• type MachineGetter
• type MachineSetter
• type Reconciler
• type ReconcilerWithResult

Constants

const (
	// DefaultNumRegionsPerZone is the default number of zones per region.
	DefaultNumRegionsPerZone = 3
)

Types

type Client

type Client interface {
	Cloud() Cloud
}

Client is an interface which can get cloud client.

type Cloud

type Cloud = cloud.Cloud

Cloud alias for cloud.Cloud interface.

type Cluster

type Cluster interface {
	ClusterGetter
	ClusterSetter
}

Cluster is an interface which can get and set cluster information.

type ClusterGetter

type ClusterGetter interface {
	Client
	Project() string
	Region() string
	Name() string
	Namespace() string
	NetworkName() string
	Network() *infrav1.Network
	AdditionalLabels() infrav1.Labels
	FailureDomains() clusterv1.FailureDomains
	ControlPlaneEndpoint() clusterv1.APIEndpoint
}

ClusterGetter is an interface which can get cluster information.

type ClusterSetter

type ClusterSetter interface {
	SetControlPlaneEndpoint(endpoint clusterv1.APIEndpoint)
}

ClusterSetter is an interface which can set cluster information.

type Machine

type Machine interface {
	MachineGetter
	MachineSetter
}

Machine is an interface which can get and set machine information.

type MachineGetter

type MachineGetter interface {
	Client
	Name() string
	Namespace() string
	Zone() string
	Project() string
	Role() string
	IsControlPlane() bool
	ControlPlaneGroupName() string
	GetInstanceID() *string
	GetProviderID() string
	GetBootstrapData() (string, error)
	GetInstanceStatus() *infrav1.InstanceStatus
}

MachineGetter is an interface which can get machine information.

type MachineSetter

type MachineSetter interface {
	SetProviderID()
	SetInstanceStatus(v infrav1.InstanceStatus)
	SetFailureMessage(v error)
	SetFailureReason(v capierrors.MachineStatusError)
	SetAnnotation(key, value string)
	SetAddresses(addressList []corev1.NodeAddress)
}

MachineSetter is an interface which can set machine information.

type Reconciler

type Reconciler interface {
	Reconcile(ctx context.Context) error
	Delete(ctx context.Context) error
}

Reconciler is a generic interface used by components offering a type of service.

type ReconcilerWithResult

type ReconcilerWithResult interface {
	Reconcile(ctx context.Context) (ctrl.Result, error)
	Delete(ctx context.Context) (ctrl.Result, error)
}

ReconcilerWithResult is a generic interface used by components offering a type of service.