google.cloud.gcp_iam_service_account_key модуль – Создает GCP ServiceAccountKey

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

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

Для установки используйте: ansible-galaxy collection install google.cloud. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Для использования в playbook, укажите: google.cloud.gcp_iam_service_account_key.

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

Краткое описание

Учетная запись сервисного аккаунта в API Identity and Access Management.

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / required	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Это не должно быть установлено, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API.
key_algorithm string	Указывает алгоритм для ключа. Некоторые допустимые варианты: “KEY_ALG_UNSPECIFIED”, “KEY_ALG_RSA_1024”, “KEY_ALG_RSA_2048”
path path	Полное имя файла, который будет содержать закрытый ключ учетной записи сервисного аккаунта. Если файл уже существует, будет предпринята попытка его чтения. Убедитесь, что файл не существует или уже является действительным ключом. Путь к файлу должен быть абсолютным.
private_key_type string	Выходной формат для ключа учетной записи сервисного аккаунта. Некоторые допустимые варианты: “TYPE_UNSPECIFIED”, “TYPE_PKCS12_FILE”, “TYPE_GOOGLE_CREDENTIALS_FILE”
project string	Проект Google Cloud Platform для использования.
scopes list / elements=string	Массив областей, которые будут использоваться
service_account dictionary	Имя serviceAccount. Это поле представляет собой ссылку на ресурс ServiceAccount в GCP. Он может быть указан двумя способами. Во-первых, вы можете разместить словарь с ключом «name» и значением имени вашего ресурса. В качестве альтернативы вы можете добавить `register: name-of-resource` в задачу gcp_iam_service_account, а затем установить это поле service_account в «{{ name-of-resource }}»
service_account_contents jsonarg	Содержимое файла Service Account JSON, либо в словаре, либо в виде JSON-строки, которая его представляет.
service_account_email string	Необязательный адрес электронной почты учетной записи сервисного аккаунта, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file path	Путь к файлу Service Account JSON, если в качестве типа выбран serviceaccount.
state string	Должен ли данный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`

Примеры

- name: create a service account
  google.cloud.gcp_iam_service_account:
    name: test-ansible@graphite-playground.google.com.iam.gserviceaccount.com
    display_name: My Ansible test key
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: serviceaccount

- name: create a service account key
  google.cloud.gcp_iam_service_account_key:
    service_account: "{{ serviceaccount }}"
    private_key_type: TYPE_GOOGLE_CREDENTIALS_FILE
    path: "~/test_account.json"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ	Описание
keyAlgorithm строка	Указывает алгоритм для ключа. Возвращено: success
keyType строка	Указывает тип ключа. Возможные значения включают KEY_TYPE_UNSPECIFIED, USER_MANAGED и SYSTEM_MANAGED. Возвращено: success
name строка	Имя ключа. Возвращено: success
path строка	Полное имя файла, который будет содержать закрытый ключ учетной записи сервиса. Если файл уже существует, будет выполнена попытка его чтения. Убедитесь, что файл не существует или уже является допустимым ключом. Путь к файлу должен быть абсолютным. Возвращено: success
privateKeyData строка	Данные закрытого ключа. Кодировка в Base-64. Возвращено: success
privateKeyType строка	Формат вывода ключа учетной записи сервиса. Возвращено: success
publicKeyData строка	Данные открытого ключа. Кодировка в Base-64. Возвращено: success
serviceAccount словарь	Имя учетной записи сервиса. Возвращено: success
validAfterTime строка	Ключ может быть использован только после этой даты. Возвращено: success
validBeforeTime строка	Ключ может быть использован только до этой даты. Возвращено: success

Авторы

Google Inc. (@googlecloudplatform)

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

© 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/google/cloud/gcp_iam_service_account_key_module.html