Модуль google.cloud.gcp_spanner_database_info – Сбор информации о базе данных GCP

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_spanner_database_info.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Сбор информации о базе данных GCP

Требования

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type строка	Указывает, в какой среде Ansible выполняется этот модуль. Это поле не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
instance словарь / обязательно	Инстанс, на котором создается база данных. Это поле представляет ссылку на ресурс Instance в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'name' и значением имени вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` в задачу gcp_spanner_instance, а затем установить это поле instance в «{{ name-of-resource }}»
project строка	Проект Google Cloud Platform для использования.
scopes список / элементы=строка	Массив используемых областей
service_account_contents jsonarg	Содержание файла JSON учетной записи службы, либо в виде словаря, либо как строка JSON, его представляющая.
service_account_email строка	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран в качестве типа.

Примечания

Примечание

для аутентификации можно установить service_account_file с использованием переменной среды GCP_SERVICE_ACCOUNT_FILE.
для аутентификации можно установить service_account_contents с использованием переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно установить service_account_email с использованием переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно установить access_token с использованием переменной среды GCP_ACCESS_TOKEN.
Для аутентификации можно установить auth_kind с использованием переменной среды GCP_AUTH_KIND.
Для аутентификации можно установить scopes с использованием переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения плейбука не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a database
  gcp_spanner_database_info:
    instance: "{{ instance }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ	Описание
resources сложный	Список ресурсов Возвращается: всегда
encryptionConfig сложный	Настройка шифрования для базы данных. Возвращается: успешно
kmsKeyName строка	Полное имя KMS-ключа, используемого для шифрования этой базы данных. Этот ключ должен существовать в том же расположении, что и база данных Spanner. Возвращается: успешно
extraStatements список / элементы=строка	Необязательный список инструкций DDL для выполнения внутри вновь созданной базы данных. Инструкции могут создавать таблицы, индексы и т. д. Эти инструкции выполняются атомарно вместе с созданием базы данных: если в какой-либо инструкции произойдет ошибка, база данных не создается. Возвращается: успешно
instance словарь	Инстанс, на котором нужно создать базу данных. Возвращается: успешно
name строка	Уникальный идентификатор базы данных, который нельзя изменить после создания инстанса. Значения имеют вид [a-z][-a-z0-9][a-z0-9]. Возвращается:* успешно

Авторы

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_spanner_database_info_module.html