v1alpha1

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"`
}

type HostAddress struct {
	// Host address type identifies the source of the the address,
	// one of Hostname, ExternalIP, InternalIP, ExternalDNS or InternalDNS.
	Type HostAddressType `json:"type"`

	// The machine address.
	Address string `json:"address"`
}

type HostAddressType string

type HostAddresses []HostAddress

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

	Spec   HostClaimSpec   `json:"spec,omitempty"`
	Status HostClaimStatus `json:"status,omitempty"`
}

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

type HostClaimSpec struct {
	// Kind identifies the type of the target of the claim. If not set will default
	// to host.kanod.io/kind selector
	Kind string `json:"kind,omitempty"`

	// Should the compute resource be powered on? Changing this value will trigger
	// a change in power state of the host.
	Online bool `json:"online"`

	// ConsumerRef can be used to store information about something
	// that is using a HostClaim. When it is not empty, the HostClaim is
	// considered "in use".
	ConsumerRef *corev1.ObjectReference `json:"consumerRef,omitempty"`

	// Image holds the details of the image to be provisioned.
	Image *Image `json:"image,omitempty"`

	// UserData holds the reference to the Secret containing the user
	// data to be passed to the host before it boots.
	UserData *corev1.SecretReference `json:"userData,omitempty"`

	// NetworkData holds the reference to the Secret containing network
	// configuration (e.g content of network_data.json) which is passed
	// to the Config Drive.
	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"`

	// When set to disabled, automated cleaning of host disks will be skipped
	// during provisioning and deprovisioning.
	// +kubebuilder:validation:Enum:=metadata;disabled
	// +optional
	AutomatedCleaningMode *string `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"`
}

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 Host.
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
	// Ready is the state of the HostClaim
	// Value true means the reconciliation completed.
	Ready bool `json:"ready,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 MACAddress of the interface used to boot the underlying compute resource
	BootMACAddress string `json:"bootMACAddress,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"`
}

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

	Spec   HostQuotaSpec   `json:"spec,omitempty"`
	Status HostQuotaStatus `json:"status,omitempty"`
}

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

type HostQuotaSpec struct {
	// Hard contains a list of Quota constraints
	Hard []Quota `json:"hard,omitempty"`
}

type HostQuotaStatus struct {
	// Hard is a copy of the quota specified for which the last reconciliation was done.
	Hard []Quota `json:"quotas,omitempty"`
	// Used contains the host count/reource usage for each kind of constraint on hostclaims
	Used      []Quota `json:"used,omitempty"`
	UsedQuota string  `json:"usedQuota,omitempty"`
}

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"`
}

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

type HostStatusError string

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

	// Checksum is the checksum for the image.
	Checksum string `json:"checksum,omitempty"`

	// ChecksumType is the checksum algorithm for the image, e.g md5, sha256 or sha512.
	// The special value "auto" can be used to detect the algorithm from the checksum.
	// If missing, MD5 is used. If in doubt, use "auto".
	// +kubebuilder:validation:Enum=md5;sha256;sha512;auto
	// +optional
	ChecksumType *string `json:"checksumType,omitempty"`

	// DiskFormat contains the format of the image (raw, qcow2, ...).
	// Needs to be set to raw for raw images streaming.
	// Note live-iso means an iso referenced by the url will be live-booted
	// and not deployed to disk, and in this case the checksum options
	// are not required and if specified will be ignored.
	// +kubebuilder:validation:Enum=raw;qcow2;vdi;vmdk;live-iso
	// +optional
	DiskFormat *string `json:"format,omitempty"`
}

type NIC struct {
	// The name of the network interface, e.g. "en0"
	Name string `json:"name"`
	// The device MAC address
	MAC string `json:"MAC"`
	// The IP address of the interface. This will be an IPv4 or IPv6 address
	// if one is present.  If both IPv4 and IPv6 addresses are present in a
	// dual-stack environment, two nics will be output, one with each IP.
	IP string `json:"ip,omitempty"`
	// Whether the NIC is PXE Bootable
	PXE bool `json:"pxe,omitempty"`
}

type ProvisionState string

type Quota struct {
	// LabelSelector contains a map of label/value for HostClaim selection
	LabelSelector map[string]string `json:"labelSelector,omitempty"`
	// LabelName contains the name of the label in the HostClaim resource
	LabelName string `json:"labelName"`
	// LabelName contains the value of the label in the HostClaim resource
	LabelValue string `json:"labelValue,omitempty"`
	// LabelName contains the limits
	// if Aggregate is false : this limits is the maximum count of HostClaim resources
	// if Aggregate is true : this limits is the maximum value of the aggragation of label values
	Quantity int `json:"quantity"`
	// Aggregate indicate if the label value must be aggregated
	Aggregate bool `json:"aggregate,omitempty"`
}