Serve the UI on a gateway

1. Add a gateway for the UI to your configuration file, and point the ui section at it. The following example serves proxy traffic on port 4000 of the default gateway and the UI on port 4001 of the ui-gateway.

   # yaml-language-server: $schema=https://agentgateway.dev/schema/config
   gateways:
     default:
       port: 4000
     ui-gateway:
       port: 4001
   ui:
     gateways: [ui-gateway]
   routes:
   - matches:
     - path:
         pathPrefix: /
     backends:
     - host: httpbin.org:80

2. Start agentgateway with the updated configuration.

   agentgateway -f config.yaml

   Agentgateway logs the UI gateway address.

   INFO app  serving UI at http://localhost:4001/ui

3. Confirm that the UI answers on its own port.

   curl -s -o /dev/null -w "%{http_code}\n" http://localhost:4001/ui

   Example output:

   200

4. Confirm that the UI no longer answers on the proxy port. The response code depends on what your route does with the /ui path. In this example, the request reaches httpbin, which returns a 404.

   curl -s -o /dev/null -w "%{http_code}\n" http://localhost:4000/ui

   Example output:

   404

The container must publish the new UI port, so this change needs a container restart even though agentgateway reloads the gateways and ui sections in place.

1. Add a gateway for the UI to the configuration file that you mount, and point the ui section at it. The following example serves proxy traffic on port 4000 of the default gateway and the UI on port 4001 of the ui-gateway.

   # yaml-language-server: $schema=https://agentgateway.dev/schema/config
   gateways:
     default:
       port: 4000
     ui-gateway:
       port: 4001
   ui:
     gateways: [ui-gateway]
   routes:
   - matches:
     - path:
         pathPrefix: /
     backends:
     - host: httpbin.org:80

2. Remove the running container.

   docker rm -f agentgateway

3. Start the container again, publishing both the proxy port and the new UI port.

   docker run -d \
     --name agentgateway \
     --user "$(id -u):$(id -g)" \
     -v "$PWD/config.yaml:/config.yaml" \
     -p 4000:4000 -p 4001:4001 \
     cr.agentgateway.dev/agentgateway:v1.5.0 \
     -f /config.yaml

   Note

   If you followed the Mount a directory option in the Docker installation, edit config.yaml inside the directory that you mounted, and keep your -v "$PWD/agentgateway-config:/config" mount and no -f option instead of the file mount in this example.

4. Confirm the UI gateway address in the container logs.

   docker logs agentgateway | grep "serving UI"

   Example output:

   INFO app  serving UI at http://localhost:4001/ui

5. Confirm that the UI answers on its own port.

   curl -s -o /dev/null -w "%{http_code}\n" http://localhost:4001/ui

   Example output:

   200

6. Confirm that the UI no longer answers on the proxy port, and that the proxy still serves your route. The response code for /ui depends on what your route does with that path. In this example, the request reaches httpbin, which returns a 404.

   curl -s -o /dev/null -w "%{http_code}\n" http://localhost:4000/ui
   curl -s -o /dev/null -w "%{http_code}\n" http://localhost:4000/get

   Example output:

   404
   200

1. Add a ui-gateway gateway to your Helm values file, and point the ui section at it. The following example serves proxy traffic such as httpbin routes on port 4000 of the default gateway and the UI on port 4001 of the ui-gateway.

   cat <<'EOF' > values.yaml
   config:
     gateways:
       default:
         port: 4000
       ui-gateway:
         port: 4001
     ui:
       gateways: [ui-gateway]
     routes:
     - matches:
       - path:
           pathPrefix: /
       backends:
       - host: httpbin.httpbin.svc.cluster.local:8000
   EOF

2. Upgrade the release with your values file.

   helm upgrade -i agentgateway-standalone \
     oci://cr.agentgateway.dev/charts/agentgateway-standalone \
     --namespace agentgateway-system \
     --version v1.5.0 \
     --reuse-values \
     -f values.yaml

3. Confirm that the UI no longer answers on the proxy port.

   1. Port-forward the agentgateway Deployment on port 4000 for proxy traffic.

      kubectl port-forward -n agentgateway-system \
        deploy/agentgateway-standalone 4000:4000

   2. Send a request to the /ui path. Confirm that the request fails, because port 4000 now serves only your routes.

      curl -s -o /dev/null -w "%{http_code}\n" http://localhost:4000/ui

      Example output:

      503

4. Confirm that the UI answers on its own port.

   1. Port-forward the agentgateway Deployment on port 4001 for UI traffic.

      kubectl port-forward -n agentgateway-system \
        deploy/agentgateway-standalone 4001:4001

   2. Send a request to the /ui path. Confirm that the request returns a 200 success code.

      curl -s -o /dev/null -w "%{http_code}\n" http://localhost:4001/ui

      Example output:

      200

To reach the UI port from outside the cluster instead of through a port-forward, see Expose the UI.