nova

type CandidateGatherer interface {
	// Gather all placement candidates and mutate the request accordingly.
	MutateWithAllCandidates(ctx context.Context, request *api.ExternalSchedulerRequest) error
}

type ChecksConfig struct {
	// Secret ref to keystone credentials stored in a k8s secret.
	KeystoneSecretRef corev1.SecretReference `json:"keystoneSecretRef"`
	// Secret ref to SSO credentials stored in a k8s secret, if applicable.
	SSOSecretRef *corev1.SecretReference `json:"ssoSecretRef"`
	// DomainNameHintCheck holds optional configuration for the domain_name hint check.
	// When nil the check is skipped. Provide DomainName, EligibleHosts, and FlavorName
	// to exercise the filter_external_customer path for CR reservation scheduling.
	DomainNameHintCheck *DomainNameHintConfig `json:"domainNameHintCheck,omitempty"`
}

type DeschedulingsCleanup struct {
	// Client for the kubernetes API.
	client.Client
	// Kubernetes scheme to use for the deschedulings.
	Scheme *runtime.Scheme
}

type DeschedulingsCleanupOnStartup struct{ *DeschedulingsCleanup }

type DeschedulingsExecutor struct {
	// Client for the kubernetes API.
	client.Client
	// Kubernetes scheme to use for the deschedulings.
	Scheme *runtime.Scheme

	// Nova client to execute the descheduling operations.
	NovaClient NovaClient
	// Configuration for the descheduler.
	Conf DeschedulingsExecutorConfig
}

type DeschedulingsExecutorConfig struct {
	// DisableDeschedulerDryRun disables the dry-run mode of the descheduler, allowing it to execute live-migrations.
	DisableDeschedulerDryRun bool `json:"disableDeschedulerDryRun"`
}

type DetectorCycleBreaker struct {
	// Nova API to get needed information for cycle detection.
	NovaClient NovaClient
}

type DetectorPipelineController struct {
	// Toolbox shared between all pipeline controllers.
	lib.BasePipelineController[*lib.DetectorPipeline[plugins.VMDetection]]

	// Monitor to pass down to all pipelines.
	Monitor lib.DetectorPipelineMonitor
	// Cycle detector to avoid descheduling loops.
	Breaker lib.DetectorCycleBreaker[plugins.VMDetection]
}

type DomainNameHintConfig struct {
	// DomainName is the OpenStack domain name passed as the domain_name scheduler hint.
	// Use a real domain name from the target environment so filter_external_customer
	// can apply its prefix-matching logic.
	DomainName string `json:"domainName"`
	// EligibleHosts is the list of compute hostnames offered to the scheduler.
	// Include at least one host with CUSTOM_EXTERNAL_CUSTOMER_EXCLUSIVE and one without
	// to give the filter something to act on.
	EligibleHosts []string `json:"eligibleHosts"`
	// FlavorName is the Nova flavor name to use in the request (e.g. "g_k_c1_m2_v2").
	FlavorName string `json:"flavorName"`
	// FlavorExtraSpecs are the extra specs for the flavor. Required by most pipeline
	// filters to determine hypervisor type, capabilities, and traits.
	// Example: {"capabilities:hypervisor_type": "CH", "quota:hw_version": "2101"}
	FlavorExtraSpecs map[string]string `json:"flavorExtraSpecs,omitempty"`
	// Pipeline is the scheduler pipeline to target. Empty means default.
	Pipeline string `json:"pipeline,omitempty"`
}

type FeatureGates struct {
	// CommittedResourceTracking enables committed resource integration: writing
	// placed VM UUIDs back into Reservation slots and classifying no-host-found
	// results by committed resource coverage. Enable only on deployments that
	// use committed resources.
	CommittedResourceTracking bool `json:"committedResourceTracking,omitempty"`
}

type FilterWeigherPipelineController struct {
	// Toolbox shared between all pipeline controllers.
	lib.BasePipelineController[lib.FilterWeigherPipeline[api.ExternalSchedulerRequest]]

	// FeatureGates holds feature flags for this controller.
	FeatureGates FeatureGates
	// Monitor to pass down to all pipelines.
	Monitor lib.FilterWeigherPipelineMonitor

	// CRRecorder receives scheduling events and updates CR reservations and metrics.
	CRRecorder crs.Recorder
	// contains filtered or unexported fields
}

type HTTPAPI interface {
	// Bind the server handlers.
	Init(*http.ServeMux)
}

type HTTPAPIConfig struct {
	// Number of top hosts to shuffle for evacuation requests.
	// Set to 0 or negative to disable shuffling.
	EvacuationShuffleK int `json:"evacuationShuffleK,omitempty"`
	// NovaLimitHostsToRequest, if true, will filter the Nova scheduler response
	// to only include hosts that were in the original request.
	NovaLimitHostsToRequest bool `json:"novaLimitHostsToRequest,omitempty"`
}

type HTTPAPIDelegate interface {
	// Process the decision from the API. Should create and return the updated decision.
	ProcessNewDecisionFromAPI(ctx context.Context, decision *v1alpha1.Decision) error
}

type HistoryCleanupConfig struct {
	// Secret ref to keystone credentials stored in a k8s secret.
	KeystoneSecretRef corev1.SecretReference `json:"keystoneSecretRef"`
	// Secret ref to SSO credentials stored in a k8s secret, if applicable.
	SSOSecretRef *corev1.SecretReference `json:"ssoSecretRef"`
}

type HypervisorOvercommitConfig struct {
	// OvercommitMappings is a list of mappings that map hypervisor traits to
	// overcommit ratios. Note that this list is applied in order, so if there
	// are multiple mappings applying to the same hypervisors, the last mapping
	// in this list will override the previous ones.
	OvercommitMappings []HypervisorOvercommitMapping `json:"overcommitMappings"`
}

type HypervisorOvercommitController struct {
	client.Client
	// contains filtered or unexported fields
}

type HypervisorOvercommitMapping struct {
	// Overcommit is the overcommit ratio to set for hypervisors by resource name.
	// Values must be set to something >= 1.0, otherwise the controller will
	// ignore them.
	Overcommit map[hv1.ResourceName]float64 `json:"overcommit"`

	// HasTrait specifies a trait that a hypervisor may have, and that, if present,
	// triggers the controller to set the overcommit ratio specified in the
	// overcommit field for that hypervisor.
	HasTrait *string `json:"hasTrait,omitempty"`

	// HasntTrait specifies a trait that a hypervisor may have, and that, if
	// NOT present, triggers the controller to set the overcommit ratio
	// specified in the overcommit field for that hypervisor.
	HasntTrait *string `json:"hasntTrait,omitempty"`
}

type NovaClient interface {
	// Initialize the Nova API with the Keystone authentication.
	Init(ctx context.Context, client client.Client, conf NovaClientConfig) error
	// Get a server by ID.
	Get(ctx context.Context, id string) (server, error)
	// Live migrate a server to a new host (doesnt wait for it to complete).
	LiveMigrate(ctx context.Context, id string) error
	// Get migrations for a server by ID.
	GetServerMigrations(ctx context.Context, id string) ([]migration, error)
	// List all servers for a project with detailed info.
	ListProjectServers(ctx context.Context, projectID string) ([]ServerDetail, error)
}

type NovaClientConfig struct {
	// Secret ref to keystone credentials stored in a k8s secret.
	KeystoneSecretRef corev1.SecretReference `json:"keystoneSecretRef"`

	// Secret ref to SSO credentials stored in a k8s secret, if applicable.
	SSOSecretRef *corev1.SecretReference `json:"ssoSecretRef,omitempty"`
}

type ServerDetail struct {
	ID               string            `json:"id"`
	Name             string            `json:"name"`
	Status           string            `json:"status"`
	TenantID         string            `json:"tenant_id"`
	Created          string            `json:"created"`
	AvailabilityZone string            `json:"OS-EXT-AZ:availability_zone"`
	Hypervisor       string            `json:"OS-EXT-SRV-ATTR:hypervisor_hostname"`
	FlavorName       string            // Populated from nested flavor.original_name
	FlavorRAM        uint64            // Populated from nested flavor.ram
	FlavorVCPUs      uint64            // Populated from nested flavor.vcpus
	FlavorDisk       uint64            // Populated from nested flavor.disk
	Metadata         map[string]string // Server metadata key-value pairs
	Tags             []string          // Server tags
	OSType           string            // OS type determined by OSTypeProber
}