google.cloud.gcp_compute_region_instance_group_manager – Создаёт GCP RegionInstanceGroupManager
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_compute_region_instance_group_manager.
Обзор
- Создаёт управляемую группу экземпляров с использованием информации, указанной в запросе. После создания группы планируется действие для создания экземпляров в группе с использованием указанной шаблона экземпляра. Данная операция отмечается как ЗАВЕРШЕНО, когда группа создана, даже если экземпляры в группе ещё не созданы. Необходимо отдельно проверить состояние отдельных экземпляров.
- Управляемая группа экземпляров может содержать до 1000 виртуальных машин на группу.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| auto_healing_policies список / элементы=словарь | Политика автоматического исправления для этой управляемой группы экземпляров. | ||
| health_check строка | URL проверки работоспособности, сигнализирующей об автоматическом исправление. | ||
| initial_delay_sec целое число | Количество секунд, которые управляемая группа экземпляров ожидает, прежде чем применить политику автоматического исправления к новым экземплярам или недавно воссозданным экземплярам. | ||
| base_instance_name строка / обязательно | Базовое имя экземпляра, используемое для экземпляров в этой группе. Значение должно быть длиной от 1 до 58 символов. Имена экземпляров формируются путем добавления дефиса и случайной четырёхсимвольной строки к базовому имени экземпляра. Базовое имя экземпляра должно соответствовать RFC1035. | ||
| description строка | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | ||
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это значение не должно устанавливаться, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов API. | ||
| instance_template словарь / обязательно | Шаблон экземпляра, указанный для этой управляемой группы экземпляров. Группа использует этот шаблон для создания всех новых экземпляров в управляемой группе экземпляров. Это поле представляет собой ссылку на ресурс InstanceTemplate в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом «selfLink» и значением selfLink вашего ресурса. В качестве альтернативы, вы можете добавить `register: имя-ресурса` в задачу gcp_compute_instance_template, а затем установить это поле instance_template в "{{ имя-ресурса }}" | ||
| name строка / обязательно | Имя управляемой группы экземпляров. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. | ||
| named_ports список / элементы=словарь | Названные порты, настроенные для групп экземпляров, дополняющих эту группу менеджера экземпляров. | ||
| name строка | Имя для этого названного порта. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. | ||
| port целое число | Номер порта, который может быть значением от 1 до 65535. | ||
| project строка | Проект Google Cloud Platform, который следует использовать. | ||
| region строка / обязательно | Регион, в котором расположена управляемая группа экземпляров. | ||
| scopes список / элементы=строка | Массив используемых областей. | ||
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в словаре, либо в виде JSON-строки, его представляющей. | ||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если тип выбран как serviceaccount. | ||
| state строка |
| Указывает, должен ли данный объект существовать в GCP | |
| target_pools список / элементы=словарь | Ресурсы target_pools, к которым добавляются экземпляры в поле instanceGroup. Целевые пулы автоматически применяются ко всем экземплярам в управляемой группе экземпляров. | ||
| target_size целое число | Целевое количество работающих экземпляров для этой управляемой группы экземпляров. Удаление или отказ от экземпляров уменьшает это число. Изменение размера группы изменяет это число. | ||
Примеры
- name: create a network
google.cloud.gcp_compute_network:
name: network-instancetemplate
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: network
- name: create a address
google.cloud.gcp_compute_address:
name: address-instancetemplate
region: us-central1
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: address
- name: create a instance template
google.cloud.gcp_compute_instance_template:
name: "{{ resource_name }}"
properties:
disks:
- auto_delete: 'true'
boot: 'true'
initialize_params:
source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts
machine_type: n1-standard-1
network_interfaces:
- network: "{{ network }}"
access_configs:
- name: test-config
type: ONE_TO_ONE_NAT
nat_ip: "{{ address }}"
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: instancetemplate
- name: create a region instance group manager
google.cloud.gcp_compute_region_instance_group_manager:
name: test_object
base_instance_name: test1-child
region: us-central1
instance_template: "{{ instancetemplate }}"
target_size: 3
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие значения возврата описаны в этом разделе, а приведенные ниже поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| autoHealingPolicies сложное | успех | Политика автоматического исправления для этой группы управляемых виртуальных машин. | |
| healthCheck строка | успех | URL для проверки состояния, сигнализирующей об автоматическом исправление. | |
| initialDelaySec целое число | успех | Количество секунд, которое группа управляемых виртуальных машин ожидает, прежде чем применять политики автоматического исправления к новым или недавно воссозданным виртуальным машинам. | |
| baseInstanceName строка | успех | Базовое имя виртуальной машины для использования в этой группе. Значение должно быть длиной от 1 до 58 символов. Имена виртуальных машин формируются путём добавления дефиса и случайной четырёхсимвольной строки к базовому имени виртуальной машины. Базовое имя виртуальной машины должно соответствовать RFC1035. | |
| creationTimestamp строка | успех | Дата и время создания этой группы управляемых виртуальных машин в формате RFC3339. | |
| currentActions сложное | успех | Список действий виртуальных машин и количество виртуальных машин в этой группе управляемых виртуальных машин, запланированных для каждого из этих действий. | |
| abandoning целое число | успех | Общее количество виртуальных машин в группе управляемых виртуальных машин, запланированных для удаления без удаления. | |
| creating целое число | успех | Количество виртуальных машин в группе управляемых виртуальных машин, запланированных для создания или которые в настоящее время создаются. Если группе не удаётся создать какие-либо из этих виртуальных машин, она пытается снова, пока виртуальная машина не будет успешно создана. Если повторные попытки создания отключены, это поле не будет заполнено; вместо этого будет заполнено поле creatingWithoutRetries. | |
| creatingWithoutRetries целое число | успех | Количество виртуальных машин, которые группа управляемых виртуальных машин попытается создать. Группа пытается создать каждую виртуальную машину только один раз. Если группе не удаётся создать какие-либо из этих виртуальных машин, она соответственно уменьшает значение targetSize группы. | |
| deleting целое число | успех | Количество виртуальных машин в группе управляемых виртуальных машин, которые запланированы на удаление или которые в настоящее время удаляются. | |
| none целое число | успех | Количество виртуальных машин в группе управляемых виртуальных машин, которые работают и для которых нет запланированных действий. | |
| recreating целое число | успех | Количество виртуальных машин в группе управляемых виртуальных машин, которые запланированы на пересоздание или которые в настоящее время пересоздаются. При пересоздании виртуальной машины удаляется существующий корневой постоянный диск и создается новый диск из образа, определённого в шаблоне виртуальной машины. | |
| refreshing целое число | успех | Количество виртуальных машин в группе управляемых виртуальных машин, которые перенастраиваются с параметрами, не требующими перезапуска или пересоздания. Например, установка или удаление целевых пулов для виртуальной машины. | |
| restarting целое число | успех | Количество виртуальных машин в группе управляемых виртуальных машин, которые запланированы на перезапуск или которые в настоящее время перезапускаются. | |
| description строка | успех | Необязательное описание этого ресурса. Укажите этот параметр при создании ресурса. | |
| id целое число | успех | Уникальный идентификатор этого ресурса. | |
| instanceGroup словарь | успех | Группа виртуальных машин, которая управляется. | |
| instanceTemplate словарь | успех | Шаблон виртуальной машины, указанный для этой группы управляемых виртуальных машин. Группа использует этот шаблон для создания всех новых виртуальных машин в группе управляемых виртуальных машин. | |
| name строка | успех | Имя группы управляемых виртуальных машин. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. | |
| namedPorts сложное | успех | Названные порты, настроенные для групп виртуальных машин, которые дополняют эту группу менеджеров управляемых виртуальных машин. | |
| name строка | успех | Имя для этого названного порта. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. | |
| port целое число | успех | Номер порта, который может быть значением от 1 до 65535. | |
| region строка | успех | Регион, в котором расположена группа управляемых виртуальных машин. | |
| targetPools список / элементы=строка | успех | Ресурсы targetPool, к которым добавляются виртуальные машины в поле instanceGroup. Целевые пулы автоматически применяются ко всем виртуальным машинам в группе управляемых виртуальных машин. | |
| targetSize целое число | успех | Целевое количество работающих виртуальных машин для этой группы управляемых виртуальных машин. Удаление или удаление виртуальных машин уменьшает это число. Изменение размера группы изменяет это число. | |
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_region_instance_group_manager_module.html