google.cloud.gcp_iam_service_account – Создаёт учётную запись GCP ServiceAccount
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.1).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_iam_service_account.
Обзор
- Учётная запись сервиса в API управления идентификацией и доступом.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| display_name строка | Пользовательское описание учётной записи сервиса. | |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API. | |
| name строка | Имя учётной записи сервиса. | |
| project строка | Проект Google Cloud Platform, который необходимо использовать. | |
| scopes список / элементы=строка | Массив используемых областей. | |
| service_account_contents jsonarg | Содержимое файла JSON учётной записи сервиса, либо в виде словаря, либо как строка JSON, которая его представляет. | |
| service_account_email строка | Дополнительный адрес электронной почты учётной записи сервиса, если выбрано machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учётной записи сервиса, если тип выбран как serviceaccount. | |
| state строка |
| Указывает, должен ли данный объект существовать в GCP |
Примеры
- name: create a service account
google.cloud.gcp_iam_service_account:
name: sa-{{ resource_name.split("-")[-1] }}@graphite-playground.google.com.iam.gserviceaccount.com
display_name: My Ansible test key
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| displayName строка | успех | Пользовательское описание учётной записи сервиса. |
| email строка | успех | Адрес электронной почты учётной записи сервиса. |
| name строка | успех | Имя учётной записи сервиса. |
| oauth2ClientId строка | успех | Идентификатор клиента OAuth2 для учётной записи сервиса. |
| projectId строка | успех | Идентификатор проекта, которому принадлежит учётная запись сервиса. |
| uniqueId строка | успех | Уникальный и стабильный идентификатор учётной записи сервиса. |
Авторы
- 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.10/collections/google/cloud/gcp_iam_service_account_module.html