Spec-Zone.ru › Ansible 2.10

community.general.gce – создание или завершение работы экземпляров GCE

Примечание

Этот плагин является частью коллекции community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general

Для использования в книге задач, укажите: community.general.gce

  • УСТАРЕЛО
  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Статус

УСТАРЕЛО

Удалено в

версии 2.0.0

Почему

Выпущены обновлённые модули с расширенными функциями

Альтернатива

Используйте google.cloud.gcp_compute_instance вместо этого.

Описание

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

псевдонимы: base_name
network
строка
Значение по умолчанию:
"default"
имя сети, 'default' используется, если не указано
num_instances
целое число
можно использовать с 'name', указывает количество узлов для развёртывания, используя 'name' в качестве базового имени
pem_file
путь
путь к файлу pem, связанному с электронным адресом учетной записи сервиса. Этот параметр устарел. Используйте 'credentials_file'.
persistent_boot_disk
булево
    Варианты:
  • нет ←
  • да
если установлено, то создается экземпляр с постоянным загрузочным диском
preemptible
булево
    Варианты:
  • нет
  • да
если установлено в yes, экземпляры будут преемственными и ограниченными по времени. (требуется libcloud >= 0.20.0)
project_id
строка
ваш ID проекта GCE
service_account_email
строка
электронный адрес учетной записи сервиса
service_account_permissions
список / элементы=строка
разрешения учетной записи сервиса (см. https://cloud.google.com/sdk/gcloud/reference/compute/instances/create, раздел --scopes для получения подробной информации)
Доступные варианты: 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.
state
строка
    Варианты:
  • активный
  • настоящий ←
  • отсутствующий
  • удаленный
  • запущенный
  • остановленный
  • завершённый
желаемое состояние ресурса
subnetwork
строка
имя подсети, в которой должен быть создан экземпляр
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)
  - community.general.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.
  - community.general.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.
  - community.general.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.
      community.general.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
      ansible.builtin.add_host:
        hostname: "{{ item.public_ip }}"
        groupname: gce_instances_ips
      with_items: "{{ gce.instance_data }}"

    - name: Wait for SSH for instances
      ansible.builtin.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.
      community.general.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

Статус

  • Этот модуль будет удалён в версии 2.0.0. [устарел]
  • Для получения более подробной информации, см. УСТАРЕЛО.

Авторы

  • 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.10/collections/community/general/gce_module.html

Spec-Zone.ru

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