gcp_sql_instance_info – Сбор информации о GCP экземпляре
Новая версия с 2.8.
Обзор
- Сбор информации о GCP экземпляре
- Этот модуль назывался
gcp_sql_instance_factsдо Ansible 2.9. Способ использования не изменился.
Псевдонимы: gcp_sql_instance_facts
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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 с помощью переменной окружения c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents с помощью переменной окружения c(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 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 нельзя изменить после создания экземпляра. | ||||
| failoverReplica complex | успех | Имя и статус резервного экземпляра. Это свойство применимо только к экземплярам второго поколения. | ||||
| available boolean | успех | Статус доступности резервного экземпляра. Значение false означает, что резервный экземпляр не синхронизирован. Мастер может перейти к резервному экземпляру только при значении true. | ||||
| name string | успех | Имя резервного экземпляра. Если указано при создании экземпляра, для него создаётся резервный экземпляр. Имя не включает идентификатор проекта. Это свойство применимо только к экземплярам второго поколения. | ||||
| 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://bucketName/fileName. Также поддерживаются сжатые файлы .gz. Дампы должны содержать координаты бинарного журнала, с которых должна начаться репликация. Это можно сделать, установив --master-data в 1 при использовании mysqldump. | ||||
| masterHeartbeatPeriod integer | успех | Интервал в миллисекундах между реплицируемыми ударами сердца. | ||||
| password string | успех | Пароль для подключения репликации. | ||||
| sslCipher string | успех | Список разрешенных шифров для шифрования SSL. | ||||
| username string | успех | Имя пользователя для подключения репликации. | ||||
| verifyServerCertificate boolean | успех | Проверка имени узла сервера в сертификате, который он отправляет во время рукопожатия SSL. | ||||
| replicaNames list | успех | Реплики экземпляра. | ||||
| serviceAccountEmailAddress строка | success | Адрес электронной почты учётной записи службы, назначенной экземпляру. Это свойство применимо только к экземплярам второго поколения. | ||||
| settings сложная | success | Настройки пользователя. | ||||
| availabilityType строка | success | AvailabilityType определяет, работает ли ваш экземпляр PostgreSQL в зональном или региональном режиме. | ||||
| backupConfiguration сложная | success | Ежедневная конфигурация резервного копирования для экземпляра. | ||||
| binaryLogEnabled логическое | success | Включено ли двоичное протоколирование. Если конфигурация резервного копирования отключена, двоичное протоколирование также должно быть отключено. Только MySQL. | ||||
| enabled логическое | success | Включить автоматическое резервное копирование для вашего экземпляра. | ||||
| startTime строка | success | Укажите время начала резервного копирования в формате UTC (ЧЧ:ММ). | ||||
| databaseFlags сложная | success | Флаги базы данных, переданные экземпляру при запуске. | ||||
| name строка | success | Имя флага. Эти флаги передаются при запуске экземпляра, поэтому включайте как параметры сервера, так и системные переменные для MySQL. Флаги должны быть указаны с нижними подчеркиваниями, а не дефисами. | ||||
| value строка | success | Значение флага. Логические значения должны устанавливаться на «вкл» для true и «выкл» для false. Это поле должно быть опущено, если флаг не принимает значение. | ||||
| ipConfiguration сложная | success | Настройки IP-управления. Это позволяет включить или отключить IP-адрес экземпляра и управлять внешними сетями, которые могут подключаться к экземпляру. IPv4-адрес нельзя отключить для экземпляров второго поколения. | ||||
| authorizedNetworks сложная | success | Список внешних сетей, которым разрешено подключаться к экземпляру через IP. В формате CIDR, также известном как «формат с косой чертой» (например, 192.168.100.0/24). | ||||
| expirationTime строка | success | Время истечения срока действия этого элемента управления доступом в формате RFC 3339, например 2012-11-15T16:19:00.094Z. | ||||
| name строка | success | Необязательная метка для идентификации этого элемента. | ||||
| value строка | success | Разрешённое значение для списка управления доступом. Например, для предоставления доступа клиенту из внешнего IP-адреса (IPv4 или IPv6) или подсети используйте этот адрес или подсеть здесь. | ||||
| ipv4Enabled логическое | success | Должен ли экземпляру быть назначен IP-адрес. | ||||
| requireSsl логическое | success | Должен ли mysqld по умолчанию устанавливать «REQUIRE X509» для пользователей, подключающихся через IP. | ||||
| settingsVersion целое число | success | Версия настроек экземпляра. Это обязательное поле для метода обновления, чтобы убедиться, что одновременные обновления обрабатываются должным образом. При обновлении используйте последнее значение settingsVersion для этого экземпляра и не пытайтесь обновить это значение. | ||||
| tier строка | success | Уровень или тип машины для этого экземпляра, например db-n1-standard-1. Для экземпляров MySQL это поле определяет, является ли экземпляр второго поколения (рекомендуется) или первого поколения. | ||||
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/gcp_sql_instance_info_module.html
