community.aws.ecs_ecr 模块 – 管理 Elastic Container Registry 仓库

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

• 管理 Elastic Container Registry 仓库。

要求

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

• 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_access_key_id 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到剧本期间进行的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
encryption_configuration 字典 community.aws 5.2.0 中新增	仓库的加密配置。
encryption_type 字符串	要使用的加密类型。 选项 "AES256" ← (默认) "KMS"
kms_key 字符串	如果 encryption_type=KMS，请指定要用于加密的 KMS 密钥。 可以指定 KMS 密钥的别名、密钥 ID 或完整 ARN。
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月1日后的某个版本中移除。 EC2_URL环境变量的支持已被弃用，将在2024年12月1日后的某个版本中移除。
force_absent 布尔值 在community.aws 4.1.0中添加	如果force_absent=true，即使存在镜像，也会移除存储库。 选项 false ← (默认) true
force_set_policy 布尔值	如果force_set_policy=false，则会阻止设置未来可能阻止你设置其他策略的策略。 选项 false ← (默认) true
image_tag_mutability 字符串	配置存储库是否可变（即，是否可以覆盖已存在的标签）。 选项 "mutable" ← (默认) "immutable"
lifecycle_policy json	表示新的生命周期策略的JSON或字典。
name 字符串 / 必需	存储库的名称。
policy json	表示新策略的JSON或字典。
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选项互斥。
purge_lifecycle_policy 布尔值	如果true，则从存储库中移除生命周期策略。 默认为false。 选项 false true
purge_policy 布尔值	如果true，则从存储库中移除策略。 默认为false。 选项 false true
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月1日后的某个版本中移除。 EC2_REGION环境变量的支持已被弃用，将在2024年12月1日后的某个版本中移除。
registry_id 字符串	与注册表关联的AWS账户ID。 如果未指定，则假定为默认注册表。
scan_on_push 布尔值 在community.aws 1.3.0中添加	如果true，则在将镜像推送到存储库后，会扫描已知漏洞。 选项 false ← (默认) true
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月1日后的某个版本中移除。 EC2_SECRET_KEY环境变量的支持已被弃用，将在2024年12月1日后的某个版本中移除。
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月1日后的某个版本中移除。 EC2_SECRET_KEY和AWS_SECURITY_TOKEN环境变量的支持已被弃用，将在2024年12月1日后的某个版本中移除。
state 字符串	创建或销毁存储库。 选项 "present" ← (默认) "absent"
validate_certs 布尔值	设置为false时，将不会验证与AWS API通信的SSL证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑设置aws_ca_bundle。 选项 false true ← (默认)

注释

注意

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

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

示例

# If the repository does not exist, it is created. If it does exist, would not
# affect any policies already on it.
- name: ecr-repo
  community.aws.ecs_ecr:
    name: super/cool

- name: destroy-ecr-repo
  community.aws.ecs_ecr:
    name: old/busted
    state: absent

- name: Cross account ecr-repo
  community.aws.ecs_ecr:
    registry_id: 123456789012
    name: cross/account

- name: set-policy as object
  community.aws.ecs_ecr:
    name: needs-policy-object
    policy:
      Version: '2008-10-17'
      Statement:
        - Sid: read-only
          Effect: Allow
          Principal:
            AWS: '{{ read_only_arn }}'
          Action:
            - ecr:GetDownloadUrlForLayer
            - ecr:BatchGetImage
            - ecr:BatchCheckLayerAvailability

- name: set-policy as string
  community.aws.ecs_ecr:
    name: needs-policy-string
    policy: "{{ lookup('template', 'policy.json.j2') }}"

- name: delete-policy
  community.aws.ecs_ecr:
    name: needs-no-policy
    purge_policy: true

- name: create immutable ecr-repo
  community.aws.ecs_ecr:
    name: super/cool
    image_tag_mutability: immutable

- name: set-lifecycle-policy
  community.aws.ecs_ecr:
    name: needs-lifecycle-policy
    scan_on_push: true
    lifecycle_policy:
      rules:
        - rulePriority: 1
          description: new policy
          selection:
            tagStatus: untagged
            countType: sinceImagePushed
            countUnit: days
            countNumber: 365
          action:
            type: expire

- name: purge-lifecycle-policy
  community.aws.ecs_ecr:
    name: needs-no-lifecycle-policy
    purge_lifecycle_policy: true

- name: set-encryption-configuration
  community.aws.ecs_ecr:
    name: uses-custom-kms-key
    encryption_configuration:
      encryption_type: KMS
      kms_key: custom-kms-key-alias

返回值

常用的返回值已在此处记录 此处，以下是此模块特有的字段

键	描述
created 布尔值	如果为true，则已创建存储库 返回：始终
name 字符串	存储库的名称 返回：state=absent
policy 字典 在community.aws 4.0.0中添加	现有的、已创建的或已更新的存储库策略。 返回：state=present
repository 字典	已创建或已更新的存储库 返回：state=present 示例： {"createdAt": "2017-01-17T08:41:32-06:00", "registryId": "123456789012", "repositoryArn": "arn:aws:ecr:us-east-1:123456789012:repository/ecr-test-1484664090", "repositoryName": "ecr-test-1484664090", "repositoryUri": "123456789012.dkr.ecr.us-east-1.amazonaws.com/ecr-test-1484664090"}
state 字符串	存储库的断言状态（present，absent） 返回：始终

作者

• David M. Lee (@leedm777)

集合链接

• 问题追踪器
• 存储库（源代码）
• 沟通