### Problem to solve <!-- What problem do we solve? --> Users want to deploy to AWS ECS: the way you achieve this is the same amongst different companies and could easily be templatized. Users could then customize the template if they have specific needs/use cases. Additional context in product scaling agenda at https://docs.google.com/document/d/1nMJzrDfG7C14WP5v7P226oPFuXkwqIk7bdIT8ai0DNU/edit?ts=5d84fb07&skip_itp2_check=true&pli=1#bookmark=id.46hyirfrtqak ### Intended users <!-- Who will use this feature? If known, include any of the following: types of users (e.g. Developer), personas, or specific company roles (e.g. Release Manager). It's okay to write "Unknown" and fill this field in later. * [Rachel (Release Manager)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#rachel-release-manager) * [Parker (Product Manager)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#parker-product-manager) * [Delaney (Development Team Lead)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#delaney-development-team-lead) * [Sasha (Software Developer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sasha-software-developer) * [Presley (Product Designer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#presley-product-designer) * [Devon (DevOps Engineer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#devon-devops-engineer) * [Sidney (Systems Administrator)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sidney-systems-administrator) * [Sam (Security Analyst)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sam-security-analyst) * [Dana (Data Analyst)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#dana-data-analyst) Personas are described at https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/ --> Users deploying to AWS ECS ### Why build a .gitlab-ci.yml template before an Auto DevOps template Following the [iteration](https://about.gitlab.com/company/culture/all-remote/values/#iteration) value: * Having a gitlab-ci.yml template that users can use and customize is valuable on it's own, even if they never use Auto DevOps. * It will allow us to receive feedback before offering it as part of Auto DevOps. * In addition, there is a risk that connecting it to Auto DevOps might break the Kubernetes flow which needs coordination and careful consideration which may span over a single milestone This is the issue to add this as an Auto DevOps composable template https://gitlab.com/gitlab-org/gitlab/issues/208132 ### Proposal <!-- How are we going to solve the problem? Try to include the user journey! https://about.gitlab.com/handbook/journeys/#user-journey --> Create a new template (https://gitlab.com/gitlab-org/gitlab/-/tree/master/lib/gitlab/ci/templates) named `deploy to ECS`. All of the process described below uses our pre-built image (https://gitlab.com/gitlab-org/gitlab/issues/31167) as the `image:` in order to login to AWS (using the AWS typed environment variables). Any container that is created in order to deploy to ECS will be stored in the `cloud-deploy` project and published for any other use. TODO - we need to ask the Configure team how they manage these kinds of container dependencies between containers and templates within Auto DevOps and do it the same way. This iteration assumes a pre-existing cluster, we don't create one on the fly for them. The customer provides us this info via variables. Iteration: * [ ] Create a stand-alone gitlab-ci.yml template that deploys to ECS * Build the customer's Docker image * Tag and push the built (customer) docker image to Gitlab's package registry (we will add documentation to add support to ECR, but ECR configuration will not be done automatically by our template). TODO - add what we with digest here. * Create AWS Task to be used for the Docker deploy * Register AWS Task definition with the ECS cluster * Grab revision # of the Task definition using regular bash and grep * Deploy revision using the Docker deploy * [ ] Documentation *Main variables to modify for your account* (for reference see [here](https://github.com/ricktbaker/docker-circleci-ecr-ecs/blob/master/deploy.sh)) * `AWS_ACCOUNT_ID`=XXXXXXXXXXXXXXX * `REGION`='us-east-1' * `CLUSTER`='test-app' * `FAMILY`='test-app' * `DOCKER_IMAGE`='test-app' * `TASK`='test-app' * `SERVICE`='app-service *Secrets needed: * * AWS_ACCESS_KEY_ID * AWS_ACCOUNT_ID * AWS_REGION #### Reference <!-- Include use cases, benefits, and/or goals (contributes to our vision?) --> We will use Gitlab's container registry and not Amazon ECR. You'll then need to setup ECS. An ECS cluster A Task Definition - variable in the yml [here](https://github.com/ricktbaker/docker-circleci-ecr-ecs/blob/master/.circleci/config.yml) A Service within the cluster - variable in the yml [here](https://github.com/ricktbaker/docker-circleci-ecr-ecs/blob/master/.circleci/config.yml) See the [EC2 Container Service Resources Page](https://aws.amazon.com/ecs/) if you need more help on the above. You'll need AWS credentials for the step below that have access to ECS.     ### Permissions and Security <!-- What permissions are required to perform the described actions? Are they consistent with the existing permissions as documented for users, groups, and projects as appropriate? Is the proposed behavior consistent between the UI, API, and other access methods (e.g. email replies)?--> ### Documentation <!-- See the Feature Change Documentation Workflow https://docs.gitlab.com/ee/development/documentation/feature-change-workflow.html Add all known Documentation Requirements here, per https://docs.gitlab.com/ee/development/documentation/feature-change-workflow.html#documentation-requirements If this feature requires changing permissions, this document https://docs.gitlab.com/ee/user/permissions.html must be updated accordingly. --> ### Availability & Testing <!-- This section needs to be retained and filled in during the workflow planning breakdown phase of this feature proposal, if not earlier. What risks does this change pose to our availability? How might it affect the quality of the product? What additional test coverage or changes to tests will be needed? Will it require cross-browser testing? Please list the test areas (unit, integration and end-to-end) that needs to be added or updated to ensure that this feature will work as intended. Please use the list below as guidance. * Unit test changes * Integration test changes * End-to-end test change See the test engineering planning process and reach out to your counterpart Software Engineer in Test for assistance: https://about.gitlab.com/handbook/engineering/quality/test-engineering/#test-planning --> (for testing we will use: auto build, auto test and add to that auto deploy to ECS) ### What does success look like, and how can we measure that? <!-- Define both the success metrics and acceptance criteria. Note that success metrics indicate the desired business outcomes, while acceptance criteria indicate when the solution is working correctly. If there is no way to measure success, link to an issue that will implement a way to measure this. --> We need to measure the amount of times that this template is used ### What is the type of buyer? <!-- Which leads to: in which enterprise tier should this feature go? See https://about.gitlab.com/handbook/product/pricing/#four-tiers --> ### Links / references * https://github.com/ricktbaker/docker-circleci-ecr-ecs/blob/master/.circleci/config.yml * https://gitlab.com/gitlab-org/gitlab/tree/master/lib/gitlab/ci/templates * https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html