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

API adoption struggle #3288

Open
kfox1111 opened this issue Aug 21, 2024 · 7 comments
Open

API adoption struggle #3288

kfox1111 opened this issue Aug 21, 2024 · 7 comments
Labels
kind/bug Categorizes issue or PR as related to a bug. triage/needs-information Indicates an issue needs more information in order to work on it.

Comments

@kfox1111
Copy link

What happened:
Gateway API is using CRDS rather then builtins. Its hindering adoption.

What you expected to happen:
The community should support the gateway api

Anything else we need to know?:
Please respond to helm/helm#12912 (comment)
Helm really should have best practice recommendations for charts to use gateway api like it does ingress

@kfox1111 kfox1111 added the kind/bug Categorizes issue or PR as related to a bug. label Aug 21, 2024
@candita
Copy link
Contributor

candita commented Aug 21, 2024

This is an API, not an implementation, and there are already a list of helm charts in the ArtifactHub that seem related to Gateway API: https://artifacthub.io/packages/search?ts_query_web=gateway-api&sort=relevance&page=1
Each implementation of the API adds its own helm chart, which makes sense to me as good starting point for trying to standardize a helm chart.

@kfox1111
Copy link
Author

Its not about packaging gateway api implementations.

Its about making it easy for packagers of applications to include gateway api objects to make it possible for end users to use the gateway api when deploying those apps.

@candita
Copy link
Contributor

candita commented Aug 21, 2024

So, you want to be able to install the CRDs using helm, because installing the default way is not easy ?

@kfox1111
Copy link
Author

No CRDS. CR's. I want to be able to do the gateway api equivalent of (works today):

#install grafana and expose it via ingress
helm install grafana grafana --set ingres.enabled=true,ingress.hosts="grafana.example.org"

like, maybe:

#install grafana and expose it via the gateway api
helm install grafana grafana --set httpRoute.enabled=true,httpRoute.hosts="grafana.example.org" 

and have the application actually exposed properly via the cluster-admin installed gateway.

For the referred issue, its enabling:

helm create myapp

to produce the httpRoute templated code automatically so new helm chart writers wouldn't have to plumb in the httpRoute objects themselves. Just like it does for Ingress objects.

This would encurage support of the gateway api in all new helm charts rather then keep them working Ingress only.

@youngnick
Copy link
Contributor

youngnick commented Aug 22, 2024

Thanks for raising this @kfox1111!

I responded on that PR, but I agree that we need a better way to handle this - this has been in my head for some time, but I haven't had much to suggest, so I've been letting it simmer.

My current thought is that we help with defining standard fields for charts to use for HTTPRoutes.

Probably something like this (to put it in values.yaml style):

httpRoute:
  enabled: true # tbh I am not sure if this adds value by itself
  hostname: somehostname.example.com # sets the _first_ hostname in the hostnames list
  hostnames: # If you want to supply multiple - if `hostname` is also set, it will be prepended to the list
    - someotherhostname.example.com
    - thirdhostname.example.com
  parentRef:
    name: gatewayName
    namespace: gatewayNamespace
    group:  # Group, version, and kind default to Gateway, but are there so people can set other things as parents.
    version:  # These could be omitted in a first implementation.
    kind: 

My questions have mainly been in how to organize and publish this. Do we publish this as part of Gateway API, or do we do it in Helm? The latter will require more buy-in from the Helm community, which may be valuable anyway.

@kfox1111
Copy link
Author

Yeah, I think it would be most valuable if it was in helm. There 'helm create app' functionality deploys a web app out of the box, and exposing the web app outside the cluster is key functionality IMO. When I start a new chart, I usually start there.

If we can't solve this, at least having documentation/standards on the gateway-api side would still be valuable.

The big issue here I think is what is vanilla k8s?

There's several factors here that have made this problem weird:

  • api-machinery wants to push things out to crds. Even key k8s functionality these days
  • gateay-api is out of tree
  • gateway-api is part of a major k8s sig
  • ingress is in tree. Kind of grandfathered in.
  • gateway-api was to replace ingress but ingress is in tree, beta, and in tree long enough people were using it so folks decided to make it a v1, while still intending gateway to replace it

So, is gateway-api vanilla k8s? I'd say yes, but others would say no. Which is it? How do we reach agreement on it so projects like helm that assert only supporting vanilla out of the box would accept it?

I can think of another parallel too. CSI Snapshot support is done as a CRD. I'd argue its also vanilla.

@youngnick
Copy link
Contributor

I've actually submitted a CFP to Contributor Summit in Salt Lake City to talk about this and similar issues, let me report back here after that.

@shaneutt shaneutt added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. triage/needs-information Indicates an issue needs more information in order to work on it. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. triage/needs-information Indicates an issue needs more information in order to work on it.
Projects
Status: Triage
Development

No branches or pull requests

4 participants