google.cloud.gcp_sql_instance_info – Сбор информации о виртуальной машине GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в playbook укажите: google.cloud.gcp_sql_instance_info.
Обзор
- Сбор информации о виртуальной машине GCP
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Устанавливать это значение не рекомендуется, если вы не знаете, что делаете. Это меняет только строку User Agent для всех API-запросов. | |
| 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. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on an instance
gcp_sql_instance_info:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||||
|---|---|---|---|---|---|---|
| resources complex | всегда | Список ресурсов | ||||
| backendType строка | успех | * FIRST_GEN: Экземпляр первого поколения. Только MySQL. * SECOND_GEN: Экземпляр второго поколения или экземпляр PostgreSQL. * EXTERNAL: Сервер базы данных, не управляемый Google. | ||||
| connectionName строка | успех | Имя подключения экземпляра Cloud SQL, используемого в строках подключения. | ||||
| databaseVersion строка | успех | Тип и версия движка базы данных. Для экземпляров первого поколения может быть MYSQL_5_5 или MYSQL_5_6. Для экземпляров второго поколения может быть MYSQL_5_6 или MYSQL_5_7. По умолчанию MYSQL_5_6. Экземпляры PostgreSQL: POSTGRES_9_6 Свойство databaseVersion нельзя изменить после создания экземпляра. | ||||
| diskEncryptionConfiguration complex | успех | Настройки шифрования диска. | ||||
| kmsKeyName строка | успех | Ключ KMS, используемый для шифрования экземпляра Cloud SQL. | ||||
| diskEncryptionStatus complex | успех | Статус шифрования диска. | ||||
| kmsKeyVersionName строка | успех | Версия ключа KMS, используемая для шифрования экземпляра Cloud SQL. | ||||
| failoverReplica complex | успех | Имя и статус резервного реплики. Это свойство применимо только к экземплярам второго поколения. | ||||
| available логическое значение | успех | Статус доступности резервного реплики. Значение false указывает, что резервный реплика не синхронизирован. Мастер может переключиться только на резервный реплика, когда статус равен true. | ||||
| name строка | успех | Имя резервного реплики. Если указано при создании экземпляра, для экземпляра создается резервный реплика. Имя не включает идентификатор проекта. Это свойство применимо только к экземплярам второго поколения. | ||||
| gceZone строка | успех | Компьютерная зона Compute Engine, из которой в настоящее время работает экземпляр. Это значение может отличаться от зоны, указанной при создании экземпляра, если экземпляр переключился на вторичную зону. | ||||
| instanceType строка | успех | Тип экземпляра. Может быть одним из следующих. * CLOUD_SQL_INSTANCE: Экземпляр Cloud SQL, который не дублируется с мастером. * ON_PREMISES_INSTANCE: Экземпляр, работающий на оборудовании клиента. * READ_REPLICA_INSTANCE: Экземпляр Cloud SQL, настроенный как реплика чтения. | ||||
| ipAddresses complex | успех | Назначенные IP-адреса для экземпляра. | ||||
| ipAddress строка | успех | Назначенный IP-адрес. | ||||
| timeToRetire строка | успех | Дата истечения срока действия этого IP-адреса в формате RFC 3339, например 2012-11-15T16:19:00.094Z. Это поле доступно только в том случае, если IP-адрес запланирован на удаление. | ||||
| type строка | успех | Тип этого IP-адреса. Адрес PRIMARY — это адрес, который может принимать входящие подключения. Адрес OUTGOING — это исходный адрес подключений, исходящих из экземпляра, если поддерживается. | ||||
| ipv6Address строка | успех | Назначенный IPv6-адрес для экземпляра. Это свойство применимо только к экземплярам первого поколения. | ||||
| masterInstanceName строка | успех | Имя экземпляра, который будет выполнять роль мастера в настройке репликации. | ||||
| maxDiskSize целое число | успех | Максимальный размер диска экземпляра в байтах. | ||||
| name строка | успех | Имя экземпляра Cloud SQL. Не включает идентификатор проекта. | ||||
| region строка | успех | Географический регион. По умолчанию us-central или us-central1 в зависимости от типа экземпляра (первого поколения или второго поколения/PostgreSQL). | ||||
| replicaConfiguration complex | успех | Настройка, специфичная для резервных реплик и реплик чтения. | ||||
| failoverTarget логическое значение | успех | Указывает, является ли реплика целевым экземпляром для переключения. Если поле установлено в true, реплика будет назначена резервным репликой. В случае сбоя основного экземпляра экземпляр реплики будет повышен до нового основного экземпляра. Только одна реплика может быть указана как целевой резервный реплика, и реплика должна находиться в другой зоне по сравнению с основным экземпляром. | ||||
| mysqlReplicaConfiguration complex | успех | Настройка, специфичная для MySQL, при дублировании с основным MySQL-мастером на локальном компьютере. Информация о конфигурации репликации, например, имя пользователя, пароль, сертификаты и ключи, не хранятся в метаданных экземпляра. Данная информация используется только для настройки подключения репликации и хранится MySQL в файле master.info в каталоге данных. | ||||
| caCertificate строка | успех | Представление PEM доверенного CA-сертификата x509. | ||||
| clientCertificate строка | успех | Представление PEM сертификата x509 реплики. | ||||
| clientKey строка | успех | Представление PEM закрытого ключа реплики. Соответствующий открытый ключ закодирован в сертификате клиента. | ||||
| connectRetryInterval целое число | успех | Секунды ожидания между повторными попытками подключения. По умолчанию в MySQL 60 секунд. | ||||
| dumpFilePath строка | успех | Путь к файлу дампов SQL в Google Cloud Storage, из которого должен создаваться экземпляр реплики. URI имеет вид gs://bucketName/fileName. Также поддерживаются сжатые файлы gzip (.gz). Дампы должны содержать координаты binlog, с которых должна начаться репликация. Это можно сделать, установив --master-data в 1 при использовании mysqldump. | ||||
| masterHeartbeatPeriod целое число | успех | Интервал в миллисекундах между биениями репликации сердца. | ||||
| password строка | успех | Пароль для подключения репликации. | ||||
| sslCipher строка | успех | Список разрешенных шифров для шифрования SSL. | ||||
| username строка | успех | Имя пользователя для подключения репликации. | ||||
| verifyServerCertificate логическое значение | успех | Нужно ли проверять значение Common Name в сертификате, отправляемом мастером во время рукопожатия SSL. | ||||
| replicaNames список / элементы=строка | успех | Реплики экземпляра. | ||||
| serviceAccountEmailAddress string | success | Адрес электронной почты учетной записи сервиса, назначенной экземпляру. Это свойство применимо только к экземплярам второго поколения. | ||||
| serverCaCert complex | success | Настройка SSL. | ||||
| cert string | success | Представление X.509-сертификата в формате PEM. | ||||
| certSerialNumber string | success | Серийный номер, извлечённый из сертификата. | ||||
| commonName string | success | Имя, заданное пользователем. Ограничено шаблоном [a-zA-Z.-_ ]+. | ||||
| createTime string | success | Время создания сертификата в формате RFC 3339, например 2012-11-15T16:19:00.094Z. | ||||
| expirationTime string | success | Время истечения срока действия сертификата в формате RFC 3339, например 2012-11-15T16:19:00.094Z. | ||||
| sha1Fingerprint string | success | Отпечаток SHA-1 сертификата. | ||||
| settings complex | success | Настройки пользователя. | ||||
| availabilityType string | success | Тип доступности, определяющий, работает ли ваш экземпляр PostgreSQL в зональной или региональной модели. | ||||
| backupConfiguration complex | success | Ежедневная настройка резервного копирования для экземпляра. | ||||
| binaryLogEnabled boolean | success | Включено ли двоичное протоколирование. Если настройка резервного копирования выключена, двоичное протоколирование также должно быть отключено. Только MySQL. | ||||
| enabled boolean | success | Включить автоматическое резервное копирование для вашего экземпляра. | ||||
| startTime string | success | Определите время начала резервного копирования в UTC (ЧЧ:ММ). | ||||
| databaseFlags complex | success | Флаги базы данных, переданные экземпляру при запуске. | ||||
| name string | success | Имя флага. Эти флаги передаются при запуске экземпляра, поэтому включают как опции сервера, так и системные переменные для MySQL. Флаги должны быть указаны с помощью нижнего подчёркивания, а не дефисов. | ||||
| value string | success | Значение флага. Булевы значения должны быть установлены на on для true и off для false. Этот поле должно быть опущено, если флаг не принимает значения. | ||||
| ipConfiguration complex | success | Настройки управления IP. Это позволяет включить или отключить IP-адрес экземпляра и управлять внешними сетями, которые могут подключаться к экземпляру. IPv4-адрес нельзя отключить для экземпляров второго поколения. | ||||
| authorizedNetworks complex | success | Список внешних сетей, которым разрешено подключаться к экземпляру с помощью IP. В формате CIDR, также известном как нотация «слэшей» (например, 192.168.100.0/24). | ||||
| expirationTime string | success | Время истечения срока действия записи управления доступом в формате RFC 3339, например 2012-11-15T16:19:00.094Z. | ||||
| name string | success | Необязательная метка для идентификации этой записи. | ||||
| value string | success | Разрешённое значение для списка управления доступом. Например, для предоставления доступа к клиенту из внешнего IP-адреса (IPv4 или IPv6) или подсети, используйте этот адрес или подсеть здесь. | ||||
| ipv4Enabled boolean | success | Нужно ли присвоить экземпляру IP-адрес. | ||||
| requireSsl boolean | success | Должен ли mysqld по умолчанию использовать 'REQUIRE X509' для пользователей, подключающихся по IP. | ||||
| settingsVersion integer | success | Версия настроек экземпляра. Это обязательное поле для метода обновления, чтобы правильно обрабатывать одновременные обновления. При обновлении используйте последнее значение settingsVersion для данного экземпляра и не пытайтесь обновить это значение. | ||||
| tier string | success | Уровень или тип машины для данного экземпляра, например db-n1-standard-1. Для экземпляров MySQL это поле определяет, является ли экземпляр второго поколения (рекомендуется) или первого поколения. | ||||
| userLabels dictionary | success | Метки, предоставленные пользователем, представленные в виде словаря, где каждая метка — это пара «ключ-значение». | ||||
| state string | success | Текущее состояние обслуживания экземпляра базы данных. | ||||
Авторы
- 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_instance_info_module.html
