Skip to content

Commit

Permalink
docs: add example usage in README
Browse files Browse the repository at this point in the history
  • Loading branch information
josephpage committed Sep 16, 2023
1 parent 6cb4daa commit 04be592
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,42 @@
# Terraform Module for Scalingo App

An opinionated Terraform module to provision an application and database very easily with Scalingo
An opinionated Terraform module to provision an application and database very easily with Scalingo.

## Example usage

```tf
module "my_app" {
source = "scalingo-community/app/scalingo"
# Configure the name and the canonical domain of the application
name = "my-app"
domain = "my-app.example.com"
# Define environment variables
environment = {
FOO = "bar"
}
# Configure size and amount of containers "web"
containers = {
web = {
size = "S"
amount = 2
}
}
# Provision an attached PostgreSQL database
addons = [{ provider = "scalingo", plan = "scalingo-postgres:free" }]
# Configure log drains
log_drains = [{ type = "elk", url = "https://user:[email protected]" }]
}
```

## Community

Used in production by :
- [1jeune1solution.gouv.fr](https://1jeune1solution.gouv.fr). ([source code](https://github.com/DNUM-SocialGouv/1j1s-front/tree/main/terraform))

<!-- BEGIN_TF_DOCS -->
## Requirements
Expand Down

0 comments on commit 04be592

Please sign in to comment.