Generate Kubernetes Ingress Paths from Jakarta REST

[Eric-Prokop]

Description

It would be nice if the ingress routing could be more explicit by adding the paths known from Jakarta REST to the generated kubernetes ingress instead of just a

  path: /
    pathType: Prefix

Implementation ideas

No response

[quarkus-bot]

/cc @geoand (kubernetes), @iocanel (kubernetes)

[geoand]

Thanks for reporting.

Can you provide a few more details on what you would like to see here?

[Eric-Prokop]

So bascially this is my resource:

@Path("/projects")
public interface ProjectsApi {

    @GET
    @Path("/autocomplete")
    @Produces({ "application/json" })
    Uni<AutocompleteResponse> autocomplete(@QueryParam("term") @NotNull @Size(min=3) String term);

    @GET
    @Path("/filter-elements")
    @Produces({ "application/json" })
    Uni<GetFilterElementsResponse> getFilterElements();

    @GET
    @Path("/all")
    @Produces({ "application/json" })
    Uni<ListProjectsResponse> listProjects();
}

Using the kubernetes extension with quarkus.kubernetes.ingress.expose=true produces:

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    app.quarkus.io/quarkus-version: 3.17.5
  labels:
    app.kubernetes.io/name: project-service
    app.kubernetes.io/managed-by: quarkus
  name: project-service
  namespace: staging
spec:
  rules:
    - http:
        paths:
          - backend:
              service:
                name: project-service
                port:
                  name: http
            path: /
            pathType: Prefix

But it would be much nicer to get this:

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    app.quarkus.io/quarkus-version: 3.17.5
  labels:
    app.kubernetes.io/name: project-service
    app.kubernetes.io/managed-by: quarkus
  name: project-service
  namespace: staging
spec:
  rules:
    - http:
        paths:
          - backend:
              service:
                name: project-service
                port:
                  name: http
            path: /projects/autocomplete
            pathType: Exact
          - backend:
              service:
                name: project-service
                port:
                  name: http
            path: /projects/filter-elements
            pathType: Exact
          - backend:
              service:
                name: project-service
                port:
                  name: http
            path: /projects/all
            pathType: Exact

[geoand]

Thanks for the example!

Would that really be useful in practice?

[Eric-Prokop]

Having only Exact machtes makes it easier for me to deal with 404 situations, since I want such situations to be routed to a different service. Also, the kubernetes.yml would be more verbose allowing my coworkers to quickly get a board idea of which routes are actually used. Also, on a more emotional/conceptual level, determing things exactly "at build time" feels (at least for me) more fitting to the quarkus philosophy.

On the other hand, I think it would be nice-to-have and not a must-have. We already have quarkus.kubernetes.ports.http.path to at least change the Prefix.

[geoand]

Let's see what @iocanel thinks

[iocanel]

I agree, this ties nicely to our philosophy.

We should collect all registered paths and use the least common denominator for the ingress / route path.

@Eric-Prokop: Is this something you would be willing to contribute?

[Eric-Prokop]

While I would like to work on this, I won't be able to find the time in the near future.