Skip to content

Commit e20f805

Browse files
Add quick usage using correct source (#141)
* Add quick usage using correct source * Auto Format * Add more to README.yaml * Update README.yaml * Auto Format Co-authored-by: cloudpossebot <[email protected]>
1 parent 63facfd commit e20f805

File tree

2 files changed

+57
-2
lines changed

2 files changed

+57
-2
lines changed

README.md

+29-2
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,31 @@ For complete examples, see
110110

111111
For a complete example with automated tests, see [examples/complete](examples/complete) with `bats` and `Terratest` for the example [test](test).
112112

113+
```hcl
114+
module "container_definition" {
115+
source = "cloudposse/ecs-container-definition/aws"
116+
# Cloud Posse recommends pinning every module to a specific version
117+
# version = "x.x.x"
118+
119+
container_name = "geodesic"
120+
container_image = "cloudposse/geodesic"
121+
}
122+
```
123+
124+
The output of this module can then be used with one of our other modules.
125+
126+
```hcl
127+
module "ecs_alb_service_task" {
128+
source = "cloudposse/ecs-alb-service-task/aws"
129+
# Cloud Posse recommends pinning every module to a specific version
130+
# version = "x.x.x"
131+
132+
# ...
133+
container_definition_json = module.container_definition.json_map_encoded_list
134+
# ...
135+
}
136+
```
137+
113138

114139

115140

@@ -359,8 +384,8 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
359384
### Contributors
360385

361386
<!-- markdownlint-disable -->
362-
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Sarkis Varozian][sarkis_avatar]][sarkis_homepage]<br/>[Sarkis Varozian][sarkis_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] | [![Yonatan Koren][korenyoni_avatar]][korenyoni_homepage]<br/>[Yonatan Koren][korenyoni_homepage] |
363-
|---|---|---|---|---|
387+
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Sarkis Varozian][sarkis_avatar]][sarkis_homepage]<br/>[Sarkis Varozian][sarkis_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] | [![Yonatan Koren][korenyoni_avatar]][korenyoni_homepage]<br/>[Yonatan Koren][korenyoni_homepage] | [![RB][nitrocode_avatar]][nitrocode_homepage]<br/>[RB][nitrocode_homepage] |
388+
|---|---|---|---|---|---|
364389
<!-- markdownlint-restore -->
365390

366391
[osterman_homepage]: https://github.com/osterman
@@ -373,6 +398,8 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
373398
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
374399
[korenyoni_homepage]: https://github.com/korenyoni
375400
[korenyoni_avatar]: https://img.cloudposse.com/150x150/https://github.com/korenyoni.png
401+
[nitrocode_homepage]: https://github.com/nitrocode
402+
[nitrocode_avatar]: https://img.cloudposse.com/150x150/https://github.com/nitrocode.png
376403

377404
[![README Footer][readme_footer_img]][readme_footer_link]
378405
[![Beacon][beacon]][website]

README.yaml

+28
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,32 @@ usage: |-
5858
- [string env vars](examples/string_env_vars)
5959
6060
For a complete example with automated tests, see [examples/complete](examples/complete) with `bats` and `Terratest` for the example [test](test).
61+
62+
```hcl
63+
module "container_definition" {
64+
source = "cloudposse/ecs-container-definition/aws"
65+
# Cloud Posse recommends pinning every module to a specific version
66+
# version = "x.x.x"
67+
68+
container_name = "geodesic"
69+
container_image = "cloudposse/geodesic"
70+
}
71+
```
72+
73+
The output of this module can then be used with one of our other modules.
74+
75+
```hcl
76+
module "ecs_alb_service_task" {
77+
source = "cloudposse/ecs-alb-service-task/aws"
78+
# Cloud Posse recommends pinning every module to a specific version
79+
# version = "x.x.x"
80+
81+
# ...
82+
container_definition_json = module.container_definition.json_map_encoded_list
83+
# ...
84+
}
85+
```
86+
6187
include:
6288
- docs/targets.md
6389
- docs/terraform.md
@@ -72,3 +98,5 @@ contributors:
7298
github: goruha
7399
- name: Yonatan Koren
74100
github: korenyoni
101+
- name: RB
102+
github: nitrocode

0 commit comments

Comments
 (0)