Модуль community.aws.codebuild_project – Создание или удаление проекта AWS CodeBuild

Примечание

Этот модуль входит в коллекцию community.aws (версия 8.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в playbook укажите: community.aws.codebuild_project.

Новое в community.aws 1.0.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Создание или удаление проектов CodeBuild в AWS, используемых для сборки артефактов кода из исходного кода.
До версии 5.0.0 этот модуль назывался community.aws.aws_codebuild. Использование не изменилось.

Псевдонимы: aws_codebuild

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации об access токенах 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.
artifacts словарь	Информация о выходных артефактах сборки для проекта сборки. artifacts требуется при создании нового проекта.
location строка	Информация о расположении выходного артефакта сборки. При выборе type `S3`, укажите имя ведра здесь.
name строка	Вместе с path и namespace_type, шаблон, который AWS CodeBuild будет использовать для именования и хранения выходного артефакта.
namespace_type строка	Вместе с path и name, шаблон, который AWS CodeBuild будет использовать для определения имени и расположения для хранения выходных артефактов. Принимает `BUILD_ID` и `NONE`. См. документацию здесь: http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html#CodeBuild.Client.create_project.
packaging строка	Тип выходного артефакта сборки для создания на S3, может быть NONE для создания папки или ZIP для ZIP-файла.
path строка	Вместе с namespace_type и name, шаблон, который AWS CodeBuild будет использовать для именования и хранения выходных артефактов. Используется для пути в ведре S3, когда тип `S3`.
type строка / обязательно	Тип выходного результата сборки для артефактов. Может быть одним из следующих: `CODEPIPELINE`, `NO_ARTIFACTS`, `S3`.
aws_ca_bundle путь	Расположение CA Bundle для использования при проверке SSL-сертификатов. Также может быть использована переменная среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
cache словарь	Параметры кэширования для ускорения последующих сборок.
location строка / обязательно	Расположение кэша на S3.
type строка / обязательно	Тип кэша. Может быть `NO_CACHE` или `S3`.
debug_botocore_endpoint_logs логический	Используйте `botocore.endpoint` логгер для анализа уникальных (а не общих) `"resource:action"` вызовов API во время задачи, выведя их в ключ resource_actions в результатах задачи. Используйте `aws_resource_action` обратный вызов для вывода общего списка, выполненного во время выполнения playbook. Также может быть использована переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
description строка	Описание проекта CodeBuild.
encryption_key строка	AWS KMS (AWS Key Management Service) мастер-ключ (CMK), который будет использоваться для шифрования выходных артефактов сборки.
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных AWS-эндпоинтов. Хотя это можно использовать для подключения к другим AWS-совместимым сервисам, коллекции amazon.aws и community.aws протестированы только для AWS. Также могут быть использованы переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
environment словарь	Информация об окружении сборки для проекта сборки.

END_OF_DOCUMENT_MARKER

compute_type строка / обязательно	Информация о вычислительных ресурсах, которые будет использовать проект сборки. Доступные значения включают: `BUILD_GENERAL1_SMALL`, `BUILD_GENERAL1_MEDIUM`, `BUILD_GENERAL1_LARGE`.
environment_variables строка	Набор переменных среды, доступных для сборок проекта сборки. Список словарей с полями name и value. Пример: { name: ‘MY_ENV_VARIABLE’, value: ‘test’ }
image строка / обязательно	Идентификатор Docker-изображения, используемого для этого проекта сборки.
privileged_mode строка	Включает запуск Docker-демонов внутри контейнера Docker. Установите в `true` только в том случае, если проект сборки используется для создания Docker-изображений.
type строка / обязательно	Тип вычислительной среды, используемой для проекта. Обычно `LINUX_CONTAINER`.
name строка / обязательно	Имя проекта CodeBuild.
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_tags булево	Если purge_tags=true и tags заданы, существующие теги будут очищены, чтобы точно соответствовать тому, что определено параметром tags. Если параметр tags не задан, теги не будут изменены, даже если purge_tags=True. Ключи тегов, начинающиеся с `aws:` зарезервированы Amazon и не могут быть изменены. Поэтому они будут проигнорированы в параметре purge_tags. Дополнительную информацию см. в документации Amazon https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `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-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_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в выпуске после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в выпуске после 2024-12-01.
service_role строка	ARN роли AWS IAM, которая позволяет AWS CodeBuild взаимодействовать с зависимыми службами AWS от имени учетной записи AWS.
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 взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, при этом параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в выпуске после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в выпуске после 2024-12-01.
source словарь	Настройка службы и расположения для исходного источника сборки. source требуется при создании нового проекта.
buildspec строка	Декларация спецификации сборки, используемой для сборок в этом проекте сборки. Оставьте пустой, если это часть проекта CodeBuild.

git_clone_depth целое число	При использовании git вы можете указать глубину клона как целое число.
insecure_ssl логическое значение	Включите этот флаг, чтобы игнорировать предупреждения SSL при подключении к исходному коду проекта. Варианты: `false` `true`
location строка	Информация о расположении исходного кода, который будет компилироваться. Для type `CODEPIPELINE` местоположение не должно быть указано.
type строка / обязательно	Тип источника. Допускается один из следующих вариантов: `CODECOMMIT`, `CODEPIPELINE`, `GITHUB`, `S3`, `BITBUCKET`, `GITHUB_ENTERPRISE`.
state строка	Создать или удалить проект CodeBuild. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags псевдонимы: resource_tags словарь	Словарь, представляющий теги, которые будут применены к ресурсу. Если параметр tags не задан, теги не будут изменены.
timeout_in_minutes целое число	Сколько времени CodeBuild должен ждать, прежде чем прервать любую сборку, которая не была помечена как завершенная. По умолчанию: `60`
validate_certs логическое значение	При установке в `false`, сертификаты SSL не будут проверены для связи с API AWS. Установку validate_certs=false следует избегать. В качестве альтернативы, установите aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
vpc_config словарь	Конфигурация VPC позволяет AWS CodeBuild получать доступ к ресурсам в Amazon VPC.

Примечания

Примечание

Подробные сведения о параметрах и возвращаемых значениях см. в http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html.
tags был изменён с формата boto3 на стандартный формат словаря в релизе 6.0.0.
Внимание: для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». В связи с этим файлы могут потребоваться скопировать явно на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
AWS SDK (boto3), который используется Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте 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.

- community.aws.codebuild_project:
    name: my_project
    description: My nice little project
    service_role: "arn:aws:iam::123123:role/service-role/code-build-service-role"
    source:
      # Possible values: BITBUCKET, CODECOMMIT, CODEPIPELINE, GITHUB, S3
      type: CODEPIPELINE
      buildspec: ''
    artifacts:
      namespaceType: NONE
      packaging: NONE
      type: CODEPIPELINE
      name: my_project
    environment:
      computeType: BUILD_GENERAL1_SMALL
      privilegedMode: "true"
      image: "aws/codebuild/docker:17.09.0"
      type: LINUX_CONTAINER
      environmentVariables:
        - name: 'PROFILE'
          value: 'staging'
    encryption_key: "arn:aws:kms:us-east-1:123123:alias/aws/s3"
    region: us-east-1
    state: present

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
project сложный	Возвращает словарь, описывающий конфигурацию проекта кода. Возвращается: успех
arn строка	ARN проекта CodeBuild. Возвращается: всегда Пример: `"arn:aws:codebuild:us-east-1:123123123:project/vod-api-app-builder"`
artifacts сложный	Информация об выходных данных сборки артефактов. Возвращается: всегда
location строка	Место расположения выходных данных сборки артефактов. Возвращается: при конфигурации
type строка	Тип артефакта сборки. Возвращается: всегда Пример: `"CODEPIPELINE"`
cache словарь	Настройки кэша для проекта сборки. Возвращается: при конфигурации
created строка	Отметка времени создания проекта. Возвращается: всегда Пример: `"2018-04-17T16:56:03.245000+02:00"`
description строка	Описание проекта CodeBuild. Возвращается: всегда Пример: `"My nice little project"`
environment словарь	Настройки среды для сборки. Возвращается: всегда
name строка	Имя проекта CodeBuild. Возвращается: всегда Пример: `"my_project"`
reource_tags словарь добавлено в community.aws 4.0.0	Простой словарь, представляющий теги, добавленные к проекту. теги и reource_tags представляют одну и ту же информацию в разных форматах. Возвращается: при конфигурации
service_role строка	Роль IAM, используемая во время сборки для доступа к другим службам AWS. Возвращается: всегда Пример: `"arn:aws:iam::123123123:role/codebuild-service-role"`
source сложный	Информация о коде исходного кода для сборки. Возвращается: всегда
auth сложный	Информация о настройках авторизации для AWS CodeBuild для доступа к исходному коду, который будет собран. Возвращается: при конфигурации
build_spec строка	Декларация спецификации сборки для использования при сборках в этом проекте сборки. Возвращается: всегда
git_clone_depth целое число	Глубина клонирования git. Возвращается: при конфигурации
insecure_ssl логическое	Истина, если установлено игнорирование предупреждений SSL. Возвращается: при конфигурации
location строка	Идентификатор расположения, в зависимости от типа источника. Возвращается: при конфигурации
type строка	Тип репозитория. Возвращается: всегда Пример: `"CODEPIPELINE"`

Теги список / элементы=строка	Теги, добавленные к проекту в формате словарей boto3. Теги и ресурсные_теги представляют одну и ту же информацию в разных форматах. Возвращается: при настройке
Время ожидания сборки (в минутах) целое число	Время ожидания сборки в минутах. Возвращается: всегда Пример: `60`

Авторы

Stefan Horning (@stefanhorning)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/codebuild_project_module.html