gcp_resourcemanager_project – Создаёт проект GCP
Новый в версии 2.8.
Описание
- Представляет проект GCP. Проект — это контейнер для ACL, API, приложений App Engine, виртуальных машин и других ресурсов Google Cloud Platform.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| env_type строка | Указывает, в какой среде Ansible выполняется данный модуль. Необходимо устанавливать только в случае необходимости. Изменяет только строку User Agent для запросов к API. | ||
| id строка / обязательно | Уникальный, присвоенный пользователем ID проекта. Он должен состоять из 6 до 30 строчных букв, цифр или тире. Он должен начинаться с буквы. Запрещены завершающие тире. | ||
| labels словарь | Метки, связанные с данным проектом. Ключи меток должны иметь длину от 1 до 63 символов и соответствовать следующему регулярному выражению: `[a-z]([-a-z0-9]*[a-z0-9])?`. Значения меток должны иметь длину от 0 до 63 символов и соответствовать регулярному выражению `([a-z]([-a-z0-9]*[a-z0-9])?)?`. Для данного ресурса не может быть более 256 меток. Клиенты должны хранить метки в представлении, таком как JSON, которое не зависит от запрещённых символов. | ||
| name строка | Присвоенное пользователем отображаемое имя проекта. Оно должно содержать от 4 до 30 символов. Разрешены строчные и прописные буквы, цифры, дефис, одинарная и двойная кавычки, пробел и восклицательный знак. | ||
| parent словарь | Родительская организация. | ||
| id строка | Идентификатор организации. | ||
| type строка | Должно быть organization. | ||
| project строка | Проект Google Cloud Platform, который следует использовать. | ||
| scopes список | Массив используемых областей видимости. | ||
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, его представляющей. | ||
| service_account_email строка | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. | ||
| state строка |
| Требуется ли существование данного объекта в GCP | |
Примечания
Примечание
- для аутентификации можно установить service_account_file с помощью переменной среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents с помощью переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a project
gcp_resourcemanager_project:
name: My Sample Project
id: alextest-{{ 10000000000 | random }}
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
parent:
type: organization
id: 636173955921
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращённое значение | Описание | |
|---|---|---|---|
| createTime строка | success | Время создания. | |
| id строка | success | Уникальный, присвоенный пользователем ID проекта. Он должен состоять из 6 до 30 строчных букв, цифр или тире. Он должен начинаться с буквы. Запрещены завершающие тире. | |
| labels словарь | success | Метки, связанные с данным проектом. Ключи меток должны иметь длину от 1 до 63 символов и соответствовать следующему регулярному выражению: `[a-z]([-a-z0-9]*[a-z0-9])?`. Значения меток должны иметь длину от 0 до 63 символов и соответствовать регулярному выражению `([a-z]([-a-z0-9]*[a-z0-9])?)?`. Для данного ресурса не может быть более 256 меток. Клиенты должны хранить метки в представлении, таком как JSON, которое не зависит от запрещённых символов. | |
| lifecycleState строка | success | Состояние жизненного цикла проекта. | |
| name строка | success | Присвоенное пользователем отображаемое имя проекта. Оно должно содержать от 4 до 30 символов. Разрешены строчные и прописные буквы, цифры, дефис, одинарная и двойная кавычки, пробел и восклицательный знак. | |
| number целое число | success | Уникальный номер, идентифицирующий проект. | |
| parent сложная структура | success | Родительская организация. | |
| id строка | success | Идентификатор организации. | |
| type строка | success | Должно быть organization. | |
Статус
- Интерфейс данного модуля не гарантирует обратную совместимость. [превью]
- Данный модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/gcp_resourcemanager_project_module.html