Run Hasura GraphQL engine on Kubernetes¶

Step 1: Get the Kubernetes deployment and service files¶

The hasura/graphql-engine/install-manifests repo contains all installation manifests required to deploy Hasura anywhere. Get the Kubernetes deployment and service files from there:

$ wget https://raw.githubusercontent.com/hasura/graphql-engine/stable/install-manifests/kubernetes/deployment.yaml
$ wget https://raw.githubusercontent.com/hasura/graphql-engine/stable/install-manifests/kubernetes/svc.yaml

Step 2: Set the Postgres database url¶

Edit deployment.yaml and set the right database url:

...
  env:
  - name: HASURA_GRAPHQL_DATABASE_URL
    value: postgres://username:password@hostname:port/dbname
...

Examples of HASURA_GRAPHQL_DATABASE_URL:

• postgres://admin:password@localhost:5432/my-db
• postgres://admin:@localhost:5432/my-db (if there is no password)

Step 3: Create the Kubernetes deployment and service¶

$ kubectl create -f deployment.yaml
$ kubectl create -f svc.yaml

Step 4: Open the Hasura console¶

The above creates a LoadBalancer type service with port 80. So you should be able to access the console at the external IP.

For example, using Docker-for-desktop on Mac:

$ kubectl get svc
NAME         TYPE           CLUSTER-IP      EXTERNAL-IP   PORT(S)        AGE
hasura       LoadBalancer   10.96.214.240   localhost     80:30303/TCP   4m
kubernetes   ClusterIP      10.96.0.1       <none>        443/TCP        8m

Head to: http://localhost and the console should load!

Step 5: Track existing tables and relationships¶

See Setting up a GraphQL schema using an existing database to enable GraphQL over the database.

Add the HASURA_GRAPHQL_ADMIN_SECRET env var¶

Update the deployment.yaml to set the HASURA_GRAPHQL_ADMIN_SECRET environment variable.

 ...
 spec:
    containers:
      ...
      command: ["graphql-engine"]
      args: ["serve", "--enable-console"]
      env:
      - name: HASURA_GRAPHQL_DATABASE_URL
        value: postgres://username:password@hostname:port/dbname
      - name: HASURA_GRAPHQL_ADMIN_SECRET
        value: mysecretkey
      ports:
      - containerPort: 8080
        protocol: TCP
      resources: {}

(optional) Use the admin secret key with the CLI¶

In case you’re using the CLI to open the Hasura console, use the admin-secret flag when you open the console:

hasura console --admin-secret=myadminsecretkey

Step 1: Check the latest release version¶

The current latest version is:

All the versions can be found at: https://github.com/hasura/graphql-engine/releases.

Step 2: Update the container image¶

In the deployment.yaml file, update the image tag to this latest version.

For example, if you had:

you should change it to:

Step 3: Rollout the change¶

$ kubectl replace -f deployment.yaml