Rename PodInfo struct to EndpointMetadata to better reflect its purpose by shmuelk · Pull Request #1866 · kubernetes-sigs/gateway-api-inference-extension

shmuelk · 2025-11-16T10:57:18Z

What type of PR is this?
/kind cleanup

What this PR does / why we need it:
Gateway Inference Extension (GIE) PR #1663 added support for vLLM's Data Parallel feature. This feature enables running more than one exposed vLLM HTTP endpoint in a pod/container.

Previously the GIE assumed that there was only one vLLM endpoint per pod. Thus it tracked per pod information and called it PodInfo.

To simplify things PR #1663 simply treated each of the vLLM endpoints, described in a GIE InferencePool, as another pod with an appropriate PodInfo struct.

It was pointed out during the review of PR #1663 by @kfswain that we need to rename some of the structs due to the changes. Details can be found here

This PR is the first of several that will refactor/rename various structs/APIs to better reflect their usage.

In particular this PR:

Renames PodInfo (in pkg/epp/datalayer) to EndpointMetadata
Renames EndpointPodState (in pkg/epp/datalayer) to EndpointMetaState
- Its functions GetPod() and UpdatePod() have been renamed GetMetadata() and UpdateMetadata() repectively
Many places in the code that referenced backendmetrics.PodMetrics now referrece datalayer.Endpoint directly

Future PRs will do more of this refactoring/renaming and will improve variable names in the code as well.

None

netlify · 2025-11-16T10:57:24Z

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

Name	Link
🔨 Latest commit	`227243c`
🔍 Latest deploy log	https://app.netlify.com/projects/gateway-api-inference-extension/deploys/693555bce610120008f97668
😎 Deploy Preview	https://deploy-preview-1866--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.

kfswain · 2025-11-21T19:29:13Z

 }

-func (pm *podMetrics) GetPod() *backend.Pod {
+func (pm *podMetrics) GetMetadata() *backend.Pod {


This one still returns a backend.Pod :(

This seems to just be an indirection/alias of datalayer.PodInfo.

gateway-api-inference-extension/pkg/epp/backend/pod.go

Line 23 in 9dccb4b

type Pod = datalayer.PodInfo

Do we know if this is needed?

I have updated the code you mentioned.

The indirection/alias of backend.Pod to datalayer.EndpointMetadata (was PodInfo) is still used in many places in the code.

This PR removes some of those "indirect references". I though to take care of this in multiple PRs to keep the size down.

I can if you want, make all of the changes in one Pr.

elevran · 2025-12-02T14:24:17Z

@@ -480,7 +480,7 @@ func makePodListFunc(ds datastore.Datastore) func() []types.NamespacedName {
 		names := make([]types.NamespacedName, 0, len(pods))

 		for _, p := range pods {


I presume a future PR will remove all references to Pod?
For example for _, p := range pods of the function name/type (makePodListFunc)

elevran · 2025-12-02T14:25:27Z


 func (fpm *FakePodMetrics) String() string {
-	return fmt.Sprintf("Pod: %v; Metrics: %v", fpm.GetPod(), fpm.GetMetrics())
+	return fmt.Sprintf("Pod: %v; Metrics: %v", fpm.GetMetadata(), fpm.GetMetrics())


if you're changing this line anyway consider changing the text as well.

Suggested change

return fmt.Sprintf("Pod: %v; Metrics: %v", fpm.GetMetadata(), fpm.GetMetrics())

return fmt.Sprintf("Metadata: %v; Metrics: %v", fpm.GetMetadata(), fpm.GetMetrics())

The same applies in other lines in all files where you've already replaced the GetPod() and contain pod

elevran · 2025-12-02T14:29:32Z


 func (pm *podMetrics) stopRefreshLoop() {
-	pm.logger.V(logutil.DEFAULT).Info("Stopping refresher", "pod", pm.GetPod())
+	pm.logger.V(logutil.DEFAULT).Info("Stopping refresher", "pod", pm.GetMetadata())


Suggested change

pm.logger.V(logutil.DEFAULT).Info("Stopping refresher", "pod", pm.GetMetadata())

pm.logger.V(logutil.DEFAULT).Info("Stopping refresher", "endpoint", pm.GetMetadata())

elevran · 2025-12-02T14:34:03Z

 // pooled memory or other management chores in the implementation.
 type EndpointFactory interface {
-	NewEndpoint(parent context.Context, inpod *PodInfo, poolinfo PoolInfo) Endpoint
+	NewEndpoint(parent context.Context, inEnpointMetadata *EndpointMetadata, poolinfo PoolInfo) Endpoint


nit: prefer shorter variables if possible (e.g., meta or inmd in this case)?

elevran · 2025-12-02T14:34:56Z

 	}

-	logger := log.FromContext(ctx).WithValues("pod", ep.GetPod().NamespacedName)
+	logger := log.FromContext(ctx).WithValues("pod", ep.GetMetadata().NamespacedName)


Suggested change

logger := log.FromContext(ctx).WithValues("pod", ep.GetMetadata().NamespacedName)

logger := log.FromContext(ctx).WithValues("metadata", ep.GetMetadata().NamespacedName)

elevran · 2025-12-02T14:36:26Z

/lgtm

elevran · 2025-12-02T19:39:05Z

/lgtm

kfswain · 2025-12-04T19:11:53Z

/approve

k8s-ci-robot · 2025-12-04T19:12:01Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kfswain, shmuelk

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [kfswain]

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

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

elevran · 2025-12-07T11:06:33Z

/lgtm

…se (kubernetes-sigs/gateway-api-inference-extension#1866) * Renamed PodInfo EndpointMetadata Signed-off-by: Shmuel Kallner <kallner@il.ibm.com> * Non test code updates due to PodInfo rename Signed-off-by: Shmuel Kallner <kallner@il.ibm.com> * Test updates due to PodInfo rename Signed-off-by: Shmuel Kallner <kallner@il.ibm.com> * Updated new code with new struct names Signed-off-by: Shmuel Kallner <kallner@il.ibm.com> * Changed PodInfo to EndpointMetadata in comments and test function names Signed-off-by: Shmuel Kallner <kallner@il.ibm.com> * Updates from review comments Signed-off-by: Shmuel Kallner <kallner@il.ibm.com> * Updated code from rebase Signed-off-by: Shmuel Kallner <kallner@il.ibm.com> * Make messages and variable names somewhat more consistent Signed-off-by: Shmuel Kallner <kallner@il.ibm.com> * Rebase correction that was missed Signed-off-by: Shmuel Kallner <kallner@il.ibm.com> * Rebase corrections due to other changes Signed-off-by: Shmuel Kallner <kallner@il.ibm.com> --------- Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

k8s-ci-robot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Nov 16, 2025

k8s-ci-robot requested review from elevran and kfswain November 16, 2025 10:57

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. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Nov 16, 2025

shmuelk force-pushed the rename-part-one branch from facd8e6 to 0ec1d80 Compare November 18, 2025 11:24

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

kfswain mentioned this pull request Nov 18, 2025

Enable EPP to support endpoint discovery using pod selector #1833

Merged

shmuelk force-pushed the rename-part-one branch from 0ec1d80 to 474bc16 Compare November 19, 2025 12:07

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

kfswain reviewed Nov 21, 2025

View reviewed changes

shmuelk force-pushed the rename-part-one branch from 37ce4da to e4f723b Compare November 23, 2025 10:29

k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Nov 23, 2025

shmuelk force-pushed the rename-part-one branch from 79b282b to cc1c41e Compare December 1, 2025 16:01

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

elevran reviewed Dec 2, 2025

View reviewed changes

k8s-ci-robot assigned elevran Dec 2, 2025

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

shmuelk force-pushed the rename-part-one branch from 1b86ae1 to 335982f Compare December 2, 2025 15:50

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 2, 2025

k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Dec 2, 2025

shmuelk force-pushed the rename-part-one branch from af24cde to ef6aed2 Compare December 4, 2025 19:09

k8s-ci-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Dec 4, 2025

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Dec 4, 2025

shmuelk added 9 commits December 7, 2025 11:30

Renamed PodInfo EndpointMetadata

ec6598b

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

Non test code updates due to PodInfo rename

af9cdbd

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

Test updates due to PodInfo rename

ac7ce6c

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

Updated new code with new struct names

7f5098f

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

Changed PodInfo to EndpointMetadata in comments and test function names

5f26a8b

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

Updates from review comments

de2d347

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

Updated code from rebase

192584b

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

Make messages and variable names somewhat more consistent

0827910

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

Rebase correction that was missed

6fad61d

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

shmuelk force-pushed the rename-part-one branch from ef6aed2 to 6fad61d Compare December 7, 2025 10:23

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

Rebase corrections due to other changes

227243c

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

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

k8s-ci-robot merged commit 5a65e9f into kubernetes-sigs:main Dec 7, 2025
12 checks passed

shmuelk deleted the rename-part-one branch December 10, 2025 15:05

		@@ -480,7 +480,7 @@ func makePodListFunc(ds datastore.Datastore) func() []types.NamespacedName {
		names := make([]types.NamespacedName, 0, len(pods))

		for _, p := range pods {

	return fmt.Sprintf("Pod: %v; Metrics: %v", fpm.GetMetadata(), fpm.GetMetrics())
	return fmt.Sprintf("Metadata: %v; Metrics: %v", fpm.GetMetadata(), fpm.GetMetrics())

	pm.logger.V(logutil.DEFAULT).Info("Stopping refresher", "pod", pm.GetMetadata())
	pm.logger.V(logutil.DEFAULT).Info("Stopping refresher", "endpoint", pm.GetMetadata())

	logger := log.FromContext(ctx).WithValues("pod", ep.GetMetadata().NamespacedName)
	logger := log.FromContext(ctx).WithValues("metadata", ep.GetMetadata().NamespacedName)

Conversation

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

Uh oh!

Uh oh!

netlify Bot commented Nov 16, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elevran commented Dec 2, 2025

Uh oh!

elevran commented Dec 2, 2025

Uh oh!

kfswain commented Dec 4, 2025

Uh oh!

k8s-ci-robot commented Dec 4, 2025

Uh oh!

elevran commented Dec 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

shmuelk commented Nov 16, 2025 •

edited

Loading

netlify Bot commented Nov 16, 2025 •

edited

Loading