gcp_compute_url_map – Создаёт GCP UrlMap
Новая версия с 2.6.
Обзор
- UrlMap используются для перенаправления запросов на службу бэкэнда на основе правил, определённых для хоста и пути входящего URL.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. | ||
| default_service - / обязательно | Ссылка на ресурс BackendService, если ни одно из правил hostRules не соответствует. | |||
| 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. Будет использоваться, если ни одно из правил pathRules, определённых этим PathMatcher, не соответствует пути URL. | |||
| description - | Необязательное описание этого ресурса. | |||
| name - | Имя, которому ссылается этот PathMatcher в HostRule. | |||
| path_rules - | Список правил пути. | |||
| paths - | Список шаблонов путей для сопоставления. Каждый должен начинаться с /, и единственное место, где допускается *, — это в конце после /. Строка, переданная в path matcher, не включает текст после первого ? или #, и эти символы здесь не допускаются. | |||
| service - | Ссылка на ресурс BackendService, если это правило соответствует. | |||
| project - | По умолчанию: null | Проект Google Cloud Platform для использования. | ||
| scopes - | Массив используемых областей. | |||
| service_account_email - | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. | |||
| service_account_file - | Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран. | |||
| state - |
| Определяет, должен ли данный объект существовать в GCP. | ||
| tests - | Список ожидаемых сопоставлений URL. Запрос на обновление UrlMap будет успешным только в том случае, если пройдут все тестовые случаи. | |||
| description - | Описание этого тестового случая. | |||
| host - | Часть хоста URL. | |||
| path - | Часть пути URL. | |||
| service - | Ссылка на ожидаемый ресурс BackendService, к которому должен быть сопоставлен данный URL. | |||
Примечания
Примечание
- Для аутентификации можно установить 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 }}"
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 }}"
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 }}"
state: present
register: backendservice
- name: create a url map
gcp_compute_url_map:
name: "test_object"
default_service: "{{ backendservice }}"
project: "test_project"
auth_kind: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| creation_timestamp строка | успех | Маркер времени создания в формате RFC3339. | ||
| default_service словарь | успех | Ссылка на ресурс BackendService, если ни один из hostRules не соответствует. | ||
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | ||
| host_rules сложный тип | успех | Список HostRules для использования с URL. | ||
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | ||
| hosts список | успех | Список шаблонов хостов для сопоставления. Они должны быть валидными именами хостов, за исключением *, которая будет соответствовать любой строке ([a-z0-9-.]*). В этом случае * должен быть первым символом и должен следовать за ним либо - либо . | ||
| path_matcher строка | успех | Имя PathMatcher для сопоставления пути части URL, если hostRule соответствует хосту URL. | ||
| id целое число | успех | Уникальный идентификатор ресурса. | ||
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | ||
| path_matchers сложный тип | успех | Список именованных PathMatchers для использования с URL. | ||
| default_service словарь | успех | Ссылка на ресурс BackendService. Будет использоваться, если ни один из pathRules, определенных этим PathMatcher, не соответствует пути URL. | ||
| description строка | успех | Необязательное описание этого ресурса. | ||
| name строка | успех | Имя, по которому HostRule ссылается на этот PathMatcher. | ||
| path_rules сложный тип | успех | Список правил путей. | ||
| paths список | успех | Список шаблонов путей для сопоставления. Каждый должен начинаться с /, а * разрешен только в конце, после /. Строка, передаваемая в path matcher, не включает текст после первого ? или #, и эти символы здесь недопустимы. | ||
| service словарь | успех | Ссылка на ресурс BackendService, если это правило соответствует. | ||
| tests сложный тип | успех | Список ожидаемых сопоставлений URL. Запрос на обновление UrlMap будет успешным только в том случае, если пройдут все тестовые случаи. | ||
| description строка | успех | Описание этого тестового случая. | ||
| host строка | успех | Часть хоста URL. | ||
| path строка | успех | Часть пути URL. | ||
| service словарь | успех | Ссылка на ожидаемый ресурс BackendService, которому должен соответствовать данный URL. | ||
Состояние
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/gcp_compute_url_map_module.html