v1alpha1

type AvailabilityZoneQuantity struct {
	// AvailabilityZone is the name of the availability zone
	AvailabilityZone string `json:"availabilityZone"`
	// Classes defines a list of machine classes and their corresponding quantities
	Classes []MachineClassQuantity `json:"classes"`
}

type Capability struct {
	// Name is the name of the capability
	Name string `json:"name"`
	// Type defines the type of the capability
	Type string `json:"type"`
	// Value is the effective value of the capability
	Value string `json:"value"`
}

type Hash struct {
	// Algorithm indicates the algorithm with which the hash should be computed
	Algorithm string `json:"algorithm"`
	// Value is the computed hash value
	Value string `json:"value"`
}

type HashStatus struct {
	Name string `json:"name"`
	Hash string `json:"hash"`
}

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

	Spec   ImageSpec   `json:"spec,omitempty"`
	Status ImageStatus `json:"status,omitempty"`
}

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

type ImageSpec struct {
	// Type specifies the type of the image
	Type string `json:"type,omitempty"`
	// Maturity defines the manutiry of an image. It indicates whether this image is e.g. a stable or preview version.
	Maturity string `json:"maturity"`
	// ExpirationTime defines when the support for this image will expire
	ExpirationTime metav1.Time `json:"expirationTime,omitempty"`
	// OS defines the operating system name of the image
	OS string `json:"os"`
	// Version defines the operating system version
	Version string `json:"version"`
	// Source defines the source artefacts and their corresponding location
	Source []SourceAttribute `json:"source"`
}

type ImageStatus struct {
	common.StateFields `json:",inline"`
	// Hashes lists all hashes for all included artefacts
	Hashes []HashStatus `json:"hashes,omitempty"`
	// Regions indicates the availability of the image in the corresponding regions
	Regions []RegionState `json:"regions,omitempty"`
}

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

	Spec   MachineSpec   `json:"spec,omitempty"`
	Status MachineStatus `json:"status,omitempty"`
}

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

	Spec   MachineClassSpec   `json:"spec,omitempty"`
	Status MachineClassStatus `json:"status,omitempty"`
}

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

type MachineClassQuantity struct {
	// Name is the name of the machine class quantity
	Name string `json:"name"`
	// Quantity is an absolut number of the available machine class
	// +kubebuilder:validation:Minimum:=0
	Quantity int `json:"quantity"`
}

type MachineClassSpec struct {
	// Capabilities describes the features of the MachineClass
	Capabilities []Capability `json:"capabilities"`
}

type MachineClassStatus struct {
	// Availability describes the regions and zones where this MachineClass is available
	Availability common.Availability `json:"availability,omitempty"`
}

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

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

	Spec   MachinePoolSpec   `json:"spec,omitempty"`
	Status MachinePoolStatus `json:"status,omitempty"`
}

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

type MachinePoolSpec struct {
	// Region defines the region where this machine pool is available
	Region string `json:"region,omitempty"`
	// Privacy indicates the privacy scope of the machine pool
	Privacy string `json:"privacy"`
	// Capacity defines the quantity of this machine pool per availability zone
	Capacity []AvailabilityZoneQuantity `json:"capacity"`
}

type MachinePoolStatus struct {
	common.StateFields `json:",inline"`
	Used               AvailabilityZoneQuantity `json:"used"`
}

type MachineSpec struct {
	// Hostname is the hostname of the machine
	Hostname string `json:"hostname"`
	// MachineClass is the machine class/flavor of the machine
	MachineClass common.ScopeReference `json:"machineClass"`
	// MachinePool defines the compute pool of the machine
	MachinePool common.ScopeReference `json:"machinePool,omitempty"`
	// Location is the physical location of the machine
	Location common.Location `json:"location"`
	// Image is the operating system image of the machine
	Image common.ScopeReference `json:"image"`
	// SSHPublicKeys is a list of SSH public keys of a machine
	SSHPublicKeys []SSHPublicKeyEntry `json:"sshPublicKeys"`
	// Interfaces define a list of network interfaces present on the machine
	// TODO: define interfaces/network references
	// SecurityGroups is a list of security groups of a machine
	SecurityGroups []common.ScopeReference `json:"securityGroups"`
	// VolumeClaims
	VolumeClaims []VolumeClaim `json:"volumeClaims"`
	// UserData defines the ignition file
	UserData string `json:"userData,omitempty"`
}

type MachineStatus struct {
	common.StateFields `json:",inline"`
}

type RegionState struct {
	Name               string `json:"name"`
	common.StateFields `json:",inline"`
}

type RetainPolicy string

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

	Spec   SSHPublicKeySpec   `json:"spec,omitempty"`
	Status SSHPublicKeyStatus `json:"status,omitempty"`
}

type SSHPublicKeyEntry struct {
	// Scope is the scope of a SSH public key
	Scope string `json:"scope,omitempty"`
	// Name is the name of the SSH public key
	Name string `json:"name,omitempty"`
	// Selector defines a LabelSelector to filter for a public key
	Selector metav1.LabelSelector `json:"selector,omitempty"`
}

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

type SSHPublicKeySpec struct {
	// SSHPublicKey is the SSH public key string
	SSHPublicKey string `json:"sshPublicKey"`
	// Description describes the purpose of the ssh key
	Description string `json:"description,omitempty"`
	// ExpirationDate indicates until when this public key is valid
	ExpirationDate metav1.Time `json:"expirationDate,omitempty"`
}

type SSHPublicKeyStatus struct {
	common.StateFields `json:",inline"`
	// FingerPrint is the finger print of the ssh public key
	FingerPrint string `json:"fingerPrint,omitempty"`
	// KeyLength is the byte length of the ssh key
	// +kubebuilder:validation:Minimum:=0
	KeyLength int `json:"keyLength,omitempty"`
	// Algorithm is the algorithm used to generate the ssh key
	Algorithm string `json:"algorithm,omitempty"`
	// PublicKey is the PEM encoded public key
	PublicKey string `json:"publicKey,omitempty"`
}

type SourceAttribute struct {
	// Name defines the name of a source element
	Name string `json:"name"`
	// ImageName defines the name of a referred image
	ImageName string `json:"imageName,omitempty"`
	// URL defines the location of the image artefact
	URL string `json:"url,omitempty"`
	// CmdLine defines a Kernel boot command
	CmdLine string `json:"cmdLine,omitempty"`
	// Hash is the computed hash value of the artefacts content
	Hash *Hash `json:"hash,omitempty"`
}

type VolumeClaim struct {
	// Name is the name of the VolumeClaim
	Name string `json:"name"`
	// RetainPolicy defines what should happen when the machine is being deleted
	RetainPolicy RetainPolicy `json:"retainPolicy"`
	// Device defines the device for a volume on the machine
	Device string `json:"device"`
	// StorageClass describes the storage class of the volumes
	StorageClass common.ScopeReference `json:"storageClass"`
	// Size defines the size of the volume
	Size *resource.Quantity `json:"size,omitempty"`
	// Volume is a reference to an existing volume
	Volume common.ScopeReference `json:"volume,omitempty"`
}