google.cloud.gcp_sql_instance_info – Сбор информации о виртуальной машине GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.1).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: 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. - Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
- Параметры 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 string | успех | * FIRST_GEN: Экземпляр первого поколения. Только MySQL. * SECOND_GEN: Экземпляр второго поколения или PostgreSQL. * EXTERNAL: Сервер базы данных, не управляемый Google. | ||||
| connectionName string | успех | Имя подключения экземпляра Cloud SQL, используемого в строках подключения. | ||||
| databaseVersion string | успех | Тип и версия движка базы данных. Для экземпляров первого поколения может быть MYSQL_5_5 или MYSQL_5_6. Для экземпляров второго поколения может быть MYSQL_5_6 или MYSQL_5_7. По умолчанию MYSQL_5_6. Для экземпляров PostgreSQL: POSTGRES_9_6 Свойство databaseVersion не может быть изменено после создания экземпляра. | ||||
| diskEncryptionConfiguration complex | успех | Настройки шифрования диска. | ||||
| kmsKeyName string | успех | Ключ KMS, используемый для шифрования экземпляра Cloud SQL. | ||||
| diskEncryptionStatus complex | успех | Статус шифрования диска. | ||||
| kmsKeyVersionName string | успех | Версия ключа KMS, используемая для шифрования экземпляра Cloud SQL. | ||||
| failoverReplica complex | успех | Имя и статус резервного реплики. Это свойство применимо только к экземплярам второго поколения. | ||||
| available boolean | успех | Статус доступности резервного реплики. Значение false указывает, что резервный реплика не синхронизирован. Мастер может переключиться на резервный реплика только при значении true. | ||||
| name string | успех | Имя резервного реплики. Если задано при создании экземпляра, резервный реплика создается для экземпляра. Имя не включает идентификатор проекта. Это свойство применимо только к экземплярам второго поколения. | ||||
| gceZone string | успех | Зона Compute Engine, из которой в настоящее время работает экземпляр. Это значение может отличаться от зоны, указанной при создании экземпляра, если экземпляр переключился на вторичную зону. | ||||
| instanceType string | успех | Тип экземпляра. Может быть одним из следующих. * CLOUD_SQL_INSTANCE: Экземпляр Cloud SQL, который не реплицируется с мастера. * ON_PREMISES_INSTANCE: Экземпляр, работающий на оборудовании клиента. * READ_REPLICA_INSTANCE: Экземпляр Cloud SQL, настроенный как реплика для чтения. | ||||
| ipAddresses complex | успех | Назначенные IP-адреса для экземпляра. | ||||
| ipAddress string | успех | Назначенный IP-адрес. | ||||
| timeToRetire string | успех | Время отключения этого IP-адреса в формате RFC 3339, например 2012-11-15T16:19:00.094Z. Это поле доступно только при планируемом отключении IP-адреса. | ||||
| type string | успех | Тип этого IP-адреса. PRIMARY – адрес, принимающий входящие подключения. OUTGOING – исходный адрес подключений, исходящих от экземпляра, если поддерживается. | ||||
| ipv6Address string | успех | Назначенный IPv6-адрес экземпляра. Это свойство применимо только к экземплярам первого поколения. | ||||
| masterInstanceName string | успех | Имя экземпляра, который будет действовать как мастер в настройке репликации. | ||||
| maxDiskSize integer | успех | Максимальный размер диска экземпляра в байтах. | ||||
| name string | успех | Имя экземпляра Cloud SQL. Не включает идентификатор проекта. | ||||
| region string | успех | Географический регион. По умолчанию us-central или us-central1 в зависимости от типа экземпляра (первое поколение или второе поколение/PostgreSQL). | ||||
| replicaConfiguration complex | успех | Настройки, специфичные для резервных и читающих реплик. | ||||
| failoverTarget boolean | успех | Указывает, является ли реплика целевой резервной копией. Если поле установлено в true, реплика будет обозначена как резервная реплика. В случае отказа мастера, реплика будет промотирована как новый мастер. Только одна реплика может быть указана как резервная, и она должна находиться в другой зоне, чем мастер. | ||||
| mysqlReplicaConfiguration complex | успех | Настройки, специфичные для MySQL, при репликации с MySQL-мастером на локальном оборудовании. Информация о конфигурации репликации, такая как имя пользователя, пароль, сертификаты и ключи, не хранится в метаданных экземпляра. Данная информация используется только для настройки соединения репликации и хранится MySQL в файле master.info в каталоге данных. | ||||
| caCertificate string | успех | Представление PEM доверенного сертификата CA x509. | ||||
| clientCertificate string | успех | Представление PEM x509-сертификата ведомого. | ||||
| clientKey string | успех | Представление PEM закрытого ключа ведомого. Соответствующий открытый ключ закодирован в сертификате ведомого. | ||||
| connectRetryInterval integer | успех | Секунды ожидания между повторными попытками подключения. По умолчанию в MySQL 60 секунд. | ||||
| dumpFilePath string | успех | Путь к файлу дампа SQL в Google Cloud Storage, из которого создается ведомый экземпляр. URI имеет вид gs://имя_ведра/имя_файла. Также поддерживаются сжатые файлы gzip (.gz). Дампы должны содержать координаты binlog, с которых должна начаться репликация. Это можно сделать, установив --master-data в 1 при использовании mysqldump. | ||||
| masterHeartbeatPeriod integer | успех | Интервал в миллисекундах между реплицируемыми ударами сердца мастера. | ||||
| password string | успех | Пароль для подключения репликации. | ||||
| sslCipher string | успех | Список разрешенных шифров для SSL-шифрования. | ||||
| username string | успех | Имя пользователя для подключения репликации. | ||||
| verifyServerCertificate boolean | успех | Нужно ли проверять значение Common Name в сертификате, которое отправляет мастер во время рукопожатия SSL. | ||||
| replicaNames list / elements=string | успех | Реплики экземпляра. | ||||
| 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 | Значение флага. Булевы значения должны быть установлены на «вкл» для true и «выкл» для 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–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_instance_info_module.html
