google.cloud.gcp_compute_instance_group_manager – Создаёт GCP InstanceGroupManager
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_compute_instance_group_manager.
Описание
- Создаёт управляемую группу виртуальных машин (VM) с использованием указанной в запросе информации. После создания группы запланируется действие по созданию экземпляров в группе с помощью указанной шаблона экземпляра. Данная операция отмечается как ВЫПОЛНЕНО, когда группа создана, даже если экземпляры в группе ещё не созданы. Вы должны отдельно проверить статус отдельных экземпляров.
- Управляемая группа виртуальных машин может содержать до 1000 виртуальных машин на группу.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| 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 для использования. | ||
| scopes список / элементы=строка | Массив используемых областей | ||
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, которая его представляет. | ||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. | ||
| state строка |
| Должен ли данный объект существовать в GCP | |
| target_pools список / элементы=словарь | Ресурсы TargetPool, к которым добавляются экземпляры в поле instanceGroup. Целевые пулы автоматически применяются ко всем экземплярам в управляемой группе экземпляров. | ||
| target_size целое число | Целевое количество работающих экземпляров для этой управляемой группы экземпляров. Удаление или отказ от экземпляров уменьшает это число. Изменение размера группы изменяет это число. | ||
| zone строка / обязательно | Зона, в которой находится управляемая группа экземпляров. | ||
Примеры
- 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-west1
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 instance group manager
google.cloud.gcp_compute_instance_group_manager:
name: test_object
base_instance_name: test1-child
instance_template: "{{ instancetemplate }}"
target_size: 3
zone: us-west1-a
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возврат | Описание | |
|---|---|---|---|
| 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 целое число | успех | Целевое количество работающих экземпляров для этой управляемой группы экземпляров. Удаление или удаление экземпляров уменьшает это число. Изменение размера группы изменяет это число. | |
| zone строка | успех | Зона, в которой находится управляемая группа экземпляров. | |
Авторы
- 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_instance_group_manager_module.html