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 при использовании предварительного варианта
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| credentials_file (добавлен в 2.1.0)
|
нет | путь к JSON-файлу, связанному с адресом электронной почты учетной записи службы |
||
| disk_auto_delete (добавлен в 1.9)
|
нет | true | если установлено, то системный диск будет удален после уничтожения экземпляра |
|
| 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 (добавлен в 1.9)
|
нет | false | установите в true, если экземпляр может пересылать пакеты IP (полезно для шлюзов) |
|
| machine_type |
нет | n1-standard-1 | тип машины, используемый для экземпляра, по умолчанию 'n1-standard-1' |
|
| metadata |
нет | хеш/словарь пользовательских данных для экземпляра; '{"key":"value", ...}' |
||
| 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 |
нет | false | если установлено, то создаётся экземпляр с постоянным системным диском |
|
| preemptible (добавлен в 2.1)
|
нет | false | если установлено в true, то экземпляры будут предварительными и ограничены по времени. (требуется 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 |
нет | present |
|
требуемое состояние ресурса |
| subnetwork (добавлен в 2.2)
|
нет | имя подсети, в которой должен быть создан экземпляр |
||
| tags |
нет | список тегов через запятую, которые нужно добавить к экземпляру |
||
| zone |
да | us-central1-a | зона GCE. Список доступных зон находится по адресу https://cloud.google.com/compute/docs/regions-zones/regions-zones#available. |
Примеры
# 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
Примечания
Примечание
- Требуется либо instance_names, либо name.
- JSON-аутентификация предпочтительнее.
Статус
Этот модуль помечен как превью, что означает, что гарантии обратной совместимости интерфейса нет.
Для помощи в разработке модулей, если вы захотите, пожалуйста, ознакомьтесь с Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/gce_module.html