Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Current »

You can use the Amazon ECS Service task to create, update or delete an Amazon Elastic Container Service (ECS) service (see Deploying to Amazon ECS for an overview of the ECS component lifecycle and deployment workflow).


Configuration

To configure an Amazon ECS Service task:

Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).

Click the name of an existing Amazon ECS Service task, or click Add Task and then Amazon ECS Service to create a new task.

Complete the following settings:

Common to all tasks

 Click here to expand...

Common (Bamboo)


Task Description (Optional) Identify the purpose of the task.
Disable this task

Check, or clear, to selectively run this task.

...Configure task/action specific parameters, see below ...
Bamboo Variables
NamespaceProvide the namespace for generated variables – defaults to custom.aws for backward compatibility.
Scope

Select the scope for generated variables – can be either Local (Variables will only be available in this job), or Result (Variables will be available in subsequent plan stages and deployment releases).

Common (AWS)


Action

Each task supports one or more actions depending on the target AWS resource. Select the desired action and configure the action specific parameters below.

RegionSelect the desired AWS Region. Alternatively, select [Use region variable ...] to supply the region dynamically via Bamboo variables (needs to be a region code such as ap-southeast-2) - refer to How to parametrize the AWS region via a Bamboo variable for details.
...Configure task/action specific parameters, see below ...
AWS Security Credentials
SourceSelect the source for the required AWS Security Credentials – can be either Inline, an IAM Role for EC2 or a shared Identity Federation for AWS Connector.
Connector(Conditional) Select the shared Identity Federation for AWS Connector. Alternatively, select [Use connector variable ...] to supply the connector dynamically via Bamboo variables (needs to be a connector id such as f24e81bc-7aff-42db-86a2-7cf82e24d871) - refer to How to parametrize the AWS connector via a Bamboo variable for details.

Actions supported by this task:

Create Service


Launch TypeSelect the launch type on which to run your service.
Task DefinitionSpecify the family and revision (family:revision) or Amazon Resource Name (ARN) of the task definition to use.
Cluster Name or ARN

(Optional) Specify the cluster name or Amazon Resource Name (ARN).

  •  (warning) If you do not specify a cluster, the default cluster is assumed. 
Service NameSpecify the service name.
Desired Count(Optional) Specify the number of tasks to keep running.
Deployment Configuration(Optional) Specify the deployment configuration in JSON format – refer to Deployment Configuration for details.
Network Configuration(Optional) Specify an awsvpc network configuration (JSON – inline or via URL) – refer to Task Networking with the awsvpc Network Mode for details.
Load Balancers(Optional) Specify one or more load balancer objects (JSON – inline or via URL) – refer to Service Load Balancing for details.
Role Name or ARN

(Conditional) Specify the name or Amazon Resource Name (ARN) of the IAM role that allows the ECS container agent to make calls to the load balancer.

  •  (info) This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode.
TagsSpecify the tags to apply (JSON – inline or via URL).
EC2 Options
Placement Strategy(Optional) Specify placement strategy objects (JSON – inline or via URL– refer to Amazon ECS Task Placement Strategies for details.
Placement Constraints(Optional) Specify placement constraint objects in (JSON – inline or via URL– refer to Amazon ECS Task Placement Constraints for details.
Advanced Options
Fargate Platform Version(Optional) Specify the platform version on which to run your task. If none is specified, Fargate defaults to the latest version.
Await Steady State TimeoutSpecify how long to await the service reaching a steady state (seconds, 0 to skip).
Verify Steady State Period Specify how long to verify the service's state staying steady (seconds, 0 to skip).

Update Service


Force new deploymentCheck to enforce a new deployment of the service – refer to the UpdateService API action for details.
Task Definitionsee Create Service above
Cluster Name or ARNsee Create Service above
Service Name or ARNSpecify the service name or Amazon Resource Name (ARN).
Desired Countsee Create Service above
Deployment Configurationsee Create Service above
Network Configurationsee Create Service above
Advanced Options
Fargate Platform Versionsee Create Service above
Await Steady State Timeoutsee Create Service above
Verify Steady State Period see Create Service above

Delete Service


Cluster Name or ARNsee Create Service above
Service Name or ARN
see Update Service above

Variables

All tasks support Bamboo Variable Substitution/Definition - this task's actions generate variables as follows:

A task's generated variables might get amended with respective AWS API additions over time - a live build log will always provide the most current variable shape accordingly

Create Service

Creating common variables for 1 services:
... bamboo.custom.aws.ecs.service.resources: TAWS-IT270-ECSSE-nginx
Creating resource variables for service 'TAWS-IT270-ECSSE-nginx':
... bamboo.custom.aws.ecs.service.resources.TAWS-IT270-ECSSE-nginx.ClusterArn: arn:aws:ecs:us-east-1:309600995652:cluster/TAWS-IT270-43-ubot
... bamboo.custom.aws.ecs.service.resources.TAWS-IT270-ECSSE-nginx.RoleArn: arn:aws:iam::309600995652:role/amazon-ecs-service
... bamboo.custom.aws.ecs.service.resources.TAWS-IT270-ECSSE-nginx.ServiceArn: arn:aws:ecs:us-east-1:309600995652:service/TAWS-IT270-ECSSE-nginx
... bamboo.custom.aws.ecs.service.resources.TAWS-IT270-ECSSE-nginx.ServiceName: TAWS-IT270-ECSSE-nginx
... bamboo.custom.aws.ecs.service.resources.TAWS-IT270-ECSSE-nginx.Status: ACTIVE
... bamboo.custom.aws.ecs.service.resources.TAWS-IT270-ECSSE-nginx.TaskDefinition: arn:aws:ecs:us-east-1:309600995652:task-definition/TAWS-IT270-ECSSE-nginx:124
... bamboo.custom.aws.ecs.service.resources.TAWS-IT270-ECSSE-nginx.DesiredCount: 2
... bamboo.custom.aws.ecs.service.resources.TAWS-IT270-ECSSE-nginx.PendingCount: 0
... bamboo.custom.aws.ecs.service.resources.TAWS-IT270-ECSSE-nginx.RunningCount: 2
Creating common variables for first resource affected by task:
Creating resource variables for service 'TAWS-IT270-ECSSE-nginx':
... bamboo.custom.aws.ecs.service.first.ClusterArn: arn:aws:ecs:us-east-1:309600995652:cluster/TAWS-IT270-43-ubot
... bamboo.custom.aws.ecs.service.first.RoleArn: arn:aws:iam::309600995652:role/amazon-ecs-service
... bamboo.custom.aws.ecs.service.first.ServiceArn: arn:aws:ecs:us-east-1:309600995652:service/TAWS-IT270-ECSSE-nginx
... bamboo.custom.aws.ecs.service.first.ServiceName: TAWS-IT270-ECSSE-nginx
... bamboo.custom.aws.ecs.service.first.Status: ACTIVE
... bamboo.custom.aws.ecs.service.first.TaskDefinition: arn:aws:ecs:us-east-1:309600995652:task-definition/TAWS-IT270-ECSSE-nginx:124
... bamboo.custom.aws.ecs.service.first.DesiredCount: 2
... bamboo.custom.aws.ecs.service.first.PendingCount: 0
... bamboo.custom.aws.ecs.service.first.RunningCount: 2

Update Service

See Create above.

Delete Service

See Create above.

How-to Articles

Frequently Asked Questions (FAQ)

Atlassian account required

Due to a regression within Questions for Confluence Cloud, you need to log in with your Atlassian ID (or sign up for a new account) to access these automatically curated FAQs (refer to UAA-312 for the background).

  • No labels