Skip to content

Commit

Permalink
Add some notes about the variables and expected syntax / values
Browse files Browse the repository at this point in the history
  • Loading branch information
kathawala authored and Rayraegah committed Jun 15, 2021
1 parent 4f64f02 commit e650f34
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,15 @@ module "hasura" {
}
```

### Additional info about variables

- `hasura_version_tag` comes from [here](https://hub.docker.com/r/hasura/graphql-engine/tags?page=1&ordering=last_updated) (e.g. "v.2.0.0-alpha.3")
- `az_count` needs to be at least 2 or higher (due to AWS constraints, an rds instance must have at least one availability zone for failover)
- `hasura_console_enabled` must be a string (i.e. `"true"`) and NOT a boolean (i.e. `true`). Other true/false variables can be booleans
- `rds_db_name` must only contain alphanumeric characters and start with a letter
- `ecs_cluster_name` must only contain alphanumeric characters and start with a letter
- `domain` must be a domain you have a Route 53 hosted zone for

## License

Released under MIT License. Based on [Gordon Johnston](https://github.com/elgordino)'s proposed architecture.
Expand Down

0 comments on commit e650f34

Please sign in to comment.