v1alpha1

package
v0.0.0-...-e6dd756 Latest Latest
Warning

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

Go to latest
Published: Dec 5, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the settings.gardener.cloud API group +groupName=infrastructure.cluster.x-k8s.io +kubebuilder:object:generate=true

Package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io

Index

Constants

View Source
const (
	// MachineFinalizer allows ReconcileMetalMachine to clean up resources associated with MetalMachine before
	// removing it from the apiserver.
	MachineFinalizer = "metalmachine.infrastructure.cluster.x-k8s.io"

	// DefaultReconcilerRequeue is the default value for the reconcile retry.
	DefaultReconcilerRequeue = 5 * time.Second
)
View Source
const (
	// ClusterFinalizer allows MetalClusterReconciler to clean up resources associated with MetalCluster before
	// removing it from the apiserver.
	ClusterFinalizer = "metalcluster.infrastructure.cluster.x-k8s.io"
)
View Source
const (
	// MetalClusterReady documents the status of MetalCluster and its underlying resources.
	MetalClusterReady clusterv1.ConditionType = "ClusterReady"
)

Variables

View Source
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "infrastructure.cluster.x-k8s.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type MetalCluster

type MetalCluster struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   MetalClusterSpec   `json:"spec,omitempty"`
	Status MetalClusterStatus `json:"status,omitempty"`
}

MetalCluster is the Schema for the metalclusters API

func (*MetalCluster) DeepCopy

func (in *MetalCluster) DeepCopy() *MetalCluster

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetalCluster.

func (*MetalCluster) DeepCopyInto

func (in *MetalCluster) DeepCopyInto(out *MetalCluster)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*MetalCluster) DeepCopyObject

func (in *MetalCluster) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*MetalCluster) GetConditions

func (c *MetalCluster) GetConditions() clusterv1.Conditions

GetConditions returns the observations of the operational state of the MetalCluster resource.

func (*MetalCluster) SetConditions

func (c *MetalCluster) SetConditions(conditions clusterv1.Conditions)

SetConditions sets the underlying service state of the MetalCluster to the predescribed clusterv1.Conditions.

type MetalClusterList

type MetalClusterList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []MetalCluster `json:"items"`
}

MetalClusterList contains a list of MetalCluster

func (*MetalClusterList) DeepCopy

func (in *MetalClusterList) DeepCopy() *MetalClusterList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetalClusterList.

func (*MetalClusterList) DeepCopyInto

func (in *MetalClusterList) DeepCopyInto(out *MetalClusterList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*MetalClusterList) DeepCopyObject

func (in *MetalClusterList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type MetalClusterSpec

type MetalClusterSpec struct {
	// ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
	// +optional
	ControlPlaneEndpoint clusterv1.APIEndpoint `json:"controlPlaneEndpoint,omitempty"`
}

MetalClusterSpec defines the desired state of MetalCluster

func (*MetalClusterSpec) DeepCopy

func (in *MetalClusterSpec) DeepCopy() *MetalClusterSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetalClusterSpec.

func (*MetalClusterSpec) DeepCopyInto

func (in *MetalClusterSpec) DeepCopyInto(out *MetalClusterSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MetalClusterStatus

type MetalClusterStatus struct {
	// Ready denotes that the cluster (infrastructure) is ready.
	// +optional
	Ready bool `json:"ready"`

	// Conditions defines current service state of the MetalCluster.
	// +optional
	Conditions clusterv1.Conditions `json:"conditions,omitempty"`
}

MetalClusterStatus defines the observed state of MetalCluster

func (*MetalClusterStatus) DeepCopy

func (in *MetalClusterStatus) DeepCopy() *MetalClusterStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetalClusterStatus.

func (*MetalClusterStatus) DeepCopyInto

func (in *MetalClusterStatus) DeepCopyInto(out *MetalClusterStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MetalMachine

type MetalMachine struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   MetalMachineSpec   `json:"spec,omitempty"`
	Status MetalMachineStatus `json:"status,omitempty"`
}

MetalMachine is the Schema for the metalmachines API

func (*MetalMachine) DeepCopy

func (in *MetalMachine) DeepCopy() *MetalMachine

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetalMachine.

func (*MetalMachine) DeepCopyInto

func (in *MetalMachine) DeepCopyInto(out *MetalMachine)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*MetalMachine) DeepCopyObject

func (in *MetalMachine) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type MetalMachineList

type MetalMachineList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []MetalMachine `json:"items"`
}

MetalMachineList contains a list of MetalMachine

func (*MetalMachineList) DeepCopy

func (in *MetalMachineList) DeepCopy() *MetalMachineList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetalMachineList.

func (*MetalMachineList) DeepCopyInto

func (in *MetalMachineList) DeepCopyInto(out *MetalMachineList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*MetalMachineList) DeepCopyObject

func (in *MetalMachineList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type MetalMachineSpec

type MetalMachineSpec struct {
	// ProviderID is the unique identifier as specified by the cloud provider.
	// +optional
	ProviderID *string `json:"providerID,omitempty"`

	// Image specifies the boot image to be used for the server.
	Image string `json:"image"`

	// ServerSelector specifies matching criteria for labels on Servers.
	// This is used to claim specific Server types for a MetalMachine.
	// +optional
	ServerSelector *metav1.LabelSelector `json:"serverSelector,omitempty"`
}

MetalMachineSpec defines the desired state of MetalMachine

func (*MetalMachineSpec) DeepCopy

func (in *MetalMachineSpec) DeepCopy() *MetalMachineSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetalMachineSpec.

func (*MetalMachineSpec) DeepCopyInto

func (in *MetalMachineSpec) DeepCopyInto(out *MetalMachineSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MetalMachineStatus

type MetalMachineStatus struct {
	// Ready indicates the Machine infrastructure has been provisioned and is ready.
	// +optional
	Ready bool `json:"ready"`

	// FailureReason will be set in the event that there is a terminal problem
	// reconciling the Machine and will contain a succinct value suitable
	// for machine interpretation.
	//
	// This field should not be set for transitive errors that a controller
	// faces that are expected to be fixed automatically over
	// time (like service outages), but instead indicate that something is
	// fundamentally wrong with the Machine's spec or the configuration of
	// the controller, and that manual intervention is required. Examples
	// of terminal errors would be invalid combinations of settings in the
	// spec, values that are unsupported by the controller, or the
	// responsible controller itself being critically misconfigured.
	//
	// Any transient errors that occur during the reconciliation of Machines
	// can be added as events to the Machine object and/or logged in the
	// controller's output.
	// +optional
	FailureReason *errors.MachineStatusError `json:"failureReason,omitempty"`

	// FailureMessage will be set in the event that there is a terminal problem
	// reconciling the Machine and will contain a more verbose string suitable
	// for logging and human consumption.
	//
	// This field should not be set for transitive errors that a controller
	// faces that are expected to be fixed automatically over
	// time (like service outages), but instead indicate that something is
	// fundamentally wrong with the Machine's spec or the configuration of
	// the controller, and that manual intervention is required. Examples
	// of terminal errors would be invalid combinations of settings in the
	// spec, values that are unsupported by the controller, or the
	// responsible controller itself being critically misconfigured.
	//
	// Any transient errors that occur during the reconciliation of Machines
	// can be added as events to the Machine object and/or logged in the
	// controller's output.
	// +optional
	FailureMessage *string `json:"failureMessage,omitempty"`
}

MetalMachineStatus defines the observed state of MetalMachine

func (*MetalMachineStatus) DeepCopy

func (in *MetalMachineStatus) DeepCopy() *MetalMachineStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetalMachineStatus.

func (*MetalMachineStatus) DeepCopyInto

func (in *MetalMachineStatus) DeepCopyInto(out *MetalMachineStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MetalMachineTemplate

type MetalMachineTemplate struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec MetalMachineTemplateSpec `json:"spec,omitempty"`
}

MetalMachineTemplate is the Schema for the metalmachinetemplates API

func (*MetalMachineTemplate) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetalMachineTemplate.

func (*MetalMachineTemplate) DeepCopyInto

func (in *MetalMachineTemplate) DeepCopyInto(out *MetalMachineTemplate)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*MetalMachineTemplate) DeepCopyObject

func (in *MetalMachineTemplate) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type MetalMachineTemplateList

type MetalMachineTemplateList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []MetalMachineTemplate `json:"items"`
}

MetalMachineTemplateList contains a list of MetalMachineTemplate

func (*MetalMachineTemplateList) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetalMachineTemplateList.

func (*MetalMachineTemplateList) DeepCopyInto

func (in *MetalMachineTemplateList) DeepCopyInto(out *MetalMachineTemplateList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*MetalMachineTemplateList) DeepCopyObject

func (in *MetalMachineTemplateList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type MetalMachineTemplateResource

type MetalMachineTemplateResource struct {
	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty"`
	Spec       MetalMachineSpec     `json:"spec"`
}

MetalMachineTemplateResource defines the spec and metadata for MetalMachineTemplate supported by capi.

func (*MetalMachineTemplateResource) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetalMachineTemplateResource.

func (*MetalMachineTemplateResource) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MetalMachineTemplateSpec

type MetalMachineTemplateSpec struct {
	Template MetalMachineTemplateResource `json:"template"`
}

MetalMachineTemplateSpec defines the desired state of MetalMachineTemplate

func (*MetalMachineTemplateSpec) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetalMachineTemplateSpec.

func (*MetalMachineTemplateSpec) DeepCopyInto

func (in *MetalMachineTemplateSpec) DeepCopyInto(out *MetalMachineTemplateSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

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