google.cloud.gcp_sql_database_info – Сбор информации о базе данных GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Чтобы использовать его в книге задач, укажите: google.cloud.gcp_sql_database_info.
Обзор
- Сбор информации о базе данных GCP
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind
строка / обязательно
|
|
Тип используемых учетных данных. |
| env_type
строка
|
Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это влияет только на строку User-Agent для всех запросов API. | |
| instance
строка / обязательно
|
Имя экземпляра Cloud SQL. Не включает идентификатор проекта. | |
| 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_sql_database_info:
instance: "{{ instance.name }}"
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| resources
сложное
|
всегда | Список ресурсов |
|
| charset
строка
|
успех | Значение charset. Подробнее см. в руководстве MySQL по [Поддерживаемые наборы символов и сортировки](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html) и в документации PostgreSQL по [Поддержка наборов символов](https://www.postgresql.org/docs/9.6/static/multibyte.html). Базы данных PostgreSQL поддерживают только значение `UTF8` при создании. | |
| collation
строка
|
успех | Значение сортировки. Подробнее см. в руководстве MySQL по [Поддерживаемые наборы символов и сортировки](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html) и в документации PostgreSQL по [Поддержка сортировки](https://www.postgresql.org/docs/9.6/static/collation.html). Базы данных PostgreSQL поддерживают только значение `en_US.UTF8` при создании. | |
| instance
строка
|
успех | Имя экземпляра Cloud SQL. Не включает идентификатор проекта. |
|
| name
строка
|
успех | Имя базы данных в экземпляре Cloud SQL. Не включает идентификатор проекта или имя экземпляра. |
|
Авторы
- 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_sql_database_info_module.html