Spec-Zone.ru › Ansible 2.6

gcp_compute_url_map - Создаёт GCP UrlMap

Новая версия с 2.6.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

  • UrlMap используются для перенаправления запросов на службу обратного вызова на основе правил, которые вы определяете для хоста и пути входящего URL-адреса.

Требования

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

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_kind
обязательно
    Варианты:
  • machineaccount
  • serviceaccount
  • application
Тип используемых учетных данных.
default_service
обязательно
Ссылка на ресурс BackendService.
description
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
host_rules
Список HostRules для использования с URL-адресом.
description
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
hosts
Список шаблонов хостов для сопоставления. Они должны быть валидными именами хостов, за исключением *, которое будет соответствовать любой строке ([a-z0-9-.]*). В этом случае * должен быть первым символом и должен следовать за ним либо - или .
path_matcher
Имя PathMatcher, используемого для сопоставления пути части URL-адреса, если hostRule соответствует хосту URL-адреса.
name
Имя ресурса. Указывается клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
path_matchers
Список именованных PathMatchers для использования с URL-адресом.
default_service
Ссылка на ресурс BackendService.
description
Необязательное описание этого ресурса.
name
Имя, к которому ссылается этот PathMatcher в HostRule.
path_rules
Список правил пути.
paths
Список шаблонов путей для сопоставления. Каждый должен начинаться с /, и единственное место, где допускается *, - это в конце после /. Строка, передаваемая в обработчик пути, не включает текст после первого ? или #, и эти символы не допускаются здесь.
service
Ссылка на ресурс BackendService.
project
Проект Google Cloud Platform, который нужно использовать.
scopes
обязательно
Массив используемых областей.
service_account_email
Необязательный адрес электронной почты учётной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file
Путь к файлу JSON учётной записи сервиса, если в качестве типа выбран serviceaccount.
state
обязательно
    Варианты:
  • present ←
  • absent
Требуется ли существование данного объекта в GCP
tests
Список ожидаемых сопоставлений URL-адресов. Запрос на обновление этого UrlMap будет успешным только в том случае, если все тестовые случаи пройдут.
description
Описание этого тестового случая.
host
Часть хоста URL-адреса.
path
Часть пути URL-адреса.
service
Ссылка на ресурс BackendService.

Примечания

Примечание

  • Для аутентификации можно установить service_account_file, используя переменную среды GCP_SERVICE_ACCOUNT_FILE.
  • Для аутентификации можно установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
  • Для аутентификации можно установить auth_kind, используя переменную среды GCP_AUTH_KIND.
  • Для аутентификации можно установить scopes, используя переменную среды GCP_SCOPES.
  • Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
  • Параметры service_account_email и service_account_file взаимоисключают друг друга.

Примеры

- name: create a instance group
  gcp_compute_instance_group:
      name: 'instancegroup-urlmap'
      zone: 'us-central1-a'
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      scopes:
        - https://www.googleapis.com/auth/compute
      state: present
  register: instancegroup
- name: create a http health check
  gcp_compute_http_health_check:
      name: 'httphealthcheck-urlmap'
      healthy_threshold: 10
      port: 8080
      timeout_sec: 2
      unhealthy_threshold: 5
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      scopes:
        - https://www.googleapis.com/auth/compute
      state: present
  register: healthcheck
- name: create a backend service
  gcp_compute_backend_service:
      name: 'backendservice-urlmap'
      backends:
        - group: "{{ instancegroup }}"
      health_checks:
        - "{{ healthcheck.selfLink }}"
      enable_cdn: true
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      scopes:
        - https://www.googleapis.com/auth/compute
      state: present
  register: backendservice
- name: create a url map
  gcp_compute_url_map:
      name: testObject
      default_service: "{{ backendservice }}"
      project: testProject
      auth_kind: service_account
      service_account_file: /tmp/auth.pem
      scopes:
        - https://www.googleapis.com/auth/compute
      state: present

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

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

Ключевые значения Возвращаемое значение Описание
creation_timestamp
str
success
Маркер создания в формате RFC3339.

default_service
dict
success
Ссылка на ресурс BackendService.

description
str
success
Необязательное описание этого ресурса. Укажите при создании ресурса.

host_rules
complex
success
Список HostRules для использования с URL.

description
str
success
Необязательное описание этого ресурса. Укажите при создании ресурса.

hosts
list
success
Список шаблонов хостов для сопоставления. Они должны быть валидными именами хостов, за исключением *, которая будет соответствовать любой строке ([a-z0-9-.]*). В этом случае * должен быть первым символом и должен быть после него либо тире, либо точка.

path_matcher
str
success
Имя PathMatcher для сопоставления части пути URL, если hostRule соответствует хосту URL.

id
int
success
Уникальный идентификатор ресурса.

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

path_matchers
complex
success
Список именованных PathMatchers для использования с URL.

default_service
dict
success
Ссылка на ресурс BackendService.

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

name
str
success
Имя, по которому на этот PathMatcher ссылается HostRule.

path_rules
complex
success
Список правил пути.

paths
list
success
Список шаблонов путей для сопоставления. Каждый должен начинаться с /, и * разрешен только в конце после /. Строка, переданная в обработчик пути, не включает текст после первого ? или #, и эти символы здесь не допускаются.

service
dict
success
Ссылка на ресурс BackendService.

tests
complex
success
Список ожидаемых сопоставлений URL. Запрос на обновление этого UrlMap будет успешным только в том случае, если все тестовые сценарии пройдут.

description
str
success
Описание этого тестового сценария.

host
str
success
Часть хоста URL.

path
str
success
Часть пути URL.

service
dict
success
Ссылка на ресурс BackendService.



Статус

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

Техническое обслуживание

Этот модуль помечен как сообщественный, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

  • Google Inc. (@googlecloudplatform)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/gcp_compute_url_map_module.html

Spec-Zone.ru

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