google.cloud.gcp_sql_database_info – Сбор информации о базе данных GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: 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). Postgres базы данных поддерживают только значение `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). Postgres базы данных поддерживают только значение `en_US.UTF8` во время создания. | |
| instance строка | успех | Имя экземпляра Cloud SQL. Не включает идентификатор проекта. | |
| name строка | успех | Имя базы данных в экземпляре Cloud SQL. Не включает идентификатор проекта или имя экземпляра. | |
Авторы
- 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_sql_database_info_module.html