v1alpha2

package
v0.2.2 Latest Latest
Warning

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

 Go to latest Published: Feb 20, 2020 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package v1alpha2 contains API Schema definitions for the baremetal v1alpha2 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io

Package v1alpha2 contains API Schema definitions for the infrastructure v1alpha2 API group +kubebuilder:object:generate=true +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=infrastructure.cluster.x-k8s.io

Index

Constants

View Source 
const (
	// ClusterFinalizer allows BareMetalClusterReconciler to clean up resources associated with BareMetalCluster before
	// removing it from the apiserver.
	ClusterFinalizer = "baremetalcluster.infrastructure.cluster.x-k8s.io"
)
View Source 
const (
	// MachineFinalizer allows ReconcileBareMetalMachine to clean up resources associated with BareMetalMachine before
	// removing it from the apiserver.
	MachineFinalizer = "baremetalmachine.infrastructure.cluster.x-k8s.io"
)

Variables

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

	// 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 APIEndPointError 

type APIEndPointError struct {
	Message string
}

APIEndPointError represents error in the APIEndPoint in BareMetalCluster.Spec

func (*APIEndPointError) DeepCopy 

func (in *APIEndPointError) DeepCopy() *APIEndPointError

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

func (*APIEndPointError) DeepCopyInto 

func (in *APIEndPointError) DeepCopyInto(out *APIEndPointError)

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

func (*APIEndPointError) Error 

func (e *APIEndPointError) Error() string

Error implements the error interface and returns the error message

type APIEndpoint 

type APIEndpoint struct {
	// Host is the hostname on which the API server is serving.
	Host string `json:"host"`

	// Port is the port on which the API server is serving.
	Port int `json:"port"`
}

APIEndpoint represents a reachable Kubernetes API endpoint.

func (*APIEndpoint) DeepCopy 

func (in *APIEndpoint) DeepCopy() *APIEndpoint

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

func (*APIEndpoint) DeepCopyInto 

func (in *APIEndpoint) DeepCopyInto(out *APIEndpoint)

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

type BareMetalCluster 

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

	Spec   BareMetalClusterSpec   `json:"spec,omitempty"`
	Status BareMetalClusterStatus `json:"status,omitempty"`
}

BareMetalCluster is the Schema for the baremetalclusters API

func (*BareMetalCluster) DeepCopy 

func (in *BareMetalCluster) DeepCopy() *BareMetalCluster

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

func (*BareMetalCluster) DeepCopyInto 

func (in *BareMetalCluster) DeepCopyInto(out *BareMetalCluster)

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

func (*BareMetalCluster) DeepCopyObject 

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

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

type BareMetalClusterList 

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

BareMetalClusterList contains a list of BareMetalCluster

func (*BareMetalClusterList) DeepCopy 

func (in *BareMetalClusterList) DeepCopy() *BareMetalClusterList

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

func (*BareMetalClusterList) DeepCopyInto 

func (in *BareMetalClusterList) DeepCopyInto(out *BareMetalClusterList)

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

func (*BareMetalClusterList) DeepCopyObject 

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

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

type BareMetalClusterSpec 

type BareMetalClusterSpec struct {
	APIEndpoint     string `json:"apiEndpoint"`
	NoCloudProvider bool   `json:"noCloudProvider,omitempty"`
}

BareMetalClusterSpec defines the desired state of BareMetalCluster.

func (*BareMetalClusterSpec) DeepCopy 

func (in *BareMetalClusterSpec) DeepCopy() *BareMetalClusterSpec

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

func (*BareMetalClusterSpec) DeepCopyInto 

func (in *BareMetalClusterSpec) DeepCopyInto(out *BareMetalClusterSpec)

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

func (*BareMetalClusterSpec) IsValid 

func (s *BareMetalClusterSpec) IsValid() error

IsValid returns an error if the object is not valid, otherwise nil. The string representation of the error is suitable for human consumption.

type BareMetalClusterStatus 

type BareMetalClusterStatus struct {
	// LastUpdated identifies when this status was last observed.
	// +optional
	LastUpdated *metav1.Time `json:"lastUpdated,omitempty"`

	// ErrorReason will be set in the event that there is a terminal problem
	// reconciling the BaremetalMachine 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 BaremetalMachine'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 BaremetalMachine object and/or logged in the
	// controller's output.
	// +optional
	ErrorReason *capierrors.ClusterStatusError `json:"errorReason,omitempty"`

	// ErrorMessage will be set in the event that there is a terminal problem
	// reconciling the BaremetalMachine 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 BaremetalMachine'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 BaremetalMachine object and/or logged in the
	// controller's output.
	// +optional
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// Ready denotes that the baremetal cluster (infrastructure) is ready. In
	// Baremetal case, it does not mean anything for now as no infrastructure
	// steps need to be performed. Required by Cluster API. Set to True by the
	// BaremetalCluster controller after creation.
	Ready bool `json:"ready"`

	// APIEndpoints represents the endpoints to communicate with the control plane.
	// +optional
	APIEndpoints []APIEndpoint `json:"apiEndpoints,omitempty"`
}

BareMetalClusterStatus defines the observed state of BareMetalCluster.

func (*BareMetalClusterStatus) DeepCopy 

func (in *BareMetalClusterStatus) DeepCopy() *BareMetalClusterStatus

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

func (*BareMetalClusterStatus) DeepCopyInto 

func (in *BareMetalClusterStatus) DeepCopyInto(out *BareMetalClusterStatus)

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

type BareMetalMachine 

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

	Spec   BareMetalMachineSpec   `json:"spec,omitempty"`
	Status BareMetalMachineStatus `json:"status,omitempty"`
}

BareMetalMachine is the Schema for the baremetalmachines API

func (*BareMetalMachine) DeepCopy 

func (in *BareMetalMachine) DeepCopy() *BareMetalMachine

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

func (*BareMetalMachine) DeepCopyInto 

func (in *BareMetalMachine) DeepCopyInto(out *BareMetalMachine)

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

func (*BareMetalMachine) DeepCopyObject 

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

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

type BareMetalMachineList 

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

BareMetalMachineList contains a list of BareMetalMachine

func (*BareMetalMachineList) DeepCopy 

func (in *BareMetalMachineList) DeepCopy() *BareMetalMachineList

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

func (*BareMetalMachineList) DeepCopyInto 

func (in *BareMetalMachineList) DeepCopyInto(out *BareMetalMachineList)

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

func (*BareMetalMachineList) DeepCopyObject 

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

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

type BareMetalMachineSpec 

type BareMetalMachineSpec struct {
	// ProviderID will be the baremetal machine in ProviderID format
	// (baremetal:////<machinename>)
	// +optional
	ProviderID *string `json:"providerID,omitempty"`

	// Image is the image to be provisioned.
	Image Image `json:"image"`

	// UserData references the Secret that holds user data needed by the bare metal
	// operator. The Namespace is optional; it will default to the BaremetalMachine's
	// namespace if not specified.
	UserData *corev1.SecretReference `json:"userData,omitempty"`

	// HostSelector specifies matching criteria for labels on BareMetalHosts.
	// This is used to limit the set of BareMetalHost objects considered for
	// claiming for a BaremetalMachine.
	HostSelector HostSelector `json:"hostSelector,omitempty"`
}

BareMetalMachineSpec defines the desired state of BareMetalMachine

func (*BareMetalMachineSpec) DeepCopy 

func (in *BareMetalMachineSpec) DeepCopy() *BareMetalMachineSpec

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

func (*BareMetalMachineSpec) DeepCopyInto 

func (in *BareMetalMachineSpec) DeepCopyInto(out *BareMetalMachineSpec)

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

func (*BareMetalMachineSpec) IsValid 

func (s *BareMetalMachineSpec) IsValid() error

IsValid returns an error if the object is not valid, otherwise nil. The string representation of the error is suitable for human consumption.

type BareMetalMachineStatus 

type BareMetalMachineStatus struct {

	// LastUpdated identifies when this status was last observed.
	// +optional
	LastUpdated *metav1.Time `json:"lastUpdated,omitempty"`

	// ErrorReason will be set in the event that there is a terminal problem
	// reconciling the BaremetalMachine 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 BaremetalMachine'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
	// BaremetalMachines can be added as events to the BaremetalMachine object
	// and/or logged in the controller's output.
	// +optional
	ErrorReason *capierrors.MachineStatusError `json:"errorReason,omitempty"`

	// ErrorMessage will be set in the event that there is a terminal problem
	// reconciling the BaremetalMachine 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 BaremetalMachine'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
	// BaremetalMachines can be added as events to the BaremetalMachine object
	// and/or logged in the controller's output.
	// +optional
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// Addresses is a list of addresses assigned to the machine.
	// This field is copied from the infrastructure provider reference.
	// +optional
	Addresses capi.MachineAddresses `json:"addresses,omitempty"`

	// Phase represents the current phase of machine actuation.
	// E.g. Pending, Running, Terminating, Failed etc.
	// +optional
	Phase string `json:"phase,omitempty"`

	// Ready is the state of the metal3.
	// TODO : Document the variable :
	// mhrivnak: " it would be good to document what this means, how to interpret
	// it, under what circumstances the value changes, etc."
	// +optional
	Ready bool `json:"ready"`
}

BareMetalMachineStatus defines the observed state of BareMetalMachine

func (*BareMetalMachineStatus) DeepCopy 

func (in *BareMetalMachineStatus) DeepCopy() *BareMetalMachineStatus

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

func (*BareMetalMachineStatus) DeepCopyInto 

func (in *BareMetalMachineStatus) DeepCopyInto(out *BareMetalMachineStatus)

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

type BareMetalMachineTemplate 

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

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

BareMetalMachineTemplate is the Schema for the baremetalmachinetemplates API

func (*BareMetalMachineTemplate) DeepCopy 

func (in *BareMetalMachineTemplate) DeepCopy() *BareMetalMachineTemplate

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

func (*BareMetalMachineTemplate) DeepCopyInto 

func (in *BareMetalMachineTemplate) DeepCopyInto(out *BareMetalMachineTemplate)

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

func (*BareMetalMachineTemplate) DeepCopyObject 

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

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

type BareMetalMachineTemplateList 

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

BareMetalMachineTemplateList contains a list of BareMetalMachineTemplate

func (*BareMetalMachineTemplateList) DeepCopy 

func (in *BareMetalMachineTemplateList) DeepCopy() *BareMetalMachineTemplateList

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

func (*BareMetalMachineTemplateList) DeepCopyInto 

func (in *BareMetalMachineTemplateList) DeepCopyInto(out *BareMetalMachineTemplateList)

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

func (*BareMetalMachineTemplateList) DeepCopyObject 

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

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

type BareMetalMachineTemplateResource 

type BareMetalMachineTemplateResource struct {
	// Spec is the specification of the desired behavior of the machine.
	Spec BareMetalMachineSpec `json:"spec"`
}

BareMetalMachineTemplateResource describes the data needed to create a BareMetalMachine from a template

func (*BareMetalMachineTemplateResource) DeepCopy 

func (in *BareMetalMachineTemplateResource) DeepCopy() *BareMetalMachineTemplateResource

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

func (*BareMetalMachineTemplateResource) DeepCopyInto 

func (in *BareMetalMachineTemplateResource) DeepCopyInto(out *BareMetalMachineTemplateResource)

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

type BareMetalMachineTemplateSpec 

type BareMetalMachineTemplateSpec struct {
	Template BareMetalMachineTemplateResource `json:"template"`
}

BareMetalMachineTemplateSpec defines the desired state of BareMetalMachineTemplate

func (*BareMetalMachineTemplateSpec) DeepCopy 

func (in *BareMetalMachineTemplateSpec) DeepCopy() *BareMetalMachineTemplateSpec

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

func (*BareMetalMachineTemplateSpec) DeepCopyInto 

func (in *BareMetalMachineTemplateSpec) DeepCopyInto(out *BareMetalMachineTemplateSpec)

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

type HostSelector 

type HostSelector struct {
	// Key/value pairs of labels that must exist on a chosen BareMetalHost
	MatchLabels map[string]string `json:"matchLabels,omitempty"`

	// Label match expressions that must be true on a chosen BareMetalHost
	MatchExpressions []HostSelectorRequirement `json:"matchExpressions,omitempty"`
}

HostSelector specifies matching criteria for labels on BareMetalHosts. This is used to limit the set of BareMetalHost objects considered for claiming for a Machine.

func (*HostSelector) DeepCopy 

func (in *HostSelector) DeepCopy() *HostSelector

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

func (*HostSelector) DeepCopyInto 

func (in *HostSelector) DeepCopyInto(out *HostSelector)

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

type HostSelectorRequirement 

type HostSelectorRequirement struct {
	Key      string             `json:"key"`
	Operator selection.Operator `json:"operator"`
	Values   []string           `json:"values"`
}

func (*HostSelectorRequirement) DeepCopy 

func (in *HostSelectorRequirement) DeepCopy() *HostSelectorRequirement

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

func (*HostSelectorRequirement) DeepCopyInto 

func (in *HostSelectorRequirement) DeepCopyInto(out *HostSelectorRequirement)

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

type Image 

type Image struct {
	// URL is a location of an image to deploy.
	URL string `json:"url"`

	// Checksum is a md5sum value or a URL to retrieve one.
	Checksum string `json:"checksum"`
}

Image holds the details of an image to use during provisioning.

func (*Image) DeepCopy 

func (in *Image) DeepCopy() *Image

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

func (*Image) DeepCopyInto 

func (in *Image) DeepCopyInto(out *Image)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.