Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lineupninja/hasura-cdk
A deployment of Hasura using AWS CDK
https://github.com/lineupninja/hasura-cdk
Last synced: 3 months ago
JSON representation
A deployment of Hasura using AWS CDK
- Host: GitHub
- URL: https://github.com/lineupninja/hasura-cdk
- Owner: lineupninja
- License: mit
- Created: 2020-06-23T13:21:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T09:40:52.000Z (almost 2 years ago)
- Last Synced: 2024-07-05T16:38:26.380Z (4 months ago)
- Language: TypeScript
- Size: 1.69 MB
- Stars: 69
- Watchers: 3
- Forks: 18
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Deploying Hasura using CDK
This repository contains an example of how to deploy Hasura into AWS using [AWS CDK](https://aws.amazon.com/cdk/).
This project exists as a companion to a talk given at [Hasura Con 2020](https://hasura.io/events/hasura-con-2020/talks/how-to-deploy-hasura-on-aws-using-a-language-you-already-know/). If you intend to use this repository then checking out the talk first might be a good idea.
## Infrastructure Layout
The deployed Hasura instance looks like this:
Which is to say a multi-az deployment of both Hasura and Postgres. It can be deployed either multi or single AZ with an environment flag.
In addition to the Hasura deployment a simple API gateway with a single function is deployed, this is use to demonstrate the 'actions' feature in Hasura.
## Project Layout
* `cdk` Contains the main CDK stack
* `actions` Contains a simple lambda handler that returns a 'fortune'
* `hasura` Contains a simple schema that connects the deployed 'action'
## CDK Layout
CDK has been configured into 4 stacks
* `vpc-stack` contains the main VPC component to deploy Hasura into
* `certificates-stack` the ACM certificates for the Hasura and actions endpoints
* `hasura-stack` the main Hasura Fargate and RDS components
* `actions-stack` the API Gateway / Lambda stack for the actions endpoint.
The stack has been split into multiple components to make deployment and rollback easier. Note that new AWS accounts have an ACM limit of 20 certificates, so it's easy to run out of certificates if you regularly build up and tear down the environments.
## How to deploy
First copy `.env.example` to `.env` and fill out the properties. They should be fairly obvious:
```
APP_NAME=Whatever you want to call the app, this is used to name the created objects
AWS_REGION=The region to deploy into
AWS_PROFILE=The profile in ~/.aws/credentials to use
AWS_ACCOUNT_ID=The ID of your AWS account
HOSTED_ZONE_ID=The ID of the zone in which to create the DNS records
HOSTED_ZONE_NAME=The name of the same zone
HASURA_ADMIN_SECRET=A secret to use to access the hasura admin interface
HASURA_JWT_SECRET='{"type":"HS256", "key": ""}' - Fill out the 'key' with something with at least 256bit.
HASURA_HOSTNAME=The hostname to use for Hasura, must exist in the hosted zone given above.
ACTIONS_HOSTNAME=The hostname to use for the Actions endpoint, must exist in the hosted zone given above.
```
Then to deploy just do
make deploy
make deploy-schema
This has been tested on macOS Catalina only but should work on Linux.
## Learning More
This project was bought to you by [Gordon Johnston](https://twitter.com/gordonj) at [Lineup Ninja](https://lineup.ninja) where he writes award winning event management software.
If you need help with your Hasura deployment check out the `#deployment-help` channel in the [Hasura Discord](https://hasura.io/community/#discord) community. You can ping Gordon at `@elgordino` in Discord.