gcp_sql_instance – Создаёт экземпляр GCP
Новая версия с 2.7.
Описание
- Представляет экземпляр Cloud SQL. Экземпляры Cloud SQL — это SQL-базы данных, размещённые в облаке Google. Ресурс Instances предоставляет методы для общих задач конфигурирования и управления.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. | |||
| backend_type - |
| * FIRST_GEN: Экземпляр первого поколения. Только MySQL. * SECOND_GEN: Экземпляр второго поколения или PostgreSQL экземпляр. * EXTERNAL: Сервер базы данных, не управляемый Google. | |||
| connection_name - | Имя подключения экземпляра Cloud SQL, используемого в строках подключения. | ||||
| database_version - |
| Тип и версия движка базы данных. Для экземпляров первого поколения может быть MYSQL_5_5 или MYSQL_5_6. Для экземпляров второго поколения может быть MYSQL_5_6 или MYSQL_5_7. По умолчанию MYSQL_5_6. Для PostgreSQL экземпляров: POSTGRES_9_6 Свойство databaseVersion не может быть изменено после создания экземпляра. | |||
| failover_replica - | Имя и статус резервного реплики. Это свойство применимо только к экземплярам второго поколения. | ||||
| available boolean |
| Статус доступности резервного реплики. Ложное значение указывает, что резервный реплика не синхронизирован. Мастер может переключиться только на резервный реплика, когда статус истинный. | |||
| name - | Имя резервного реплики. Если задано при создании экземпляра, для экземпляра создается резервный реплика. Имя не включает идентификатор проекта. Это свойство применимо только к экземплярам второго поколения. | ||||
| instance_type - |
| Тип экземпляра. Может быть одним из следующих. * CLOUD_SQL_INSTANCE: Экземпляр Cloud SQL, который не дублируется с мастером. * ON_PREMISES_INSTANCE: Экземпляр, работающий на оборудовании клиента. * READ_REPLICA_INSTANCE: Экземпляр Cloud SQL, настроенный как реплика чтения. | |||
| ipv6_address - | Адрес IPv6, назначенный экземпляру. Это свойство применимо только к экземплярам первого поколения. | ||||
| master_instance_name - | Имя экземпляра, который будет выступать в качестве мастера в настройке репликации. | ||||
| max_disk_size - | Максимальный размер диска экземпляра в байтах. | ||||
| name - / обязательно | Имя экземпляра Cloud SQL. Не включает идентификатор проекта. | ||||
| project - | Значение по умолчанию: null | Проект Google Cloud Platform, который следует использовать. | |||
| region - | Географический регион. По умолчанию us-central или us-central1, в зависимости от типа экземпляра (первого или второго поколения/PostgreSQL). | ||||
| replica_configuration - | Настройки, специфичные для резервных и читающих реплик. | ||||
| failover_target boolean |
| Указывает, является ли реплика целевой резервной репликой. Если поле установлено в true, реплика будет назначена как резервная реплика. В случае сбоя экземпляра-мастера экземпляр-реплика будет повышен до статуса нового экземпляра-мастера. Только одна реплика может быть указана в качестве целевой резервной реплики, и реплика должна находиться в другой зоне с экземпляром-мастером. | |||
| mysql_replica_configuration - | Настройки, специфичные для MySQL, при дублировании с MySQL мастером на локальном оборудовании. Информация о настройках репликации, такая как имя пользователя, пароль, сертификаты и ключи, не сохраняются в метаданных экземпляра. Информация о конфигурации используется только для настройки подключения репликации и сохраняется MySQL в файле master.info в каталоге данных. | ||||
| ca_certificate - | Представление PEM доверенного сертификата CA x509. | ||||
| client_certificate - | Представление PEM сертификата x509 реплики. | ||||
| client_key - | Представление PEM закрытого ключа реплики. Соответствующий открытый ключ закодирован в сертификате реплики. | ||||
| connect_retry_interval - | Секунды ожидания между повторами подключения. По умолчанию в MySQL 60 секунд. | ||||
| dump_file_path - | Путь к файлу дампов SQL в Google Cloud Storage, из которого должен быть создан экземпляр реплики. URI имеет вид gs://bucketName/fileName. Также поддерживаются сжатые файлы gzip (.gz). Дампы должны содержать координаты binlog, с которых должна начаться репликация. Это можно сделать, установив --master-data в 1 при использовании mysqldump. | ||||
| master_heartbeat_period - | Интервал в миллисекундах между пульсами репликации. | ||||
| password - | Пароль для подключения репликации. | ||||
| ssl_cipher - | Список разрешенных шифров для шифрования SSL. | ||||
| username - | Имя пользователя для подключения репликации. | ||||
| verify_server_certificate boolean |
| Требовать проверку значения Common Name в сертификате, отправляемом мастером во время рукопожатия SSL. | |||
| replica_names - | Реплики экземпляра. | ||||
| service_account_email_address - | Адрес электронной почты учетной записи сервиса, назначенной экземпляру. Это свойство применимо только к экземплярам второго поколения. | ||||
| scopes - | Массив используемых областей. | ||||
| service_account_email - | Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | ||||
| service_account_file - | Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount. | ||||
| settings - | Настройки пользователя. | ||||
| ip_configuration - | Настройки управления IP. Это позволяет включить или отключить IP экземпляра и управлять тем, какие внешние сети могут подключаться к экземпляру. IPv4-адрес нельзя отключить для экземпляров второго поколения. | ||||
| authorized_networks - | Список внешних сетей, которым разрешено подключиться к экземпляру с использованием IP-адреса. В формате CIDR, также известном как нотация «слэш» (например, 192.168.100.0/24). | ||||
| expiration_time - | Время истечения срока действия этого элемента управления доступом в формате RFC 3339, например 2012-11-15T16:19:00.094Z. | ||||
| name - | Необязательная метка для идентификации этого элемента. | ||||
| value - | Разрешённое значение для списка управления доступом. Например, для предоставления доступа клиенту с внешнего IP-адреса (IPv4 или IPv6) или подсети, используйте этот адрес или подсеть здесь. | ||||
| ipv4_enabled boolean |
| Должен ли экземпляру быть назначен IP-адрес. | |||
| require_ssl boolean |
| Нужно ли mysqld по умолчанию устанавливать 'REQUIRE X509' для пользователей, подключающихся по IP? | |||
| tier - | Уровень или тип машины для данного экземпляра, например db-n1-standard-1. Для экземпляров MySQL этот параметр определяет, является ли экземпляр второго поколения (рекомендуется) или первого поколения. | ||||
| state - |
| Должен ли данный объект существовать в GCP | |||
Примечания
Примечание
- Для аутентификации можно установить service_account_file используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в плейбуке не заданы.
- Параметры service_account_email и service_account_file являются взаимоисключающими.
Примеры
- name: create a instance
gcp_sql_instance:
name: "test_object"
settings:
ip_configuration:
authorized_networks:
- name: google dns server
value: 8.8.8.8/32
tier: db-n1-standard-1
region: us-central1
project: "test_project"
auth_kind: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| backend_type строка | успех | * FIRST_GEN: Экземпляр первого поколения. Только MySQL. * SECOND_GEN: Экземпляр второго поколения или экземпляр PostgreSQL. * EXTERNAL: Сервер базы данных, не управляемый Google. | |||
| connection_name строка | успех | Имя подключения экземпляра Cloud SQL, используемого в строках подключения. | |||
| database_version строка | успех | Тип и версия движка базы данных. Для экземпляров первого поколения может быть MYSQL_5_5 или MYSQL_5_6. Для экземпляров второго поколения может быть MYSQL_5_6 или MYSQL_5_7. По умолчанию MYSQL_5_6. Для экземпляров PostgreSQL: POSTGRES_9_6. Свойство databaseVersion не может быть изменено после создания экземпляра. | |||
| failover_replica сложный тип | успех | Имя и статус резервного реплики. Это свойство применимо только к экземплярам второго поколения. | |||
| available булево | успех | Статус доступности резервного реплики. Ложное значение указывает, что резервный реплика не синхронизирован. Мастер может переключиться на резервный реплика только при статусе истинно. | |||
| name строка | успех | Имя резервного реплики. Если указано при создании экземпляра, для экземпляра создается резервный реплика. Имя не включает идентификатор проекта. Это свойство применимо только к экземплярам второго поколения. | |||
| instance_type строка | успех | Тип экземпляра. Может быть одним из следующих. * CLOUD_SQL_INSTANCE: экземпляр Cloud SQL, который не реплицирует данные с мастера. * ON_PREMISES_INSTANCE: экземпляр, работающий на оборудовании клиента. * READ_REPLICA_INSTANCE: экземпляр Cloud SQL, настроенный как реплика чтения. | |||
| ip_addresses сложный тип | успех | Назначенные IP-адреса для экземпляра. | |||
| ip_address строка | успех | Назначенный IP-адрес. | |||
| time_to_retire строка | успех | Время, когда этот IP-адрес должен быть удален в формате RFC 3339, например 2012-11-15T16:19:00.094Z. Это поле доступно только в случае, если IP-адрес запланирован на удаление. | |||
| type строка | успех | Тип этого IP-адреса. PRIMARY — адрес, который может принимать входящие соединения. OUTGOING — адрес источника соединений, исходящих из экземпляра, если поддерживается. | |||
| ipv6_address строка | успех | Назначенный IPv6-адрес для экземпляра. Это свойство применимо только к экземплярам первого поколения. | |||
| master_instance_name строка | успех | Имя экземпляра, который будет выступать в качестве мастера в настройке репликации. | |||
| max_disk_size целое число | успех | Максимальный размер диска экземпляра в байтах. | |||
| name строка | успех | Имя экземпляра Cloud SQL. Не включает идентификатор проекта. | |||
| region строка | успех | Географический регион. По умолчанию us-central или us-central1, в зависимости от типа экземпляра (первого поколения или второго поколения/PostgreSQL). | |||
| replica_configuration сложный тип | успех | Настройки, специфичные для резервных реплик и реплик чтения. | |||
| failover_target булево | успех | Указывает, является ли реплика целевой резервной копией. Если поле установлено в true, реплика будет назначена резервной копией. В случае сбоя экземпляра-мастера реплика-экземпляр будет повышен до статуса нового экземпляра-мастера. Только одна реплика может быть назначена целевой резервной копией, и реплика должна находиться в другом регионе с экземпляром-мастером. | |||
| mysql_replica_configuration сложный тип | успех | Настройки, специфичные для MySQL, при репликации с MySQL-мастером на локальном оборудовании. Информация о конфигурации репликации, такая как имя пользователя, пароль, сертификаты и ключи, не хранится в метаданных экземпляра. Информация о конфигурации используется только для настройки подключения репликации и хранится MySQL в файле master.info в каталоге данных. | |||
| ca_certificate строка | успех | Представление в формате PEM доверенного сертификата CA x509. | |||
| client_certificate строка | успех | Представление в формате PEM сертификата x509 раба. | |||
| client_key строка | успех | Представление в формате PEM закрытого ключа раба. Соответствующий открытый ключ закодирован в сертификате клиента. | |||
| connect_retry_interval целое число | успех | Секунды ожидания между повторными попытками подключения. По умолчанию в MySQL 60 секунд. | |||
| dump_file_path строка | успех | Путь к файлу дампа SQL в Google Cloud Storage, из которого должен быть создан экземпляр реплики. URI имеет вид gs://bucketName/fileName. Также поддерживаются сжатые файлы gzip (.gz). Дампы должны содержать координаты binlog, с которых следует начать репликацию. Это можно сделать, установив --master-data в 1 при использовании mysqldump. | |||
| master_heartbeat_period целое число | успех | Интервал в миллисекундах между ударами сердца репликации. | |||
| password строка | успех | Пароль для подключения репликации. | |||
| ssl_cipher строка | успех | Список разрешенных шифров для шифрования SSL. | |||
| username строка | успех | Имя пользователя для подключения репликации. | |||
| verify_server_certificate булево | успех | Необходимо ли проверять значение Common Name в сертификате, отправленном мастером во время рукопожатия SSL. | |||
| replica_names список | успех | Реплики экземпляра. | |||
| service_account_email_address строка | успех | Адрес электронной почты учетной записи службы, назначенной экземпляру. Это свойство применимо только к экземплярам второго поколения. | |||
| settings сложный тип | успех | Настройки пользователя. | |||
| ip_configuration сложный тип | успех | Настройки IP-управления. Это позволяет включить или отключить IP-адрес экземпляра и управлять внешними сетями, которые могут подключаться к экземпляру. IPv4-адрес нельзя отключить для экземпляров второго поколения. | |||
| authorized_networks сложный тип | успех | Список внешних сетей, которым разрешено подключаться к экземпляру с использованием IP-адреса. В формате CIDR, также известном как «формат с косой чертой» (например, 192.168.100.0/24). | |||
| expiration_time строка | успех | Время истечения срока действия этого элемента управления доступом в формате RFC 3339, например 2012-11-15T16:19:00.094Z. | |||
| Имя строка | успешно | Необязательная метка для идентификации этой записи. | |||
| Значение строка | успешно | Допускаемое значение для списка управления доступом. Например, для предоставления доступа клиенту из внешнего IP-адреса (IPv4 или IPv6) или подсети используйте этот адрес или подсеть здесь. | |||
| ipv4_enabled булево | успешно | Следует ли присваивать экземпляру IP-адрес или нет. | |||
| require_ssl булево | успешно | Следует ли mysqld по умолчанию использовать 'REQUIRE X509' для пользователей, подключающихся по IP. | |||
| уровень строка | успешно | Уровень или тип машины для данного экземпляра, например 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.7/modules/gcp_sql_instance_module.html
