Skip to content

Document how to prevent ECS deploy jobs from waiting for rollout

Alishan Ladhani requested to merge ali/docs-ecs-disable-wait-for-rollout into master

What does this MR do and why?

In cloud-deploy!49 (merged), we changed the behavior of the ECS deploy command to wait for the rollout to complete before returning. This change may not work for some custom configurations, so we also added a way to keep the old behaviour using the CI_AWS_ECS_WAIT_FOR_ROLLOUT_COMPLETE_DISABLED variable. This MR updates the documentation to reflect the change.

Related to #228908 (closed)

Screenshots or screen recordings

Payloads have been abbreviated to highlight the relevant fields.

Default

$ ecs update-task-definition
{
  "service": {
    "deployments": [
      {
        "status": "PRIMARY",
        "rolloutState": "IN_PROGRESS",
      },
      {
        "status": "ACTIVE",
        "rolloutState": "COMPLETED",
      }
    ]
  }
}
Waiting for rollout...
Waiting for rollout...
Waiting for rollout...
Rollout COMPLETED!

With CI_AWS_ECS_WAIT_FOR_ROLLOUT_COMPLETE_DISABLED set

$ ecs update-task-definition
{
  "service": {
    "deployments": [
      {
        "status": "PRIMARY",
        "rolloutState": "IN_PROGRESS",
      },
      {
        "status": "ACTIVE",
        "rolloutState": "COMPLETED",
      }
    ]
  }
}

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Alishan Ladhani

Merge request reports