gcp_sql_instance_facts – Сбор фактов для экземпляра GCP

Новое в версии 2.8.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Обзор

Сбор фактов для экземпляра GCP

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
project строка		Проект Google Cloud Platform для использования.
scopes список		Массив используемых областей.
service_account_contents строка		Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а как строка с точным содержимым файла service account json (валидный JSON).
service_account_email строка		Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран как тип.

Примечания

Примечание

Для аутентификации можно задать service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно задать service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно задать service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно задать auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно задать scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: " a instance facts"
  gcp_sql_instance_facts:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: facts

Значения возврата

Общие значения возврата описаны в документе, а ниже перечислены поля, уникальные для этого модуля:

Ключи				Возвращаемое значение	Описание
items сложный				всегда	Список элементов
	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 не может быть изменено после создания экземпляра.
	failoverReplica сложный			успех	Имя и статус резервного реплики. Это свойство применимо только к экземплярам второго поколения.
		available булево		успех	Статус доступности резервного реплики. Статус false указывает, что резервный реплика устарел. Мастер может переключиться только на резервный реплика, когда статус true.
		name строка		успех	Имя резервного реплики. Если указано при создании экземпляра, резервный реплика создаётся для экземпляра. Имя не включает идентификатор проекта. Это свойство применимо только к экземплярам второго поколения.
	instanceType строка			успех	Тип экземпляра. Может быть одним из следующих. * CLOUD_SQL_INSTANCE: экземпляр Cloud SQL, который не дублируется с мастером. * ON_PREMISES_INSTANCE: экземпляр, работающий на локальном оборудовании клиента. * READ_REPLICA_INSTANCE: экземпляр Cloud SQL, настроенный как реплика чтения.
	ipAddresses сложный			успех	Назначенные 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 сложный			успех	Конфигурация, специфичная для резервных реплик и реплик чтения.
		failoverTarget булево		успех	Указывает, является ли реплика целевой резервной репликой. Если значение поля установлено в true, реплика будет назначена резервной репликой. В случае сбоя экземпляра-мастера экземпляр-реплика будет повышен до статуса нового экземпляра-мастера. Только одна реплика может быть указана как целевая резервная реплика, и реплика должна находиться в другой зоне, отличной от зоны экземпляра-мастера.
		mysqlReplicaConfiguration сложный		успех	Конфигурация, специфичная для 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). Дампы должны содержать координаты бинарного журнала, с которых должна начаться репликация. Это можно сделать, установив --master-data в 1 при использовании mysqldump.
			masterHeartbeatPeriod целое число	успех	Интервал в миллисекундах между ударами сердца репликации.
			password строка	успех	Пароль для подключения репликации.
			sslCipher строка	успех	Список разрешённых шифров для шифрования SSL.
			username строка	успех	Имя пользователя для подключения репликации.
			verifyServerCertificate булево	успех	Проверять или нет значение Common Name в сертификате, которое отправляет мастер во время рукопожатия SSL.
		replicaNames список		успех	Реплики экземпляра.
		serviceAccountEmailAddress строка		успех	Электронный адрес учётной записи службы, назначенный экземпляру. Это свойство применимо только к экземплярам второго поколения.
	settings сложный			успех	Настройки пользователя.

availabilityType строка			success	Тип доступности определяет, работает ли ваш экземпляр PostgreSQL в зональном или региональном режиме.
backupConfiguration сложное			success	Настройка ежедневного резервного копирования для экземпляра.
	binaryLogEnabled булево		success	Включена ли двоичная регистрация. Если настройка резервного копирования отключена, двоичная регистрация также должна быть отключена. Только MySQL.
	enabled булево		success	Включить автоматическое резервное копирование для вашего экземпляра.
	startTime строка		success	Укажите время начала резервного копирования в формате UTC (ЧЧ:ММ).
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. [community]

Авторы

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.8/modules/gcp_sql_instance_facts_module.html