Модуль google.cloud.gcp_sql_instance_info – Сбор информации о экземпляре GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: 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
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не уверены. Это влияет только на строку User Agent для запросов к API. |
project строка | Проект Google Cloud Platform для использования. |
scopes список / элементы=строка | Массив используемых областей. |
| ... | ... |
Примечания
Примечание
- для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить access_token с помощью переменной среды
GCP_ACCESS_TOKEN. - для аутентификации можно установить 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 |
Имя и статус резервной копии для failover. Это свойство применимо только к экземплярам второго поколения. Возвращается: успех |
|
available boolean |
Статус доступности резервной копии для failover. Статус false указывает, что резервная копия для failover не синхронизирована. Мастер может перейти на резервную копию для failover только тогда, когда статус равен true. Возвращается: успех |
|
name string |
Имя резервной копии для failover. Если указано при создании экземпляра, для экземпляра создается резервная копия для failover. Имя не включает идентификатор проекта. Это свойство применимо только к экземплярам второго поколения. Возвращается: успех |
|
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 |
Имя экземпляра, который будет выступать в качестве основного в настройке репликации. Returned: success |
|
maxDiskSize integer |
Максимальный размер диска экземпляра в байтах. Returned: success |
|
name string |
Имя экземпляра Cloud SQL. Это не включает идентификатор проекта. Returned: success |
|
region string |
Географический регион. По умолчанию us-central или us-central1 в зависимости от типа экземпляра (первого или второго поколения/PostgreSQL). Returned: success |
|
replicaConfiguration complex |
Конфигурация, специфичная для реплик отработки отказа и реплик чтения. Returned: success |
|
failoverTarget boolean |
Указывает, является ли реплика целевым объектом отработки отказа. Если поле установлено в true, реплика будет обозначена как реплика отработки отказа. В случае сбоя основного экземпляра реплика будет повышена до нового основного экземпляра. В качестве целевого объекта отработки отказа может быть указана только одна реплика, и реплика должна находиться в другой зоне, чем основной экземпляр. Returned: success |
|
mysqlReplicaConfiguration complex |
Конфигурация, специфичная для MySQL, при репликации из основного экземпляра MySQL на локальном сервере. Информация о конфигурации репликации, такая как имя пользователя, пароль, сертификаты и ключи, не хранится в метаданных экземпляра. Информация о конфигурации используется только для настройки подключения репликации и хранится MySQL в файле с именем master.info в каталоге данных. Returned: success |
|
caCertificate string |
PEM-представление сертификата x509 доверенного центра сертификации. Returned: success |
|
clientCertificate string |
PEM-представление сертификата x509 реплики. Returned: success |
|
clientKey string |
PEM-представление закрытого ключа реплики. Соответствующий открытый ключ закодирован в сертификате клиента. Returned: success |
|
connectRetryInterval integer |
Время ожидания между попытками подключения в секундах. Значение по умолчанию для MySQL — 60 секунд. Returned: success |
|
dumpFilePath string |
Путь к файлу SQL-дампа в Google Cloud Storage, из которого должен быть создан экземпляр реплики. URI имеет вид gs://bucketName/fileName. Также поддерживаются сжатые gzip-файлы (.gz). Дампы должны содержать координаты binlog, с которых должна начинаться репликация. Этого можно достичь, установив –master-data в 1 при использовании mysqldump. Returned: success |
|
masterHeartbeatPeriod integer |
Интервал в миллисекундах между сигналами «сердцебиение» репликации. Returned: success |
|
password string |
Пароль для подключения репликации. Returned: success |
|
sslCipher string |
Список допустимых шифров для использования при шифровании SSL. Returned: success |
|
username string |
Имя пользователя для подключения репликации. Returned: success |
|
verifyServerCertificate boolean |
Проверять ли значение общего имени (Common Name) основного сервера в сертификате, который он отправляет во время SSL-взаимодействия. Returned: success |
|
replicaNames list / elements=string |
Реплики экземпляра. Returned: success |
|
serviceAccountEmailAddress string |
Адрес электронной почты учётной записи службы, назначенный экземпляру. Это свойство применимо только к экземплярам второго поколения. Возвращено: success |
|
serverCaCert complex |
Конфигурация SSL. Возвращено: success |
|
cert string |
PEM-представление сертификата X.509. Возвращено: success |
|
certSerialNumber string |
Серийный номер, извлечённый из сертификата. Возвращено: success |
|
commonName string |
Указанное пользователем имя. Ограничено [a-zA-Z.-_ ]+. Возвращено: success |
|
createTime string |
Время создания сертификата в формате RFC 3339, например 2012-11-15T16:19:00.094Z. Возвращено: success |
|
expirationTime string |
Время истечения срока действия сертификата в формате RFC 3339, например 2012-11-15T16:19:00.094Z. Возвращено: success |
|
sha1Fingerprint string |
SHA-1 отпечаток сертификата. Возвращено: success |
|
settings complex |
Настройки пользователя. Возвращено: success |
|
availabilityType string |
availabilityType определяет, запущен ли ваш экземпляр Postgres в зональном или региональном режиме. Возвращено: success |
|
backupConfiguration complex |
Ежедневная конфигурация резервного копирования для экземпляра. Возвращено: success |
|
binaryLogEnabled boolean |
Включён ли бинарный лог. Если конфигурация резервного копирования отключена, бинарный лог также должен быть отключен. Только для MySQL. Возвращено: success |
|
enabled boolean |
Включить автоматическое резервное копирование для вашего экземпляра. Возвращено: success |
|
startTime string |
Укажите время начала резервного копирования в UTC (ЧЧ:ММ). Возвращено: success |
|
databaseFlags complex |
Флаги базы данных, передаваемые экземпляру при запуске. Возвращено: success |
|
name string |
Имя флага. Эти флаги передаются при запуске экземпляра, поэтому включают в себя как параметры сервера, так и системные переменные для MySQL. Флаги должны указываться с подчёркиванием, а не с дефисом. Возвращено: success |
|
value string |
Значение флага. Булевы значения должны быть установлены в on для true и off для false. Это поле должно быть опущено, если флаг не принимает значение. Возвращено: success |
|
ipConfiguration complex |
Настройки управления IP-адресами. Это позволяет включить или отключить IP-адрес экземпляра и управлять тем, какие внешние сети могут подключаться к экземпляру. IPv4-адрес нельзя отключить для экземпляров второго поколения. Возвращено: success |
|
authorizedNetworks complex |
Список внешних сетей, которым разрешено подключаться к экземпляру с использованием IP-адреса. В нотации CIDR, также известной как нотация «слэш» (например, 192.168.100.0/24). Возвращено: success |
|
expirationTime string |
Время истечения срока действия этой записи управления доступом в формате RFC 3339, например 2012-11-15T16:19:00.094Z. Возвращено: success |
|
name string |
Дополнительная метка для идентификации этой записи. Возвращаемое значение: успех |
|
value string |
Разрешённое значение для списка управления доступом. Например, чтобы предоставить доступ клиенту из внешнего IP-адреса (IPv4 или IPv6) или подсети, используйте этот адрес или подсеть здесь. Возвращаемое значение: успех |
|
ipv4Enabled boolean |
Нужно ли назначать IP-адрес экземпляру? Возвращаемое значение: успех |
|
privateNetwork string |
Ссылка на ресурс сети VPC, из которой экземпляр Cloud SQL доступен по приватному IP (например, /projects/myProject/global/networks/default). Возвращаемое значение: успех |
|
requireSsl boolean |
Требовать ли mysqld по умолчанию ‘REQUIRE X509’ для пользователей, подключающихся по IP. Возвращаемое значение: успех |
|
settingsVersion integer |
Версия настроек экземпляра. Это обязательное поле для метода обновления, чтобы гарантировать правильную обработку одновременных обновлений. При обновлении используйте последнее значение settingsVersion для этого экземпляра и не пытайтесь обновить это значение. Возвращаемое значение: успех |
|
tier string |
Уровень или тип машины для этого экземпляра, например db-n1-standard-1. Для экземпляров MySQL это поле определяет, является ли экземпляр второго поколения (рекомендуется) или первого поколения. Возвращаемое значение: успех |
|
userLabels dictionary |
Метки, предоставленные пользователем, представлены в виде словаря, где каждая метка — это пара ключ-значение. Возвращаемое значение: успех |
|
state string |
Текущее состояние работы экземпляра базы данных. Возвращаемое значение: успех |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_sql_instance_info_module.html