status-im/consul
2
0
Fork 0
mirror of https://github.com/status-im/consul.git synced 2025-01-10 13:55:55 +00:00
Code Issues Projects Releases Wiki Activity

docs: ECS docs for GA

Browse Source
This commit is contained in:
Paul Glass 2021-11-16 10:55:23 -06:00
parent 319a7b389c
commit 2d4d867e41
4 changed files with 12 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
website/content/docs/ecs/get-started/install.mdx
View File

@ -49,7 +49,7 @@ module "my_task" {
] ]
port = "9090" port = "9090"
retry_join = "<address of the Consul server>" retry_join = ["<address of the Consul server>"]
} }
``` ```
@ -63,7 +63,7 @@ however there are some important inputs worth highlighting:
- `port` is the port that your application listens on. This should be set to a - `port` is the port that your application listens on. This should be set to a
string, not an integer, i.e. `port = "9090"`, not `port = 9090`. string, not an integer, i.e. `port = "9090"`, not `port = 9090`.
- `retry_join` is passed to the [`-retry-join`](/docs/agent/options#_retry_join) option for the Consul agent. This tells - `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. the agent the location of your Consul servers so that it can join the Consul cluster.
-> **NOTE:** If your tasks run in a public subnet, they must have `assign_public_ip = true` -> **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. 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.

2
website/content/docs/ecs/get-started/migrate-existing-tasks.mdx
View File

@ -91,7 +91,7 @@ module "my_task" {
] ]
port = "9090" port = "9090"
retry_join = "<address of the Consul server>" retry_join = ["<address of the Consul server>"]
} }
``` ```

19
website/content/docs/ecs/index.mdx
View File

@ -8,11 +8,7 @@ description: >-
# AWS ECS # AWS ECS
-> **Beta:** This functionality is currently in beta and is Consul can be deployed on [AWS ECS](https://aws.amazon.com/ecs/) (Elastic Container Service) using our official Terraform modules.
not recommended for use in production environments. Refer to the [consul-ecs project road map](https://github.com/hashicorp/consul-ecs/projects/1) for information about upcoming features and enhancements.
Consul can be deployed on [AWS ECS](https://aws.amazon.com/ecs/) (Elastic Container Service) using our official
Terraform modules.
![Consul on ECS Architecture](/img/consul-ecs-arch.png) ![Consul on ECS Architecture](/img/consul-ecs-arch.png)
@ -22,12 +18,13 @@ Using Consul on AWS ECS enables you to add your ECS tasks to the service mesh an
take advantage of features such as zero-trust-security, intentions, observability, take advantage of features such as zero-trust-security, intentions, observability,
traffic policy, and more. traffic policy, and more.
## Example Installation ## Getting Started
See our [Example Installation](https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/examples/dev-server-fargate) There are several ways to get started with Consul with ECS.
to learn how to install Consul on an example ECS cluster along with example service mesh applications.
## Install * The [Serverless Consul service mesh with ECS and HCP](https://learn.hashicorp.com/tutorials/cloud/consul-ecs-hcp?in=consul/cloud-integrations) learn guide shows how to use Terraform to run Consul service mesh applications on ECS with managed Consul servers running in HashiCorp Cloud Platform (HCP).
* The [Service mesh with ECS and Consul on EC2](https://learn.hashicorp.com/tutorials/consul/consul-ecs-ec2?in=consul/cloud-integrations) learn guide shows shows how to use Terraform to run consul service mesh applications on ECS with Consul servers running on EC2 instances.
* The [Consul With Dev Server on Fargate](https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/examples/dev-server-fargate) example installation deploys a sample service mesh application in ECS using the Fargate launch type.
* The [Consul With Dev Server on EC2](https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/examples/dev-server-ec2) example installation deploys a sample service mesh applciation in ECS using the ECS launch type.
See our full [Install Guide](/docs/ecs/get-started/install) when you're ready to install Consul See the [Requirements](/docs/ecs/get-started/requirements) and the full [Install Guide](/docs/ecs/get-started/install) when you're ready to install Consul on an existing ECS cluster and add existing tasks to the service mesh.
on an existing ECS cluster and add existing tasks to the service mesh.

10
website/data/docs-nav-data.json
View File

@ -560,7 +560,7 @@
] ]
}, },
{ {
"title": "AWS ECS <sup>BETA</sup>", "title": "AWS ECS",
"routes": [ "routes": [
{ {
"title": "Overview", "title": "Overview",
@ -569,14 +569,6 @@
{ {
"title": "Get Started", "title": "Get Started",
"routes": [ "routes": [
{
"title": "Example Installation on ECS Fargate",
"href": "https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/examples/dev-server-fargate"
},
{
"title": "Example Installation on ECS EC2",
"href": "https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/examples/dev-server-ec2"
},
{ {
"title": "Requirements", "title": "Requirements",
"path": "ecs/get-started/requirements" "path": "ecs/get-started/requirements"