Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add EP-10611 #10674

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add EP-10611 #10674

wants to merge 2 commits into from

Conversation

lgadban
Copy link
Contributor

@lgadban lgadban commented Feb 20, 2025

No description provided.

@lgadban lgadban force-pushed the law/ep-rename-upstream branch from 42654db to 1b4826d Compare February 20, 2025 20:17
design/10611.md Outdated

AWS Lambdas and GCP Cloud Run services are examples of backends that have no native representation in Kubernetes, thus a standalone resource to represent them makes complete sense.

Static/external hosts theoretically have a way to be expressed via K8s as `Service` of `ExternalName` type, although this usage is not supported in Gloo Gateway (and now, kgateway) mostly due to lack of user demand. Additionally, there are some caveats with ExternalName services that may discourage use if there is a viable alternative. In this case, using the `Upstream` resource also makes sense.
Copy link
Contributor

Choose a reason for hiding this comment

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

there are some caveats with ExternalName services

what are the caveats?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See the 'Caution' section here: https://kubernetes.io/docs/concepts/services-networking/service/#externalname

I'll add this reference into the EP.

design/10611.md Outdated
The `Upstream` name and concept are well-established for GG users but the current API does not completely fit the semantics and idioms of the K8s Gateway API.

The first "layer" of defining various backend types that do not have a native K8s representation is still relevant & important within K8s Gateway API, with the exception of not needing to support native `Services`.
In fact, this is the [primary extension point](https://gateway-api.sigs.k8s.io/concepts/api-overview/#extension-points) for supporting non-K8s backends.
Copy link
Contributor

Choose a reason for hiding this comment

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

"this is the primary extension point" - do you mean backendRefs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"This" being a custom type that backendRefs can refer to.

I'll clear this wording up.


## Proposal

**Rename the `Upstream.kgateway.dev` type to `Backend.kgateway.dev`.**
Copy link
Contributor

Choose a reason for hiding this comment

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

are there pros / cons to having a single Backend resource vs having a separate resource per backend type, e.g. AwsBackend, GcpBackend, etc?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is definitely some discussion that can be had on this, in fact this might be relevant to the AI Gateway feature that is actively being worked on.

However I think it should be considered out of scope for this EP as I am primarily focused on the naming of the existing type, which is currently 'monolithic' API. The 'monolithic' style also currently applies to our policy APIs (e.g. RoutePolicy) so changing that should be a larger discussion.

That isn't to say that in the (near) future we may want to have discrete resources to represent the various backend types. In fact it may actually be preferable to go down this path but we should probably capture that in a separate EP.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants