Spec-Zone.ru › Ansible 2.5

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)
Значение по умолчанию:
None
путь к JSON-файлу, связанному с электронным адресом учетной записи службы
disk_auto_delete
(добавлен в 1.9)
Значение по умолчанию:
true
если установлено, диск по умолчанию будет удалён после уничтожения экземпляра
disk_size
(добавлен в 2.3)
Значение по умолчанию:
10
Размер диска по умолчанию, создаваемого для этого экземпляра (в ГБ)
disks
(добавлен в 1.7)
Значение по умолчанию:
None
список постоянных дисков, которые необходимо подключить к экземпляру; строковое значение задаёт имя диска; в качестве альтернативы, значение словаря может определить 'name' и 'mode' ('READ_ONLY' или 'READ_WRITE'). Первый элемент будет диском по умолчанию (который должен быть READ_WRITE).
external_ip
(добавлен в 1.9)
Значение по умолчанию:
ephemeral
тип внешнего IP-адреса, по умолчанию временный; в качестве альтернативы можно указать фиксированный IP-адрес gce или имя IP-адреса. Укажите 'none', если внешний IP-адрес не нужен.
external_projects
(добавлен в 2.4)
Значение по умолчанию:
None
Список других проектов (доступных с учетными данными предоставления) для поиска образа.
image Значение по умолчанию:
debian-8
строковое представление образа для использования в экземпляре (значение по умолчанию соответствует последнему стабильному образу debian)
image_family
(добавлен в 2.4)
Значение по умолчанию:
None
семейство образов, из которого следует выбрать образ. Будет использован последний не устаревший образ в семействе.
instance_names Значение по умолчанию:
None
список имён экземпляров, разделённых запятыми, для создания или удаления
ip_forward
(добавлен в 1.9)
Значение по умолчанию:
false
установите в значение true, если экземпляр может передавать пакеты IP (полезно для шлюзов)
machine_type Значение по умолчанию:
n1-standard-1
тип машины для использования в экземпляре, по умолчанию используется 'n1-standard-1'
metadata Значение по умолчанию:
None
словарь/хеш с пользовательными данными для экземпляра; '{"key":"value", ...}'
name
имя отдельного экземпляра или, когда используется с 'num_instances', базовое имя кластера узлов

псевдонимы: base_name
network Значение по умолчанию:
default
имя сети, если не указано, будет использоваться 'default'
num_instances
(добавлен в 2.3)
можно использовать с 'name', указывает количество узлов, которые необходимо развернуть, используя 'name' в качестве базового имени
pem_file
(добавлен в 1.5.1)
Значение по умолчанию:
None
путь к файлу pem, связанному с электронным адресом учетной записи службы. Этот параметр устарел. Используйте 'credentials_file'.
persistent_boot_disk Значение по умолчанию:
false
если установлено, создать экземпляр с постоянным загрузочным диском
preemptible
(добавлен в 2.1)
Значение по умолчанию:
false
если установлено в значение true, экземпляры будут временными и ограниченными по времени. (требуется libcloud >= 0.20.0)
project_id
(добавлен в 1.5.1)
Значение по умолчанию:
None
ваш идентификатор проекта GCE
service_account_email
(добавлен в 1.5.1)
Значение по умолчанию:
None
электронный адрес учетной записи службы
service_account_permissions
(добавлено в 2.0)
    Варианты:
  • bigquery
  • cloud-platform
  • compute-ro
  • compute-rw
  • useraccounts-ro
  • useraccounts-rw
  • datastore
  • logging-write
  • monitoring
  • sql-admin
  • storage-full
  • storage-ro
  • storage-rw
  • taskqueue
  • userinfo-email
По умолчанию:
None
разрешения учетной записи сервиса (см. https://cloud.google.com/sdk/gcloud/reference/compute/instances/create, раздел --scopes для получения подробной информации)
state
    Варианты:
  • active
  • present ←
  • absent
  • deleted
  • started
  • stopped
  • terminated
желаемое состояние ресурса
subnetwork
(добавлено в 2.2)
По умолчанию:
None
имя подсети, в которой должен быть создан экземпляр
tags По умолчанию:
None
список тегов, разделенных запятыми, которые необходимо привязать к экземпляру
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

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

  • Eric Johnson (@erjohnso) <erjohnso@google.com>, Tom Melendez (@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.5/modules/gce_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API