Spec-Zone.ru › Ansible 2.8

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
строка / обязательно
    Варианты:
  • application
  • machineaccount
  • serviceaccount
Тип используемых учетных данных.
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
строка
Строка, представляющая содержимое файла JSON учетной записи службы.
Это не должно передаваться как словарь, а как строка, содержащая точное содержимое файла JSON учетной записи службы (валидный JSON).
service_account_email
строка
Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file
путь
Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state
-
    Варианты:
  • present ←
  • absent
Существует ли данный объект в GCP

Примечания

Примечание

  • Для аутентификации можно установить service_account_file с помощью переменной окружения GCP_SERVICE_ACCOUNT_FILE.
  • Для аутентификации можно установить service_account_email с помощью переменной окружения GCP_SERVICE_ACCOUNT_EMAIL.
  • Для аутентификации можно установить service_account_contents с помощью переменной окружения GCP_SERVICE_ACCOUNT_CONTENTS.
  • Для аутентификации можно установить 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
строка
успешно
Время создания.

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, которое не зависит от запрещённых символов.

lifecycleState
строка
успешно
Состояние жизненного цикла проекта.

name
строка
успешно
Присвоенное пользователем отображаемое имя проекта. Оно должно иметь длину от 4 до 30 символов. Допустимые символы: строчные и прописные буквы, цифры, дефис, одинарная и двойная кавычки, пробел и знак восклицания.

number
целое число
успешно
Число, уникально идентифицирующее проект.

parent
сложный
успешно
Родительская организация.

id
строка
успешно
Идентификатор организации.

type
строка
успешно
Должно быть organization.



Статус

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

Авторы

  • 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.8/modules/gcp_resourcemanager_project_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API