Merge branch 'main' into hasura-with-config-interpolation

Author: raphaeltm

.devcontainer/Dockerfile

@@ -0,0 +1,4 @@
+FROM mcr.microsoft.com/devcontainers/typescript-node:22-bookworm
+
+# Install hasura cli
+RUN curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | bash

.devcontainer/devcontainer.json

@@ -0,0 +1,11 @@
+{
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": ".."
+  },
+  "features": {
+    "ghcr.io/defanglabs/devcontainer-feature/defang-cli:1.0.4": {},
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+    "ghcr.io/devcontainers/features/aws-cli:1": {}
+  }
+}

.github/workflows/deploy.yaml

@@ -0,0 +1,20 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+    - name: Checkout Repo
+      uses: actions/checkout@v4
+
+    - name: Deploy
+      uses: DefangLabs/[email protected]

README.md

@@ -0,0 +1,64 @@
+# Hasura & Postgres
+
+[![1-click-deploy](https://defang.io/deploy-with-defang.png)](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-hasura-template%26template_owner%3DDefangSamples)
+
+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 [Defang CLI](https://github.com/DefangLabs/defang)
+2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
+3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
+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
+
+To start the development environment, run `docker -f ./compose.dev.yaml 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.
+
+**NOTE**: If you are using the [Dev Container](https://containers.dev/) defined in [.devcontainer/devcontainer.json](.devcontainer/devcontainer.json), the Hasura CLI will already be installed.
+
+## Configuration
+
+For this sample, you will need to provide the following [configuration](https://docs.defang.io/docs/concepts/configuration). Note that if you are using the 1-click deploy option, you can set these values as secrets in your GitHub repository and the action will automatically deploy them for you.
+
+### `HASURA_GRAPHQL_ADMIN_SECRET`
+This password will be used to allow you to access the hasura console. 
+
+
+### `POSTGRES_PASSWORD`
+This password will be used to initialize the PostgreSQL database and to connect to it. You could use a command like `openssl rand -base64 16` to generate a random password.
+
+
+## Deployment
+
+> [!NOTE]
+> Download [Defang CLI](https://github.com/DefangLabs/defang)
+
+### Defang Playground
+
+Deploy your application to the defang playground by opening up your terminal and typing `defang up`.
+
+**Keep in mind that the playground does not support [managed Postgres](https://docs.defang.io/docs/concepts/managed-storage/managed-postgres).**
+
+### BYOC (AWS)
+
+If you want to deploy to your own cloud account, you can use Defang BYOC:
+
+1. [Authenticate your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html), and check that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
+2. Run `defang --provider=aws up` in a terminal that has access to your AWS environment variables.
+
+
+---
+
+Title: Hasura & PostgreSQL
+
+Short Description: A sample project demonstrating how to deploy Hasura with Defang and connect it to a PostgreSQL database.
+
+Tags: Hasura, GraphQL, PostgreSQL, Database
+
+Languages: SQL, GraphQL

compose.dev.yaml

@@ -0,0 +1,21 @@
+services:
+  hasura:
+    extends:
+      file: compose.yaml
+      service: hasura
+    environment:
+      - HASURA_GRAPHQL_DATABASE_URL=postgres://postgres:password@database:5432/postgres
+      - HASURA_GRAPHQL_ADMIN_SECRET=password
+    volumes:
+      - ./hasura:/hasura
+  database:
+    extends:
+      file: compose.yaml
+      service: database
+    environment:
+      - POSTGRES_PASSWORD=password
+    volumes:
+      - database_data:/var/lib/postgresql/data
+
+volumes:
+  database_data:

compose.yaml

@@ -0,0 +1,33 @@
+services:
+  hasura:
+    restart: unless-stopped
+    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_ADMIN_SECRET
+      - HASURA_GRAPHQL_DATABASE_URL=postgres://postgres:${POSTGRES_PASSWORD}@database:5432/postgres
+      - 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
+      - POSTGRES_PASSWORD
+  
+  database:
+    image: postgres:16
+    x-defang-postgres: true
+    ports:
+      - target: 5432
+        mode: host
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_DB=postgres
+      - POSTGRES_PASSWORD

hasura/Dockerfile

@@ -0,0 +1,3 @@
+FROM hasura/graphql-engine:v2.39.0.cli-migrations-v3.ubuntu
+
+COPY . /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

hasura/metadata/actions.graphql

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