GraphQL Summit is back for three days of insights, hands-on learning, and fun to celebrate the GraphQL community. Join us in San Diego Oct 3-5.
Docs
Try Apollo Studio

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.

In both the following examples, we are using 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

Using helm chart from our Open Container Initiative (OCI) registry

Starting with release 0.14.0, each time we release the router, we'll release our helm chart and store it in the same OCI registry in which we store our router docker images.

You can use helm to install charts from an OCI registry as follows:

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 oci://ghcr.io/apollographql/helm-charts/router --version 1.0.0-rc.3 --values router/values.yaml

For more details about using helm with OCI based registries, see here

Using helm chart from your filesystem

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

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

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:

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.

---
# Source: router/templates/serviceaccount.yaml
apiVersion: v1
kind: ServiceAccount
metadata:
name: release-name-router
labels:
helm.sh/chart: router-1.0.0-rc.3
app.kubernetes.io/name: router
app.kubernetes.io/instance: release-name
app.kubernetes.io/version: "v1.0.0"
app.kubernetes.io/managed-by: Helm
---
# Source: router/templates/secret.yaml
apiVersion: v1
kind: Secret
metadata:
name: "release-name-router"
labels:
helm.sh/chart: router-1.0.0-rc.3
app.kubernetes.io/name: router
app.kubernetes.io/instance: release-name
app.kubernetes.io/version: "v1.0.0"
app.kubernetes.io/managed-by: Helm
data:
managedFederationApiKey: "UkVEQUNURUQ="
---
# Source: router/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: release-name-router
labels:
helm.sh/chart: router-1.0.0-rc.3
app.kubernetes.io/name: router
app.kubernetes.io/instance: release-name
app.kubernetes.io/version: "v1.0.0"
app.kubernetes.io/managed-by: Helm
data:
configuration.yaml: |
supergraph:
listen: 0.0.0.0:80
telemetry:
metrics:
common:
resources:
service.name: release-name-router
prometheus:
enabled: true
---
# Source: router/templates/service.yaml
apiVersion: v1
kind: Service
metadata:
name: release-name-router
labels:
helm.sh/chart: router-1.0.0-rc.3
app.kubernetes.io/name: router
app.kubernetes.io/instance: release-name
app.kubernetes.io/version: "v1.0.0"
app.kubernetes.io/managed-by: Helm
spec:
type: ClusterIP
ports:
- port: 80
targetPort: http
protocol: TCP
name: http
selector:
app.kubernetes.io/name: router
app.kubernetes.io/instance: release-name
---
# Source: router/templates/deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: release-name-router
labels:
helm.sh/chart: router-1.0.0-rc.3
app.kubernetes.io/name: router
app.kubernetes.io/instance: release-name
app.kubernetes.io/version: "v1.0.0"
app.kubernetes.io/managed-by: Helm
annotations:
prometheus.io/path: /metrics
prometheus.io/port: 9090
prometheus.io/scrape: "true"
spec:
replicas: 1
selector:
matchLabels:
app.kubernetes.io/name: router
app.kubernetes.io/instance: release-name
template:
metadata:
labels:
app.kubernetes.io/name: router
app.kubernetes.io/instance: release-name
spec:
serviceAccountName: release-name-router
securityContext:
{}
containers:
- name: router
securityContext:
{}
image: "ghcr.io/apollographql/router:v1.0.0"
imagePullPolicy: IfNotPresent
args:
- --hot-reload
- --config
- /app/configuration.yaml
env:
- name: APOLLO_KEY
valueFrom:
secretKeyRef:
name: "release-name-router"
key: managedFederationApiKey
optional: true
- name: APOLLO_GRAPH_REF
value: REDACTED
ports:
- name: http
containerPort: 80
protocol: TCP
livenessProbe:
httpGet:
path: "/health"
port: 8088
readinessProbe:
httpGet:
path: "/health"
port: 8088
resources:
{}
volumeMounts:
- name: router-configuration
mountPath: /app/configuration.yaml
subPath: configuration.yaml
readOnly: true
volumes:
- name: router-configuration
configMap:
name: release-name-router
---
# Source: router/templates/tests/test-connection.yaml
apiVersion: v1
kind: Pod
metadata:
name: "release-name-router-test-connection"
labels:
helm.sh/chart: router-1.0.0-rc.3
app.kubernetes.io/name: router
app.kubernetes.io/instance: release-name
app.kubernetes.io/version: "v1.0.0"
app.kubernetes.io/managed-by: Helm
annotations:
"helm.sh/hook": test
spec:
containers:
- name: wget
image: busybox
command: ['wget']
args: ['release-name-router:80']
restartPolicy: Never

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 8088 on your localhost, you could exercise the health endpoint as follows:

curl "http://localhost:8088/health"
{"status":"UP"}

If you had a router running on your localhost, with default health-check configuration, you could exercise the health endpoint as follows:

curl "http://localhost:8088/health"

Edit on GitHub
Previous
Docker
Next
Build and run queries