aws_codebuild – Создание или удаление проекта AWS CodeBuild

Новая версия с 2.9.

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

Описание

Создаёт или удаляет проекты CodeBuild в AWS, используемые для сборки артефактов кода из исходного кода.

Требования

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

boto
boto3
botocore
python >= 2.6

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
artifacts - / обязательно			Информация о результатах сборки для проекта сборки.
	location -		Информация о расположении результатов сборки. При выборе типа S3, укажите здесь имя ведра.
	name -		Вместе с путем и namespace_type, шаблон, который AWS CodeBuild будет использовать для именования и хранения выходного артефакта.
	namespace_type -		Вместе с путем и именем, шаблон, который 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 и именем, шаблон, который AWS CodeBuild будет использовать для именования и хранения выходных артефактов. Используется для пути в ведре S3, когда тип является S3
	type - / обязательно		Тип выходных данных сборки для артефактов. Может быть одним из следующих: CODEPIPELINE, NO_ARTIFACTS, S3
aws_access_key строка			AWS ключ доступа. Если не задано, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key
aws_secret_key строка			AWS секретный ключ. Если не задано, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key
cache -			Параметры кэширования для ускорения последующих сборок.
	location - / обязательно		Расположение кэша в S3.
	type - / обязательно		Тип кэша. Может быть NO_CACHE или S3.
debug_botocore_endpoint_logs логический тип добавлено в 2.8		Варианты: нет ← да	Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», сделанных во время задачи, выводимых в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения книги сценариев. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
description -			Описание проекта CodeBuild
ec2_url строка			URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где регион является обязательным. Должен быть указан для всех остальных модулей, если регион не используется. Если не указано, используется значение переменной среды EC2_URL, если таковое имеется.
encryption_key -			AWS ключ управления ключами (AWS KMS) для шифрования выходных артефактов сборки.
environment - / обязательно			Информация об среде сборки для проекта сборки.
	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 строка			Использует профиль boto. Работает только с boto >= 2.24.0.
region строка			AWS регион для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
security_token строка			AWS STS токен безопасности. Если не задано, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
service_role -			ARN AWS IAM роли, которая позволяет AWS CodeBuild взаимодействовать с зависимыми AWS сервисами от имени AWS учетной записи.
source - / обязательно			Настройка сервиса и расположения для входного источника сборки.
	buildspec -		Объявление спецификации сборки для использования для сборок в этом проекте сборки. Оставьте пустым, если это часть проекта кода.
	git_clone_depth -		При использовании git вы можете указать здесь глубину клонирования как целое число.
	insecure_ssl -		Включите этот флаг, чтобы проигнорировать предупреждения SSL при подключении к исходному коду проекта.
	location -		Информация о местоположении исходного кода, который необходимо собрать. Для типа CODEPIPELINE местоположение не должно быть указано.
	type - / обязательно		Тип источника. Разрешает одно из следующих: CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE
state -		Варианты: present ← absent	Создать или удалить проект сборки.
tags -			Набор тегов для проекта сборки.
timeout_in_minutes -		По умолчанию: 60	Сколько времени CodeBuild должен ждать, прежде чем приостановить любую сборку, которая не была отмечена как завершенная.

validate_certs boolean		Выбираемые значения: no да ←	При значении "no", сертификаты SSL для версий boto >= 2.6.0 не будут проверяться.
vpc_config -			Конфигурация VPC позволяет AWS CodeBuild получать доступ к ресурсам в Amazon VPC.

Примечания

Примечание

Подробную информацию о параметрах и возвращаемых значениях см. на странице http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html
Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION
Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- aws_codebuild:
    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 строка		всегда	Описание проекта сборки. Пример: Мой замечательный небольшой проект
	environment словарь		всегда	Настройки среды для сборки.
	name строка		всегда	Имя проекта CodeBuild. Пример: мой_проект
	service_role строка		всегда	Роль IAM, используемая во время сборки для доступа к другим службам AWS. Пример: arn:aws:iam::123123123:role/codebuild-service-role
	source сложный		всегда	Информация о входном исходном коде сборки.
		auth сложный	при конфигурировании	Информация о настройках авторизации для AWS CodeBuild для доступа к исходному коду, который будет компилироваться.
		build_spec строка	всегда	Декларация спецификации сборки, используемая для сборок в этом проекте сборки.
		git_clone_depth целое число	при конфигурировании	Глубина клонирования git.
		insecure_ssl boolean	при конфигурировании	Истина, если игнорировать предупреждения SSL.
		location строка	при конфигурировании	Идентификатор местоположения, в зависимости от типа источника.
		type строка	всегда	Тип хранилища. Пример: CODEPIPELINE
	tags список		при конфигурировании	Теги, добавленные к проекту.
	timeout_in_minutes целое число		всегда	Таймаут сборки в минутах. Пример: 60

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Stefan Horning (@stefanhorning) <horning@mediapeers.com>

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/aws_codebuild_module.html