community.aws.ecs_task 模块 – 在 ECS 中运行、启动或停止任务

注意

此模块是 community.aws 集合 (版本 9.0.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定： community.aws.ecs_task。

community.aws 1.0.0 中的新增功能

概要

  • 创建或删除任务定义的实例。

要求

执行此模块的主机需要以下要求。

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

参数

参数

注释

access_key

别名：aws_access_key_id、aws_access_key、ec2_access_key

字符串

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_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量，优先级依次递减。

aws_access_key 和 profile 选项是互斥的。

为与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。

ec2_access_key 别名已弃用，并将在 2024-12-01 之后的发行版中移除。

EC2_ACCESS_KEY 环境变量的支持已弃用，并将在 2024-12-01 之后的发行版中移除。

aws_ca_bundle

路径

验证 SSL 证书时要使用的 CA 捆绑包的位置。

也可以使用 AWS_CA_BUNDLE 环境变量。

aws_config

字典

用于修改 botocore 配置的字典。

可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。

cluster

字符串

在其中运行任务的集群的名称。

如果未指定，集群名称将为 default。

默认值： "default"

container_instances

列表 / 元素=字符串

要在其上部署任务的容器实例列表。

count

整数

要启动的新实例数量。

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调来输出在剧本期间进行的总列表。

也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认)

  • true

endpoint_url

别名：ec2_url、aws_endpoint_url、s3_url

字符串

连接到默认 AWS 端点以外的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。

也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。

ec2_url 和 s3_url 别名已弃用，并将在 2024-12-01 之后的发行版中移除。

EC2_URL 环境变量的支持已弃用，并将在 2024-12-01 之后的发行版中移除。

launch_type

字符串

在其上运行服务的启动类型。

选项

  • "EC2"

  • "FARGATE"

network_configuration

字典

服务的网络配置。仅适用于使用 network_mode=awsvpc 创建的任务定义。

assign_public_ip

布尔值

community.aws 1.5.0 中添加

任务的弹性网络接口是否接收公共 IP 地址。

选项

  • false

  • true

security_groups

列表 / 元素=字符串

任务的组名称或组 ID 列表。

subnets

列表 / 元素=字符串

附加任务的子网 ID 列表。

operation

字符串 / 必需

要执行的任务操作。

当 operation=run 时，必须设置 task_definition。

当operation=start时，必须设置task_definition和container_instances。

当operation=stop时，必须设置task_definition和task。

选项

  • "运行"

  • "启动"

  • "停止"

覆盖

字典

传递给新实例的值的字典。

profile

别名：aws_profile

字符串

用于身份验证的命名 AWS 配置文件。

有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。

也可以使用AWS_PROFILE环境变量。

profile选项与aws_access_key、aws_secret_key和security_token选项互斥。

region

别名：aws_region, ec2_region

字符串

要使用的 AWS 区域。

对于 IAM、Route53 和 CloudFront 等全局服务，将忽略region。

也可以使用AWS_REGION或EC2_REGION环境变量。

有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。

ec2_region别名已弃用，将在 2024-12-01 之后的发行版中删除。

对EC2_REGION环境变量的支持已弃用，将在 2024-12-01 之后的发行版中删除。

secret_key

别名：aws_secret_access_key, aws_secret_key, ec2_secret_key

字符串

AWS 密钥。

有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

也可以按优先级递减的顺序使用AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY或EC2_SECRET_KEY环境变量。

secret_key和profile选项互斥。

为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了aws_secret_access_key别名。

ec2_secret_key别名已弃用，将在 2024-12-01 之后的发行版中删除。

对EC2_SECRET_KEY环境变量的支持已弃用，将在 2024-12-01 之后的发行版中删除。

session_token

别名：aws_session_token, security_token, aws_security_token, access_token

字符串

与临时凭据一起使用的 AWS STS 会话令牌。

有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

也可以按优先级递减的顺序使用AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN或EC2_SECURITY_TOKEN环境变量。

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 之后的发行版中删除。

对EC2_SECRET_KEY和AWS_SECURITY_TOKEN环境变量的支持已弃用，将在 2024-12-01 之后的发行版中删除。

启动者

字符串

显示谁或什么启动了任务的值（用于信息目的）。

tags

别名：resource_tags

字典

将在启动和运行时添加到 ecs 任务的标签。

task

字符串

要停止的任务的 ARN。

task_definition

字符串

要启动、运行或停止的任务定义。

validate_certs

布尔值

设置为false时，将不会验证与 AWS API 通信的 SSL 证书。

强烈建议不要设置validate_certs=false，作为替代方案，请考虑设置aws_ca_bundle。

选项

  • false

  • true ← (默认)

wait

布尔值

在 community.aws 4.1.0 中添加

是否等待所需状态。

选项

  • false ← (默认)

  • true

备注

注意

  • 注意：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文而不是“控制器”上下文读取的。因此，可能需要显式地将文件复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文而不是“主机”上下文读取的。

  • Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机”上下文（通常为~/.aws/credentials）中的配置文件读取凭据和其他设置的默认值，例如区域。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# Simple example of run task
- name: Run task
  community.aws.ecs_task:
    operation: run
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    count: 1
    started_by: ansible_user
  register: task_output

# Simple example of start task

- name: Start a task
  community.aws.ecs_task:
    operation: start
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
    tags:
      resourceName: a_task_for_ansible_to_run
      type: long_running_task
      network: internal
      version: 1.4
    container_instances:
      - arn:aws:ecs:us-west-2:123456789012:container-instance/79c23f22-876c-438a-bddf-55c98a3538a8
    started_by: ansible_user
    network_configuration:
      subnets:
        - subnet-abcd1234
      security_groups:
        - sg-aaaa1111
        - my_security_group
  register: task_output

- name: RUN a task on Fargate
  community.aws.ecs_task:
    operation: run
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
    started_by: ansible_user
    launch_type: FARGATE
    network_configuration:
      subnets:
        - subnet-abcd1234
      security_groups:
        - sg-aaaa1111
        - my_security_group
  register: task_output

- name: RUN a task on Fargate with public ip assigned
  community.aws.ecs_task:
    operation: run
    count: 2
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
    started_by: ansible_user
    launch_type: FARGATE
    network_configuration:
      assign_public_ip: true
      subnets:
        - subnet-abcd1234
  register: task_output

- name: Stop a task
  community.aws.ecs_task:
    operation: stop
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"

返回值

此处记录了常见的返回值 here，以下是此模块特有的字段

键

描述

task

复杂的

有关已启动任务的详细信息

返回：成功

clusterArn

字符串

托管任务的集群的 Amazon 资源名称 (ARN)。

返回：仅当 details 为 true 时

containerInstanceArn

字符串

运行任务的容器的 Amazon 资源名称 (ARN)。

返回：仅当 details 为 true 时

containers

列表 / 元素=字典

容器详细信息。

返回：仅当 details 为 true 时

createdAt

字符串

创建任务的时间戳。

返回：仅当 details 为 true 时

desiredStatus

字符串

任务的所需状态。

返回：仅当 details 为 true 时

lastStatus

字符串

任务的最后记录状态。

返回：仅当 details 为 true 时

launchType

字符串

在其上运行任务的启动类型。

返回：始终

覆盖

列表 / 元素=字典

为此任务设置的容器覆盖。

返回：仅当 details 为 true 时

startedAt

字符串

启动任务的时间戳。

返回：仅当 details 为 true 时

startedBy

字符串

启动任务的用户。

返回：仅当 details 为 true 时

stoppedAt

字符串

停止任务的时间戳。

返回：仅当 details 为 true 时

stoppedReason

字符串

停止任务的原因。

返回：仅当 details 为 true 时

taskArn

字符串

标识任务的 Amazon 资源名称 (ARN)。

返回：始终

taskDefinitionArn

字符串

任务定义的 Amazon 资源名称 (ARN)。

返回：仅当 details 为 true 时

作者

  • Mark Chance (@Java1Guy)