v1

type Capabilities struct {
	// +kubebuilder:default:=unknown
	// The hosts CPU architecture (not the guests).
	HostCpuArch string `json:"cpuArch,omitempty"`
	// Total host memory available as a sum of memory over all numa cells.
	HostMemory resource.Quantity `json:"memory,omitempty"`
	// Total host cpus available as a sum of cpus over all numa cells.
	HostCpus resource.Quantity `json:"cpus,omitempty"`
}

type Cell struct {
	// Cell ID.
	CellID uint64 `json:"cellID"`

	// Auto-discovered resource allocation of all hosted VMs in this cell.
	// +kubebuilder:validation:Optional
	Allocation map[string]resource.Quantity `json:"allocation"`

	// Auto-discovered capacity of this cell.
	// +kubebuilder:validation:Optional
	Capacity map[string]resource.Quantity `json:"capacity"`
}

type DomainCapabilities struct {
	// The available domain cpu architecture.
	// +kubebuilder:default:=unknown
	Arch string `json:"arch,omitempty"`

	// The supported type of virtualization for domains, such as "ch".
	// +kubebuilder:default:=unknown
	HypervisorType string `json:"hypervisorType,omitempty"`

	// Supported devices for domains.
	//
	// The format of this list is the device type, and if specified, a specific
	// model. For example, the take the following xml domain device definition:
	//
	// <video supported='yes'>
	//   <enum name='modelType'>
	//     <value>nvidia</value>
	//   </enum>
	// </video>
	//
	// The corresponding entries in this list would be "video" and "video/nvidia".
	//
	// +kubebuilder:default:={}
	SupportedDevices []string `json:"supportedDevices,omitempty"`

	// Supported cpu modes for domains.
	//
	// The format of this list is cpu mode, and if specified, a specific
	// submode. For example, the take the following xml domain cpu definition:
	//
	// <mode name='host-passthrough' supported='yes'>
	//   <enum name='hostPassthroughMigratable'/>
	// </mode>
	//
	// The corresponding entries in this list would be "host-passthrough" and
	// "host-passthrough/migratable".
	//
	// +kubebuilder:default:={}
	SupportedCpuModes []string `json:"supportedCpuModes,omitempty"`

	// Supported features for domains, such as "sev" or "sgx".
	//
	// This is a flat list of supported features, meaning the following xml:
	//
	// <features>
	//   <sev supported='no'/>
	//   <sgx supported='no'/>
	// </features>
	//
	// Would correspond to the entries "sev" and "sgx" in this list.
	//
	// +kubebuilder:default:={}
	SupportedFeatures []string `json:"supportedFeatures,omitempty"`
}

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

	Spec   EvictionSpec   `json:"spec,omitempty"`
	Status EvictionStatus `json:"status,omitempty"`
}

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

type EvictionSpec struct {

	// Name of hypervisor to evict
	Hypervisor string `json:"hypervisor"`

	// Reason for eviction, always required
	Reason string `json:"reason"`
}

type EvictionStatus struct {
	// +kubebuilder:validation:Optional
	HypervisorServiceId string `json:"hypervisorServiceId"`
	// +kubebuilder:validation:Optional
	// +kubebuilder:default=0
	OutstandingRamMb int64 `json:"outstandingRamMb"`
	// +kubebuilder:validation:Optional
	OutstandingInstances []string `json:"outstandingInstances"`

	// Conditions is an array of current conditions
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

type HyperVisorUpdateStatus struct {
	// +kubebuilder:default:=false
	// Represents a running Operating System update.
	InProgress bool `json:"inProgress"`

	// +kubebuilder:default:=unknown
	// Represents the Operating System installed update version.
	Installed string `json:"installed,omitempty"`

	// +kubebuilder:default:=3
	// Represents the number of retries.
	Retry int `json:"retry"`
}

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

	Spec   HypervisorSpec   `json:"spec,omitempty"`
	Status HypervisorStatus `json:"status,omitempty"`
}

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

type HypervisorSpec struct {
	// +kubebuilder:validation:Optional
	// OperatingSystemVersion represents the desired operating system version.
	OperatingSystemVersion string `json:"version,omitempty"`

	// +kubebuilder:default:=false
	// Reboot request an reboot after successful installation of an upgrade.
	Reboot bool `json:"reboot"`

	// +kubebuilder:default:=true
	// EvacuateOnReboot request an evacuation of all instances before reboot.
	EvacuateOnReboot bool `json:"evacuateOnReboot"`

	// +kubebuilder:default:=true
	// LifecycleEnabled enables the lifecycle management of the hypervisor via hypervisor-operator.
	LifecycleEnabled bool `json:"lifecycleEnabled"`

	// +kubebuilder:default:=false
	// SkipTests skips the tests during the onboarding process.
	SkipTests bool `json:"skipTests"`

	// +kubebuilder:default:={}
	// CustomTraits are used to apply custom traits to the hypervisor.
	CustomTraits []string `json:"customTraits"`

	// +kubebuilder:default:={}
	// Aggregates are used to apply aggregates to the hypervisor.
	Aggregates []string `json:"aggregates"`

	// +kubebuilder:default:={}
	// AllowedProjects defines which openstack projects are allowed to schedule
	// instances on this hypervisor. The values of this list should be project
	// uuids. If left empty, all projects are allowed.
	AllowedProjects []string `json:"allowedProjects"`

	// +kubebuilder:default:=true
	// HighAvailability is used to enable the high availability handling of the hypervisor.
	HighAvailability bool `json:"highAvailability"`

	// +kubebuilder:default:=false
	// Require to issue a certificate from cert-manager for the hypervisor, to be used for
	// secure communication with the libvirt API.
	CreateCertManagerCertificate bool `json:"createCertManagerCertificate"`

	// +kubebuilder:default:=true
	// InstallCertificate is used to enable the installations of the certificates via kvm-node-agent.
	InstallCertificate bool `json:"installCertificate"`

	// +kubebuilder:optional
	// +kubebuilder:validation:Enum:="";manual;auto;ha;termination
	// Maintenance indicates whether the hypervisor is in maintenance mode.
	Maintenance string `json:"maintenance,omitempty"`
}

type HypervisorStatus struct {
	// +kubebuilder:default:=unknown
	// Represents the LibVirt version.
	LibVirtVersion string `json:"libVirtVersion,omitempty"`

	// Represents the Operating System status.
	OperatingSystem OperatingSystemStatus `json:"operatingSystem,omitempty"`

	// Represents the Hypervisor update status.
	Update HyperVisorUpdateStatus `json:"updateStatus,omitempty"`

	// Represents the Hypervisor hosted Virtual Machines
	Instances []Instance `json:"instances,omitempty"`

	// Auto-discovered capabilities as reported by libvirt.
	// +kubebuilder:validation:Optional
	Capabilities Capabilities `json:"capabilities"`

	// Auto-discovered domain capabilities relevant to check if a VM
	// can be scheduled on the hypervisor.
	// +kubebuilder:validation:Optional
	DomainCapabilities DomainCapabilities `json:"domainCapabilities"`

	// Auto-discovered resource allocation of all hosted VMs.
	// +kubebuilder:validation:Optional
	Allocation map[string]resource.Quantity `json:"allocation"`

	// Auto-discovered capacity of the hypervisor.
	// +kubebuilder:validation:Optional
	Capacity map[string]resource.Quantity `json:"capacity"`

	// Auto-discovered cells on this hypervisor.
	// +kubebuilder:validation:Optional
	Cells []Cell `json:"cells,omitempty"`

	// +kubebuilder:default:=0
	// Represent the num of instances
	NumInstances int `json:"numInstances"`

	// HypervisorID is the unique identifier of the hypervisor in OpenStack.
	HypervisorID string `json:"hypervisorId,omitempty"`

	// ServiceID is the unique identifier of the compute service in OpenStack.
	ServiceID string `json:"serviceId,omitempty"`

	// Traits are the applied traits of the hypervisor.
	Traits []string `json:"traits,omitempty"`

	// Aggregates are the applied aggregates of the hypervisor.
	Aggregates []string `json:"aggregates,omitempty"`

	// InternalIP is the internal IP address of the hypervisor.
	InternalIP string `json:"internalIp,omitempty"`

	// Evicted indicates whether the hypervisor is evicted. (no instances left with active maintenance mode)
	Evicted bool `json:"evicted,omitempty"`

	// Represents the Hypervisor node conditions.
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`

	SpecHash string `json:"specHash,omitempty"`
}

type Instance struct {
	// Represents the instance ID (uuidv4).
	ID string `json:"id"`

	// Represents the instance name.
	Name string `json:"name"`

	// Represents the instance state.
	Active bool `json:"active"`
}

type OperatingSystemStatus struct {
	// Represents the Operating System version.
	Version string `json:"version,omitempty"`

	// Identifying a specific variant or edition of the operating system
	VariantID string `json:"variantID,omitempty"`

	// PrettyVersion
	PrettyVersion string `json:"prettyVersion,omitempty"`

	// KernelName
	KernelName string `json:"kernelName,omitempty"`

	// KernelRelease
	KernelRelease string `json:"kernelRelease,omitempty"`

	// KernelVersion
	KernelVersion string `json:"kernelVersion,omitempty"`

	// HardwareVendor
	HardwareVendor string `json:"hardwareVendor,omitempty"`

	// HardwareModel
	HardwareModel string `json:"hardwareModel,omitempty"`

	// HardwareSerial
	HardwareSerial string `json:"hardwareSerial,omitempty"`

	// FirmwareVersion
	FirmwareVersion string `json:"firmwareVersion,omitempty"`

	// FirmwareVendor
	FirmwareVendor string `json:"firmwareVendor,omitempty"`

	// FirmwareDate
	FirmwareDate metav1.Time `json:"firmwareDate,omitempty"`

	// Represents the Garden Linux build commit id
	GardenLinuxCommitID string `json:"gardenLinuxCommitID,omitempty"`

	// Represents the Garden Linux Feature Set
	GardenLinuxFeatures []string `json:"gardenLinuxFeatures,omitempty"`
}