From 392919ae6122c1273150a8fc2712c358c3ec76f5 Mon Sep 17 00:00:00 2001 From: Paul Glass Date: Thu, 16 Sep 2021 10:39:37 -0500 Subject: [PATCH] docs: adjust references between ECS "migrate" and "install" pages --- website/content/docs/ecs/get-started/install.mdx | 13 +++++++------ .../docs/ecs/get-started/migrate-existing-tasks.mdx | 11 ++++++++--- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/website/content/docs/ecs/get-started/install.mdx b/website/content/docs/ecs/get-started/install.mdx index 45b1bd0780..39ad895956 100644 --- a/website/content/docs/ecs/get-started/install.mdx +++ b/website/content/docs/ecs/get-started/install.mdx @@ -65,7 +65,12 @@ however there are some important inputs worth highlighting: - `retry_join` is passed to the [`-retry-join`](/docs/agent/options#_retry_join) option for the Consul agent. This tells the agent the location of your Consul server so that it can join the Consul cluster. -To define an ECS service, reference the mesh-task module's `task_definition_arn` output value +-> **NOTE:** If your tasks run in a public subnet, they must have `assign_public_ip = true` +in their [`network_configuration`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service#network_configuration) block so that ECS can pull the Docker images. + +## ECS Service + +To define an ECS Service, reference the mesh-task module's `task_definition_arn` output value in your `aws_ecs_service` resource: ```hcl @@ -75,9 +80,6 @@ resource "aws_ecs_service" "my_task" { } ``` --> **NOTE:** If your tasks run in a public subnet, they must have `assign_public_ip = true` -in their [`network_configuration`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service#network_configuration) block so that ECS can pull the Docker images. - After running `terraform apply`, you should see your tasks registered in the Consul UI. @@ -94,7 +96,6 @@ proxy on that port. For example, if your application `web` makes calls to another application called `backend`, then you would first configure the `mesh-task` module's upstream(s): `backend`. - ```hcl module "web" { family = "web" @@ -178,7 +179,7 @@ python manage.py runserver "127.0.0.1:8080" ## Next Steps -- Configure a secure [Production Installation](TODO-LINK). +- Configure a secure [Production Installation](/docs/ecs/production-installation). - Now that your applications are running in the service mesh, read about other [Service Mesh features](/docs/connect). - View the [Architecture](/docs/ecs/architecture) documentation to understand diff --git a/website/content/docs/ecs/get-started/migrate-existing-tasks.mdx b/website/content/docs/ecs/get-started/migrate-existing-tasks.mdx index b6378e3f5c..717cbed9c3 100644 --- a/website/content/docs/ecs/get-started/migrate-existing-tasks.mdx +++ b/website/content/docs/ecs/get-started/migrate-existing-tasks.mdx @@ -98,7 +98,8 @@ module "my_task" { The main differences are: - You must remove the `execution_role_arn` and `task_role_arn` fields. The `mesh-task` module will create the task and execution roles. -- You must add the `port` field. This is the port that your application listens on. +- You must set the `port` field to the port that your application listens on. + If your application has no listening port, set `outbound_only = true` and remove the `port` field. - You must add the `retry_join` field. This specifies the location of your Consul servers so that your task can join the mesh. - You must remove the `jsonencode()` function from the `container_definitions` field. @@ -106,5 +107,9 @@ The `mesh-task` module will create a new version of your task definition with th necessary sidecar containers added so you can delete your existing `aws_ecs_task_definition` resource. -Now that your task(s) are migrated to the `mesh-task` module, see the [Installation Guide](/docs/ecs/get-started/install) to continue installing -Consul on ECS. +## Next Steps + +Now that your task(s) are migrated to the `mesh-task` module, + +- Start at the [ECS Service section](/docs/ecs/get-started/install#ecs-service) of the Installation Guide to continue installing Consul on ECS. +- Refer to the [`mesh-task` reference documentation](https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/submodules/mesh-task?tab=inputs) for all available inputs to your mesh tasks.