Skip to content

Commit ae467ea

Browse files
committed
Readme fixes
Closes aws#429.
1 parent 5b757aa commit ae467ea

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
# Amazon ECS CLI
22

3-
The Amazon ECS Command Line Interface (CLI) is a command line interface for Amazon Elastic Container
3+
The Amazon ECS Command Line Interface (CLI) is a command line tool for Amazon Elastic Container
44
Service (Amazon ECS) that provides high-level commands to simplify creating, updating, and
55
monitoring clusters and tasks from a local development environment. The Amazon ECS CLI supports
66
[Docker Compose](https://docs.docker.com/compose/), a popular open-source tool for defining and
77
running multi-container applications. Use the CLI as part of your everyday development and testing
8-
cycle as an alternative to the AWS Management Console.
8+
cycle as an alternative to the AWS Management Console or the AWS CLI.
99

1010
For more information about Amazon ECS, see the [Amazon ECS Developer
11-
Guide](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html). For information
12-
about installing and using the Amazon ECS CLI, see the [ECS Command Line
13-
Interface](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_CLI.html).
11+
Guide](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html).
1412

1513
The AWS Command Line Interface (AWS CLI) is a unified client for AWS services that provides commands
1614
for all public API operations. These commands are lower level than those provided by the Amazon ECS
@@ -43,6 +41,8 @@ Line Interface](http://aws.amazon.com/cli/) product detail page.
4341
Download the binary archive for your platform, and install the binary on your `$PATH`.
4442
You can use the provided `md5` hash to verify the integrity of your download.
4543

44+
For information about installing and using the Amazon ECS CLI, see the [ECS Command Line Interface](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_CLI.html).
45+
4646
### Latest version
4747
* Linux:
4848
* [https://s3.amazonaws.com/amazon-ecs-cli/ecs-cli-linux-amd64-latest](https://s3.amazonaws.com/amazon-ecs-cli/ecs-cli-linux-amd64-latest)
@@ -165,6 +165,9 @@ If you are trying to use Multi-Factor Authentication, please see this comment an
165165
a) AWS_PROFILE environment variable (OR) –aws-
166166
b) AWS_DEFAULT_PROFILE environment variable (defaults to 'default')
167167

168+
169+
For more information, see [ECS CLI Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_CLI_Configuration.html).
170+
168171
## Using the CLI
169172

170173
ECS now offers two different launch types for tasks and services: EC2 and FARGATE. With the FARGATE
@@ -258,6 +261,8 @@ following resources:
258261
The subnet and VPC ids will be printed to the terminal once the creation is complete. You can then
259262
use the subnet IDs in your ECS Params file to launch Fargate tasks.
260263

264+
For more information on using AWS Fargate, see the [ECS CLI Fargate tutorial](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_CLI_tutorial_fargate.html).
265+
261266
### Starting/Running Tasks
262267
After the cluster is created, you can run tasks – groups of containers – on the ECS cluster. First,
263268
author a [Docker Compose configuration file](https://docs.docker.com/compose). You can run the
@@ -281,7 +286,7 @@ for example:
281286
```
282287
$ ecs-cli compose ps
283288
Name State Ports TaskDefinition
284-
fd8d5a69-87c5-46a4-80b6-51918092e600/web RUNNING 54.209.244.64:80->80/tcp ecscompose-web:1
289+
fd8d5a69-87c5-46a4-80b6-51918092e600/web RUNNING 54.209.244.64:80->80/tcp web:1
285290
```
286291

287292
Navigate your web browser to the task’s IP address to see the sample app running in the ECS cluster.
@@ -294,8 +299,8 @@ container instance fails for some reason).
294299
```
295300
$ ecs-cli compose --project-name wordpress-test service create
296301
297-
INFO[0000] Using Task definition TaskDefinition=ecscompose-wordpress-test:1
298-
INFO[0000] Created an ECS Service serviceName=ecscompose-service-wordpress-test taskDefinition=ecscompose-wordpress-test:1
302+
INFO[0000] Using Task definition TaskDefinition=wordpress-test:1
303+
INFO[0000] Created an ECS Service serviceName=wordpress-test taskDefinition=wordpress-test:1
299304
300305
```
301306

@@ -307,8 +312,8 @@ the following command:
307312
```
308313
$ ecs-cli compose --project-name wordpress-test service ps
309314
Name State Ports TaskDefinition
310-
34333aa6-e976-4096-991a-0ec4cd5af5bd/wordpress RUNNING 54.186.138.217:80->80/tcp ecscompose-wordpress-test:1
311-
34333aa6-e976-4096-991a-0ec4cd5af5bd/mysql RUNNING ecscompose-wordpress-test:1
315+
34333aa6-e976-4096-991a-0ec4cd5af5bd/wordpress RUNNING 54.186.138.217:80->80/tcp wordpress-test:1
316+
34333aa6-e976-4096-991a-0ec4cd5af5bd/mysql RUNNING wordpress-test:1
312317
```
313318

314319
See the `$ ecs-cli compose service` [documentation page](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cmd-ecs-cli-compose-service.html) for more information about available service options, including load balancing.

0 commit comments

Comments
 (0)