Skip to content

Commit e5e29d7

Browse files
SoManyHsSoManyHs
committed
Update README
1 parent 3893a12 commit e5e29d7

File tree

1 file changed

+32
-13
lines changed

1 file changed

+32
-13
lines changed

‎README.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ Line Interface](http://aws.amazon.com/cli/) product detail page.
3434
- [Using Route53 Service Discovery](#using-route53-service-discovery)
3535
- [Viewing Running Tasks](#viewing-running-tasks)
3636
- [Viewing Container Logs](#viewing-container-logs)
37-
- [Using Private Registry Authentication](#using-private-registry-authentication)
37+
- [Using FIPS Endpoints](#using-fips-endpoints)
38+
- [Using Private Registry Authentication](#using-private-registry-authentication)
3839
- [Amazon ECS CLI Commands](#amazon-ecs-cli-commands)
3940
- [Contributing to the CLI](#contributing-to-the-cli)
4041
- [License](#license)
@@ -338,17 +339,17 @@ For the EC2 launch type, the ECS CLI always creates EC2 instances that include t
338339
echo ECS_CLUSTER={ clusterName } >> /etc/ecs/ecs.config
339340
```
340341

341-
This user data directs the EC2 instance to join your ECS Cluster. You can optionally include extra user data with `--extra-user-data`; this flag takes a file name as its argument.
342+
This user data directs the EC2 instance to join your ECS Cluster. You can optionally include extra user data with `--extra-user-data`; this flag takes a file name as its argument.
342343
The flag can be used multiple times to specify multiple files. Extra user data can be shell scripts or cloud-init directives- see the [EC2 documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) for more information.
343344
The ECS CLI takes all the User Data, and packs it into a MIME Multipart archive which can be used by cloud-init on the EC2 instance. The ECS CLI even allows existing MIME Multipart archives to be passed in with `--extra-user-data`.
344345
The CLI will unpack the existing archive, and then repack it into the final archive (preserving all header and content type information). Here is an example of specifying extra user data:
345346

346347
```
347-
ecs-cli up \
348-
--capability-iam \
349-
--extra-user-data my-shellscript \
350-
--extra-user-data my-cloud-boot-hook \
351-
--extra-user-data my-mime-multipart-archive \
348+
ecs-cli up \
349+
--capability-iam \
350+
--extra-user-data my-shellscript \
351+
--extra-user-data my-cloud-boot-hook \
352+
--extra-user-data my-mime-multipart-archive \
352353
--launch-type EC2
353354
```
354355

@@ -850,7 +851,26 @@ OPTIONS:
850851
--timestamps, -t [Optional] Shows timestamps on each line in the log output.
851852
```
852853

853-
## Using Private Registry Authentication
854+
### Using FIPS Endpoints
855+
The ECS-CLI supports using [FIPS endpoints](https://aws.amazon.com/compliance/fips/) for calls to ECR. To ensure you are accessing ECR using FIPS endpoints, use the `--use-fips` flag on the `push`, `pull`, or `images` command. FIPS endpoints are currently available in us-west-1, us-west-2, us-east-1, us-east-2, and in the [GovCloud partition](https://docs.aws.amazon.com/govcloud-us/latest/ug-west/using-govcloud-endpoints.html).
856+
857+
```
858+
$ ecs-cli push myRepository:latest --use-fips --debug
859+
DEBU[0000] Using FIPS endpoint: https://ecr-fips.us-west-2.amazonaws.com
860+
INFO[0000] Getting AWS account ID...
861+
DEBU[0000] Getting authorization token...
862+
DEBU[0000] Checking file cache registry=xxxxxxxxxx123
863+
DEBU[0000] Calling ECR.GetAuthorizationToken registry=xxxxxxxxxx123
864+
DEBU[0000] Saving credentials to file cache registry=xxxxxxxxxx123
865+
DEBU[0000] Retrieved authorization token via endpoint: https://xxxxxxxxxxx123.dkr.ecr-fips.us-west-2.amazonaws.com
866+
INFO[0000] Tagging image image=myRepository repository=xxxxxxxxxxx123.dkr.ecr-fips.us-west-2.amazonaws.com/myRepository tag=latest
867+
INFO[0000] Image tagged
868+
DEBU[0000] Check if repository exists repository=myRepository
869+
INFO[0000] Pushing image repository=xxxxxxxxxxx123.dkr.ecr-fips.us-west-2.amazonaws.com/myRepository tag=latest
870+
INFO[0002] Image pushed
871+
```
872+
873+
### Using Private Registry Authentication
854874

855875
If you want to use privately hosted container images with ECS, the ECS CLI can store your private registry credentials in AWS Secrets Manager and create an IAM role which ECS can use to access the credentials and private images. This allows you to:
856876

@@ -863,7 +883,7 @@ Using privately hosted images with the ECS CLI is done in two parts:
863883
1) Create new AWS Secrets Manager secrets and an IAM Task Execution Role with `ecs-cli registry-creds up`
864884
2) Run `ecs-cli compose` commands to create and run a task definition that includes the new resources
865885

866-
### Storing private registry credentials with `ecs-cli registry-creds up`
886+
#### Storing private registry credentials with `ecs-cli registry-creds up`
867887

868888
To get started, first create an input file that contains the name of your registry and the credentials needed to access it:
869889

@@ -876,7 +896,7 @@ registry_credentials:
876896
my-registry.example.com:
877897
secrets_manager_arn: # required when using (with no modification) or updating an existing secret
878898
username: myUserName # required when creating or updating a new secret
879-
password: ${MY_PASSWORD} # required when creating or updating a new secret
899+
password: ${MY_PASSWORD} # required when creating or updating a new secret
880900
kms_key_id: # optional custom KMS Key ID to use to encrypt new secret
881901
container_names: # required to match credential resources with docker-compose services
882902
- web
@@ -891,7 +911,7 @@ Other options:
891911
* If you want to encrypt the AWS Secrets Manager secret for your registry with a custom KMS Key, then add the ARN, ID or Alias of the Key in the `kms_key_id` field. Otherwise, AWS Secrets Manager will use the default key in your account.
892912
* If you don't want to create or update an IAM Task Execution Role for these secrets, use the `--no-role` flag instead of specifying a role name.
893913
* If you don't want to generate an output file for use with `compose` or for records purposes, use the `--no-output-file` flag.
894-
* If you want the output file to be created in a specific directory on your machine, you can specify it with the `--output-dir <value>` flag. Otherwise, the file will be created in your working directory.
914+
* If you want the output file to be created in a specific directory on your machine, you can specify it with the `--output-dir <value>` flag. Otherwise, the file will be created in your working directory.
895915

896916
After creating the input file, run the `registry-creds up` command on the file and pass in the name of the new or existing Task Execution Role you want to use for the secrets:
897917

@@ -933,7 +953,7 @@ This file contains:
933953

934954
We can now use this file with `ecs-cli compose` commands to start a task with images in our private registry.
935955

936-
### Using private registry credentials when launching tasks or services
956+
#### Using private registry credentials when launching tasks or services
937957

938958
Now that we have an output file that identifies which resources we need to use our private registry, the ECS CLI will incorporate them into our Docker Compose project when we run `ecs-cli compose`.
939959

@@ -984,7 +1004,6 @@ INFO[0018] Started container... container=bf35a813-dd76-4fe0-b5a2-c1334c2331f4/l
9841004

9851005
For more information about using private registries with ECS, see [Private Registry Authentication for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/private-auth.html).
9861006

987-
9881007
## Amazon ECS CLI Commands
9891008

9901009
For a complete list of commands, see the

0 commit comments

Comments
 (0)