|
| 1 | +/* |
| 2 | +Copyright 2025 The Kubernetes Authors. |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package framework |
| 18 | + |
| 19 | +import ( |
| 20 | + "context" |
| 21 | + "sync" |
| 22 | + |
| 23 | + scheduling "sigs.k8s.io/gateway-api-inference-extension/pkg/epp/scheduling/types" |
| 24 | +) |
| 25 | + |
| 26 | +// Plugin is the parent type for all the scheduling framework plugins. |
| 27 | +type Plugin interface { |
| 28 | + Name() string |
| 29 | +} |
| 30 | + |
| 31 | +type Endpoint interface { |
| 32 | + GetState() EndpointState |
| 33 | + GetScore() float32 |
| 34 | + SetScore(val float32) |
| 35 | +} |
| 36 | + |
| 37 | +type EndpointState struct { |
| 38 | + // only need to use a sync.Map if we do not plan on snapshotting data. |
| 39 | + storage sync.Map |
| 40 | +} |
| 41 | + |
| 42 | +type SchedulingResult struct { |
| 43 | + results map[string][]Endpoint |
| 44 | +} |
| 45 | + |
| 46 | +type Scheduler interface { |
| 47 | + Plugin |
| 48 | + // ProfileSelection is an optional function that selects scheduling |
| 49 | + // profiles through the implemented logic, and returns a subset of the |
| 50 | + // registered scheduling profiles. |
| 51 | + ProfileSelection() map[string]SchedulingProfile |
| 52 | + |
| 53 | + // SchedulingProfiles lists all of the scheduling profiles registered |
| 54 | + // with the scheduler. |
| 55 | + SchedulingProfiles() map[string]SchedulingProfile |
| 56 | + |
| 57 | + // SchedulingResult takes the output of the result(s) of the scheduling cycle(s) |
| 58 | + // and makes sense of the data to be consumed by request control. |
| 59 | + // For example: suppose you have 2 profiles ShadowBoxing Profile & Production Profile. |
| 60 | + // SchedulingResult would know to simply log the result of ShadowBoxing |
| 61 | + // profile, and do nothing else with it. |
| 62 | + SchedulingResult(map[string][]Endpoint) SchedulingResult |
| 63 | +} |
| 64 | + |
| 65 | +// SchedulingProfile is an interface to used to describe a profile that will |
| 66 | +// run for a given scheduling cycle. |
| 67 | +type SchedulingProfile interface { |
| 68 | + Plugin |
| 69 | + // PreSchedulePlugins are optional, and will be ran at the start of a |
| 70 | + // scheduling cycle. This should be scoped to any foundational work needed |
| 71 | + // that is custom to this scheduling profile. |
| 72 | + PreSchedulePlugins() []PreSchedule |
| 73 | + // Filters lists all Filter plugins associated with this Profile. Filters |
| 74 | + // are optional. |
| 75 | + Filters() []Filter |
| 76 | + // Scorers lists all Score plugins associated with this Profile. At |
| 77 | + // least 1 scorer must be registered for a profile to be valid. |
| 78 | + Scorers() map[Scorer]int |
| 79 | + // Selection returns the function that picks the endpoint(s). |
| 80 | + Selection() Picker |
| 81 | + // PostSchedulePlugins lists all Filter plugins associated with this |
| 82 | + // Profile. PostSchedulePlugins are ran after every scheduling cycle, |
| 83 | + // and are optional. |
| 84 | + PostSchedulePlugins() []PostSchedule |
| 85 | +} |
| 86 | + |
| 87 | +// Preschedule will be ran at the start of a scheduling cycle. This should be |
| 88 | +// scoped to any foundational work needed that is custom to this scheduling |
| 89 | +// profile. |
| 90 | +type PreSchedule interface { |
| 91 | + Plugin |
| 92 | + PreSchedule(ctx context.Context, state scheduling.CycleState, endpoints []Endpoint) |
| 93 | +} |
| 94 | + |
| 95 | +// Filter runs before any scoring, and remove endpoints that are not fit for |
| 96 | +// selection. The framework will return an error to the client if the endpoints |
| 97 | +// are filtered to zero. |
| 98 | +type Filter interface { |
| 99 | + Plugin |
| 100 | + Filter(ctx context.Context, state scheduling.CycleState, endpoints []Endpoint) []Endpoint |
| 101 | +} |
| 102 | + |
| 103 | +// Scorer applies a score to each remaining endpoint provided. Scorers SHOULD |
| 104 | +// keep their score values in a normalized range: [0-1]. Any weighting should |
| 105 | +// be added at the SchedulingProfile configuration level. |
| 106 | +type Scorer interface { |
| 107 | + Plugin |
| 108 | + Score(ctx context.Context, state scheduling.CycleState, endpoints []Endpoint) []Endpoint |
| 109 | +} |
| 110 | + |
| 111 | +// Picker selects the endpoint(s) from the provided list of scored endpoints. |
| 112 | +// Picker MUST return, one endpoint at minimum. |
| 113 | +type Picker interface { |
| 114 | + Plugin |
| 115 | + Selection(ctx context.Context, state scheduling.CycleState, endpoints []Endpoint) []Endpoint |
| 116 | +} |
| 117 | + |
| 118 | +// PostSchedule runs per-scheduling cycle, and is part of a scheduling profile. |
| 119 | +// PostSchedule performs any remaining work needed for the scheduling cycle. |
| 120 | +// PostSchedule is not expected to change any values of the parameters. |
| 121 | +type PostSchedule interface { |
| 122 | + Plugin |
| 123 | + PostSchedule(ctx context.Context, state scheduling.CycleState, selectedEndpoints []Endpoint) |
| 124 | +} |
0 commit comments