options.go

// Copyright SAP SE
// SPDX-License-Identifier: Apache-2.0

package scheduling

import (
	"errors"

	"github.com/cobaltcore-dev/cortex/api/v1alpha1"
)

// Options configure the behavior of a single pipeline run at call time.
// These are distinct from per-step YAML options (FilterWeigherPipelineStepOpts),
// which are static and set when the pipeline is initialized.
type Options struct {
	// ReadOnly means the pipeline run does not modify shared scheduling state (reservations,
	// history, ...). Cortex may run read-only runs concurrently.
	ReadOnly bool `json:"read_only,omitempty"`

	// AssumeEmptyHosts ignores running instances on hosts, considering them as empty.
	AssumeEmptyHosts bool `json:"assume_empty_hosts,omitempty"`
	// LockReservations prevents reservation unlocking, i.e. considering those as unavailable resources.
	LockReservations bool `json:"lock_reservations,omitempty"`
	// IgnoredReservationTypes lists reservation types which get completely ignored by filters/weighers.
	IgnoredReservationTypes []v1alpha1.ReservationType `json:"ignored_reservation_types,omitempty"`

	// MaxCandidates limits the number of candidates (hosts) returned after weighing. 0 means no limit.
	MaxCandidates int `json:"max_candidates,omitempty"`

	// SkipHistory skips recording the placement decision in placement history.
	SkipHistory bool `json:"skip_history,omitempty"`
	// SkipInflight skips creating pessimistic blocking reservations for returned candidates.
	SkipInflight bool `json:"skip_inflight,omitempty"`
	// SkipCommittedResourceTracking skips writing the placed VM UUID into the matching
	// committed resource reservation slot. Set for non-VM-placement runs (capacity checks,
	// failover scheduling, CR slot scheduling) that must not modify reservation allocations.
	SkipCommittedResourceTracking bool `json:"skip_committed_resource_tracking,omitempty"`
}

// Validate checks for mutually exclusive or inconsistent option combinations.
func (o Options) Validate() error {
	if o.ReadOnly && !o.SkipHistory {
		return errors.New("read-only runs must not write scheduling history: set SkipHistory=true")
	}
	if o.ReadOnly && !o.SkipInflight {
		return errors.New("read-only runs cannot create inflight reservations")
	}
	if o.ReadOnly && !o.SkipCommittedResourceTracking {
		return errors.New("read-only runs must not write CR reservation allocations: set SkipCommittedResourceTracking=true")
	}
	return nil
}