google.cloud.gcp_spanner_database_info – Сбор информации о базе данных GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: 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 словарь / обязательно | Экземпляр, на котором будет создана база данных. Это поле представляет ссылку на ресурс экземпляра в 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_spanner_database_info_module.html
