Conversation
…o ecs-atmos-deployment * 'ecs-atmos-deployment' of github.com:cloudposse/docs: Fix release versioning by storing library docs in draft releases (#854) docs: Add RunsOn regional availability guidance to primary region decision (#851) Add redirects for all Spacelift tutorials (#853) Add redirect for Spacelift tutorial (#850)
milldr
left a comment
milldr
left a comment
There was a problem hiding this comment.
please fix build (broken links)
docs/jumpstart/action-items.mdx
Outdated
There was a problem hiding this comment.
Let's just remove this whole section from this page and move all requirements for ecspresso to that ecspresso page, docs/layers/software-delivery/ecs-ecspresso/ecs-ecspresso.mdx
There was a problem hiding this comment.
Instead of asking the user to redeploy these specific three components, we should have a task list that lists what is required for the ECS app. (see the "TaskList" component).
Phrasing like we have in now implies that the user has to redeploy a VPC, EKS cluster, and GitHub OIDC, but in reality, those are already all deployed by this point.
There was a problem hiding this comment.
Fix formatting. Use one of the existing components. For example, TaskList, or Steps.
There was a problem hiding this comment.
| ### ECS with Atmos (Recommended) | ||
|
|
||
| The [app-on-ecs-v2](https://github.com/cloudposse-examples/app-on-ecs-v2) example demonstrates a self-contained approach where workflows are defined directly in the application repository. This approach uses Atmos for configuration orchestration and OpenTofu for infrastructure management. | ||
|
|
||
| With this approach, you need only a few workflows in your application repository: | ||
|
|
||
| 1. `feature-branch.yml` - Build and deploy to preview environments | ||
| 2. `preview-cleanup.yml` - Clean up preview environments when PRs close | ||
| 3. `main-branch.yaml` - Build, deploy to dev, and create draft release | ||
| 4. `release.yaml` - Promote and deploy to staging/production | ||
| 5. (optional) `validate.yml` - Run validation checks | ||
| 6. (optional) `labeler.yaml` - Auto-label PRs | ||
|
|
||
| ```console | ||
| app-on-ecs-v2/ | ||
| ├── .github/ | ||
| │ └── workflows/ | ||
| │ ├── feature-branch.yml | ||
| │ ├── preview-cleanup.yml | ||
| │ ├── main-branch.yaml | ||
| │ ├── release.yaml | ||
| │ ├── validate.yml | ||
| │ └── labeler.yaml | ||
| ├── app/ | ||
| │ ├── main.go | ||
| │ └── Dockerfile | ||
| ├── terraform/ | ||
| │ ├── components/ | ||
| │ │ └── ecs-task/ | ||
| │ └── stacks/ | ||
| │ ├── dev.yaml | ||
| │ ├── staging.yaml | ||
| │ ├── prod.yaml | ||
| │ └── preview.yaml | ||
| └── .opentofu-version | ||
| ``` | ||
|
|
||
| ### ECS with Ecspresso (Deprecated) | ||
|
|
||
| :::warning | ||
| The ecspresso-based approach is deprecated. For new projects, use [ECS with Atmos](/layers/software-delivery/ecs-atmos/) instead. | ||
| ::: | ||
|
|
||
| <details> | ||
| <summary>View deprecated ecspresso workflow structure</summary> |
There was a problem hiding this comment.
these should be on the given page for the implementation. For instance move ECS with Atmos (Recommended) to the ecs-atmos.mdx and ECS with Ecspresso to ecs-ecspresso.mdx
Or if it's a high-level description, it should be included in the tab content.
There was a problem hiding this comment.
did you add this to refarch-scaffold?
| ```yaml title="terraform/stacks/deps/vpc.yaml" | ||
| components: | ||
| terraform: | ||
| vpc: | ||
| metadata: | ||
| component: vpc | ||
| type: abstract | ||
| terraform_workspace: "{{ .vars.tenant }}-{{ .vars.environment }}-{{ .vars.deps_stage }}" | ||
| backend_type: s3 | ||
| backend: | ||
| s3: | ||
| bucket: "acme-core-gbl-root-tfstate" | ||
| region: "us-east-1" | ||
| encrypt: true | ||
| key: terraform.tfstate | ||
| acl: bucket-owner-full-control | ||
| assume_role: | ||
| role_arn: "arn:aws:iam::111111111111:role/acme-core-gbl-root-tfstate-ro" | ||
| ``` | ||
|
|
||
| ```yaml title="terraform/stacks/deps/ecs-cluster.yaml" | ||
| components: | ||
| terraform: | ||
| vpc: | ||
| metadata: | ||
| component: vpc | ||
| type: abstract | ||
| terraform_workspace: "{{ .vars.tenant }}-{{ .vars.environment }}-{{ .vars.deps_stage }}" | ||
| backend_type: s3 | ||
| backend: | ||
| s3: | ||
| bucket: "acme-core-gbl-root-tfstate" | ||
| region: "us-east-1" | ||
| encrypt: true |
There was a problem hiding this comment.
The second YAML example appears to have a copy-paste error—it defines vpc: instead of ecs-cluster::
components:
terraform:
ecs-cluster: # <-- Should be ecs-cluster, not vpc
metadata:
component: ecs-cluster # <-- And here
...
| - [ ] Container definitions configured in `terraform/stacks/default/app.yaml` | ||
| - [ ] `atmos terraform plan app -s preview` runs successfully | ||
| </TaskList> | ||
|
|
There was a problem hiding this comment.
Add call to action for trigger workflows. See the CTA component
There was a problem hiding this comment.
- Where can the user see this preview environment? (github ui has deployment link)
- What are the different CI or CD steps that are being run for a preview environment? (add simple explanation)
- What cluster is this deployed to by default? (dev)
|
|
||
| Then add the `deploy` label to the PR in GitHub. | ||
| </Step> | ||
|
|
There was a problem hiding this comment.
- What CI or CD steps are being run now?
- Where can the engineer see the deployment?
- What ECS cluster is this deployed to? How is that determined?
| <Step> | ||
| ### <StepNumber/> Publish a Release | ||
|
|
||
| Edit the draft release created by the main branch workflow and click "Publish release". This will: | ||
| - Promote the Docker image tag | ||
| - Deploy to `staging` | ||
| - Wait for approval (if configured) | ||
| - Deploy to `prod` | ||
| </Step> | ||
| </Steps> |
There was a problem hiding this comment.
- Again, now what CI / CD steps are being run?
- Where can the engineer see the deployment?
- How do we configure approval?
Co-authored-by: Dan Miller <miller0daniel@gmail.com>
Co-authored-by: Igor Rodionov <goruha@users.noreply.github.com>
2 participants
what
why