v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the baremetal v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api-provider-baremetal/pkg/apis/baremetal +k8s:defaulter-gen=TypeMeta +groupName=baremetal.cluster.k8s.io

Package v1alpha1 contains API Schema definitions for the baremetal v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api-provider-baremetal/pkg/apis/baremetal +k8s:defaulter-gen=TypeMeta +groupName=baremetal.cluster.k8s.io

Index

• Variables
• func Resource(resource string) schema.GroupResource
• type BareMetalMachineProviderSpec
  • func (in *BareMetalMachineProviderSpec) DeepCopy() *BareMetalMachineProviderSpec
  • func (in *BareMetalMachineProviderSpec) DeepCopyInto(out *BareMetalMachineProviderSpec)
  • func (in *BareMetalMachineProviderSpec) DeepCopyObject() runtime.Object
  • func (s *BareMetalMachineProviderSpec) IsValid() error
• type BareMetalMachineProviderSpecList
  • func (in *BareMetalMachineProviderSpecList) DeepCopy() *BareMetalMachineProviderSpecList
  • func (in *BareMetalMachineProviderSpecList) DeepCopyInto(out *BareMetalMachineProviderSpecList)
  • func (in *BareMetalMachineProviderSpecList) DeepCopyObject() runtime.Object
• type BareMetalMachineProviderStatus
  • func (in *BareMetalMachineProviderStatus) DeepCopy() *BareMetalMachineProviderStatus
  • func (in *BareMetalMachineProviderStatus) DeepCopyInto(out *BareMetalMachineProviderStatus)
  • func (in *BareMetalMachineProviderStatus) DeepCopyObject() runtime.Object
• type BareMetalMachineProviderStatusList
  • func (in *BareMetalMachineProviderStatusList) DeepCopy() *BareMetalMachineProviderStatusList
  • func (in *BareMetalMachineProviderStatusList) DeepCopyInto(out *BareMetalMachineProviderStatusList)
  • func (in *BareMetalMachineProviderStatusList) DeepCopyObject() runtime.Object
• type HostSelector
  • func (in *HostSelector) DeepCopy() *HostSelector
  • func (in *HostSelector) DeepCopyInto(out *HostSelector)
• type HostSelectorRequirement
  • func (in *HostSelectorRequirement) DeepCopy() *HostSelectorRequirement
  • func (in *HostSelectorRequirement) DeepCopyInto(out *HostSelectorRequirement)
• type Image
  • func (in *Image) DeepCopy() *Image
  • func (in *Image) DeepCopyInto(out *Image)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "baremetal.cluster.k8s.io", Version: "v1alpha1"}

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

	// AddToScheme is required by pkg/client/...
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource is required by pkg/client/listers/...

Types

type BareMetalMachineProviderSpec

type BareMetalMachineProviderSpec struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,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 Machine'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 Machine.
	HostSelector HostSelector `json:"hostSelector,omitempty"`
}

BareMetalMachineProviderSpec holds data that the actuator needs to provision and manage a Machine. +k8s:openapi-gen=true

func (*BareMetalMachineProviderSpec) DeepCopy

func (in *BareMetalMachineProviderSpec) DeepCopy() *BareMetalMachineProviderSpec

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

func (*BareMetalMachineProviderSpec) DeepCopyInto

func (in *BareMetalMachineProviderSpec) DeepCopyInto(out *BareMetalMachineProviderSpec)

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

func (*BareMetalMachineProviderSpec) DeepCopyObject

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

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

func (*BareMetalMachineProviderSpec) IsValid

func (s *BareMetalMachineProviderSpec) 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 BareMetalMachineProviderSpecList

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

BareMetalMachineProviderSpecList contains a list of BareMetalMachineProviderSpec

func (*BareMetalMachineProviderSpecList) DeepCopy

func (in *BareMetalMachineProviderSpecList) DeepCopy() *BareMetalMachineProviderSpecList

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

func (*BareMetalMachineProviderSpecList) DeepCopyInto

func (in *BareMetalMachineProviderSpecList) DeepCopyInto(out *BareMetalMachineProviderSpecList)

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

func (*BareMetalMachineProviderSpecList) DeepCopyObject

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

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

type BareMetalMachineProviderStatus

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

BareMetalMachineProviderStatus is the Schema for the baremetalmachineproviderstatuses API +k8s:openapi-gen=true

func (*BareMetalMachineProviderStatus) DeepCopy

func (in *BareMetalMachineProviderStatus) DeepCopy() *BareMetalMachineProviderStatus

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

func (*BareMetalMachineProviderStatus) DeepCopyInto

func (in *BareMetalMachineProviderStatus) DeepCopyInto(out *BareMetalMachineProviderStatus)

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

func (*BareMetalMachineProviderStatus) DeepCopyObject

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

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

type BareMetalMachineProviderStatusList

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

BareMetalMachineProviderStatusList contains a list of BareMetalMachineProviderStatus

func (*BareMetalMachineProviderStatusList) DeepCopy

func (in *BareMetalMachineProviderStatusList) DeepCopy() *BareMetalMachineProviderStatusList

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

func (*BareMetalMachineProviderStatusList) DeepCopyInto

func (in *BareMetalMachineProviderStatusList) DeepCopyInto(out *BareMetalMachineProviderStatusList)

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

func (*BareMetalMachineProviderStatusList) DeepCopyObject

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

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

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.