Merge pull request #372 from defang-io/hasura-rds-example

Hasura Example

Author: raphaeltm

samples/other/hasura/README.md

@@ -0,0 +1,27 @@
+# GraphQL API with Hasura + Postgres
+
+This sample project demonstrates how to deploy Hasura with Defang and connect it to a Postgres database. We also demonstrate how to run a Postgres container during development and how to switch over to a managed postgres service like RDS, Neon, or others in production. If you want to get a compatible database ready to go really quickly for free, [Neon](https://neon.tech/) is a quick and easy way to go. The sample populates the database with some sample data so you can quickly start playing with the Hasura console. It sets wide open permissions on the tables as well so you can start querying or mutating the data right away.
+
+## Prerequisites
+1. Download <a href="https://github.com/defang-io/defang">Defang CLI</a>
+2. Have a managed database service configured and have the connection string ready.
+3. (optional) If you are using <a href="https://docs.defang.io/docs/concepts/defang-byoc">Defang BYOC</a>, make sure you have properly <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">authenticated your AWS account</a>.
+4. (optional) [Install the Hasura CLI](https://hasura.io/docs/latest/hasura-cli/install-hasura-cli/) to create migrations and update metadata for your Hasura GraphQL api.
+
+## Development
+
+For development, we use a Postgres container. The Postgres container is defined in the `compose.dev.yml` file. The Hasura container is defined in the `compose.yml` file, with some overrides in the `compose.dev.yml` file so it can correctly connect to the development database container. 
+
+To start the development environment, run `docker compose -f ./compose.yml -f ./compose.dev.yml up`. This will start the Postgres container and the Hasura container. The Hasura console will be available at `http://localhost:8080` with the password `password`. 
+**Note:** _If you want to make changes to your database, permissions, etc. you should use the Hasura console and the Hasura CLI to make those changes. See the next section for more information._
+
+### Editing the database/permissions etc.
+
+If you want to edit the database, permissions, or any other Hasura settings such that you can deploy them to production, you should [install the Hasura CLI](https://hasura.io/docs/latest/hasura-cli/install-hasura-cli/). Then, after starting the development environment, you can run `hasura console` _inside the `./hasura` directory_. This will open the Hasura console in your browser. Any changes you make in the console will be saved to the `migrations` and `metadata` directories. When you run `defang compose up` these changes will be applied to the production environment.
+
+## Deploying
+1. Open the terminal and type `defang login`
+2. Add your connection string as a defang config value by typing `defang config set HASURA_GRAPHQL_DATABASE_URL` and pasting your connection string (which should be in the format `postgres://username:password@host:port/dbname`)
+3. Setup a password for hasura by typing `defang config set HASURA_GRAPHQL_ADMIN_SECRET` and adding a password you would like to login with.
+2. Type `defang compose up` in the CLI.
+3. Your app will be running within a few minutes.

samples/other/hasura/compose.dev.yml

@@ -0,0 +1,21 @@
+services:
+  postgres:
+    image: postgres:16
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+      - POSTGRES_DB=postgres
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+  hasura:
+    depends_on:
+      - postgres
+    restart: on-failure
+    environment: 
+      - HASURA_GRAPHQL_DATABASE_URL=postgres://postgres:postgres@postgres:5432/postgres
+      - HASURA_GRAPHQL_ADMIN_SECRET=password
+    volumes:
+      - ./hasura:/hasura
+
+volumes:
+  postgres_data:

samples/other/hasura/compose.yml

@@ -0,0 +1,22 @@
+version: '3.7'
+name: hasura-rds
+services:
+  hasura:
+    build:
+      dockerfile: Dockerfile
+      context: ./hasura
+    # If you want to add your own domain name in Defang BYOC, uncomment the following line and replace the domain name with your own
+    # domainname: hasura.mycoolapp.com
+    ports:
+      - target: 8080
+        published: 8080
+        mode: ingress
+    environment:
+      - HASURA_GRAPHQL_DATABASE_URL
+      - HASURA_GRAPHQL_ADMIN_SECRET
+      - HASURA_GRAPHQL_ENABLE_CONSOLE=true
+      - HASURA_GRAPHQL_UNAUTHORIZED_ROLE=public
+      - HASURA_GRAPHQL_EXPERIMENTAL_FEATURES=naming_convention
+      - HASURA_GRAPHQL_DEFAULT_NAMING_CONVENTION=graphql-default
+      - HASURA_GRAPHQL_MIGRATIONS_DIR=/hasura/migrations
+      - HASURA_GRAPHQL_METADATA_DIR=/hasura/metadata

samples/other/hasura/hasura/Dockerfile

@@ -0,0 +1,3 @@
+FROM hasura/graphql-engine:v2.39.0.cli-migrations-v3.ubuntu
+
+COPY . /hasura

samples/other/hasura/hasura/config.yaml

@@ -0,0 +1,7 @@
+version: 3
+endpoint: http://localhost:8080
+metadata_directory: metadata
+admin_secret: password
+actions:
+  kind: synchronous
+  handler_webhook_baseurl: http://localhost:3000

samples/other/hasura/hasura/metadata/actions.graphql

@@ -0,0 +1,6 @@
+actions: []
+custom_types:
+  enums: []
+  input_objects: []
+  objects: []
+  scalars: []

samples/other/hasura/hasura/metadata/actions.yaml

@@ -0,0 +1 @@
+[]

samples/other/hasura/hasura/metadata/allow_list.yaml

@@ -0,0 +1 @@
+{}

samples/other/hasura/hasura/metadata/api_limits.yaml

@@ -0,0 +1 @@
+{}