Модуль google.cloud.gcp_compute_target_instance – Создаёт экземпляр GCP TargetInstance

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.4.1).

У вас, возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для деталей.

Чтобы использовать его в playbook, укажите: google.cloud.gcp_compute_target_instance.

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

Обзор

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

Требования

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description строка	Необязательное описание этого ресурса.
env_type строка	Указывает, в какой среде Ansible вы выполняете этот модуль. Это не должно устанавливаться, если вы не знаете, что делаете. Это изменяет только строку User-Agent для любых запросов API.
instance словарь / обязательно	Ссылка на виртуальный экземпляр машины, обрабатывающий трафик для этой конечной точки. Принимает самоссылки или частичные пути в формате `projects/project/zones/zone/instances/instance’ или `zones/zone/instances/instance` . Это поле представляет ссылку на ресурс Instance в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_compute_instance, а затем установить это поле instance на «{{ name-of-resource }}»
name строка / обязательно	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.
nat_policy строка	Параметр NAT, контролирующий, как IP-адреса NAT-преобразуются для экземпляра. В настоящее время поддерживается только NO_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 строка	Указывает, должен ли заданный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`
zone строка / обязательно	URL зоны, где находится экземпляр конечной точки.

Примечания

Примечание

Ссылка на 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.
Для аутентификации можно установить access_token с помощью переменной среды GCP_ACCESS_TOKEN.
Для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры 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-адреса переадресовываются на экземпляр. В настоящее время поддерживается только NO_NAT (значение по умолчанию). Возвращается: успешно
zone строка	URL зоны, в которой находится целевой экземпляр. Возвращается: успешно

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

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