google.cloud.gcp_spanner_database_info – Сбор информации о базе данных GCP
Примечание
Этот плагин является частью коллекции google.cloud (версия 1.0.1).
Для его установки используйте: 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
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это не должно устанавливаться, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов API. | |
| instance словарь / обязательно | Экземпляр, на котором создается база данных. Это поле представляет ссылку на ресурс Instance в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'name' и значением имени вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` к задаче gcp_spanner_instance, а затем установить это поле instance в "{{ имя-ресурса }}" | |
| 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. - Для аутентификации можно установить 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 сложное | всегда | Список ресурсов | |
| extraStatements список / элементы=строка | успех | Необязательный список DDL-команд для выполнения внутри новой базы данных. Команды могут создавать таблицы, индексы и т. д. Эти команды выполняются атомарно вместе с созданием базы данных: если возникает ошибка в любой команде, база данных не создается. | |
| instance словарь | успех | Экземпляр, на котором создается база данных. | |
| name строка | успех | Уникальный идентификатор базы данных, который нельзя изменить после создания экземпляра. Значения имеют вид [a-z][-a-z0-9]*[a-z0-9]. | |
Авторы
- 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_spanner_database_info_module.html
