AWS CodeDeploy User Guide Code Deploy
User Manual:
Open the PDF directly: View PDF
Page Count: 305 [warning: Documents this large are best viewed by clicking the View PDF Link!]
- AWS CodeDeploy
- Table of Contents
- What Is AWS CodeDeploy?
- Getting Started with AWS CodeDeploy
- Step 1: Provision an IAM User
- Step 2: Install or Upgrade and Then Configure the AWS CLI
- Step 3: Create a Service Role for AWS CodeDeploy
- Step 4: Create an IAM Instance Profile for Your Amazon EC2 Instances
- Step 5: Try the AWS CodeDeploy Create Deployment Walkthrough
- Video Walkthrough of a Sample AWS CodeDeploy Deployment
- Prerequisites
- Start the Walkthrough
- Step 1: Welcome
- Step 2: Instance Settings
- Step 3: Application Name
- Step 4: Revision
- Step 5: Deployment Group
- Step 6: Service Role
- Step 7: Deployment Configuration
- Step 8: Review
- Clean Up Deployment Walkthrough Resources
- Product and Service Integrations with AWS CodeDeploy
- Integration with Other AWS Services
- Integration with Partner Products and Services
- Integration Examples from the Community
- AWS CodeDeploy Tutorials
- Tutorial: Deploy WordPress to an Amazon EC2 Instance (Amazon Linux or Red Hat Enterprise Linux and Linux, OS X, or Unix)
- Step 1: Launch an Amazon Linux or Red Hat Enterprise Linux Amazon EC2 Instance
- Step 2: Configure Your Source Content to Deploy to the Amazon Linux or Red Hat Enterprise Linux Amazon EC2 Instance
- Step 3: Upload Your WordPress Application to Amazon S3
- Step 4: Deploy Your WordPress Application
- Step 5: Update and Redeploy Your WordPress Application
- Step 6: Clean Up Your WordPress Application and Related Resources
- Tutorial: Deploy a "Hello, World!" Application with AWS CodeDeploy (Windows Server)
- Step 1: Launch a Windows Server Amazon EC2 Instance
- Step 2: Configure Your Source Content to Deploy to the Windows Server Amazon EC2 Instance
- Step 3: Upload Your "Hello, World!" Application to Amazon S3
- Step 4: Deploy Your "Hello, World!" Application
- Step 5: Update and Redeploy Your "Hello, World!" Application
- Step 6: Clean Up Your "Hello, World!" Application and Related Resources
- Tutorial: Deploy an Application to an On-Premises Instance with AWS CodeDeploy (Windows Server, Ubuntu Server, or Red Hat Enterprise Linux)
- Tutorial: Deploy an Application to an Auto Scaling Group Using AWS CodeDeploy
- Tutorial: Deploy an Application from GitHub Using AWS CodeDeploy
- Prerequisites
- Step 1: Set Up a GitHub Account
- Step 2: Create a GitHub Repository
- Step 3: Upload a Sample Application to Your GitHub Repository
- Step 4: Provision an Instance
- Step 5: Deploy the Application to the Instance
- Step 6: Monitor and Verify the Deployment
- Step 7: Clean Up
- To delete a AWS CloudFormation stack (if you used the AWS CloudFormation template to create an Amazon EC2 instance)
- To manually deregister and clean up an on-premises instance (if you provisioned an on-premises instance)
- To manually terminate an Amazon EC2 instance (if you manually launched an Amazon EC2 instance)
- To delete the AWS CodeDeploy deployment component records
- To delete your GitHub repository
- Tutorial: Deploy WordPress to an Amazon EC2 Instance (Amazon Linux or Red Hat Enterprise Linux and Linux, OS X, or Unix)
- Working with the AWS CodeDeploy Agent
- Operating Systems Supported by the AWS CodeDeploy Agent
- Communication Protocol and Port for the AWS CodeDeploy Agent
- AWS SDK for Ruby (aws-sdk-core) Support for the AWS CodeDeploy Agent
- Supported Versions of the AWS CodeDeploy Agent
- Application Revision and Log File Cleanup
- Managing AWS CodeDeploy Agent Operations
- Working with Instances for AWS CodeDeploy
- Creating an Instance for AWS CodeDeploy (AWS CLI or Amazon EC2 Console)
- Creating an Amazon EC2 Instance for AWS CodeDeploy (AWS CloudFormation Template)
- Configuring an Amazon EC2 Instance to Work with AWS CodeDeploy
- View Instance Details with AWS CodeDeploy
- On-Premises Instances with AWS CodeDeploy
- Configuring an On-Premises Instance to Work with AWS CodeDeploy
- Prerequisites for Configuring an On-Premises Instance
- Configure and Register an On-Premises Instance (CLI)
- Manually Configure and Register an On-Premises Instance
- Step 1: Create an IAM User on Behalf of the On-Premises Instance
- Step 2: Assign Permissions to the IAM User
- Step 3: Get the IAM User Credentials
- Step 4: Add a Configuration File to the On-Premises Instance
- Step 5: Install and Configure the AWS CLI
- Step 6: Set the AWS_REGION Environment Variable (Ubuntu Server and RHEL Only)
- Step 7: Install the AWS CodeDeploy Agent
- Step 8: Register the On-Premises Instance with AWS CodeDeploy
- Step 9: Tag the On-Premises Instance
- Step 10: Deploy Application Revisions to the On-Premises Instance
- Step 11: Track Deployments to the On-Premises Instance
- Next Steps
- Get Information About a Single On-Premises Instance
- Get Information About Multiple On-Premises Instances
- Deregister an On-Premises Instance
- Automatically Uninstall the AWS CodeDeploy Agent and Remove the Configuration File from an On-Premises Instance
- Manually Remove On-Premises Instance Tags from an On-Premises Instance
- Manually Deregister an On-Premises Instance
- AWS CodeDeploy Instance Health
- Working with Deployment Groups in AWS CodeDeploy
- Working with Applications in AWS CodeDeploy
- Working with Deployment Groups in AWS CodeDeploy
- Working with Application Revisions for AWS CodeDeploy
- Plan a Revision for AWS CodeDeploy
- Add an Application Specification File to a Revision for AWS CodeDeploy
- Choose an AWS CodeDeploy Repository Type
- Push a Revision for AWS CodeDeploy to Amazon S3
- View Application Revision Details with AWS CodeDeploy
- Register an Application Revision in Amazon S3 with AWS CodeDeploy
- Working with Deployments in AWS CodeDeploy
- Create a Deployment with AWS CodeDeploy
- View Deployment Details with AWS CodeDeploy
- Deploy a Revision with AWS CodeDeploy
- Stop a Deployment with AWS CodeDeploy
- Redeploy and Roll Back a Deployment with AWS CodeDeploy
- Deploy an Application in a Different AWS Account
- Step 1: Create an S3 Bucket in Either Account
- Step 2: Grant Amazon S3 Bucket Permissions to the Production Account's IAM Instance Profile
- Step 3: Create Resources and a Cross-Account Role in the Production Account
- Step 4: Upload the Application Revision to Amazon S3 Bucket
- Step 5: Assume the Cross-Account Role and Deploy Applications
- Monitoring Deployments in AWS CodeDeploy
- Automated Monitoring Tools
- Manual Monitoring Tools
- Monitoring Deployments with Amazon CloudWatch Tools
- Monitoring Deployments with AWS CloudTrail
- Monitoring Deployments with Amazon SNS Event Notifications
- AWS CodeDeploy AppSpec File Reference
- AWS CodeDeploy User Access Permissions Reference
- AWS CodeDeploy Agent Configuration Reference
- AWS CloudFormation Templates for AWS CodeDeploy Reference
- AWS CodeDeploy Resource Kit Reference
- AWS CodeDeploy Limits
- Troubleshooting AWS CodeDeploy
- General Troubleshooting Issues
- General Troubleshooting Checklist
- AWS CodeDeploy deployment resources are supported in certain regions only
- Required IAM roles are not available
- Avoid concurrent deployments to the same Amazon EC2 instance
- Using some text editors to create AppSpec files and shell scripts can cause deployments to fail
- Using Finder in Mac OS to bundle an application revision can cause deployments to fail
- Troubleshoot Deployment Issues
- Troubleshooting a failed ApplicationStop deployment lifecycle event
- Troubleshooting a failed DownloadBundle deployment lifecycle event with "UnknownError: not opened for reading"
- Windows PowerShell scripts fail to use the 64-bit version of Windows PowerShell by default
- Long-running processes can cause deployments to fail
- Troubleshoot Deployment Group Issues
- Troubleshoot Instance Issues
- Tags must be set correctly
- AWS CodeDeploy agent must be installed and running on instances
- Deployments do not fail for up to an hour when an instance is terminated during a deployment
- Analyzing log files to investigate deployment failures on instances
- Create a new AWS CodeDeploy log file if it was accidentally deleted
- Deployment or redeployment of the same files to the same instance locations fail with the error "File already exists at location"
- Troubleshooting “InvalidSignatureException – Signature expired: [time] is now earlier than [time]” deployment errors
- Troubleshoot Auto Scaling Issues
- General Auto Scaling troubleshooting
- Terminating or rebooting an Auto Scaling instance may cause deployments to fail
- Avoid associating multiple deployment groups with a single Auto Scaling group
- Amazon EC2 instances in an Auto Scaling group fail to launch and receive the error "Heartbeat Timeout"
- Mismatched Auto Scaling lifecycle hooks might cause automatic deployments to Auto Scaling groups to stop or fail
- Error Codes for AWS CodeDeploy
- General Troubleshooting Issues
- AWS CodeDeploy Resources
- Document History
- AWS Glossary