AWS CodeDeploy - User Guide

1 AWS CodeDeployUser GuideAPI Version 2014-10-06 AWS CodeDeploy user GuideAWS CodeDeploy : user GuideCopyright 2018 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored CodeDeploy user GuideTable of ixWhat Is AWS CodeDeploy ? .. 1 Video Introduction to AWS CodeDeploy .. 1 Benefits of AWS CodeDeploy .. 1 Overview of AWS CodeDeploy Compute Platforms .. 2 Overview of AWS CodeDeploy Deployment Types .. 6 Overview of an In-Place Deployment .. 7 Overview of a Blue/Green Deployment .. 8We Want to Hear from You .. 10 Primary Components .. 10 Deployments.

2 13 Deployments on an AWS Lambda Compute 13 Deployments on an Amazon ECS Compute 16 Deployments on an EC2/On-Premises Compute 20 Application Specification 25 AppSpec Files on an Amazon ECS Compute 25 AppSpec Files on an AWS Lambda Compute 25 AppSpec Files on an EC2/On-Premises Compute 25 How the AWS CodeDeploy Agent Uses the AppSpec File .. 26 Getting Started .. 27 Step 1: Provision an IAM user .. 27 Step 2: Install or Upgrade and Then Configure the AWS CLI .. 28 Step 3: Create a Service Role .. 29 Create a Service Role (Console) .. 29 Create a Service Role (CLI) .. 31 Get the Service Role ARN (Console) .. 32 Get the Service Role ARN (CLI) .. 33 Step 4: Create an IAM Instance Profile .. 33 Create an IAM Instance Profile for Your Amazon EC2 Instances (CLI) .. 33 Create an IAM Instance Profile for Your Amazon EC2 Instances (Console) .. 35 Product and Service Integrations .. 38 Integration with Other AWS Services.

3 38 Amazon EC2 Auto Scaling .. 42 Elastic Load 45 Integration with Partner Products and Services .. 51 Integration Examples from the Community .. 54 Blog 54 Tutorials .. 55 Tutorial: Deploy WordPress to a Non-Windows Instance .. 55 Step 1: Launch an Amazon EC2 Instance .. 56 Step 2: Configure Your Source Content .. 58 Step 3: Upload Your Application to Amazon S3 .. 61 Step 4: Deploy Your Application .. 64 Step 5: Update and Redeploy Your Application .. 68 Step 6: Clean 71 Tutorial: Deploy a Hello World Application to a Windows Server Instance .. 73 Step 1: Launch an Amazon EC2 Instance .. 74 Step 2: Configure Your Source Content .. 74 Step 3: Upload Your Application to Amazon S3 .. 77 Step 4: Deploy Your Application .. 80 Step 5: Update and Redeploy Your Application .. 83 Step 6: Clean 85 API Version 2014-10-06iiiAWS CodeDeploy user GuideTutorial: Deploy an Application to an On-Premises Instance.

4 87 Prerequisites .. 88 Step 1: Configure the On-Premises Instance .. 88 Step 2: Create a Sample Application Revision .. 88 Step 3: Bundle and Upload Your Application Revision to Amazon S3 .. 91 Step 4: Deploy Your Application Revision .. 92 Step 5: Verify Your Deployment .. 92 Step 6: Clean Up Resources .. 92 Tutorial: Deploy to an Amazon EC2 Auto Scaling Group .. 93 Prerequisites .. 94 Step 1: Create and Configure the Amazon EC2 Auto Scaling Group .. 94 Step 2: Deploy the Application to the Amazon EC2 Auto Scaling Group .. 99 Step 3: Check Your Results .. 105 Step 4: Increase the Number of Amazon EC2 Instances in the Amazon EC2 Auto Scaling Group .. 106 Step 5: Check Your Results Again .. 107 Step 6: Clean 108 Tutorial: Deploy an Application from GitHub .. 110 Prerequisites .. 110 Step 1: Set Up a GitHub Account .. 110 Step 2: Create a GitHub Repository .. 110 Step 3: Upload a Sample Application to Your GitHub Repository.

5 112 Step 4: Provision an Instance .. 115 Step 5: Create an Application and Deployment Group .. 115 Step 6: Deploy the Application to the Instance .. 117 Step 7: Monitor and Verify the Deployment .. 119 Step 8: Clean 120 Working with the AWS CodeDeploy Agent .. 122 Operating Systems Supported by the AWS CodeDeploy Agent .. 122 Supported Amazon EC2 AMI Operating Systems .. 122 Supported On-Premises Operating Systems .. 122 Communication Protocol and Port for the AWS CodeDeploy Agent .. 123 AWS SDK for Ruby (aws-sdk-core) Support for the AWS CodeDeploy Agent .. 123 Version History of the AWS CodeDeploy Agent .. 123 Application Revision and Log File Cleanup .. 126 Files Installed by the AWS CodeDeploy Agent .. 127 Managing AWS CodeDeploy Agent Operations .. 129 Verify the AWS CodeDeploy Agent Is Running .. 129 Determine the Version of the AWS CodeDeploy Agent .. 131 Install or Reinstall the AWS CodeDeploy Agent .. 131 Update the AWS CodeDeploy Agent.

6 138 Uninstall the AWS CodeDeploy Agent .. 142 Working with Instances .. 144 Comparing Amazon EC2 Instances to On-Premises Instances .. 144 Instance Tasks for AWS CodeDeploy .. 145 Tagging Instances for AWS CodeDeploy Deployments .. 146 Example 1: Single Tag Group, Single Tag .. 147 Example 2: Single Tag Group, Multiple Tags .. 147 Example 3: Multiple Tag Groups, Single Tags .. 148 Example 4: Multiple Tag Groups, Multiple Tags .. 150 Working with Amazon EC2 Instances .. 152 Create an Amazon EC2 Instance (AWS CLI or Amazon EC2 Console) .. 153 Create an Amazon EC2 Instance (AWS CloudFormation Template) .. 158 Configure an Amazon EC2 Instance .. 165 Working with On-Premises Instances .. 168 Prerequisites for Configuring an On-Premises Instance .. 168 Register an On-Premises Instance .. 169 Managing On-Premises Instances Operations .. 189 API Version 2014-10-06ivAWS CodeDeploy user GuideView Instance Details.

7 194 View Instance Details (Console) .. 194 View Instance Details (CLI) .. 194 Instance Health .. 195 Health 196 Minimum Healthy Instances and Deployments .. 197 Working with Deployment Configurations .. 199 Deployment Configurations on an EC2/On-Premises Compute 199 Predefined Deployment Configurations .. 199 Deployment Configurations on an Amazon ECS Compute 201 Deployment Configurations on an AWS Lambda Compute 202 Predefined Deployment Configurations .. 203 Create a Deployment Configuration .. 203 View Deployment Configuration Details .. 204 View Deployment Configuration Details (Console) .. 204 View Deployment Configuration (CLI) .. 204 Delete a Deployment Configuration .. 204 Working with Applications .. 206 Create an Application .. 206 Create an Application for an In-Place Deployment (Console) .. 208 Create an Application for a Blue/Green Deployment (Console) .. 210 Create an Application for an Amazon ECS Service Deployment (Console).

8 212 Create an Application for an AWS Lambda Function Deployment (Console) .. 214 Create an Application (CLI) .. 215 View Application 215 View Application Details (Console) .. 215 View Application Details (CLI) .. 215 Rename an Application .. 216 Delete an 216 Delete an Application (Console) .. 216 Delete an Application (AWS CLI) .. 217 Working with Deployment Groups .. 218 Deployment Groups in Amazon ECS Compute Platform Deployments .. 218 Deployment Groups in AWS Lambda Compute Platform Deployments .. 218 Deployment Groups in EC2/On-Premises Compute Platform Deployments .. 219 Create a Deployment Group .. 219 Create a Deployment Group for an In-Place Deployment (Console) .. 219 Create a Deployment Group for an EC2/On-Premises Blue/Green Deployment (Console) .. 221 Create a Deployment Group for an Amazon ECS Deployment (Console) .. 224 Set Up a Load Balancer in Elastic Load Balancing for AWS CodeDeploy Deployments.

9 225 Create a Deployment Group (CLI) .. 225 View Deployment Group Details .. 226 View Deployment Group Details (Console) .. 226 View Deployment Group Details (CLI) .. 227 Change Deployment Group Settings .. 227 Change Deployment Group Settings (Console) .. 228 Change Deployment Group Settings (CLI) .. 228 Configure Advanced Options for a Deployment Group .. 229 Delete a Deployment Group .. 230 Delete a Deployment Group (Console) .. 231 Delete a Deployment Group (CLI) .. 231 Working with Application Revisions .. 232 Plan a Revision .. 232 Add an AppSpec File .. 233 Add an AppSpec File for an Amazon ECS Deployment .. 233 API Version 2014-10-06vAWS CodeDeploy user GuideAdd an AppSpec File for an AWS Lambda Deployment .. 235 Add an AppSpec File for an EC2/On-Premises Deployment .. 236 Choose a Repository Type .. 239 Push a Revision .. 241 Push a Revision Using the AWS CLI .. 242 View Application Revision Details.

10 244 View Application Revision Details (Console) .. 244 View Application Revision Details (CLI) .. 244 Register an Application Revision .. 245 Register a revision in Amazon S3 with AWS CodeDeploy (CLI) .. 245 Register a revision in GitHub with AWS CodeDeploy (CLI) .. 246 Working with Deployments .. 247 Create a Deployment .. 248 Deployment Prerequisites .. 248 Create an Amazon ECS Compute Platform Deployment (Console) .. 250 Create an AWS Lambda Compute Platform Deployment (Console) .. 252 Create an EC2/On-Premises Compute Platform Deployment (Console) .. 253 Create an Amazon ECS Compute Platform Deployment (CLI) .. 256 Create an AWS Lambda Compute Platform Deployment (CLI) .. 257 Create an EC2/On-Premises Compute Platform Deployment (CLI) .. 258 View Deployment Details .. 260 View Deployment Details (Console) .. 260 View Deployment Details (CLI) .. 260 View Deployment Log Data .. 261 View Log File Data in the Amazon CloudWatch Console.