|
| 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 scheduling |
| 18 | + |
| 19 | +import ( |
| 20 | + "fmt" |
| 21 | + |
| 22 | + "sigs.k8s.io/gateway-api-inference-extension/pkg/epp/scheduling/plugins" |
| 23 | + "sigs.k8s.io/gateway-api-inference-extension/pkg/epp/scheduling/plugins/scorer" |
| 24 | +) |
| 25 | + |
| 26 | +// NewSchedulerConfig creates a new SchedulerConfig object and returns its pointer. |
| 27 | +func NewSchedulerConfig() *SchedulerConfig { |
| 28 | + return &SchedulerConfig{ |
| 29 | + preSchedulePlugins: []plugins.PreSchedule{}, |
| 30 | + filters: []plugins.Filter{}, |
| 31 | + scorers: []*scorer.WeightedScorer{}, |
| 32 | + postSchedulePlugins: []plugins.PostSchedule{}, |
| 33 | + postResponsePlugins: []plugins.PostResponse{}, |
| 34 | + // picker remains nil since config doesn't support multiple pickers |
| 35 | + } |
| 36 | +} |
| 37 | + |
| 38 | +// SchedulerConfig provides a configuration for the scheduler which influence routing decisions. |
| 39 | +type SchedulerConfig struct { |
| 40 | + preSchedulePlugins []plugins.PreSchedule |
| 41 | + filters []plugins.Filter |
| 42 | + scorers []*scorer.WeightedScorer |
| 43 | + picker plugins.Picker |
| 44 | + postSchedulePlugins []plugins.PostSchedule |
| 45 | + postResponsePlugins []plugins.PostResponse |
| 46 | +} |
| 47 | + |
| 48 | +// WithPreSchedulePlugins sets the given plugins as the PreSchedule plugins. |
| 49 | +// If the SchedulerConfig has PreSchedule plugins, this call replaces the existing plugins with the given ones. |
| 50 | +func (c *SchedulerConfig) WithPreSchedulePlugins(plugins ...plugins.PreSchedule) *SchedulerConfig { |
| 51 | + c.preSchedulePlugins = plugins |
| 52 | + return c |
| 53 | +} |
| 54 | + |
| 55 | +// WithFilters sets the given filter plugins as the Filter plugins. |
| 56 | +// if the SchedulerConfig has Filter plugins, this call replaces the existing plugins with the given ones. |
| 57 | +func (c *SchedulerConfig) WithFilters(filters ...plugins.Filter) *SchedulerConfig { |
| 58 | + c.filters = filters |
| 59 | + return c |
| 60 | +} |
| 61 | + |
| 62 | +// WithScorers sets the given scorer plugins as the Scorer plugins. |
| 63 | +// if the SchedulerConfig has Scorer plugins, this call replaces the existing plugins with the given ones. |
| 64 | +func (c *SchedulerConfig) WithScorers(scorers ...*scorer.WeightedScorer) *SchedulerConfig { |
| 65 | + c.scorers = scorers |
| 66 | + return c |
| 67 | +} |
| 68 | + |
| 69 | +// WithPicker sets the given picker plugins as the Picker plugin. |
| 70 | +// if the SchedulerConfig has Picker plugin, this call replaces the existing plugin with the given one. |
| 71 | +func (c *SchedulerConfig) WithPicker(picker plugins.Picker) *SchedulerConfig { |
| 72 | + c.picker = picker |
| 73 | + return c |
| 74 | +} |
| 75 | + |
| 76 | +// WithPostSchedulePlugins sets the given plugins as the PostSchedule plugins. |
| 77 | +// If the SchedulerConfig has PostSchedule plugins, this call replaces the existing plugins with the given ones. |
| 78 | +func (c *SchedulerConfig) WithPostSchedulePlugins(plugins ...plugins.PostSchedule) *SchedulerConfig { |
| 79 | + c.postSchedulePlugins = plugins |
| 80 | + return c |
| 81 | +} |
| 82 | + |
| 83 | +// WithPostResponsePlugins sets the given plugins as the PostResponse plugins. |
| 84 | +// If the SchedulerConfig has PostResponse plugins, this call replaces the existing plugins with the given ones. |
| 85 | +func (c *SchedulerConfig) WithPostResponsePlugins(plugins ...plugins.PostResponse) *SchedulerConfig { |
| 86 | + c.postResponsePlugins = plugins |
| 87 | + return c |
| 88 | +} |
| 89 | + |
| 90 | +// AddPlugins adds the given plugins to all scheduler plugins according to the interfaces each plugin implements. |
| 91 | +// A plugin may implement more than one scheduler plugin interface. |
| 92 | +// Special Case: In order to add a scorer, one must use the scorer.NewWeightedScorer function in order to provide a weight. |
| 93 | +// if a scorer implements more than one interface, supplying a WeightedScorer is sufficient. The function will take the internal |
| 94 | +// scorer object and register it to all interfaces it implements. |
| 95 | +func (c *SchedulerConfig) AddPlugins(pluginObjects ...plugins.Plugin) error { |
| 96 | + for _, plugin := range pluginObjects { |
| 97 | + if weightedScorer, ok := plugin.(*scorer.WeightedScorer); ok { |
| 98 | + c.scorers = append(c.scorers, weightedScorer) |
| 99 | + plugin = weightedScorer.Scorer // if we got WeightedScorer, unwrap the plugin |
| 100 | + } else if scorer, ok := plugin.(plugins.Scorer); ok { // if we got a Scorer instead of WeightedScorer that's an error. |
| 101 | + return fmt.Errorf("failed to register scorer '%s' without a weight. follow function documentation to register a scorer", scorer.Name()) |
| 102 | + } |
| 103 | + if preSchedulePlugin, ok := plugin.(plugins.PreSchedule); ok { |
| 104 | + c.preSchedulePlugins = append(c.preSchedulePlugins, preSchedulePlugin) |
| 105 | + } |
| 106 | + if filter, ok := plugin.(plugins.Filter); ok { |
| 107 | + c.filters = append(c.filters, filter) |
| 108 | + } |
| 109 | + if picker, ok := plugin.(plugins.Picker); ok { |
| 110 | + if c.picker != nil { |
| 111 | + return fmt.Errorf("failed to set '%s' as picker, already have a registered picker plugin '%s'", picker.Name(), c.picker.Name()) |
| 112 | + } |
| 113 | + c.picker = picker |
| 114 | + } |
| 115 | + if postSchedulePlugin, ok := plugin.(plugins.PostSchedule); ok { |
| 116 | + c.postSchedulePlugins = append(c.postSchedulePlugins, postSchedulePlugin) |
| 117 | + } |
| 118 | + if postResponsePlugin, ok := plugin.(plugins.PostResponse); ok { |
| 119 | + c.postResponsePlugins = append(c.postResponsePlugins, postResponsePlugin) |
| 120 | + } |
| 121 | + } |
| 122 | + return nil |
| 123 | +} |
0 commit comments