Skip to content
home
1.21.x
Gateway setup
Listeners
If you are interested in trying out Gloo Gateway with the Kubernetes Gateway API, check out Solo Enterprise for kgateway. This version adds enterprise functionality on top of the kgateway open source project.

HTTP

Page as Markdown
Set up an HTTP listener on your API gateway.
Before you begin

  1. Decide whether to set up an HTTP listener inline on the Gateway resource or as a separate ListenerSet resource. Note that ListenerSets are an experimental feature in the upstream Kubernetes Gateway API project, and subject to change. For more information, see the Listener overview.
  2. If you followed the Get started guide, you already have a gateway named http in the gloo-system namespace of your cluster. This gateway can be used as the main ingress for the apps in your cluster. ListenerSets and HTTPRoutes can refer to this gateway independent of the namespace they are in. However, you can also use the steps in this guide to create more gateways, such as to support different deployment patterns.
Set up an HTTP listener

  1. Create a Gateway resource with an HTTP listener.
    kubectl apply -f- <<EOF
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
  name: my-http-gateway
  namespace: gloo-system
  labels:
    example: httpbin-mydomain
spec:
  gatewayClassName: gloo-gateway
  listeners:
  - protocol: HTTP
    port: 8080
    hostname: mydomain.com
    name: http
    allowedRoutes:
      namespaces:
        from: All
EOF
    Review the following table to understand this configuration.
    SettingDescription
    spec.gatewayClassNameThe name of the Kubernetes gateway class that you want to use to configure the gateway. When you set up Gloo Gateway, a default gateway class is set up for you. To view the gateway class configuration, see Gateway classes and types.
    spec.listenersConfigure the listeners for this gateway. In this example, you configure an HTTP gateway that listens for incoming traffic for the mydomain.com domain on port 8080. The gateway can serve HTTP routes from any namespace.
    1. Create a Gateway that enables the attachment of ListenerSets.
      kubectl apply -f- <<EOF
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
  name: my-http-gateway
  namespace: gloo-system
  labels:
    example: httpbin-mydomain
spec:
  gatewayClassName: gloo-gateway
  allowedListeners:
    namespaces:
      from: All
  listeners:
  - protocol: HTTP
    port: 80
    name: http
    allowedRoutes:
      namespaces:
        from: All        
EOF
      Review the following table to understand this configuration.
      SettingDescription
      spec.gatewayClassNameThe name of the Kubernetes gateway class that you want to use to configure the gateway. When you set up Gloo Gateway, a default gateway class is set up for you. To view the gateway class configuration, see Gateway classes and types.
      spec.allowedListenersEnable the attachment of ListenerSets to this Gateway. The example allows listeners from any namespace, which is helpful in multitenant environments. You can also limit the allowed listeners. To limit to listeners in the same namespace as the Gateway, set this value to Same. To limit to listeners with a particular label, set this value to Selector.
      spec.listenersOptionally, you can configure a listener that is specific to the Gateway. Note that due to a Gateway API limitation, you must configure at least one listener on the Gateway resource, even if the listener is not used and is a “dummy” listener. This dummy listener cannot conflict with the listener that you configure in the ListenerSet, such as using the same port or name. In this example, the dummy listener is configured on port 80, which differs from port 8080 in the ListenerSet that you create later.
    2. Create a ListenerSet that configures an HTTP listener for the Gateway.
      kubectl apply -f- <<EOF
apiVersion: gateway.networking.x-k8s.io/v1alpha1
kind: XListenerSet
metadata:
  name: my-http-listenerset
  namespace: httpbin
  labels:
    example: httpbin-mydomain
spec:
  parentRef:
    name: my-http-gateway
    namespace: gloo-system
    kind: Gateway
    group: gateway.networking.k8s.io
  listeners:
  - protocol: HTTP
    port: 8080
    hostname: mydomain.com
    name: http-listener-set
    allowedRoutes:
      namespaces:
        from: All
EOF
      Review the following table to understand this configuration.
      SettingDescription
      spec.parentRefThe name of the Gateway to attach the ListenerSet to.
      spec.listenersConfigure the listeners for this ListenerSet. In this example, you configure an HTTP gateway that listens for incoming traffic for the mydomain.com domain on port 8080. The gateway can serve HTTP routes from any namespace.
  2. Check the status of the Gateway to make sure that your configuration is accepted and no conflicts exist in your cluster.
    kubectl get gateway my-http-gateway -n gloo-system -o yaml
  3. Create an HTTPRoute resource for the httpbin app that is served by the gateway that you created.
    kubectl apply -f- <<EOF
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
  name: httpbin-mydomain
  namespace: httpbin
  labels:
    example: httpbin-mydomain
spec:
  parentRefs:
    - name: my-http-gateway
      namespace: gloo-system
      kind: Gateway
  rules:
    - backendRefs:
        - name: httpbin
          port: 8000
EOF
    kubectl apply -f- <<EOF
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
  name: httpbin-mydomain
  namespace: httpbin
  labels:
    example: httpbin-mydomain
spec:
  parentRefs:
    - name: my-http-listenerset
      namespace: httpbin
      kind: XListenerSet
      group: gateway.networking.x-k8s.io
  rules:
    - backendRefs:
        - name: httpbin
          port: 8000
EOF
  4. Verify that the HTTPRoute is applied successfully.
    kubectl get httproute/httpbin-mydomain -n httpbin -o yaml
    Example output: Notice in the status section that the parentRef is either the Gateway or the ListenerSet, depending on how you attached the HTTPRoute.
    ...
status:
  parents:
  - conditions:
    - lastTransitionTime: "2025-04-29T20:48:51Z"
      message: ""
      observedGeneration: 3
      reason: Accepted
      status: "True"
      type: Accepted
    - lastTransitionTime: "2025-04-29T20:48:51Z"
      message: ""
      observedGeneration: 3
      reason: ResolvedRefs
      status: "True"
      type: ResolvedRefs
    controllerName: solo.io/gloo-gateway
  parentRef:
    group: gateway.networking.x-k8s.io
    kind: XListenerSet
    name: my-http-listenerset
    namespace: httpbin
  5. Verify that the listener now has a route attached.
    kubectl get gateway -n gloo-system my-http-gateway -o yaml
    Example output:
    ...
listeners:
- attachedRoutes: 1
    kubectl get xlistenerset -n httpbin my-http-listenerset -o yaml
    Example output:
    ...
listeners:
- attachedRoutes: 1
    Note that because the HTTPRoute is attached to the ListenerSet, the Gateway does not show the route in its status.
    kubectl get gateway -n gloo-system my-http-gateway -o yaml
    Example output:
    ...
listeners:
- attachedRoutes: 0
    If you create another HTTPRoute that attaches to the Gateway and uses the same listener as the ListenerSet, then the route is reported in the status of both the Gateway (attachedRoutes: 1) and the ListenerSet (attachedRoutes: 2).
  6. Get the external address of the gateway and save it in an environment variable.
    export INGRESS_GW_ADDRESS=$(kubectl get svc -n gloo-system gloo-proxy-my-http-gateway -o jsonpath="{.status.loadBalancer.ingress[0]['hostname','ip']}")
echo $INGRESS_GW_ADDRESS   
    kubectl port-forward deployment/gloo-proxy-my-http-gateway -n gloo-system 8080:8080
  7. Send a request to the httpbin app and verify that you get back a 200 HTTP response code.
    curl -vik http://$INGRESS_GW_ADDRESS:8080/status/200 -H "host: mydomain.com:8080" 
    curl -vik localhost:8080/status/200 -H "host: mydomain.com"
    Example output:
    * Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
HTTP/1.1 200 OK
< access-control-allow-credentials: true
access-control-allow-credentials: true
< access-control-allow-origin: *
access-control-allow-origin: *
< date: Fri, 03 Nov 2023 20:02:48 GMT
date: Fri, 03 Nov 2023 20:02:48 GMT
< content-length: 0
content-length: 0
< x-envoy-upstream-service-time: 1
x-envoy-upstream-service-time: 1
< server: envoy
server: envoy
Cleanup

You can optionally remove the resources that you set up as part of this guide.
kubectl delete -A gateways,httproutes -l example=httpbin-mydomain
kubectl delete -A httproutes,xlistenersets -l example=httpbin-mydomain
OverviewHTTPS