Kubernetes and the router

Using router images with kubernetes

Sample Kubernetes Configuration

Note: The Apollo Router is made available under the Elastic License v2.0 (ELv2). This applies to its source code and all distributions, including versions installed via Helm charts. Read our licensing page for more details.

Helm

Helm is the package manager for kubernetes.

There is a complete helm chart definition in the repo which illustrates how to use helm to deploy the router in kubernetes.

Here's an example which would use helm to install the router:

into namespace "router-deploy" (create namespace if it doesn't exist)
with helm install name "router-test"
with support for prometheus enabled

You would run this command from "repo"/helm/chart directory.

(where "repo" is the directory containing your checked out router github repository)

1
helm install --set router.configuration.telemetry.metrics.prometheus.enabled=true --set managedFederation.apiKey="REDACTED" --set managedFederation.graphRef="REDACTED" --create-namespace --namespace router-deploy router-test router --values router/values.yaml

Once executed, you can check the status of the helm deploy:

1
helm list --namespace router-deploy

Kubernetes Configuration

If you aren't familiar with helm, the following example illustrates how you could do the same thing manually or as a base for kustomize.

Note: This example is generated using the helm template capability to generate the required kubernetes configuration from our helm chart. After generation, it is edited to remove the Helm management annotations.

1
---
2
# Source: router/templates/serviceaccount.yaml
3
apiVersion: v1
4
kind: ServiceAccount
5
metadata:
6
  name: router-test
7
  labels:
8
    app.kubernetes.io/name: router
9
    app.kubernetes.io/instance: router-test
10
    app.kubernetes.io/version: "v0.9.2"
11
---
12
# Source: router/templates/secret.yaml
13
apiVersion: v1
14
kind: Secret
15
metadata:
16
  name: router-test
17
  labels:
18
    app.kubernetes.io/name: router
19
    app.kubernetes.io/instance: router-test
20
    app.kubernetes.io/version: "v0.9.2"
21
data:
22
  managedFederationApiKey: "REDACTED"
23
---
24
# Source: router/templates/configmap.yaml
25
apiVersion: v1
26
kind: ConfigMap
27
metadata:
28
  name: router-test
29
  labels:
30
    app.kubernetes.io/name: router
31
    app.kubernetes.io/instance: router-test
32
    app.kubernetes.io/version: "v0.9.2"
33
data:
34
  configuration.yaml: |
35
    server:
36
      listen: 0.0.0.0:80
37
    telemetry:
38
      metrics:
39
        prometheus:
40
          enabled: true
41
---
42
# Source: router/templates/service.yaml
43
apiVersion: v1
44
kind: Service
45
metadata:
46
  name: router-test
47
  labels:
48
    app.kubernetes.io/name: router
49
    app.kubernetes.io/instance: router-test
50
    app.kubernetes.io/version: "v0.9.2"
51
spec:
52
  type: ClusterIP
53
  ports:
54
    - port: 80
55
      targetPort: http
56
      protocol: TCP
57
      name: http
58
  selector:
59
    app.kubernetes.io/name: router
60
    app.kubernetes.io/instance: router-test
61
---
62
# Source: router/templates/deployment.yaml
63
apiVersion: apps/v1
64
kind: Deployment
65
metadata:
66
  name: router-test
67
  labels:
68
    app.kubernetes.io/name: router
69
    app.kubernetes.io/instance: router-test
70
    app.kubernetes.io/version: "v0.9.2"
71
  annotations:
72
    prometheus.io/path: /plugins/apollo.telemetry/prometheus
73
    prometheus.io/port: "80"
74
    prometheus.io/scrape: "true"
75
spec:
76
  replicas: 1
77
  selector:
78
    matchLabels:
79
      app.kubernetes.io/name: router
80
      app.kubernetes.io/instance: router-test
81
  template:
82
    metadata:
83
      labels:
84
        app.kubernetes.io/name: router
85
        app.kubernetes.io/instance: router-test
86
    spec:
87
      serviceAccountName: router-test
88
      securityContext:
89
        {}
90
      containers:
91
        - name: router
92
          securityContext:
93
            {}
94
          image: "ghcr.io/apollographql/router:v0.9.2"
95
          imagePullPolicy: IfNotPresent
96
          args:
97
            - --hot-reload
98
            - --config
99
            - /app/configuration.yaml
100
          env:
101
            - name: APOLLO_KEY
102
              valueFrom:
103
                secretKeyRef:
104
                  name: router-test
105
                  key: managedFederationApiKey
106
            - name: APOLLO_GRAPH_REF
107
              value: "REDACTED"
108
          ports:
109
            - name: http
110
              containerPort: 80
111
              protocol: TCP
112
          livenessProbe:
113
            httpGet:
114
              path: /.well-known/apollo/server-health
115
              port: http
116
          readinessProbe:
117
            httpGet:
118
              path: /.well-known/apollo/server-health
119
              port: http
120
          resources:
121
            {}
122
          volumeMounts:
123
            - name: router-configuration
124
              mountPath: /app/configuration.yaml
125
              subPath: configuration.yaml
126
              readOnly: true
127
      volumes:
128
        - name: router-configuration
129
          configMap:
130
            name: router-test

The health endpoint

The router supports a health endpoint. You can see from the examples above how it can be used in a kubernetes deployment.

If you had a router running on port 4000 on your localhost, you could exercise the health endpoint as follows:

1
curl "http://localhost:4000/.well-known/apollo/server-health"
2
{"status":"pass"}

This health endpoint can be used to check the health of the router. It will always return a status of pass if all is well.

Edit on GitHub

Docker

Build and run queries