Skip to content

Commit e4f6028

Browse files
authored
Merge pull request #228 from chenrui333/add-homebrew-installation
docs: add homebrew installation note
2 parents 37a0872 + 5751736 commit e4f6028

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ The project is available on PyPI. Simply run::
4949

5050
$ pip install ecs-deploy
5151

52+
For [Homebrew](https://brew.sh/) users, you can also install [it](https://formulae.brew.sh/formula/ecs-deploy) via brew::
53+
54+
$ brew install ecs-deploy
5255

5356
Run via Docker
5457
--------------
@@ -57,7 +60,7 @@ Instead of installing **ecs-deploy** locally, which requires a Python environmen
5760
Running **ecs-deploy** via Docker is easy as::
5861

5962
docker run fabfuel/ecs-deploy:1.10.2
60-
63+
6164
In this example, the stable version 1.10.2 is executed. Alternatively you can use Docker tags ``master`` or ``latest`` for the latest stable version or Docker tag ``develop`` for the newest development version of **ecs-deploy**.
6265

6366
Please be aware, that when running **ecs-deploy** via Docker, the configuration - as described below - does not apply. You have to provide credentials and the AWS region via the command as attributes or environment variables::
@@ -80,7 +83,7 @@ AWS IAM
8083
-------
8184

8285
If you are using **ecs-deploy** with a role or user account that does not have full AWS access, such as in a deploy script, you will
83-
need to use or create an IAM policy with the correct set of permissions in order for your deploys to succeed. One option is to use the
86+
need to use or create an IAM policy with the correct set of permissions in order for your deploys to succeed. One option is to use the
8487
pre-specified ``AmazonECS_FullAccess`` (https://docs.aws.amazon.com/AmazonECS/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-AmazonECS_FullAccess) policy. If you would prefer to create a role with a more minimal set of permissions,
8588
the following are required:
8689

@@ -93,7 +96,7 @@ the following are required:
9396
* ``ecs:ListTaskDefinitions``
9497
* ``ecs:DescribeTaskDefinition``
9598
* ``ecs:DeregisterTaskDefinition``
96-
99+
97100
If using custom IAM permissions, you will also need to set the ``iam:PassRole`` policy for each IAM role. See here https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html for more information.
98101

99102
Note that not every permission is required for every action you can take in **ecs-deploy**. You may be able to adjust permissions based on your specific needs.
@@ -310,7 +313,7 @@ To change the command of a specific container, run the following command::
310313

311314
$ ecs deploy my-cluster my-service --command webserver "nginx"
312315

313-
This will modify the **webserver** container and change its command to "nginx". If you have
316+
This will modify the **webserver** container and change its command to "nginx". If you have
314317
a command that requires arguments as well, then you can simply specify it like this as you would normally do:
315318

316319
$ ecs deploy my-cluster my-service --command webserver "ngnix -c /etc/ngnix/ngnix.conf"

0 commit comments

Comments
 (0)