v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the app v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=inventory.open-cluster-management.io

Package v1alpha1 contains API Schema definitions for the app v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=inventory.open-cluster-management.io

Index

• Constants
• Variables
• type BMCDetails
  • func (in *BMCDetails) DeepCopy() *BMCDetails
  • func (in *BMCDetails) DeepCopyInto(out *BMCDetails)
• type BareMetalAsset
  • func (in *BareMetalAsset) DeepCopy() *BareMetalAsset
  • func (in *BareMetalAsset) DeepCopyInto(out *BareMetalAsset)
  • func (in *BareMetalAsset) DeepCopyObject() runtime.Object
• type BareMetalAssetList
  • func (in *BareMetalAssetList) DeepCopy() *BareMetalAssetList
  • func (in *BareMetalAssetList) DeepCopyInto(out *BareMetalAssetList)
  • func (in *BareMetalAssetList) DeepCopyObject() runtime.Object
• type BareMetalAssetSpec
  • func (in *BareMetalAssetSpec) DeepCopy() *BareMetalAssetSpec
  • func (in *BareMetalAssetSpec) DeepCopyInto(out *BareMetalAssetSpec)
• type BareMetalAssetStatus
  • func (in *BareMetalAssetStatus) DeepCopy() *BareMetalAssetStatus
  • func (in *BareMetalAssetStatus) DeepCopyInto(out *BareMetalAssetStatus)
• type Role

Constants

const (
	// ConditionCredentialsFound reports whether the secret containing the credentials
	// of a BareMetalAsset have been found.
	ConditionCredentialsFound string = "CredentialsFound"

	// ConditionAssetSyncStarted reports whether synchronization of a BareMetalHost
	// to a managed cluster has started
	ConditionAssetSyncStarted string = "AssetSyncStarted"

	// ConditionClusterDeploymentFound reports whether the cluster deployment referenced in
	// a BareMetalAsset has been found.
	ConditionClusterDeploymentFound string = "ClusterDeploymentFound"

	// ConditionAssetSyncCompleted reports whether synchronization of a BareMetalHost
	// to a managed cluster has completed
	ConditionAssetSyncCompleted string = "AssetSyncCompleted"
)

Condition Types

const ManagedClusterResourceNamespace string = "openshift-machine-api"

ManagedClusterResourceNamespace is the namespace on the managed cluster where BareMetalHosts are placed.

Variables

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

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

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

Types

type BMCDetails

type BMCDetails struct {

	// Address holds the URL for accessing the controller on the
	// network.
	Address string `json:"address"`

	// The name of the secret containing the BMC credentials (requires
	// keys "username" and "password").
	CredentialsName string `json:"credentialsName"`
}

BMCDetails contains the information necessary to communicate with the bare metal controller module on host.

func (*BMCDetails) DeepCopy

func (in *BMCDetails) DeepCopy() *BMCDetails

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

func (*BMCDetails) DeepCopyInto

func (in *BMCDetails) DeepCopyInto(out *BMCDetails)

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

type BareMetalAsset

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

	Spec   BareMetalAssetSpec   `json:"spec,omitempty"`
	Status BareMetalAssetStatus `json:"status,omitempty"`
}

BareMetalAsset is the Schema for the baremetalassets API +kubebuilder:subresource:status +kubebuilder:resource:path=baremetalassets,scope=Namespaced

func (*BareMetalAsset) DeepCopy

func (in *BareMetalAsset) DeepCopy() *BareMetalAsset

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

func (*BareMetalAsset) DeepCopyInto

func (in *BareMetalAsset) DeepCopyInto(out *BareMetalAsset)

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

func (*BareMetalAsset) DeepCopyObject

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

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

type BareMetalAssetList

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

BareMetalAssetList contains a list of BareMetalAsset

func (*BareMetalAssetList) DeepCopy

func (in *BareMetalAssetList) DeepCopy() *BareMetalAssetList

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

func (*BareMetalAssetList) DeepCopyInto

func (in *BareMetalAssetList) DeepCopyInto(out *BareMetalAssetList)

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

func (*BareMetalAssetList) DeepCopyObject

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

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

type BareMetalAssetSpec

type BareMetalAssetSpec struct {

	// How do we connect to the BMC?
	BMC BMCDetails `json:"bmc,omitempty"`

	// What is the name of the hardware profile for this host? It
	// should only be necessary to set this when inspection cannot
	// automatically determine the profile.
	HardwareProfile string `json:"hardwareProfile,omitempty"`

	// Which MAC address will PXE boot? This is optional for some
	// types, but required for libvirt VMs driven by vbmc.
	// +kubebuilder:validation:Pattern=`[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}`
	BootMACAddress string `json:"bootMACAddress,omitempty"`

	// Role holds the role of the asset
	// +kubebuilder:validation:Enum=master;worker
	Role Role `json:"role,omitempty"`

	// ClusterDeployment which the asset belongs to.
	// +kubebuilder:pruning:PreserveUnknownFields
	ClusterDeployment metav1.ObjectMeta `json:"clusterDeployment,omitempty"`
}

BareMetalAssetSpec defines the desired state of BareMetalAsset

func (*BareMetalAssetSpec) DeepCopy

func (in *BareMetalAssetSpec) DeepCopy() *BareMetalAssetSpec

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

func (*BareMetalAssetSpec) DeepCopyInto

func (in *BareMetalAssetSpec) DeepCopyInto(out *BareMetalAssetSpec)

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

type BareMetalAssetStatus

type BareMetalAssetStatus struct {
	// Conditions describes the state of the BareMetalAsset resource.
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"  patchStrategy:"merge" patchMergeKey:"type"`

	// RelatedObjects is a list of objects created and maintained by this
	// operator. Object references will be added to this list after they have
	// been created AND found in the cluster.
	// +optional
	RelatedObjects []corev1.ObjectReference `json:"relatedObjects,omitempty"`
}

BareMetalAssetStatus defines the observed state of BareMetalAsset

func (*BareMetalAssetStatus) DeepCopy

func (in *BareMetalAssetStatus) DeepCopy() *BareMetalAssetStatus

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

func (*BareMetalAssetStatus) DeepCopyInto

func (in *BareMetalAssetStatus) DeepCopyInto(out *BareMetalAssetStatus)

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

type Role

type Role string

Role represents the role assigned to the asset

const (
	// MasterRole is the master role assigned to the asset
	MasterRole Role = "master"

	// WorkerRole is the worker role assigned to the asset
	WorkerRole Role = "worker"
)