Skip to content

Commit b952733

Browse files
author
Nicolas Huray
committed
Add an indication regarding pip dependency
1 parent 9f53d4e commit b952733

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,28 @@ This wercker step allows to deploy applications with [AWS Code Deploy](http://do
77

88
Please read the [AWS Code Deploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html) documentation and [API](http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html) before using this step.
99

10+
11+
The step install the [AWS Cli](http://docs.aws.amazon.com/cli/latest/userguide/installing.html) through pip, if the CLI is not already installed.
12+
13+
1014
## AWS Code Deploy workflow
1115

12-
To deploy an application with AWS Code Deploy, the Wercker step follow this steps :
16+
To deploy an application with AWS Code Deploy, the Wercker step follow this steps :
1317

1418
#### Step 1 : [Configuring AWS](http://docs.aws.amazon.com/cli/latest/reference/configure/index.html)
1519

16-
This initial step consists on configuring AWS.
17-
20+
This initial step consists on configuring AWS.
21+
1822
The following configuration allows to setup this step :
1923

2024
* `key` (required): AWS Access Key ID
2125
* `secret` (required): AWS Secret Access Key
2226
* `region` (optional): Default region name
2327

24-
#### Step 2 : [Defining Application](http://docs.aws.amazon.com/cli/latest/reference/deploy/create-application.html)
28+
#### Step 2 : [Defining Application](http://docs.aws.amazon.com/cli/latest/reference/deploy/create-application.html)
2529

2630
This second step consists on defining the application. If the application does not exists this step create the application in Code Deploy.
27-
31+
2832
The following configuration allows to setup this step :
2933

3034
* `application-name` (required): Name of the application to deploy
@@ -48,7 +52,7 @@ The following configuration allows to setup this step :
4852
* `deployment-group-name` (required): Deployment group name
4953
* `service-role-arn` (optional): Service role arn giving permissions to use Code Deploy when creating a deployment group
5054
* `ec2-tag-filters` (optional): EC2 tags to filter on when creating a deployment group
51-
* `auto-scaling-groups` (optional): Auto Scaling groups when creating a deployment group
55+
* `auto-scaling-groups` (optional): Auto Scaling groups when creating a deployment group
5256

5357
#### Step 5 : [Pushing to S3](http://docs.aws.amazon.com/cli/latest/reference/deploy/push.html)
5458

@@ -60,7 +64,7 @@ The following configuration allows to setup this step :
6064
* `s3-source` (optional): S3 Source. By default : _._
6165
* `s3-key` (optional): S3 Key. By default: _{application-name}_
6266

63-
#### Step 6 : [Registering Revision](http://docs.aws.amazon.com/cli/latest/reference/deploy/register-application-revision.html)
67+
#### Step 6 : [Registering Revision](http://docs.aws.amazon.com/cli/latest/reference/deploy/register-application-revision.html)
6468

6569
This step consists to register the revision in Code Deploy.
6670

@@ -69,7 +73,7 @@ The following configuration allows to setup this step :
6973
* `revision` (optional): Revision of the application to deploy. By default: _{application-name}-{application-version}.zip_
7074
* `revision-description` (optional): Description of the revision of the application to deploy
7175

72-
#### Step 7 : [Creating Deployment](http://docs.aws.amazon.com/cli/latest/reference/deploy/create-deployment.html)
76+
#### Step 7 : [Creating Deployment](http://docs.aws.amazon.com/cli/latest/reference/deploy/create-deployment.html)
7377

7478
This final step consists to create the deployment in Code Deploy.
7579

0 commit comments

Comments
 (0)