Amazon Elastic Container Service (ECS) Anywhere enables customers to easily run and manage container workloads on customer-managed infrastructure like Physical or Virtual Machines (VM). It provides a consistent tooling and API experience across your container-based applications. ECS Anywhere helps customer to reduce infrastructure and operational cost, also mitigate the complex local container orchestration. It ensures compliance requirements and provide scalability using your existing on-premise investments.
This sample code demonstrates the step by step approach to provision ECS Anywhere cluster by using AWS Cloud Development Kit v2 (AWS CDK) stacks. Then it setup a CI/CD Pipeline using AWS CodePipeline service. Additionally, it shows how you can replicate GitLab code repository to AWS CodeCommit and deploy your containerised application on ECS Anywhere cluster.
This sample code can be beneficial to the customers who are already running their container applications using on-premise infrastructure and controlling codebase using GitLab repositories, but now want to manage their workload using AWS Cloud services without disturbing and sacrificing existing on-premise infrastructure.
-
An active AWS account
-
AWS Command Line Interface (AWS CLI), installed and configured. For more information about this, see Installing, updating, and uninstalling the AWS CLI in the AWS CLI documentation.
-
AWS Cloud Development Kit (AWS CDK) Toolkit, installed and configured. For more information about this, see AWS CDK Toolkit (cdk command) in the AWS CDK documentation.
-
Node package manager (npm), installed and configured for CDK Typescript. For more information about this, see Downloading and installing Node.js and npm in the npm documentation.
Check out this APG Pattern for detailed deployment instructions: Set up a CI/CD pipeline for hybrid workloads on Amazon ECS Anywhere by using AWS CDK and GitLab
1.1. Install the package dependencies and compile the TypeScript files by running the following commands:
$cd EcsAnywhereCdk
$npm install
$npm fund
1.2. To build the project code, run the command:
npm run build
For more information about building and deploying the project, see Your first AWS CDK app in the AWS CDK documentation.
1.3. To list the stacks, run the command:
$cdk list
To deploy the project code, run the command:
$cdk deploy EcsAnywhereInfraStack
1.4. Open the AWS CloudFormation console at https://console.aws.amazon.com/cloudformation, and choose the EcsAnywhereInfraStack stack.
Please note : It would take sometime to setup ECS cluster meanwhile follow next steps.
2.1. For demonstration purposes, you can use Vagrant to create a VM. Vagrant is an open-source utility for building and maintaining portable virtual software development environments. Create a Vagrant VM by running the vagrant up command from the root directory where Vagrantfile is placed. For more information, see the Vagrant documentation.
2.2. Install AWS CLI by following AWS CLI installation instructions and run following commands on VM.
2.3. Create an activation code and ID that you can use to register your VM with AWS Systems Manager and to activate your external instance. The output from this command includes ActivationId and ActivationCode values:
aws ssm create-activation --iam-role EcsAnywhereInstanceRole | tee ssm-activation.json
2.4. Export the activation ID and code values
export ACTIVATION_ID=<activation-ID>
export ACTIVATION_CODE=<activation-code>
2.5. Download the installation script to your on-premises server or VM
curl --proto "https" -o "ecs-anywhere-install.sh" "https://amazon-ecs-agent.s3.amazonaws.com/ecs-anywhere-install-latest.sh"
2.6. Run the installation script on your on-premises server or VM
sudo bash ecs-anywhere-install.sh \
--cluster EcsAnywhereCluster \
--activation-id $ACTIVATION_ID \
--activation-code $ACTIVATION_CODE \
--region <region-name>`
For more information about setting up and registering your VM, see Registering an external instance to a cluster in the Amazon ECS documentation. If you face any issue, please see Troubleshooting section as below.
3.1. Create 'main' branch on AWS CodeCommit repo by creating the first commit for a repository. You can follow AWS documentation to Create a commit in AWS CodeCommit. Below command given for reference:
aws codecommit put-file \
--repository-name EcsAnywhereRepo \
--branch-name main \
--file-path README.md \
--file-content "Test" \
--name "Dev Ops" \
--email "devops@example.com" \
--commit-message "Adding README."
3.2. You can mirror a GitLab repository to and from external sources. You can select which repository serves as the source. Branches, tags, and commits are synced automatically. Setup GitLab mirroring using GitLab repository mirroring documentation. Once setup, you can update a mirror manually so it would replicate code from GitLab repo to AWS CodeCommit.
3.3. To deploy the CICD project code, run the command:
$cdk deploy EcsAnywherePipelineStack
3.4. To test the CICD Pipeline, you can make application code changes and push it to source on-prem GitLab repo. For more information, refer GitLab push documentation. For instance, edit ../application/index.html file to update value of "App Version"
3.5. A repository mirror at GitLab updates automatically or can also manually trigger. For more details, refer update a GitLab mirror.
3.6. After replication the code, it would merge to AWS CodeCommit repo which triggers CICD Pipeline result.
4.1. After you walk through this sample code, you should remove the resources you created to avoid incurring any further charges. To clean up, run the command:
$cdk destroy EcsAnywherePipelineStack
$cdk destroy EcsAnywhereInfraStack
See CONTRIBUTING for more information.
This library is licensed under the MIT-0 License. See the LICENSE file.