Skip to content

[ECS-Plugin] Document for user#6712

Open
armistcxy wants to merge 10 commits intopipe-cd:masterfrom
armistcxy:ecs-plugin/user-docs
Open

[ECS-Plugin] Document for user#6712
armistcxy wants to merge 10 commits intopipe-cd:masterfrom
armistcxy:ecs-plugin/user-docs

Conversation

@armistcxy
Copy link
Copy Markdown
Contributor

What this PR does: Adds user documentation for the ECS plugin (docs-v1.0.x) covering:

  • Prerequisites: piped configuration and IAM permissions (deployment role, task execution role, task role)
  • Definition files: task definition file and service definition file format, supported fields, and known limitations
  • Deployment modes: service (with ELB, service discovery) and standalone task
  • Deployment strategy selection: how the plugin automatically chooses between quick sync and pipeline sync based on container image changes
  • Pipeline sync stages: ECS_PRIMARY_ROLLOUT, ECS_CANARY_ROLLOUT, ECS_TRAFFIC_ROUTING, ECS_CANARY_CLEAN, ECS_ROLLBACK
  • Application live state: sync status, resource tree, resource metadata, and health status
  • Plan preview: how diff is computed for ECS applications
  • Migration guide from v0: key behavioral changes including the shift to EXTERNAL deployment controller, drift detection via commit hash tag, and rollback behavior changes

Why we need it:

Which issue(s) this PR fixes:

Fixes #6443

Does this PR introduce a user-facing change?:

  • How are users affected by this change:
  • Is this breaking change:
  • How to migrate (if breaking change):

Signed-off-by: Hoang Ngo <adlehoang118@gmail.com>
Signed-off-by: Hoang Ngo <adlehoang118@gmail.com>
Signed-off-by: Hoang Ngo <adlehoang118@gmail.com>
Signed-off-by: Hoang Ngo <adlehoang118@gmail.com>
Signed-off-by: Hoang Ngo <adlehoang118@gmail.com>
Signed-off-by: Hoang Ngo <adlehoang118@gmail.com>
Signed-off-by: Hoang Ngo <adlehoang118@gmail.com>
…on file"

Signed-off-by: Hoang Ngo <adlehoang118@gmail.com>
Signed-off-by: Hoang Ngo <adlehoang118@gmail.com>
Signed-off-by: Hoang Ngo <adlehoang118@gmail.com>
@armistcxy armistcxy force-pushed the ecs-plugin/user-docs branch from 7ca28b5 to c93da0a Compare April 24, 2026 03:40
@armistcxy armistcxy marked this pull request as ready for review April 24, 2026 03:42
@armistcxy armistcxy requested review from a team as code owners April 24, 2026 03:42
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 37.92%. Comparing base (fdec720) to head (c93da0a).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6712      +/-   ##
==========================================
+ Coverage   29.48%   37.92%   +8.44%     
==========================================
  Files         593       61     -532     
  Lines       63440     5331   -58109     
==========================================
- Hits        18706     2022   -16684     
+ Misses      43289     3193   -40096     
+ Partials     1445      116    -1329     
Flag Coverage Δ
. ?
.-pkg-app-pipedv1-plugin-analysis 32.43% <ø> (ø)
.-pkg-app-pipedv1-plugin-ecs ?
.-pkg-app-pipedv1-plugin-kubernetes ?
.-pkg-app-pipedv1-plugin-kubernetes_multicluster ?
.-pkg-app-pipedv1-plugin-scriptrun 54.83% <ø> (ø)
.-pkg-app-pipedv1-plugin-terraform ?
.-pkg-app-pipedv1-plugin-wait 33.04% <ø> (ø)
.-pkg-app-pipedv1-plugin-waitapproval 52.71% <ø> (ø)
.-pkg-plugin-sdk 50.34% <ø> (ø)
.-tool-actions-gh-release 19.23% <ø> (ø)
.-tool-actions-plan-preview ?
.-tool-codegen-protoc-gen-auth 0.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[LFX Mentorship T-1 2026] Implement Amazon ECS Plugin for pipedv1

1 participant