community.general.gcp_url_map – Создание, обновление или удаление карты URL.
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.gcp_url_map.
УСТЕРЕГЛО
- Удалено в
-
версии 2.0.0
- Почему
-
Обновлённые модули выпущены с повышенной функциональностью
- Альтернатива
-
Используйте google.cloud.gcp_compute_url_map вместо этого.
Описание
- Создание, обновление или удаление карты URL. См. https://cloud.google.com/compute/docs/load-balancing/http/url-map для обзора. Более подробные сведения об API карты URL можно найти по адресу https://cloud.google.com/compute/docs/reference/latest/urlMaps#resource.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- google-api-python-client >= 1.6.2
- google-auth >= 0.9.0
- google-auth-httplib2 >= 0.0.2
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| credentials_file строка | Путь к JSON-файлу, связанному с электронным адресом учётной записи сервиса. | |
| default_service строка / обязательно | Умолчание по умолчанию если ни одно правило хоста не соответствует. | |
| host_rules список / элементы=строка | Список HostRules для использования с URL. Содержит список хостов и связанный с ним path_matcher. Параметр 'hosts' — список шаблонов хостов для сопоставления. Они должны быть допустимыми именами хостов, за исключением * будет соответствовать любой строке ([a-z0-9-.]*). В этом случае * должен быть первым символом и должен быть после него в шаблоне либо - либо .. Параметр 'path_matcher' — имя PathMatcher для использования для сопоставления пути URL, если hostRule соответствует хосту URL. | |
| path_matchers список / элементы=строка | Список именованных PathMatchers для использования с URL. Содержит path_rules, которые представляют собой список путей и связанную службу. Также можно указать default_service для каждого path_matcher. Параметр 'name', с помощью которого host_rule ссылается на этот path_matcher. Параметр 'default_service' — имя ресурса BackendService. Он будет использоваться, если ни одно из path_rules, определённых этим path_matcher, не соответствует пути URL. Параметр 'path_rules' — список словарей, содержащих список путей и службу для направления трафика. Каждый элемент пути должен начинаться с /, и единственное место, где разрешено использование *, — в конце, за которым следует /. Строка, передаваемая path matcher, не включает текст после первого ? или | |
| pem_file строка | Путь к PEM-файлу, связанному с электронным адресом учётной записи сервиса. Этот параметр устарел и может быть удален в будущих выпусках. Используйте credentials_file вместо него. | |
| project_id строка | Идентификатор проекта Google Cloud Platform. | |
| service_account_email строка | Электронный адрес учётной записи сервиса | |
| service_account_permissions список / элементы=строка | Разрешения учётной записи сервиса | |
| state строка |
| Состояние, в котором должна находиться карта URL. Только present или absent являются допустимыми вариантами. |
| url_map_name строка / обязательно | Имя карты URL. |
Примечания
Примечание
- Поддерживает только глобальные Backend Services.
- Тестирование карт URL в настоящее время не поддерживается.
Примеры
- name: Create Minimal Url_Map
community.general.gcp_url_map:
service_account_email: "{{ service_account_email }}"
credentials_file: "{{ credentials_file }}"
project_id: "{{ project_id }}"
url_map_name: my-url_map
default_service: my-backend-service
state: present
- name: Create UrlMap with pathmatcher
community.general.gcp_url_map:
service_account_email: "{{ service_account_email }}"
credentials_file: "{{ credentials_file }}"
project_id: "{{ project_id }}"
url_map_name: my-url-map-pm
default_service: default-backend-service
path_matchers:
- name: 'path-matcher-one'
description: 'path matcher one'
default_service: 'bes-pathmatcher-one-default'
path_rules:
- service: 'my-one-bes'
paths:
- '/data'
- '/aboutus'
host_rules:
- hosts:
- '*.'
path_matcher: 'path-matcher-one'
state: "present"
Возвращаемые значения
Общие значения возврата описаны здесь, следующие — это поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| host_rules словарь | Если указано. | Список HostRules. Пример: [{'hosts': ['*.'], 'path_matcher': 'my-pm'}] |
| path_matchers словарь | Если указано. | Список именованных PathMatchers для использования с URL. Пример: [{'name': 'my-pm', 'path_rules': [{'paths': ['/data']}], 'service': 'my-service'}] |
| state строка | Всегда. | Состояние карты URL Пример: present |
| updated_url_map булево | если карта url была обновлена. | True, если карта url была обновлена. Не будет отображаться при первоначальном создании карты url. Пример: True |
| url_map словарь | Всегда. Обратитесь к документации GCP для подробного описания полей. | Словарь GCP Url_Map Пример: {'hostRules': ['...'], 'name': 'my-url-map', 'pathMatchers': ['...']} |
| url_map_name строка | Всегда | Имя карты URL Пример: my-url-map |
Статус
- Этот модуль будет удален в версии 2.0.0. [устарел]
- Дополнительную информацию см. в разделе УСТЕРЕГЛО.
Авторы
- Tom Melendez (@supertom) <tom@supertom.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/gcp_url_map_module.html