gcp_compute_instance_group_manager – Создаёт управляемую группу виртуальных машин GCP
Новая в версии 2.6.
Синопсис
- Создаёт управляемую группу виртуальных машин с использованием информации, указанной в запросе. После создания группы, планируется действие по созданию виртуальных машин в группе с использованием указанной шаблона виртуальной машины. Эта операция помечается как ЗАВЕРШЕНО, когда группа создана, даже если виртуальные машины в группе ещё не созданы. Вы должны отдельно проверить статус отдельных виртуальных машин.
- Управляемая группа виртуальных машин может содержать до 1000 виртуальных машин на группу.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. | |
| base_instance_name - / обязательно | Базовое имя виртуальной машины для использования в этой группе. Значение должно быть длиной от 1 до 58 символов. Имена виртуальных машин образуются путём добавления дефиса и случайной четырёхзначной строки к базовому имени виртуальной машины. Базовое имя виртуальной машины должно соответствовать RFC1035. | ||
| description - | Необязательное описание этого ресурса. Укажите эту свойство при создании ресурса. | ||
| instance_template - / обязательно | Шаблон виртуальной машины, указанный для этой управляемой группы виртуальных машин. Группа использует этот шаблон для создания всех новых виртуальных машин в управляемой группе виртуальных машин. | ||
| name - / обязательно | Имя управляемой группы виртуальных машин. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. | ||
| named_ports - | Названные порты, настроенные для групп виртуальных машин, дополняющих эту управляемую группу виртуальных машин. | ||
| name - | Имя для этого названного порта. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. | ||
| port - | Номер порта, который может быть значением от 1 до 65535. | ||
| project - | По умолчанию: null | Проект Google Cloud Platform для использования. | |
| scopes - | Массив используемых областей. | ||
| service_account_email - | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | ||
| service_account_file - | Путь к файлу JSON учетной записи службы, если в качестве типа выбрано serviceaccount. | ||
| state - |
| Следует ли данному объекту существовать в GCP | |
| target_pools - | Ресурсы TargetPool, к которым добавляются виртуальные машины в поле instanceGroup. Целевые пулы автоматически применяются ко всем виртуальным машинам в управляемой группе виртуальных машин. | ||
| target_size - | Целевое количество работающих виртуальных машин для этой управляемой группы виртуальных машин. Удаление или отказ от виртуальных машин уменьшает это число. Изменение размера группы изменяет это число. | ||
| zone - / обязательно | Зона, в которой находится управляемая группа виртуальных машин. | ||
Примечания
Примечание
- Для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a network
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
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
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
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: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| base_instance_name строка | успех | Базовое имя экземпляра для использования в этой группе. Значение должно быть длиной от 1 до 58 символов. Имена экземпляров образуются путем добавления дефиса и случайной четырёхсимвольной строки к базовому имени экземпляра. Базовое имя экземпляра должно соответствовать RFC1035. | |
| creation_timestamp строка | успех | Маркер времени создания этой управляемой группы экземпляров в формате RFC3339. | |
| current_actions сложное | успех | Список действий для экземпляров и количество экземпляров в этой управляемой группе экземпляров, запланированных для каждого из этих действий. | |
| abandoning целое число | успех | Общее количество экземпляров в управляемой группе экземпляров, запланированных для отмены. Отмена экземпляра удаляет его из управляемой группы экземпляров без удаления самого экземпляра. | |
| creating целое число | успех | Количество экземпляров в управляемой группе экземпляров, которые запланированы для создания или в данный момент создаются. Если группе не удаётся создать какой-либо из этих экземпляров, она пытается снова, пока не создаст экземпляр успешно. Если повторные попытки создания отключены, это поле не будет заполняться; вместо этого будет заполнено поле creatingWithoutRetries. | |
| creating_without_retries целое число | успех | Количество экземпляров, которые управляемая группа экземпляров попытается создать. Группа пытается создать каждый экземпляр только один раз. Если группе не удаётся создать какой-либо из этих экземпляров, она уменьшает значение targetSize группы соответственно. | |
| deleting целое число | успех | Количество экземпляров в управляемой группе экземпляров, которые запланированы для удаления или в данный момент удаляются. | |
| none целое число | успех | Количество экземпляров в управляемой группе экземпляров, которые работают и для которых не запланированы действия. | |
| recreating целое число | успех | Количество экземпляров в управляемой группе экземпляров, которые запланированы для пересоздания или в данный момент пересоздаются. Пересоздание экземпляра удаляет существующий корневой постоянный диск и создает новый диск из образа, определенного в шаблоне экземпляра. | |
| refreshing целое число | успех | Количество экземпляров в управляемой группе экземпляров, которые переконфигурируются с помощью свойств, для которых не требуется перезапуск или пересоздание. Например, установка или удаление целевых пулов для экземпляра. | |
| restarting целое число | успех | Количество экземпляров в управляемой группе экземпляров, которые запланированы для перезапуска или в данный момент перезапускаются. | |
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| id целое число | успех | Уникальный идентификатор этого ресурса. | |
| instance_group словарь | успех | Управляемая группа экземпляров. | |
| instance_template словарь | успех | Шаблон экземпляра, указанный для этой управляемой группы экземпляров. Группа использует этот шаблон для создания всех новых экземпляров в управляемой группе экземпляров. | |
| name строка | успех | Имя управляемой группы экземпляров. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. | |
| named_ports сложное | успех | Настроенные именованные порты для групп экземпляров, дополняющие эту группу управляемых экземпляров. | |
| name строка | успех | Имя для этого именованного порта. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. | |
| port целое число | успех | Номер порта, значение которого может быть от 1 до 65535. | |
| region строка | успех | Регион, в котором находится эта управляемая группа экземпляров (для региональных ресурсов). | |
| target_pools список | успех | Ресурсы TargetPool, к которым добавляются экземпляры из поля instanceGroup. Целевые пулы автоматически применяются ко всем экземплярам в управляемой группе экземпляров. | |
| target_size целое число | успех | Целевое количество работающих экземпляров для этой управляемой группы экземпляров. Удаление или отмена экземпляров уменьшает это число. Изменение размера группы изменяет это число. | |
| zone строка | успех | Зона, в которой находится управляемая группа экземпляров. | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_compute_instance_group_manager_module.html