gce – создание или завершение работы экземпляров GCE
Новое в версии 1.4.
Описание
- Создаёт или завершает работу экземпляров Google Compute Engine (GCE). См. https://cloud.google.com/compute для общего обзора. Полные инструкции по установке и настройке модулей gce* можно найти в комментариях в файле ansible/test/gce_tests.py.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- apache-libcloud >= 0.13.3, >= 0.17.0 при использовании JSON-креденциалов, >= 0.20.0 при использовании опции preemptible
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| credentials_file - добавлен в 2.1.0 | путь к JSON-файлу, связанному с электронным адресом учетной записи службы | |
| disk_auto_delete boolean добавлен в 1.9 |
| если установлено, то диск загрузки будет удалён после уничтожения экземпляра |
| disk_size - добавлен в 2.3 | По умолчанию: 10 | Размер диска загрузки, создаваемого для этого экземпляра (в ГБ) |
| disks - добавлен в 1.7 | список постоянных дисков, которые необходимо подключить к экземпляру; строковое значение указывает имя диска; в качестве альтернативы, значение словаря может определять 'name' и 'mode' ('READ_ONLY' или 'READ_WRITE'). Первое значение будет диском загрузки (который должен быть READ_WRITE). | |
| external_ip - добавлен в 1.9 | По умолчанию: "ephemeral" | тип внешнего IP-адреса, по умолчанию ephemeral; в качестве альтернативы можно указать фиксированный IP-адрес GCE или имя IP-адреса. Укажите 'none', если внешний IP-адрес не требуется. |
| external_projects - добавлен в 2.4 | Список других проектов (доступных с учетными данными для предоставления) для поиска образа. | |
| image - | По умолчанию: "debian-8" | имя образа для использования в экземпляре (значение по умолчанию будет соответствовать последнему стабильному образу debian) |
| image_family - добавлен в 2.4 | семейство образов для выбора образа. Будет использован последний не устаревший образ в семействе. | |
| instance_names - | список имён экземпляров, которые необходимо создать или уничтожить, разделённые запятыми | |
| ip_forward boolean добавлен в 1.9 |
| установлено в yes если экземпляр может пересылать IP-пакеты (полезно для шлюзов) |
| machine_type - | По умолчанию: "n1-standard-1" | тип машины для использования в экземпляре, по умолчанию используется 'n1-standard-1' |
| metadata - | словарь пользовательских данных для экземпляра; '{"ключ":"значение", ...}' | |
| name - | либо имя отдельного экземпляра, либо, при использовании с 'num_instances', базовое имя кластера узлов псевдонимы: base_name | |
| network - | По умолчанию: "default" | имя сети, по умолчанию используется 'default' |
| num_instances - добавлен в 2.3 | может использоваться с 'name', указывает количество узлов, которые необходимо предоставить, используя 'name' в качестве базового имени | |
| pem_file - добавлен в 1.5.1 | путь к файлу pem, связанному с электронным адресом учетной записи службы. Этот параметр устарел. Используйте 'credentials_file'. | |
| persistent_boot_disk boolean |
| если установлено, то создаётся экземпляр с постоянным диском загрузки |
| preemptible boolean добавлен в 2.1 |
| если установлено в yes, экземпляры будут временными и ограниченными по времени. (требуется libcloud >= 0.20.0) |
| project_id - добавлен в 1.5.1 | ваш идентификатор проекта GCE | |
| service_account_email - добавлен в 1.5.1 | электронный адрес учетной записи службы | |
| service_account_permissions - добавлен в 2.0 |
| разрешения учетной записи службы (см. https://cloud.google.com/sdk/gcloud/reference/compute/instances/create, раздел --scopes для подробной информации) |
| state - |
| желаемое состояние ресурса |
| subnetwork - добавлен в 2.2 | имя подсети, в которой должен быть создан экземпляр | |
| tags - | список тегов, разделённых запятыми, которые необходимо ассоциировать с экземпляром | |
| zone - / обязательно | По умолчанию: "us-central1-a" | зона GCE для использования. Список доступных зон находится по адресу https://cloud.google.com/compute/docs/regions-zones/regions-zones#available. |
Примечания
Примечание
- Требуется либо instance_names, либо name.
- JSON-креденциалы предпочтительнее.
Примеры
# Basic provisioning example. Create a single Debian 8 instance in the
# us-central1-a Zone of the n1-standard-1 machine type.
# Create multiple instances by specifying multiple names, separated by
# commas in the instance_names field
# (e.g. my-test-instance1,my-test-instance2)
- gce:
instance_names: my-test-instance1
zone: us-central1-a
machine_type: n1-standard-1
image: debian-8
state: present
service_account_email: "your-sa@your-project-name.iam.gserviceaccount.com"
credentials_file: "/path/to/your-key.json"
project_id: "your-project-name"
disk_size: 32
# Create a single instance of an image from the "my-base-image" image family
# in the us-central1-a Zone of the n1-standard-1 machine type.
# This image family is in the "my-other-project" GCP project.
- gce:
instance_names: my-test-instance1
zone: us-central1-a
machine_type: n1-standard-1
image_family: my-base-image
external_projects:
- my-other-project
state: present
service_account_email: "your-sa@your-project-name.iam.gserviceaccount.com"
credentials_file: "/path/to/your-key.json"
project_id: "your-project-name"
disk_size: 32
# Create a single Debian 8 instance in the us-central1-a Zone
# Use existing disks, custom network/subnetwork, set service account permissions
# add tags and metadata.
- gce:
instance_names: my-test-instance
zone: us-central1-a
machine_type: n1-standard-1
state: present
metadata: '{"db":"postgres", "group":"qa", "id":500}'
tags:
- http-server
- my-other-tag
disks:
- name: disk-2
mode: READ_WRITE
- name: disk-3
mode: READ_ONLY
disk_auto_delete: false
network: foobar-network
subnetwork: foobar-subnetwork-1
preemptible: true
ip_forward: true
service_account_permissions:
- storage-full
- taskqueue
- bigquery
- https://www.googleapis.com/auth/ndev.clouddns.readwrite
service_account_email: "your-sa@your-project-name.iam.gserviceaccount.com"
credentials_file: "/path/to/your-key.json"
project_id: "your-project-name"
---
# Example Playbook
- name: Compute Engine Instance Examples
hosts: localhost
vars:
service_account_email: "your-sa@your-project-name.iam.gserviceaccount.com"
credentials_file: "/path/to/your-key.json"
project_id: "your-project-name"
tasks:
- name: create multiple instances
# Basic provisioning example. Create multiple Debian 8 instances in the
# us-central1-a Zone of n1-standard-1 machine type.
gce:
instance_names: test1,test2,test3
zone: us-central1-a
machine_type: n1-standard-1
image: debian-8
state: present
service_account_email: "{{ service_account_email }}"
credentials_file: "{{ credentials_file }}"
project_id: "{{ project_id }}"
metadata : '{ "startup-script" : "apt-get update" }'
register: gce
- name: Save host data
add_host:
hostname: "{{ item.public_ip }}"
groupname: gce_instances_ips
with_items: "{{ gce.instance_data }}"
- name: Wait for SSH for instances
wait_for:
delay: 1
host: "{{ item.public_ip }}"
port: 22
state: started
timeout: 30
with_items: "{{ gce.instance_data }}"
- name: Configure Hosts
hosts: gce_instances_ips
become: yes
become_method: sudo
roles:
- my-role-one
- my-role-two
tags:
- config
- name: delete test-instances
# Basic termination of instance.
gce:
service_account_email: "{{ service_account_email }}"
credentials_file: "{{ credentials_file }}"
project_id: "{{ project_id }}"
instance_names: "{{ gce.instance_names }}"
zone: us-central1-a
state: absent
tags:
- delete
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Эрик Джонсон (@erjohnso) <erjohnso@google.com>, Том Мелендез (@supertom) <supertom@google.com>
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/gce_module.html