Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
qbart committed Jun 22, 2021
1 parent 8832abd commit 3a98417
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 7 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Changelog

# 0.2.1 - ...
# 0.3.0 - ...

* Breaking change: Changing launch configuration will not force ASG to be recreated.

# 0.2.1 - 0.2.6

* Add generated documentation
* Add additional outputs
Expand Down
2 changes: 1 addition & 1 deletion modules/ecs-background-job/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Define background job:
```tf
module "ecs_background_job" {
source = "Selleo/backend/aws//modules/ecs-background-job"
version = "0.2.0"
version = "0.3.0"
name = "shoryuken"
ecs_cluster_id = module.ecs_cluster.ecs_cluster_id
Expand Down
10 changes: 7 additions & 3 deletions modules/ecs-cluster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Define cluster:
```tf
module "ecs_cluster" {
source = "Selleo/backend/aws//modules/ecs-cluster"
version = "0.2.0"
version = "0.3.0"
name_prefix = "my-cluster"
region = "eu-central-1"
Expand Down Expand Up @@ -61,8 +61,8 @@ Module defines permissions for EC2 instance that allows managing application lif

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | 3.44.0 |
| <a name="provider_random"></a> [random](#provider\_random) | 3.1.0 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 3.0 |
| <a name="provider_random"></a> [random](#provider\_random) | n/a |

## Modules

Expand Down Expand Up @@ -93,14 +93,17 @@ No modules.
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_ami"></a> [ami](#input\_ami) | Image ID for Autoscaling group. If left blank, latest ECS-optimized version will be used. | `string` | `""` | no |
| <a name="input_associate_public_ip_address"></a> [associate\_public\_ip\_address](#input\_associate\_public\_ip\_address) | Associate a public ip address with an instance in a VPC. | `bool` | `false` | no |
| <a name="input_autoscaling_group"></a> [autoscaling\_group](#input\_autoscaling\_group) | Autoscaling group configuration. | <pre>object({<br> min_size = number<br> max_size = number<br> desired_capacity = number<br> })</pre> | n/a | yes |
| <a name="input_backward_compatibility_single_instance_sg_per_vpc"></a> [backward\_compatibility\_single\_instance\_sg\_per\_vpc](#input\_backward\_compatibility\_single\_instance\_sg\_per\_vpc) | Use backward compatibility mode for security group name. If set to `True` default SG will be named `instance_sg`, otherwsie random prefix is added. | `bool` | `false` | no |
| <a name="input_ecs_loglevel"></a> [ecs\_loglevel](#input\_ecs\_loglevel) | ECS Cluster log level. | `string` | `"info"` | no |
| <a name="input_enable_container_insights"></a> [enable\_container\_insights](#input\_enable\_container\_insights) | Enable container insights for the cluster. | `bool` | `false` | no |
| <a name="input_instance_type"></a> [instance\_type](#input\_instance\_type) | EC2 instance type i.e. t3.medium. | `string` | n/a | yes |
| <a name="input_key_name"></a> [key\_name](#input\_key\_name) | Key pair name for SSH access. | `string` | `""` | no |
| <a name="input_loadbalancer_sg_id"></a> [loadbalancer\_sg\_id](#input\_loadbalancer\_sg\_id) | LoadBalancer security group id. | `string` | n/a | yes |
| <a name="input_name_prefix"></a> [name\_prefix](#input\_name\_prefix) | Name prefix (hyphen suffix should be skipped). | `string` | n/a | yes |
| <a name="input_region"></a> [region](#input\_region) | AWS region for cluster. | `string` | n/a | yes |
| <a name="input_root_block_configuration"></a> [root\_block\_configuration](#input\_root\_block\_configuration) | Configuration for root block device block. | <pre>object({<br> volume_type = string<br> volume_size = number<br> })</pre> | <pre>{<br> "volume_size": 30,<br> "volume_type": "gp2"<br>}</pre> | no |
| <a name="input_security_groups"></a> [security\_groups](#input\_security\_groups) | List of security groups attached to launch configuration. | `list(string)` | `[]` | no |
| <a name="input_subnet_ids"></a> [subnet\_ids](#input\_subnet\_ids) | List of AWS subent IDs for Autoscaling group. | `list(string)` | n/a | yes |
| <a name="input_tags"></a> [tags](#input\_tags) | Additional tags attached to resources. | `map(string)` | `{}` | no |
Expand All @@ -112,4 +115,5 @@ No modules.
|------|-------------|
| <a name="output_ecs_cluster_id"></a> [ecs\_cluster\_id](#output\_ecs\_cluster\_id) | ECS cluster ID (contains randomized suffix). |
| <a name="output_instance_role"></a> [instance\_role](#output\_instance\_role) | IAM role that is attached to EC2 instances. |
| <a name="output_instance_security_group_id"></a> [instance\_security\_group\_id](#output\_instance\_security\_group\_id) | ID of the security group attached to an instance. |
| <a name="output_prefix"></a> [prefix](#output\_prefix) | Random prefix to use for associated resources. |
2 changes: 1 addition & 1 deletion modules/ecs-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Define service:
```tf
module "ecs_service" {
source = "Selleo/backend/aws//modules/ecs-service"
version = "0.2.0"
version = "0.3.0"
name = "rails-api"
vpc_id = module.vpc.vpc_id
Expand Down
2 changes: 1 addition & 1 deletion modules/load-balancer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Define application load balancer:
```tf
module "load_balancer" {
source = "Selleo/backend/aws//modules/load-balancer"
version = "0.2.6"
version = "0.3.0"
name = "ecs-lb"
vpc_id = module.vpc.vpc_id # "vpc-1234"
Expand Down

0 comments on commit 3a98417

Please sign in to comment.