community.aws.ecs_service 模块 – 在 ECS 中创建、终止、启动或停止服务
注意
此模块是 community.aws 集合 (版本 9.0.0) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：community.aws.ecs_service。
community.aws 1.0.0 中的新增功能
概要
创建或终止 ECS 服务。
要求
执行此模块的主机需要以下要求。
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
参数
参数 |
注释 |
|---|---|
AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 还可以按优先级递减的顺序使用 aws_access_key 和 profile 选项是互斥的。 aws_access_key_id 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 ec2_access_key 别名已被弃用，并将在 2024-12-01 后的某个版本中删除。
|
|
验证 SSL 证书时使用的 CA 捆绑包的位置。 还可以使用 |
|
用于修改 botocore 配置的字典。 参数可在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
要与您的服务一起使用的容量提供程序策略。每个策略最多可以指定 6 个提供程序。 默认值： |
|
至少有多少个任务应该使用指定的提供程序。 |
|
容量提供程序的名称。 |
|
应该使用指定提供程序的已启动任务总数的相对百分比。 |
|
您提供的唯一区分大小写的标识符，用于确保请求的幂等性。最多允许 32 个 ASCII 字符。 默认值： |
|
服务所在的集群的名称。 如果未指定，集群名称将为 默认值： |
|
使用 还可以使用 选项
|
|
在检查服务可用之前要等待的时间。 默认值： |
|
控制 deployment_configuration 的可选参数。 格式为“{“maximum_percent”:<integer>，“minimum_healthy_percent”:<integer>}” 默认值： |
|
部署断路器确定如果服务无法达到稳定状态，服务部署是否会失败。 |
|
如果启用，服务部署将过渡到失败状态并停止启动新任务。 选项
|
|
如果启用，在发生故障后，ECS 将会将您的服务回滚到上次完成的部署。 选项
|
|
在部署期间，服务中允许处于 RUNNING 或 PENDING 状态的任务数量的上限。 |
|
部署期间必须保持在 RUNNING 状态的服务任务数量的下限。 |
|
要用于服务的部署控制器。如果未指定部署控制器，则使用 ECS 控制器。 默认值： |
|
要使用的部署控制器类型。 选项
|
|
服务的实例数量。 当state=present时，此参数是必需的。 |
|
是否为 ECS 任务中的容器启用 execute command 功能。 如果enable_execute_command=true，则在 ECS 任务中的所有容器上启用 execute command 功能。 选项
|
|
用于连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他兼容 AWS 的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的发行版中移除。 对 |
|
强制删除服务。当删除规模 >0 或没有目标组的服务时，需要此参数。 选项
|
|
即使没有更改，也强制部署服务。 选项
|
|
等待新添加/更新的服务进行健康检查的秒数。 |
|
运行服务的启动类型。 选项
|
|
为此服务定义的 ELB 列表。 现有服务的负载均衡器无法更新，这样做会报错。 当部署控制器为 CODE_DEPLOY 时，对此值的更改将被忽略，不会导致错误。 默认值： |
|
服务的名称。 |
|
服务的网络配置。仅适用于使用network_mode=awsvpc创建的任务定义。 |
|
任务的弹性网络接口是否接收公共 IP 地址。 选项
|
|
要与任务关联的安全组名称或组 ID 列表。 |
|
要与任务关联的子网 ID 列表。 |
|
服务中任务的放置约束。 更多详情请参见https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PlacementConstraint.html。 默认值： |
|
应用于约束的集群查询语言表达式。 |
|
约束的类型。 |
|
要用于服务中任务的放置策略对象。每个服务最多可以指定 5 个策略规则。 默认值： |
|
应用放置策略的字段。 |
|
放置策略的类型。 |
|
平台版本的数字部分或 LATEST 更多详情请参见https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html。 |
|
要用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息，请参见 AWS 文档https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile选项与aws_access_key、aws_secret_key和security_token选项互斥。 |
|
将标签从 ECS 任务定义或 ECS 服务传播到 ECS 任务。 选项
|
|
切换覆盖现有放置约束。这对于向后兼容性是必要的。 默认情况下，purge_placement_constraints=false。在 9.0.0 版本中，这将更改为purge_placement_constraints=true。 选项
|
|
切换覆盖现有放置策略。这对于向后兼容性是必要的。 默认情况下，purge_placement_strategy=false。在 9.0.0 版本中，这将更改为purge_placement_strategy=true。 选项
|
|
要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，将忽略region。 也可以使用 更多信息请参见 Amazon AWS 文档http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。
对 |
|
检查服务是否可用的次数。 默认值： |
|
允许您的 Amazon ECS 容器代理代表您调用负载均衡器的 IAM 角色的名称或完整的 Amazon 资源名称 (ARN)。 仅当您在非 默认值： |
|
调度策略。 如果未给出，则默认为 选项
|
|
AWS 密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 secret_key和profile选项互斥。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了aws_secret_access_key别名。 ec2_secret_key别名已弃用，将在 2024-12-01 之后的发行版中移除。 对 |
|
描述此服务将向其注册的服务发现注册表。 默认值： |
|
服务发现注册表 ARN。 |
|
服务发现注册的容器名称。 |
|
服务发现注册的容器端口。 |
|
与临时凭证一起使用的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 security_token和profile选项互斥。 在 3.2.0 版本中添加了aws_session_token和session_token别名，在 6.0.0 版本中将参数名称从security_token重命名为session_token。 security_token、aws_security_token和access_token别名已弃用，将在 2024-12-01 之后的发行版中移除。 对 |
|
服务的所需状态。 选项
|
|
要向资源添加或从中删除的标签字典。 |
|
服务将运行的任务定义。 当state=present时，此参数是必需的，除非force_new_deployment=True。 当使用 |
|
设置为 强烈建议不要设置validate_certs=false，作为替代方案，请考虑设置aws_ca_bundle。 选项
|
|
是否等待服务变为非活动状态。 仅当state为 选项
|
注释
注意
指定的 service role 必须是可以假定的。（即，对 ecs 服务 ecs.amazonaws.com 有信任关系）
有关参数和返回值的详细信息，请参见https://boto3.readthedocs.io/en/latest/reference/services/ecs.html。
必须事先创建 IAM 角色。
警告：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文而不是“控制器”上下文读取的。因此，可能需要显式地将文件复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文而不是“主机”上下文读取的。
Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible 的“主机”上下文中的配置文件（通常为
~/.aws/credentials）读取凭据和其他设置的默认值，例如区域。更多信息请参见https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。
示例
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Basic provisioning example
- community.aws.ecs_service:
state: present
name: console-test-service
cluster: new_cluster
task_definition: 'new_cluster-task:1'
desired_count: 0
- name: create ECS service on VPC network
community.aws.ecs_service:
state: present
name: console-test-service
cluster: new_cluster
task_definition: 'new_cluster-task:1'
desired_count: 0
network_configuration:
subnets:
- subnet-abcd1234
security_groups:
- sg-aaaa1111
- my_security_group
# Simple example to delete
- community.aws.ecs_service:
name: default
state: absent
cluster: new_cluster
# With custom deployment configuration (added in version 2.3), placement constraints and strategy (added in version 2.4)
- community.aws.ecs_service:
state: present
name: test-service
cluster: test-cluster
task_definition: test-task-definition
desired_count: 3
deployment_configuration:
minimum_healthy_percent: 75
maximum_percent: 150
placement_constraints:
- type: memberOf
expression: 'attribute:flavor==test'
placement_strategy:
- type: binpack
field: memory
# With deployment circuit breaker (added in version 4.0)
- community.aws.ecs_service:
state: present
name: test-service
cluster: test-cluster
task_definition: test-task-definition
desired_count: 3
deployment_configuration:
deployment_circuit_breaker:
enable: true
rollback: true
# With capacity_provider_strategy (added in version 4.0)
- community.aws.ecs_service:
state: present
name: test-service
cluster: test-cluster
task_definition: test-task-definition
desired_count: 1
capacity_provider_strategy:
- capacity_provider: test-capacity-provider-1
weight: 1
base: 0
# With tags and tag propagation
- community.aws.ecs_service:
state: present
name: tags-test-service
cluster: new_cluster
task_definition: 'new_cluster-task:1'
desired_count: 1
tags:
Firstname: jane
lastName: doe
propagate_tags: SERVICE
返回的事实
此模块返回的事实将添加到hostvars主机事实中/在其中更新，并且可以像任何其他主机事实一样按名称引用。它们无需注册即可使用。
键 |
描述 |
|---|---|
已删除服务的详细信息。 返回：当服务存在并被删除时 |
|
托管服务的集群的 Amazon 资源名称 (ARN)。 返回：始终 |
|
部署配置字典 返回：始终 |
|
部署断路器字典 返回：始终 |
|
断路器功能的状态。 返回：始终 |
|
断路器的回滚功能的状态。 返回：始终 |
|
maximumPercent 参数 返回：始终 |
|
minimumHealthyPercent 参数 返回：始终 |
|
服务部署列表 返回：始终 |
|
希望在服务上保持运行的任务定义实例数量。 返回：始终 |
|
服务事件列表 返回：始终 |
|
负载均衡器对象列表 返回：始终 |
|
与负载均衡器关联的容器名称。 返回：始终 |
|
与负载均衡器关联的容器端口。 返回：始终 |
|
名称 返回：始终 |
|
集群中处于 PENDING 状态的任务数量。 返回：始终 |
|
放置约束对象列表 返回：始终 |
|
应用于约束的集群查询语言表达式。请注意，如果约束类型为 distinctInstance，则不能指定表达式。 返回：始终 |
|
约束类型。有效值为 distinctInstance 和 memberOf。 返回：始终 |
|
放置策略对象列表 返回：始终 |
|
应用放置策略的字段。对于 spread 放置策略，有效值为 instanceId（或 host，效果相同），或应用于容器实例的任何平台或自定义属性，例如 attribute:ecs.availability-zone。对于 binpack 放置策略，有效值为 CPU 和 MEMORY。 返回：始终 |
|
放置策略类型。有效值为 random、spread 和 binpack。 返回：始终 |
|
应用于资源的标签传播类型 返回：始终 |
|
集群中处于 RUNNING 状态的任务数量。 返回：始终 |
|
标识服务的 Amazon 资源名称 (ARN)。ARN 包含 arn:aws:ecs 命名空间，后跟服务的区域、服务所有者的 AWS 账户 ID、服务命名空间，然后是服务名称。 返回：始终 示例： |
|
用于标识服务的用户生成的字符串 返回：始终 |
|
有效值为 ACTIVE、DRAINING 或 INACTIVE。 返回：始终 |
|
应用于此资源的标签。 返回： 当找到标签时 |
|
服务中任务要使用的任务定义的 ARN。 返回：始终 |
返回值
常见的返回值已在 此处 记录，以下是此模块独有的字段
键 |
描述 |
|---|---|
已创建服务的详细信息。 返回： 创建服务时 |
|
与您的服务一起使用的容量提供程序策略。 返回：始终 |
|
至少有多少个任务应该使用指定的提供程序。 返回：始终 |
|
容量提供程序的名称。 返回：始终 |
|
应该使用指定提供程序的已启动任务总数的相对百分比。 返回：始终 |
|
托管服务的集群的 Amazon 资源名称 (ARN)。 返回：始终 |
|
部署配置字典 返回：始终 |
|
部署断路器字典 返回：始终 |
|
断路器功能的状态。 返回：始终 |
|
断路器的回滚功能的状态。 返回：始终 |
|
maximumPercent 参数 返回：始终 |
|
minimumHealthyPercent 参数 返回：始终 |
|
服务部署列表 返回：始终 |
|
希望在服务上保持运行的任务定义实例数量。 返回：始终 |
|
服务事件列表 返回：始终 |
|
负载均衡器对象列表 返回：始终 |
|
与负载均衡器关联的容器名称。 返回：始终 |
|
与负载均衡器关联的容器端口。 返回：始终 |
|
名称 返回：始终 |
|
集群中处于 PENDING 状态的任务数量。 返回：始终 |
|
放置约束对象列表 返回：始终 |
|
应用于约束的集群查询语言表达式。请注意，如果约束类型为 distinctInstance，则不能指定表达式。 返回：始终 |
|
约束类型。有效值为 distinctInstance 和 memberOf。 返回：始终 |
|
放置策略对象列表 返回：始终 |
|
应用放置策略的字段。对于 spread 放置策略，有效值为 instanceId（或 host，效果相同），或应用于容器实例的任何平台或自定义属性，例如 attribute:ecs.availability-zone。对于 binpack 放置策略，有效值为 CPU 和 MEMORY。 返回：始终 |
|
放置策略类型。有效值为 random、spread 和 binpack。 返回：始终 |
|
应用于资源的标签传播类型。 返回：始终 |
|
集群中处于 RUNNING 状态的任务数量。 返回：始终 |
|
标识服务的 Amazon 资源名称 (ARN)。ARN 包含 返回：始终 示例： |
|
用于标识服务的用户生成的字符串 返回：始终 |
|
有效值为 ACTIVE、DRAINING 或 INACTIVE。 返回：始终 |
|
应用于此资源的标签。 返回： 成功 |
|
服务中任务要使用的任务定义的 ARN。 返回：始终 |