Spec-Zone.ru › Ansible 2.11

google.cloud.gcp_compute_target_instance – Создаёт GCP TargetInstance

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).

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

Для использования в книге задач укажите: google.cloud.gcp_compute_target_instance.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Представляет ресурс TargetInstance, определяющий экземпляр конечной точки, который завершает трафик определённых протоколов. В частности, они используются в Протокольной передаче, где правила переадресации могут отправлять пакеты в не-NAT'ированный целевой экземпляр. Каждый целевой экземпляр содержит единственный виртуальный машинны экземпляр, который принимает и обрабатывает трафик от соответствующих правил переадресации.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_kind
строка / обязательно
    Варианты:
  • application
  • machineaccount
  • serviceaccount
Тип используемых учетных данных.
description
строка
Необязательное описание этого ресурса.
env_type
строка
Указывает, в какой среде Ansible вы выполняете этот модуль.
Это не должно устанавливаться, если вы не знаете, что делаете.
Это изменяет только строку User Agent для всех запросов API.
instance
словарь / обязательно
Ссылка на виртуальный машинны экземпляр, который обрабатывает трафик для этого целевого экземпляра. Принимает самоссылку или частичные пути в формате `projects/project/zones/zone/instances/instance` или `zones/zone/instances/instance`.
Это поле представляет ссылку на ресурс Instance в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением самоссылкой своего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` в задачу gcp_compute_instance, а затем установить это поле instance в "{{ имя-ресурса }}"
name
строка / обязательно
Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
nat_policy
строка
Значение по умолчанию:
"NO_NAT"
Параметр NAT, контролирующий, как IP-адреса NAT'ятся на экземпляр.
В настоящее время поддерживается только NO_NAT (значение по умолчанию).
Некоторые допустимые варианты включают: "NO_NAT"
project
строка
Проект Google Cloud Platform, который нужно использовать.
scopes
список / элементы=строка
Массив из используемых областей
service_account_contents
jsonarg
Содержание файла JSON учетной записи службы, либо в словаре, либо как JSON-строка, которая его представляет.
service_account_email
строка
Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file
путь
Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state
строка
    Варианты:
  • present ←
  • absent
Указывает, должен ли данный объект существовать в GCP
zone
строка / обязательно
Ссылка на зону, в которой находится целевой экземпляр.

Примечания

Примечание

  • Справочник API: https://cloud.google.com/compute/docs/reference/v1/targetInstances
  • Использование протокольной переадресации: https://cloud.google.com/compute/docs/protocol-forwarding
  • для аутентификации можно установить service_account_file используя переменную среды gcp_service_account_file.
  • для аутентификации можно установить service_account_contents используя переменную среды GCP_SERVICE_ACCOUNT_CONTENTS.
  • для аутентификации можно установить service_account_email используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
  • для аутентификации можно установить auth_kind используя переменную среды GCP_AUTH_KIND.
  • для аутентификации можно установить scopes используя переменную среды GCP_SCOPES.
  • Значения переменных среды будут использоваться только в том случае, если значения в книге задач не установлены.
  • Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a network
  google.cloud.gcp_compute_network:
    name: network-instance
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a instance
  google.cloud.gcp_compute_instance:
    name: "{{ resource_name }}"
    machine_type: n1-standard-1
    disks:
    - auto_delete: 'true'
      boot: 'true'
      initialize_params:
        source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts
    labels:
      environment: production
    network_interfaces:
    - network: "{{ network }}"
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instance

- name: create a target instance
  google.cloud.gcp_compute_target_instance:
    name: target
    instance: "{{ instance }}"
    zone: us-central1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ Возвращаемое значение Описание
creationTimestamp
строка
успех
Время создания в формате RFC3339.

description
строка
успех
Необязательное описание этого ресурса.

instance
словарь
успех
Ссылка на виртуальный машинны экземпляр, который обрабатывает трафик для этого целевого экземпляра. Принимает самоссылку или частичные пути в формате `projects/project/zones/zone/instances/instance` или `zones/zone/instances/instance`.

name
строка
успех
Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.

natPolicy
строка
успех
Параметр NAT, контролирующий, как IP-адреса NAT'ятся на экземпляр.
В настоящее время поддерживается только NO_NAT (значение по умолчанию).

zone
строка
успех
Ссылка на зону, в которой находится целевой экземпляр.



Авторы

  • Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_target_instance_module.html

Spec-Zone.ru

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