Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@josephpage
josephpage committed Aug 22, 2023
1 parent d0496b1 commit bdfc591
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ An opinionated Terraform module to provision an application and database very ea

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.9, < 2.0.0 |
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0, < 2.0.0 |
| <a name="requirement_environment"></a> [environment](#requirement\_environment) | ~> 1.3 |
| <a name="requirement_scalingo"></a> [scalingo](#requirement\_scalingo) | ~> 2.0 |
| <a name="requirement_scalingo"></a> [scalingo](#requirement\_scalingo) | ~> 2.2 |

## Resources

Expand All @@ -31,25 +31,29 @@ An opinionated Terraform module to provision an application and database very ea
|------|-------------|------|---------|:--------:|
| <a name="input_additionnal_collaborators"></a> [additionnal\_collaborators](#input\_additionnal\_collaborators) | List of emails of collaborators that have admin rights for the application | `list(string)` | `[]` | no |
| <a name="input_addons"></a> [addons](#input\_addons) | List of addons to add to the application | <pre>list(object({<br> provider = string<br> plan = string<br> database_features = optional(list(string))<br> }))</pre> | `[]` | no |
| <a name="input_authorize_unsecure_http"></a> [authorize\_unsecure\_http](#input\_authorize\_unsecure\_http) | When true, Scalingo does not automatically redirect HTTP traffic to HTTPS | `bool` | `false` | no |
| <a name="input_authorize_unsecure_http"></a> [authorize\_unsecure\_http](#input\_authorize\_unsecure\_http) | When true, Scalingo does not automatically redirect HTTP traffic to HTTPS. The default behavior is to redirect HTTP traffic to HTTPS (when value is `false`) | `bool` | `false` | no |
| <a name="input_containers"></a> [containers](#input\_containers) | Configuration of the containers of the application. | <pre>map(object({<br> size = optional(string, "S")<br> amount = optional(number, 1)<br> autoscaler = optional(object({<br> min_containers = optional(number, 2)<br> max_containers = optional(number, 10)<br> metric = optional(string, "cpu")<br> target = optional(number, 0.8)<br> }))<br> }))</pre> | <pre>{<br> "web": {<br> "amount": 0,<br> "size": "S"<br> }<br>}</pre> | no |
| <a name="input_domain"></a> [domain](#input\_domain) | Main domain name of the application, known as "canonical domain" in Scalingo's dashboard. Note that SSL configuration must be completed through the dashboard. | `string` | `null` | no |
| <a name="input_domain_aliases"></a> [domain\_aliases](#input\_domain\_aliases) | List of others domain names for the application | `list(string)` | `[]` | no |
| <a name="input_environment"></a> [environment](#input\_environment) | Map of environment variables to set on the application | `map(string)` | `{}` | no |
| <a name="input_github_integration"></a> [github\_integration](#input\_github\_integration) | n/a | <pre>object({<br> repo_url = string<br> integration_uuid = optional(string)<br> branch = optional(string, "main")<br> auto_deploy_enabled = optional(bool, true)<br> deploy_review_apps_enabled = optional(bool, false)<br> delete_on_close_enabled = optional(bool, true)<br> delete_stale_enabled = optional(bool, true)<br> hours_before_delete_on_close = optional(string, "0")<br> hours_before_delete_stale = optional(string, "72")<br> automatic_creation_from_forks_allowed = optional(bool, false)<br> })</pre> | `null` | no |
| <a name="input_gitlab_integration"></a> [gitlab\_integration](#input\_gitlab\_integration) | n/a | <pre>object({<br> repo_url = string<br> integration_uuid = optional(string)<br> branch = optional(string, "main")<br> auto_deploy_enabled = optional(bool, true)<br> deploy_review_apps_enabled = optional(bool, false)<br> delete_on_close_enabled = optional(bool, true)<br> delete_stale_enabled = optional(bool, true)<br> hours_before_delete_on_close = optional(string, "0")<br> hours_before_delete_stale = optional(string, "72")<br> automatic_creation_from_forks_allowed = optional(bool, false)<br> })</pre> | `null` | no |
| <a name="input_environment"></a> [environment](#input\_environment) | Map of environment variables to set on the application. Note that value of environment variables can be null or empty. | `map(string)` | `null` | no |
| <a name="input_github_integration"></a> [github\_integration](#input\_github\_integration) | Configuration of the GitHub integration of the application. Only one of github\_integration or gitlab\_integration can be set. | <pre>object({<br> repo_url = string<br> integration_uuid = optional(string)<br> branch = optional(string, "main")<br> auto_deploy_enabled = optional(bool, true)<br> })</pre> | `null` | no |
| <a name="input_gitlab_integration"></a> [gitlab\_integration](#input\_gitlab\_integration) | Configuration of the GitLab integration of the application. Only one of github\_integration or gitlab\_integration can be set. | <pre>object({<br> repo_url = string<br> integration_uuid = optional(string)<br> branch = optional(string, "main")<br> auto_deploy_enabled = optional(bool, true)<br> })</pre> | `null` | no |
| <a name="input_log_drains"></a> [log\_drains](#input\_log\_drains) | n/a | <pre>list(object({<br> type = string<br> url = optional(string, "")<br> }))</pre> | `[]` | no |
| <a name="input_name"></a> [name](#input\_name) | n/a | `string` | n/a | yes |
| <a name="input_review_apps"></a> [review\_apps](#input\_review\_apps) | Configuration of the review apps of the application. | <pre>object({<br> enabled = optional(bool, false)<br><br> # By default: delete review apps 0 hours after closing the PR<br> delete_on_close_enabled = optional(bool, true)<br> hours_before_delete_on_close = optional(string, "0")<br><br> # By default: delete review apps after 5 days of inactivity (= no new deployment)<br> delete_stale_enabled = optional(bool, true)<br> hours_before_delete_stale = optional(string, "168")<br><br> # By default: do not create review apps for PRs from forks<br> automatic_creation_from_forks_allowed = optional(bool, false)<br> })</pre> | `{}` | no |
| <a name="input_router_logs"></a> [router\_logs](#input\_router\_logs) | When true, the router logs are included in the application logs. (default: `false`) | `bool` | `false` | no |
| <a name="input_stack"></a> [stack](#input\_stack) | The stack to use for the app (default: "scalingo-22"). | `string` | `"scalingo-22"` | no |
| <a name="input_sticky_session"></a> [sticky\_session](#input\_sticky\_session) | When true, sticky sessions are enabled. (default: `false`) | `bool` | `false` | no |

## Outputs

| Name | Description |
|------|-------------|
| <a name="output_all_environment_variables"></a> [all\_environment\_variables](#output\_all\_environment\_variables) | All environment variables of the Scalingo application (ones added by the terraform module and ones added by Scalingo add-ons). |
| <a name="output_app_id"></a> [app\_id](#output\_app\_id) | ID of the Scalingo application. |
| <a name="output_domain"></a> [domain](#output\_domain) | Hostname to use to access the application. Same as the `url` output but without the `https://`. |
| <a name="output_git_url"></a> [git\_url](#output\_git\_url) | Hostname to use to deploy code with Git + SSH. |
| <a name="output_log_drain_url"></a> [log\_drain\_url](#output\_log\_drain\_url) | URL of the drain to use by Scalingo to send logs to your log management system. (Note: the username and password are included in the URL, be careful with the security of this URL.). It's already marked as sensitive to avoid leaking it in the Terraform state. |
| <a name="output_origin_domain"></a> [origin\_domain](#output\_origin\_domain) | The FQDN of the Scalingo application (`<your_app_name>.<region>.scalingo.io`). Same as the url output if you have not set a canonical domain. |
| <a name="output_origin_domain"></a> [origin\_domain](#output\_origin\_domain) | The FQDN of the Scalingo application (`<your_app_name>.<region>.scalingo.io`). Same as the `domain` output if you have not set a canonical domain. |
| <a name="output_region"></a> [region](#output\_region) | Region where the application is deployed. |
| <a name="output_url"></a> [url](#output\_url) | Base URL to access the application (`https://*`). If you have set a canonical domain, this will be the URL with the canonical domain, otherwise it will be the default URL of the Scalingo application. |
<!-- END_TF_DOCS -->
Expand Down

0 comments on commit bdfc591

Please sign in to comment.