From e20f8051afa5fa9b0315a37f7837c51bbe9f8bec Mon Sep 17 00:00:00 2001 From: nitrocode Date: Wed, 11 Aug 2021 21:13:03 -0400 Subject: [PATCH] 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 <11232728+cloudpossebot@users.noreply.github.com> --- README.md | 31 +++++++++++++++++++++++++++++-- README.yaml | 28 ++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21cfe52..04a13c5 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,31 @@ For complete examples, see For a complete example with automated tests, see [examples/complete](examples/complete) with `bats` and `Terratest` for the example [test](test). +```hcl +module "container_definition" { + source = "cloudposse/ecs-container-definition/aws" + # Cloud Posse recommends pinning every module to a specific version + # version = "x.x.x" + + container_name = "geodesic" + container_image = "cloudposse/geodesic" +} +``` + +The output of this module can then be used with one of our other modules. + +```hcl +module "ecs_alb_service_task" { + source = "cloudposse/ecs-alb-service-task/aws" + # Cloud Posse recommends pinning every module to a specific version + # version = "x.x.x" + + # ... + container_definition_json = module.container_definition.json_map_encoded_list + # ... +} +``` + @@ -359,8 +384,8 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply ### Contributors -| [![Erik Osterman][osterman_avatar]][osterman_homepage]
[Erik Osterman][osterman_homepage] | [![Sarkis Varozian][sarkis_avatar]][sarkis_homepage]
[Sarkis Varozian][sarkis_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]
[Andriy Knysh][aknysh_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]
[Igor Rodionov][goruha_homepage] | [![Yonatan Koren][korenyoni_avatar]][korenyoni_homepage]
[Yonatan Koren][korenyoni_homepage] | -|---|---|---|---|---| +| [![Erik Osterman][osterman_avatar]][osterman_homepage]
[Erik Osterman][osterman_homepage] | [![Sarkis Varozian][sarkis_avatar]][sarkis_homepage]
[Sarkis Varozian][sarkis_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]
[Andriy Knysh][aknysh_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]
[Igor Rodionov][goruha_homepage] | [![Yonatan Koren][korenyoni_avatar]][korenyoni_homepage]
[Yonatan Koren][korenyoni_homepage] | [![RB][nitrocode_avatar]][nitrocode_homepage]
[RB][nitrocode_homepage] | +|---|---|---|---|---|---| [osterman_homepage]: https://github.com/osterman @@ -373,6 +398,8 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply [goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png [korenyoni_homepage]: https://github.com/korenyoni [korenyoni_avatar]: https://img.cloudposse.com/150x150/https://github.com/korenyoni.png + [nitrocode_homepage]: https://github.com/nitrocode + [nitrocode_avatar]: https://img.cloudposse.com/150x150/https://github.com/nitrocode.png [![README Footer][readme_footer_img]][readme_footer_link] [![Beacon][beacon]][website] diff --git a/README.yaml b/README.yaml index 6571af5..ee2015a 100644 --- a/README.yaml +++ b/README.yaml @@ -58,6 +58,32 @@ usage: |- - [string env vars](examples/string_env_vars) For a complete example with automated tests, see [examples/complete](examples/complete) with `bats` and `Terratest` for the example [test](test). + + ```hcl + module "container_definition" { + source = "cloudposse/ecs-container-definition/aws" + # Cloud Posse recommends pinning every module to a specific version + # version = "x.x.x" + + container_name = "geodesic" + container_image = "cloudposse/geodesic" + } + ``` + + The output of this module can then be used with one of our other modules. + + ```hcl + module "ecs_alb_service_task" { + source = "cloudposse/ecs-alb-service-task/aws" + # Cloud Posse recommends pinning every module to a specific version + # version = "x.x.x" + + # ... + container_definition_json = module.container_definition.json_map_encoded_list + # ... + } + ``` + include: - docs/targets.md - docs/terraform.md @@ -72,3 +98,5 @@ contributors: github: goruha - name: Yonatan Koren github: korenyoni +- name: RB + github: nitrocode