v1alpha3

package
v0.3.1 Latest Latest
Warning

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

 Go to latest Published: Apr 3, 2020 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package v1alpha3 contains API Schema definitions for the baremetal v1alpha3 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 v1alpha3 contains API Schema definitions for the infrastructure v1alpha3 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 Metal3ClusterReconciler to clean up resources associated with Metal3Cluster before
	// removing it from the apiserver.
	ClusterFinalizer = "metal3cluster.infrastructure.cluster.x-k8s.io"
)
View Source 
const (
	// MachineFinalizer allows ReconcileMetal3Machine to clean up resources associated with Metal3Machine before
	// removing it from the apiserver.
	MachineFinalizer = "metal3machine.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: "v1alpha3"}

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

type Metal3Cluster 

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

	Spec   Metal3ClusterSpec   `json:"spec,omitempty"`
	Status Metal3ClusterStatus `json:"status,omitempty"`
}

Metal3Cluster is the Schema for the metal3clusters API

func (*Metal3Cluster) DeepCopy 

func (in *Metal3Cluster) DeepCopy() *Metal3Cluster

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

func (*Metal3Cluster) DeepCopyInto 

func (in *Metal3Cluster) DeepCopyInto(out *Metal3Cluster)

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

func (*Metal3Cluster) DeepCopyObject 

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

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

func (*Metal3Cluster) Default 

func (c *Metal3Cluster) Default()

func (*Metal3Cluster) Hub 

func (*Metal3Cluster) Hub()

func (*Metal3Cluster) SetupWebhookWithManager 

func (c *Metal3Cluster) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*Metal3Cluster) ValidateCreate 

func (c *Metal3Cluster) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*Metal3Cluster) ValidateDelete 

func (c *Metal3Cluster) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*Metal3Cluster) ValidateUpdate 

func (c *Metal3Cluster) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type Metal3ClusterList 

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

Metal3ClusterList contains a list of Metal3Cluster

func (*Metal3ClusterList) DeepCopy 

func (in *Metal3ClusterList) DeepCopy() *Metal3ClusterList

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

func (*Metal3ClusterList) DeepCopyInto 

func (in *Metal3ClusterList) DeepCopyInto(out *Metal3ClusterList)

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

func (*Metal3ClusterList) DeepCopyObject 

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

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

func (*Metal3ClusterList) Hub 

func (*Metal3ClusterList) Hub()

type Metal3ClusterSpec 

type Metal3ClusterSpec struct {
	// ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
	ControlPlaneEndpoint APIEndpoint `json:"controlPlaneEndpoint"`
	NoCloudProvider      bool        `json:"noCloudProvider,omitempty"`
}

Metal3ClusterSpec defines the desired state of Metal3Cluster.

func (*Metal3ClusterSpec) DeepCopy 

func (in *Metal3ClusterSpec) DeepCopy() *Metal3ClusterSpec

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

func (*Metal3ClusterSpec) DeepCopyInto 

func (in *Metal3ClusterSpec) DeepCopyInto(out *Metal3ClusterSpec)

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

func (*Metal3ClusterSpec) IsValid 

func (s *Metal3ClusterSpec) 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 Metal3ClusterStatus 

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

	// FailureReason indicates that there is a fatal problem reconciling the
	// state, and will be set to a token value suitable for
	// programmatic interpretation.
	// +optional
	FailureReason *capierrors.ClusterStatusError `json:"failureReason,omitempty"`

	// FailureMessage indicates that there is a fatal problem reconciling the
	// state, and will be set to a descriptive error message.
	// +optional
	FailureMessage *string `json:"failureMessage,omitempty"`

	// Ready denotes that the Metal3 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
	// metal3Cluster controller after creation.
	Ready bool `json:"ready"`
}

Metal3ClusterStatus defines the observed state of Metal3Cluster.

func (*Metal3ClusterStatus) DeepCopy 

func (in *Metal3ClusterStatus) DeepCopy() *Metal3ClusterStatus

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

func (*Metal3ClusterStatus) DeepCopyInto 

func (in *Metal3ClusterStatus) DeepCopyInto(out *Metal3ClusterStatus)

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

type Metal3Machine 

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

	Spec   Metal3MachineSpec   `json:"spec,omitempty"`
	Status Metal3MachineStatus `json:"status,omitempty"`
}

Metal3Machine is the Schema for the metal3machines API

func (*Metal3Machine) DeepCopy 

func (in *Metal3Machine) DeepCopy() *Metal3Machine

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

func (*Metal3Machine) DeepCopyInto 

func (in *Metal3Machine) DeepCopyInto(out *Metal3Machine)

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

func (*Metal3Machine) DeepCopyObject 

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

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

func (*Metal3Machine) Default 

func (c *Metal3Machine) Default()

func (*Metal3Machine) Hub 

func (*Metal3Machine) Hub()

func (*Metal3Machine) SetupWebhookWithManager 

func (c *Metal3Machine) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*Metal3Machine) ValidateCreate 

func (c *Metal3Machine) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*Metal3Machine) ValidateDelete 

func (c *Metal3Machine) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*Metal3Machine) ValidateUpdate 

func (c *Metal3Machine) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type Metal3MachineList 

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

Metal3MachineList contains a list of Metal3Machine

func (*Metal3MachineList) DeepCopy 

func (in *Metal3MachineList) DeepCopy() *Metal3MachineList

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

func (*Metal3MachineList) DeepCopyInto 

func (in *Metal3MachineList) DeepCopyInto(out *Metal3MachineList)

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

func (*Metal3MachineList) DeepCopyObject 

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

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

func (*Metal3MachineList) Hub 

func (*Metal3MachineList) Hub()

type Metal3MachineSpec 

type Metal3MachineSpec struct {
	// ProviderID will be the Metal3 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 metal3machine'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 metal3machine.
	HostSelector HostSelector `json:"hostSelector,omitempty"`
}

Metal3MachineSpec defines the desired state of Metal3Machine

func (*Metal3MachineSpec) DeepCopy 

func (in *Metal3MachineSpec) DeepCopy() *Metal3MachineSpec

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

func (*Metal3MachineSpec) DeepCopyInto 

func (in *Metal3MachineSpec) DeepCopyInto(out *Metal3MachineSpec)

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

func (*Metal3MachineSpec) IsValid 

func (s *Metal3MachineSpec) 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 Metal3MachineStatus 

type Metal3MachineStatus struct {

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

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

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

Metal3MachineStatus defines the observed state of Metal3Machine

func (*Metal3MachineStatus) DeepCopy 

func (in *Metal3MachineStatus) DeepCopy() *Metal3MachineStatus

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

func (*Metal3MachineStatus) DeepCopyInto 

func (in *Metal3MachineStatus) DeepCopyInto(out *Metal3MachineStatus)

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

type Metal3MachineTemplate 

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

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

Metal3MachineTemplate is the Schema for the metal3machinetemplates API

func (*Metal3MachineTemplate) DeepCopy 

func (in *Metal3MachineTemplate) DeepCopy() *Metal3MachineTemplate

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

func (*Metal3MachineTemplate) DeepCopyInto 

func (in *Metal3MachineTemplate) DeepCopyInto(out *Metal3MachineTemplate)

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

func (*Metal3MachineTemplate) DeepCopyObject 

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

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

func (*Metal3MachineTemplate) Default 

func (c *Metal3MachineTemplate) Default()

func (*Metal3MachineTemplate) Hub 

func (*Metal3MachineTemplate) Hub()

func (*Metal3MachineTemplate) SetupWebhookWithManager 

func (c *Metal3MachineTemplate) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*Metal3MachineTemplate) ValidateCreate 

func (c *Metal3MachineTemplate) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*Metal3MachineTemplate) ValidateDelete 

func (c *Metal3MachineTemplate) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*Metal3MachineTemplate) ValidateUpdate 

func (c *Metal3MachineTemplate) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type Metal3MachineTemplateList 

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

Metal3MachineTemplateList contains a list of Metal3MachineTemplate

func (*Metal3MachineTemplateList) DeepCopy 

func (in *Metal3MachineTemplateList) DeepCopy() *Metal3MachineTemplateList

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

func (*Metal3MachineTemplateList) DeepCopyInto 

func (in *Metal3MachineTemplateList) DeepCopyInto(out *Metal3MachineTemplateList)

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

func (*Metal3MachineTemplateList) DeepCopyObject 

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

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

func (*Metal3MachineTemplateList) Hub 

func (*Metal3MachineTemplateList) Hub()

type Metal3MachineTemplateResource 

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

Metal3MachineTemplateResource describes the data needed to create a Metal3Machine from a template

func (*Metal3MachineTemplateResource) DeepCopy 

func (in *Metal3MachineTemplateResource) DeepCopy() *Metal3MachineTemplateResource

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

func (*Metal3MachineTemplateResource) DeepCopyInto 

func (in *Metal3MachineTemplateResource) DeepCopyInto(out *Metal3MachineTemplateResource)

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

type Metal3MachineTemplateSpec 

type Metal3MachineTemplateSpec struct {
	Template Metal3MachineTemplateResource `json:"template"`
}

Metal3MachineTemplateSpec defines the desired state of Metal3MachineTemplate

func (*Metal3MachineTemplateSpec) DeepCopy 

func (in *Metal3MachineTemplateSpec) DeepCopy() *Metal3MachineTemplateSpec

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

func (*Metal3MachineTemplateSpec) DeepCopyInto 

func (in *Metal3MachineTemplateSpec) DeepCopyInto(out *Metal3MachineTemplateSpec)

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.