✨ HostClaim custom resources

PROJECT

@@ -1,3 +1,7 @@
+# Code generated by tool. DO NOT EDIT.
+# This file is used to track the info used to scaffold your project
+# and allow the plugins properly work.
+# More info: https://book.kubebuilder.io/reference/project-config.html
 domain: metal3.io
 layout:
 - go.kubebuilder.io/v3
@@ -96,4 +100,22 @@ resources:
   kind: HostUpdatePolicy
   path: github.com/metal3-io/baremetal-operator/apis/metal3.io/v1alpha1
   version: v1alpha1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: metal3.io
+  group: metal3.io
+  kind: HostClaim
+  path: github.com/metal3-io/baremetal-operator/apis/metal3.io/v1alpha1
+  version: v1alpha1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: metal3.io
+  group: metal3.io
+  kind: HostDeployPolicy
+  path: github.com/metal3-io/baremetal-operator/apis/metal3.io/v1alpha1
+  version: v1alpha1
 version: "3"

apis/metal3.io/v1alpha1/hostclaim_types.go

@@ -0,0 +1,215 @@
+/*
+
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/selection"
+)
+
+const (
+	// Finalizer for HostClaims that are handled by the hostclaim_controller.
+	HostFinalizer = "metal3.io/hostclaim"
+
+	// AssociateCondition documents the status of the association of HostClaim with a BareMetalHost.
+	AssociationCondition = "Association"
+
+	// BareMetalHostAssociatedReason is the reason used when the Metal3Machine is successfully associated with a BareMetalHost.
+	BareMetalHostAssociatedReason = "BareMetalHostAssociated"
+	// MissingBareMetalHostReason is a reason used when the associated BareMetalHost is no more found.
+	MissingBareMetalHostReason = "MissingBareMetalHost"
+	// NoBareMetalHostReason is a reason used when no BareMetalHost matching the constraints is found.
+	NoBareMetalHostReason = "NoBareMetalHost"
+	// BadBareMetalHostStatusReason is a reason used when the status of the associated BareMetalHost cannot be marshalled.
+	BadBareMetalHostStatusReason = "BadBareMetalHostStatus"
+	// HostClaimAnnotationNotSetReason is a reason used when the annotation on the hostclaim cannot be set.
+	HostClaimAnnotationNotSetReason = "HostClaimAnnotationNotSet"
+	// PauseAnnotationSetFailedReason is a reason used when propagating the pause annotation fails.
+	PauseAnnotationSetFailedReason = "PauseAnnotationSetFailed"
+	// PauseAnnotationRemoveFailedReason is a reason used when the removal of the pause annotation fails.
+	PauseAnnotationRemoveFailedReason = "PauseAnnotationRemoveFailed"
+	// HostPausedReason is a reason used when Host or Cluster is paused.
+	HostPausedReason = "HostPaused"
+	// HostClaimDeletingReason is used while the hostclaim is being deleted.
+	HostClaimDeletingReason = "HostClaimDeleting"
+	// HostClaimDeletionFailedReason is used when the deletion of hostclaim encountered an unexpected error.
+	HostClaimDeletionFailedReason = "HostClaimDeletionFailed"
+
+	// SynchronizationCondition documents the status of the transfer of information from the
+	// HostClaim to the BareMetalHost.
+	SynchronizationCondition = "Synchronization"
+
+	// ConfigurationSyncedReason is the reason used when the synchronization of secrets is successful.
+	ConfigurationSyncedReason = "ConfigurationSynced"
+	// BadUserDataSecretReason is a reason used when the secret for user data cannot be synchronized.
+	BadUserDataSecretReason = "UserDataSecretSyncFailure"
+	// BadMetaDataSecretReason is a reason used when the secret for meta data cannot be synchronized.
+	BadMetaDataSecretReason = "MetaDataSecretSyncFailure"
+	// BadNetworkDataSecretReason is a reason used when the secret for meta data cannot be synchronized.
+	BadNetworkDataSecretReason = "NetworkDataSecretSyncFailure"
+	// BareMetalHostNotSynchronizedReason is the reason used when the synchronization of BareMetalHost state
+	// is not successful.
+	BareMetalHostNotSynchronizedReason = "BareMetalHostNotSynchronized"
+
+	// ProvisionedCondition documents the provisioning state of the associated BareMetalHost toward the Provisioned goal
+	// Reasons are values of ProvisioningState type.
+	ProvisionedCondition = "Provisioned"
+)
+
+// HostClaimSpec defines the desired state of HostClaim.
+type HostClaimSpec struct {
+	// Should the compute resource be powered on? Changing this value will trigger
+	// a change in power state of the targeted host.
+	Online bool `json:"online"`
+
+	// Image holds the details of the image to be provisioned. Populating
+	// the image will cause the target host to start provisioning.
+	Image *Image `json:"image,omitempty"`
+
+	// UserData holds the reference to the Secret containing the user data
+	// which is passed to the Config Drive and interpreted by the
+	// first-boot software such as cloud-init. The format of user data is
+	// specific to the first-boot software.
+	UserData *corev1.SecretReference `json:"userData,omitempty"`
+
+	// NetworkData holds the reference to the Secret containing network
+	// configuration which is passed to the Config Drive and interpreted
+	// by the first boot software such as cloud-init.
+	NetworkData *corev1.SecretReference `json:"networkData,omitempty"`
+
+	// MetaData holds the reference to the Secret containing host metadata
+	// (e.g. meta_data.json) which is passed to the Config Drive.
+	MetaData *corev1.SecretReference `json:"metaData,omitempty"`
+
+	// A custom deploy procedure. This is an advanced feature that allows
+	// using a custom deploy step provided by a site-specific deployment
+	// ramdisk. Most users will want to use "image" instead. Setting this
+	// field triggers provisioning.
+	// +optional
+	CustomDeploy *CustomDeploy `json:"customDeploy,omitempty"`
+
+	// When set to disabled, automated cleaning of host disks will be skipped
+	// during provisioning and deprovisioning.
+	// +kubebuilder:validation:Enum:=metadata;disabled
+	// +optional
+	AutomatedCleaningMode *AutomatedCleaningMode `json:"automatedCleaningMode,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.
+	// +optional
+	HostSelector HostSelector `json:"hostSelector,omitempty"`
+
+	// ConsumerRef can be used to store information about something
+	// that is using a host. When it is not empty, the host is
+	// considered "in use". The common use case is a link to a Machine
+	// resource when the host is used by Cluster API.
+	ConsumerRef *corev1.ObjectReference `json:"consumerRef,omitempty"`
+
+	// FailureDomain is the failure domain unique identifier this HostClaim should be attached to.
+	FailureDomain string `json:"failureDomain,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.
+type HostSelector struct {
+	// Key/value pairs of labels that must exist on a chosen BareMetalHost
+	// +optional
+	MatchLabels map[string]string `json:"matchLabels,omitempty"`
+
+	// Label match expressions that must be true on a chosen BareMetalHost
+	// +optional
+	MatchExpressions []HostSelectorRequirement `json:"matchExpressions,omitempty"`
+
+	// InNamespace specifies a single namespace where the BareMetalHost should
+	// reside. If not specified, the selection will be done over all available
+	// namespaces with a compliant policy.
+	// +optional
+	InNamespace string `json:"inNamespace,omitempty"`
+}
+
+type HostSelectorRequirement struct {
+	Key      string             `json:"key"`
+	Operator selection.Operator `json:"operator"`
+	Values   []string           `json:"values"`
+}
+
+// HostClaimStatus defines the observed state of HostClaim.
+type HostClaimStatus struct {
+	// LastUpdated identifies when this status was last observed.
+	// +optional
+	LastUpdated *metav1.Time `json:"lastUpdated,omitempty"`
+	// Conditions defines current service state of the HostClaim.
+	// +optional
+	Conditions []metav1.Condition `json:"conditions,omitempty"`
+	// HardwareData is a pointer to the name of the bound HardwareData
+	// structure.
+	// +optional
+	HardwareData *HardwareReference `json:"hardwareData,omitempty"`
+	// HostUID is the UID of the underlying compute. It is used
+	// as ID by the capm3 controller.
+	// +optional
+	HostUID string `json:"hostUID,omitempty"`
+	// The currently detected power state of the host. This field may get
+	// briefly out of sync with the actual state of the hardware while
+	// provisioning processes are running.
+	PoweredOn bool `json:"poweredOn,omitempty"`
+}
+
+// GetConditions returns the set of conditions for this object.
+func (h *HostClaim) GetConditions() []metav1.Condition {
+	return h.Status.Conditions
+}
+
+// SetConditions sets conditions for an API object.
+func (h *HostClaim) SetConditions(conditions []metav1.Condition) {
+	h.Status.Conditions = conditions
+}
+
+type HardwareReference struct {
+	// `namespace` is the namespace of the HardwareDetail bound
+	Namespace string `json:"namespace"`
+	// `name` is the name of the HardwareDetail bound
+	Name string `json:"name"`
+}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+
+// HostClaim is the Schema for the hostclaims API.
+type HostClaim struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   HostClaimSpec   `json:"spec,omitempty"`
+	Status HostClaimStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// HostClaimList contains a list of HostClaim.
+type HostClaimList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []HostClaim `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&HostClaim{}, &HostClaimList{})
+}

apis/metal3.io/v1alpha1/hostdeploypolicy_types.go

@@ -0,0 +1,74 @@
+/*
+
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// HostDeployPolicySpec defines the desired state of HostDeployPolicy.
+type HostDeployPolicySpec struct {
+	HostclaimNamespaces *HostclaimNamespaces `json:"hostclaimNamespaces,omitempty"`
+}
+
+type HostclaimNamespaces struct {
+	// Namespaces is a list of namespace names where the hostClaim is authorized to reside in.
+	Names []string `json:"names,omitempty"`
+	// NameMatches is a string interpreted as a regular expression that must be matched by the
+	// namespace of the HostClaim.
+	NameMatches string `json:"nameMatches,omitempty"`
+	// HasLabels is a list of label names and their associated value.
+	// The namespace should have all of those labels. If the value
+	// is specified, it must also match.
+	HasLabels []NameValuePair `json:"hasLabels,omitempty"`
+}
+
+type NameValuePair struct {
+	// Name of the expected label.
+	Name string `json:"name"`
+	// If specified, expected value of the label.
+	Value string `json:"value,omitempty"`
+}
+
+// HostDeployPolicyStatus defines the observed state of HostDeployPolicy.
+type HostDeployPolicyStatus struct {
+}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+
+// HostDeployPolicy is the Schema for the hostdeploypolicies API.
+type HostDeployPolicy struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   HostDeployPolicySpec   `json:"spec,omitempty"`
+	Status HostDeployPolicyStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// HostDeployPolicyList contains a list of HostDeployPolicy.
+type HostDeployPolicyList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []HostDeployPolicy `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&HostDeployPolicy{}, &HostDeployPolicyList{})
+}