Set up Ingress with Traefik to access Pachyderm UI (dash) service in your cluster¶

Before completing the following steps, read the Overview. This section provides an example of how to route cluster-external requests (URLs - hostname and path) to cluster-internal services (here Pachyderm UI (dash) service) using the ingress controller Traefik.

However, we recommend you choose the ingress controller implementation that best fits your cluster. For Pachyderm UI (dash) service in particular, make sure that it supports WebSockets (Traefik, Nginx, Ambassador...).

Pachyderm UI requires two ports to be open:

• An HTTP port used to serve static assets (HTML, CSS, JS, images, etc; port 30080 by default routes to the dash container within the dash pod)
• A WebSocket port, used to connect to the GRPC proxy (which in turn connects to pachd; port 30081 by default routes to the grpc-proxy container within the dash pod)

Traefik ingress controller on Pachyderm UI's cluster in one diagram¶

Here is a quick high-level view of the various components at play.

Traefik installation and Ingress Ressource Definition¶

1. Helm install Traefik:

   • Get Repo Info

     $ helm repo add traefik https://helm.traefik.io/traefik
     

     $ helm repo update
     

   • Install the Traefik helm chart (helm v3)

     $ helm install traefik traefik/traefik
     

2. Run a quick check:

   $ kubectl get all 
   

   You should see your Traefik pod, service, deployments.apps, and replicaset.app.

   You can now access your Traefik Dashboard at http://127.0.0.1:9000/dashboard/ following the port-forward instructions (You can choose to apply your own Ingress Ressource instead.):

   $ kubectl port-forward $(kubectl get pods --selector "app.kubernetes.io/name=traefik" --output=name) 9000:9000
   

3. Create your Ingress route rules (Ingress Ressource):

   The ingress rules expose the private services (here Pachyderm UI - dash - service) from your cluster to the ingress controller.

   • Create a mypachydermUICRDs.yaml

     apiVersion: extensions/v1beta1
     kind: Ingress
     metadata:
       name: pachyderm
       annotations:
         kubernetes.io/ingress.class: traefik
         traefik.frontend.rule.type: PathPrefixStrip
     spec:
       rules:
         - host: dash.localhost
           http:
             paths:
               - path: /
                 backend:
                   serviceName: dash
                   servicePort: dash-http
               - path: /ws
                 backend:
                   serviceName: dash
                   servicePort: grpc-proxy-http
     

     At a minimum, you will need to specify the following fields:

     • host — match the hostname header of the http request (domain). In the file above, dash.localhost
     • path - mapped to the service port servicePort of the serviceName.

4. Create/apply your ressource

   $ kubectl create -f mypachydermUICRDs.yaml
   

5. Check your new rules by running kubectl describe ingress <name-field-value-in-rules-yaml>:

   $ kubectl describe ingress pachyderm
   

   Name:             pachyderm
   Namespace:        default
   Address:
   Default backend:  default-http-backend:80 
   Rules:
   Host            Path  Backends
   dash.localhost
                     /     dash:dash-http (10.1.0.7:8080)
                     /ws   dash:grpc-proxy-http (10.1.0.7:8081)
   Annotations:      kubernetes.io/ingress.class: traefik
                     traefik.frontend.rule.type: PathPrefixStrip
   Events:           <none>
   

6. Check the Traefik Dashboard again (http://127.0.0.1:9000/dashboard/), your new set of rules should now be visible.

   "kind": "Service",
   "apiVersion": "v1",
   "metadata": {
      "name": "dash",
      "namespace": "default",
      "creationTimestamp": null,
      "labels": {
         "app": "dash",
         "suite": "pachyderm"
      }
   },
   "spec": {
      "ports": [
         {
         "name": "dash-http",
         "port": 8080,
         "targetPort": 0,
         "nodePort": 30080
         },
         {
         "name": "grpc-proxy-http",
         "port": 8081,
         "targetPort": 0,
         "nodePort": 30081
         }
      ],

Browse¶

Connect to your Pachyderm UI: http://dash.localhost/app/. You are all set!

rules:
- host: dash.localhost
   http:
      paths:
      - path: /
      backend:
         serviceName: dash
         servicePort: dash-http
- host: dashws.localhost
   http:
      paths:
      - path: /ws
      backend:
         serviceName: dash
         servicePort: grpc-proxy-http

References¶

• Traefik documentation.
• Kubernetes Ingress.
• Kubernetes Ingress Controller.