Run Hasura GraphQL engine on Kubernetes¶
Table of contents
This guide assumes that you already have Postgres running and helps you set up the Hasura GraphQL engine on Kubernetes and connect it to your Postgres database.
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-dbpostgres://admin:@localhost:5432/my-db(if there is no password)
Note
If your password contains special characters (e.g. #, %, $, @, etc.), you need to URL encode them in the
HASURA_GRAPHQL_DATABASE_URLenv var (e.g. %40 for @).You can check the logs to see if the database credentials are proper and if Hasura is able to connect to the database.
The Hasura GraphQL engine needs access permissions on your Postgres database as described in Postgres permissions.
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.
