Skip to content

Commit c587372

Browse files
update docs
1 parent c035fe3 commit c587372

File tree

5 files changed

+76
-6
lines changed

5 files changed

+76
-6
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ IMPORTANT: The master branch is used in source just as an example. In your code,
4343

4444
```hcl
4545
module "ecs" {
46-
source = "terraform-aws-modules/ecs/aws"
46+
source = "terraform-aws-module/ecs/aws"
4747
4848
name = "my-ecs"
4949
@@ -118,7 +118,6 @@ No modules.
118118
| <a name="output_ecs_cluster_name"></a> [ecs\_cluster\_name](#output\_ecs\_cluster\_name) | The name of the ECS cluster |
119119
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
120120

121-
122121
### :memo: Guidelines
123122

124123
- :memo: Use a succinct title and description.

examples/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,3 @@ These serve a few purposes:
55
1. Shows developers how to use the module in a straightforward way as integrated with other terraform community supported modules.
66
2. Serves as the test infrastructure for CI on the project.
77
3. Provides a simple way to play with the Kubernetes cluster you create.
8-
9-
## IAM Permissions
10-
11-
You can see the minimum IAM Permissions required (WORK in PROGRESS)

examples/basic/.gitkeep

Whitespace-only changes.

examples/basic/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Example
2+
3+
Configuration in this directory creates a MySQL Aurora cluster.
4+
5+
## Usage
6+
7+
To run this example you need to execute:
8+
9+
```bash
10+
$ terraform init
11+
$ terraform plan
12+
$ terraform apply
13+
```
14+
15+
Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
16+
17+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
18+
## Requirements
19+
20+
No requirements.
21+
22+
## Providers
23+
24+
No providers.
25+
26+
## Modules
27+
28+
| Name | Source | Version |
29+
|------|--------|---------|
30+
| <a name="module_ecs"></a> [ecs](#module\_ecs) | terraform-aws-module/ecs/aws | n/a |
31+
32+
## Resources
33+
34+
No resources.
35+
36+
## Inputs
37+
38+
No inputs.
39+
40+
## Outputs
41+
42+
| Name | Description |
43+
|------|-------------|
44+
| <a name="output_ecs"></a> [ecs](#output\_ecs) | ############################################################################### OUTPUTS ############################################################################### |
45+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

examples/basic/main.tf

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
################################################################################
2+
# Resources
3+
################################################################################
4+
module "ecs" {
5+
source = "terraform-aws-module/ecs/aws"
6+
7+
name = "test-ecs"
8+
9+
container_insights = false
10+
capacity_providers = ["FARGATE_SPOT"]
11+
12+
default_capacity_provider_strategy = [
13+
{
14+
capacity_provider = "FARGATE_SPOT"
15+
}
16+
]
17+
18+
tags = {
19+
Created = "Teeraform"
20+
Owner = "DevOps"
21+
}
22+
}
23+
24+
################################################################################
25+
# OUTPUTS
26+
################################################################################
27+
output "ecs" {
28+
value = { for k, v in module.ecs : k => v }
29+
}
30+

0 commit comments

Comments
 (0)