community.aws.codepipeline 模块 – 创建或删除 AWS CodePipeline
注意
此模块是 community.aws 集合(版本 9.0.0)的一部分。
如果您正在使用 ansible
包,您可能已经安装了这个集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install community.aws
。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。
要在 playbook 中使用它,请指定:community.aws.codepipeline
。
community.aws 1.0.0 中的新增功能
概要
在 AWS 上创建或删除 CodePipeline。
在 5.0.0 版本之前,此模块名为
community.aws.aws_codepipeline
。用法没有改变。
别名:aws_codepipeline
要求
在执行此模块的主机上需要以下要求。
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 botocore SDK 保持一致,在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用,将在 2024-12-01 之后的版本中删除。 对 |
|
存储构件的位置信息(在 S3 上)。带有字段 type 和 location 的字典。 |
|
用于构件的存储桶名称。 |
|
构件存储的类型(目前仅支持“S3”)。 |
|
用于验证 SSL 证书的 CA 包的位置。 也可以使用 |
|
用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
使用 也可以使用 选项
|
|
要连接到的 URL 而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以按优先级递减顺序使用 ec2_url 和 s3_url 别名已弃用,将在 2024-12-01 之后的版本中删除。 对 |
|
CodePipeline 的名称。 |
|
用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 |
|
要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务,将忽略 region。 也可以使用 有关更多信息,请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。
已弃用对 |
|
执行 CodePipeline 时使用的 IAM 角色的 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 之后的版本中移除。 已弃用对 |
|
用于临时凭证的 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 选项是互斥的。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加,参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已被弃用,并将在 2024-12-01 之后的版本中移除。 已弃用对 |
|
要在 CodePipeline 中执行的阶段列表。包含每个阶段的名称和操作的字典列表。 |
|
该阶段的操作配置列表。 有关子选项的完整文档,请参阅 boto3 文档 |
|
CodePipeline 中阶段(步骤)的名称。 |
|
创建或删除 CodePipeline。 选项
|
|
如果设置为 强烈建议不要设置 validate_certs=false,作为替代方案,请考虑设置 aws_ca_bundle。 选项
|
|
CodePipeline 的版本号。当 CodePipeline 更新时,此数字会自动递增。 |
说明
注意
有关参数和返回值的详细信息,请参阅 http://boto3.readthedocs.io/en/latest/reference/services/codepipeline.html。
注意: 对于模块,环境变量和配置文件是从 Ansible “host” 上下文而不是 “controller” 上下文读取的。 因此,可能需要将文件显式复制到“host”。 对于查找和连接插件,环境变量和配置文件是从 Ansible “controller” 上下文而不是 “host” 上下文读取的。
Ansible 使用的 AWS SDK (boto3) 也可能会从 Ansible “host” 上下文中的配置文件(通常是
~/.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.
# Example for creating a pipeline for continuous deploy of Github code to an ECS cluster (container)
- community.aws.codepipeline:
name: my_deploy_pipeline
role_arn: arn:aws:iam::123456:role/AWS-CodePipeline-Service
artifact_store:
type: S3
location: my_s3_codepipline_bucket
stages:
- name: Get_source
actions:
-
name: Git_pull
actionTypeId:
category: Source
owner: ThirdParty
provider: GitHub
version: '1'
outputArtifacts:
- { name: my-app-source }
configuration:
Owner: mediapeers
Repo: my_gh_repo
PollForSourceChanges: 'true'
Branch: master
# Generate token like this:
# https://docs.aws.amazon.com/codepipeline/latest/userguide/GitHub-rotate-personal-token-CLI.html
# GH Link: https://github.com/settings/tokens
OAuthToken: 'abc123def456'
runOrder: 1
- name: Build
actions:
-
name: CodeBuild
actionTypeId:
category: Build
owner: AWS
provider: CodeBuild
version: '1'
inputArtifacts:
- { name: my-app-source }
outputArtifacts:
- { name: my-app-build }
configuration:
# A project with that name needs to be setup on AWS CodeBuild already (use code_build module).
ProjectName: codebuild-project-name
runOrder: 1
- name: ECS_deploy
actions:
-
name: ECS_deploy
actionTypeId:
category: Deploy
owner: AWS
provider: ECS
version: '1'
inputArtifacts:
- { name: vod-api-app-build }
configuration:
# an ECS cluster with that name needs to be setup on AWS ECS already (use ecs_cluster and ecs_service module)
ClusterName: ecs-cluster-name
ServiceName: ecs-cluster-service-name
FileName: imagedefinitions.json
region: us-east-1
state: present
返回值
常见返回值记录在 此处,以下是此模块独有的字段
键 |
描述 |
---|---|
返回描述 CodePipeline 配置的字典。 返回:成功 |
|
有关构建工件存储位置的信息 返回:总是 |
|
用于加密工件存储的加密密钥,例如 AWS KMS 密钥。 返回:配置时 |
|
工件存储的位置(s3 存储桶名称) 返回:总是 示例: |
|
工件存储的类型,例如 S3 返回:总是 示例: |
|
CodePipeline 的名称 返回:总是 示例: |
|
附加到 CodePipeline 的 IAM 角色的 ARN 返回:总是 示例: |
|
为此 CodePipeline 配置的阶段列表 返回:总是 |
|
CodePipeline 的版本号。 当 CodePipeline 参数更改时,此数字会自动递增。 返回:总是 |