Implement EPP Plugins by datalayer objects #1901

elevran · 2025-11-25T15:20:59Z

What type of PR is this?
/kind feature

What this PR does / why we need it:
Implement Plugin interface by data layer objects (DataSources and Extractors) to enable configuration from file.

Refactor EPP's plugins.Handle object PodList method to avoid circular import dependency (datalayer imports plugins.TypedName and at the same time plugins.Handle.ListPod imports datalayer.Endpoint/backendmetrics.PodMetrics). Replaced with a "narrower" function that only returns the pod names so prefix scorer (the only current user) can evict entries for terminated Pods.
Add TypedName() (replacing Name()) to datalayer objects so they're "proper" plugins and can be instantiated by the configuration loader in a future PR. Note that we expect a unique type for each DataSource/Extractor so Name is effectively ignore and left empty.
Rmove unused datalayer.metrics.Client from NewDataSource (nil was passed in all cases)
Define the data layer conifguration struct

Which issue(s) this PR fixes:
Ref #1883

Does this PR introduce a user-facing change?:
Not yet. This lays the ground work for enabling data layer section in the config file but does not implement it yet.

NONE

netlify · 2025-11-25T15:21:05Z

✅ Deploy Preview for gateway-api-inference-extension ready!

Name	Link
🔨 Latest commit	`2f704b9`
🔍 Latest deploy log	https://app.netlify.com/projects/gateway-api-inference-extension/deploys/69274e142c73c6000813bf4d
😎 Deploy Preview	https://deploy-preview-1901--gateway-api-inference-extension.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

elevran · 2025-11-25T15:28:47Z

/cc
@nirrozenbaum @kfswain
@shmuelk (please review config object)

k8s-ci-robot · 2025-11-25T15:28:50Z

@elevran: GitHub didn't allow me to request PR reviews from the following users: elevran.

Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc
@nirrozenbaum @kfswain
@shmuelk (please review config object)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

pkg/epp/datalayer/config.go

pkg/epp/datalayer/metrics/datasource.go

cmd/epp/runner/runner.go

pkg/epp/datalayer/collector_test.go

pkg/epp/datalayer/datasource_test.go

pkg/epp/datalayer/metrics/datasource.go

shmuelk · 2025-11-25T16:05:10Z

Please change DataSource and Extractor to be more like the other plugins. They all have a field TypedName, that gets set in the factory function. The TypedNAme function, should simply return that field.

Signed-off-by: Etai Lev Ran <[email protected]>

elevran · 2025-11-26T12:20:37Z

@shmuelk all comments have been address and changes integrated. PTAL.

pkg/epp/datalayer/metrics/datasource.go

pkg/epp/datalayer/datasource.go

- use Name as the unique key to allow future extension to support multiple instances of the same type. - remove GetSourceByName/Type. Signed-off-by: Etai Lev Ran <[email protected]>

cmd/epp/runner/runner.go

shmuelk · 2025-11-27T12:52:50Z

/lgtm

cmd/epp/runner/runner.go

nirrozenbaum · 2025-11-27T13:40:10Z

pkg/epp/datalayer/metrics/datasource.go

 // DataSource is a Model Server Protocol (MSP) compliant metrics data source,
 // returning Prometheus formatted metrics for an endpoint.
 type DataSource struct {
+	tn            plugins.TypedName


nit: consistency with other plugins?

Suggested change

tn plugins.TypedName

typedName plugins.TypedName

current plugins use both typedName (most) and tn (e.g., lora affinity, slo scorer, some mocks in test files).
The scope (i.e., distance between where defined and used) is small enough to use tn here.
If you think it's important, can open another PR to standardize on on typedName across the entire code base.

nirrozenbaum · 2025-11-27T13:46:56Z

pkg/epp/datalayer/datasource.go

 	}
-	if _, loaded := dsr.sources.LoadOrStore(src.Name(), src); loaded {
-		return fmt.Errorf("unable to register duplicate data source: %s", src.Name())
+	if _, loaded := dsr.sources.LoadOrStore(src.TypedName().Name, src); loaded {


This is a bit confusing.
generally in the codebase, plugins have TypeName, where Type is mandatory and Name is optional.
when using ConfigFile Name defaults to Type is not mentioned otherwise, but that is not the case if configured through code (e.g., in unit tests name remains empty).
Additionally, in other plugins - Type is guaranteed to be unique, while Name is not.

maybe we can use TypedName.String() as the key of the map?

Was originally using Type as the key, went back and forth on this given @shmuelk feedback on usage for configuration file. You can see some of the discussion context in resolved conversations.

The plugin references in the configuration file use the plugin name as the reference key, hence the same is applied here.
At least in theory, you could have multiple sources or extractors of the same type registered (same as plugins).
If we want to change to use TypedName.String() should probaly do so across the entire config handling code.
@shmuelk ^^

nirrozenbaum · 2025-11-27T13:47:25Z

pkg/epp/datalayer/datasource_test.go


 type mockDataSource struct {
-	name string
+	tn plugins.TypedName


nirrozenbaum · 2025-11-27T14:02:55Z

pkg/epp/datalayer/config.go

+
+// Config defines the configuration of EPP data layer, as the set of DataSources and
+// Extractors defined on them.
+type Config struct {


is this struct a prep for next PR?

Correct!
Mainly to confirm the interface between the datalayer and the configuration setting code so they can proceed in parallel.

nirrozenbaum

left few minor non blocking comments.

I think it would be good if we standardize all plugins are keyed by TypedName in all places (in current PR, most of the places use Name but in other plugins TypedName as a whole is the unique identifier).

let's proceed with a "fix it forward" approach.

/lgtm
/approve

k8s-ci-robot · 2025-11-27T14:09:04Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: elevran, nirrozenbaum, shmuelk

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [nirrozenbaum]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

elevran · 2025-11-27T14:15:10Z

I think it would be good if we standardize all plugins are keyed by TypedName in all places (in current PR, most of the places use Name but in other plugins TypedName as a whole is the unique identifier).

let's proceed with a "fix it forward" approach.

#1910 created for tracking.

k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Nov 25, 2025

k8s-ci-robot requested review from ahg-g and robscott November 25, 2025 15:21

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 25, 2025

shmuelk suggested changes Nov 25, 2025

View reviewed changes

pkg/epp/datalayer/config.go Outdated Show resolved Hide resolved

pkg/epp/datalayer/metrics/datasource.go Outdated Show resolved Hide resolved

pkg/epp/datalayer/metrics/datasource.go Outdated Show resolved Hide resolved

shmuelk suggested changes Nov 25, 2025

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 25, 2025

elevran added 5 commits November 26, 2025 13:32

decouple handle from data layer types

3af0260

Signed-off-by: Etai Lev Ran <[email protected]>

make datasource and extractor comply with Plugin interface

ec27b21

Signed-off-by: Etai Lev Ran <[email protected]>

remove unused client from NewDataSource function

7f39815

Signed-off-by: Etai Lev Ran <[email protected]>

define datalayer configuration object

4cb4e25

Signed-off-by: Etai Lev Ran <[email protected]>

import grouping

c05299a

Signed-off-by: Etai Lev Ran <[email protected]>

elevran force-pushed the datalayer_std_plugins branch from e8d4564 to c05299a Compare November 26, 2025 11:44

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 26, 2025

elevran added 3 commits November 26, 2025 13:49

change config field names per PR review

b0b61c1

Signed-off-by: Etai Lev Ran <[email protected]>

embed Plugin interface directly

b986abc

Signed-off-by: Etai Lev Ran <[email protected]>

address PR comments on use of type/name

9b72e7e

Signed-off-by: Etai Lev Ran <[email protected]>

shmuelk suggested changes Nov 26, 2025

View reviewed changes

pkg/epp/datalayer/metrics/datasource.go Outdated Show resolved Hide resolved

pkg/epp/datalayer/datasource.go Outdated Show resolved Hide resolved

pkg/epp/datalayer/datasource.go Outdated Show resolved Hide resolved

pkg/epp/datalayer/datasource.go Outdated Show resolved Hide resolved

Address remaining review comments.

2f704b9

- use Name as the unique key to allow future extension to support multiple instances of the same type. - remove GetSourceByName/Type. Signed-off-by: Etai Lev Ran <[email protected]>

elevran commented Nov 26, 2025

View reviewed changes

cmd/epp/runner/runner.go Show resolved Hide resolved

shmuelk approved these changes Nov 27, 2025

View reviewed changes

k8s-ci-robot assigned shmuelk Nov 27, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 27, 2025

nirrozenbaum reviewed Nov 27, 2025

View reviewed changes

cmd/epp/runner/runner.go Show resolved Hide resolved

nirrozenbaum reviewed Nov 27, 2025

View reviewed changes

pkg/epp/datalayer/datasource_test.go

type mockDataSource struct {

name string

tn plugins.TypedName

Copy link

Contributor

nirrozenbaum Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typedName?

nirrozenbaum reviewed Nov 27, 2025

View reviewed changes

k8s-ci-robot assigned nirrozenbaum Nov 27, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 27, 2025

elevran mentioned this pull request Nov 27, 2025

Standardize the use of plugins.TypedName as key #1910

Open

k8s-ci-robot merged commit acd7103 into kubernetes-sigs:main Nov 27, 2025
12 checks passed

elevran mentioned this pull request Nov 27, 2025

Define and register plugin factories for datalayer #1911

Open

elevran deleted the datalayer_std_plugins branch November 27, 2025 18:10

Implement EPP Plugins by datalayer objects #1901

Implement EPP Plugins by datalayer objects #1901

Uh oh!

Conversation

elevran commented Nov 25, 2025

Uh oh!

netlify bot commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for gateway-api-inference-extension ready!

Uh oh!

elevran commented Nov 25, 2025

Uh oh!

k8s-ci-robot commented Nov 25, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shmuelk commented Nov 25, 2025

Uh oh!

elevran commented Nov 26, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shmuelk commented Nov 27, 2025

Uh oh!

Uh oh!

nirrozenbaum Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

elevran Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

nirrozenbaum Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

elevran Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

nirrozenbaum Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

nirrozenbaum Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

elevran Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

nirrozenbaum left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Nov 27, 2025

Uh oh!

elevran commented Nov 27, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

netlify bot commented Nov 25, 2025 •

edited

Loading