Spec-Zone.ru › Chef 16

Ресурс google_compute_url_map

Синтаксис

Для тестирования ресурса Google UrlMap используется google_compute_url_map

Ресурс бета-версии

Этот ресурс имеет поля бета-версии. Чтобы получить доступ к этим полям, включите beta: true в конструктор ресурса.

Примеры

describe google_compute_url_map(project: 'chef-gcp-inspec', name: 'inspec-gcp-url-map') do
  it { should exist }
  its('description') { should eq 'URL map description' }
  its('default_service') { should match /\/inspec-gcp-backend-service$/ }
  its('host_rules.count') { should eq 1 }
  its('host_rules.first.hosts') { should include 'site.com' }
  its('path_matchers.count') { should eq 1 }
  its('path_matchers.first.default_service') { should match /\/inspec-gcp-backend-service$/ }
  its('tests.count') { should eq 1 }
  its('tests.first.host') { should eq 'test.com' }
  its('tests.first.path') { should eq '/home' }
end

describe google_compute_url_map(project: 'chef-gcp-inspec', name: 'nonexistent') do
  it { should_not exist }
end

Свойства

Свойства, к которым можно получить доступ из ресурса google_compute_url_map:

creation_timestamp
Дата создания в формате RFC3339.
default_service
Полный или частичный URL ресурса defaultService, на который будет перенаправлен трафик, если ни один из hostRules не совпадёт. Если дополнительно указан defaultRouteAction, будут применены расширенные действия маршрутизации, такие как перенаправление URL, и т. п., прежде чем запрос будет отправлен на бэкенд. Однако, если указан defaultService, defaultRouteAction не может содержать weightedBackendServices. И наоборот, если routeAction содержит weightedBackendServices, service не должен быть указан. Должен быть установлен только один из defaultService, defaultUrlRedirect или defaultRouteAction.weightedBackendService.
description
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
id
Уникальный идентификатор ресурса.
fingerprint
Отпечаток этого ресурса. Хэш содержимого, хранящегося в этом объекте. Это поле используется для оптимистической блокировки.
header_action
Определяет изменения заголовков запроса и ответа, которые должны быть применены для выбранного backendService. Заголовки, указанные здесь, применяются после заголовков, указанных в pathMatcher.
request_headers_to_add
Заголовки, которые необходимо добавить к соответствующему запросу перед передачей запроса в backendService.

header_name : Название заголовка.

header_value : Значение добавляемого заголовка.

replace : Если false, значение headerValue добавляется к уже существующим значениям для заголовка. Если true, значение headerValue устанавливается для заголовка, отбрасывая любые ранее установленные значения для этого заголовка.

request_headers_to_remove
Список имён заголовков, которые необходимо удалить из запроса перед передачей его в backendService.
response_headers_to_add
Заголовки, которые необходимо добавить к ответу перед отправкой ответа клиенту.

header_name : Название заголовка.

header_value : Значение добавляемого заголовка.

replace : Если false, значение headerValue добавляется к уже существующим значениям для заголовка. Если true, значение headerValue устанавливается для заголовка, отбрасывая любые ранее установленные значения для этого заголовка.

response_headers_to_remove
Список имён заголовков, которые необходимо удалить из ответа перед отправкой его клиенту.
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
Список именованных PathMatcher для использования с URL.
default_service
Полный или частичный URL ресурса BackendService. Используется, если ни одно из pathRules или routeRules, определённых этим PathMatcher, не совпадает. Например, следующие являются допустимыми URL для ресурса BackendService: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService. Если дополнительно указан defaultRouteAction, будут применены расширенные действия маршрутизации, такие как перенаправление URL, и т. п., прежде чем запрос будет отправлен на бэкенд. Однако, если указан defaultService, defaultRouteAction не может содержать weightedBackendServices. И наоборот, если defaultRouteAction содержит weightedBackendServices, defaultService не должен быть указан. Должен быть установлен только один из defaultService, defaultUrlRedirect или defaultRouteAction.weightedBackendService. Для авторизации необходимы один или несколько разрешений Google IAM на указанный ресурс defaultService: - compute.backendBuckets.use - compute.backendServices.use
description
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
header_action
Определяет изменения заголовков запроса и ответа, которые должны быть применены для выбранного backendService. Заголовки, указанные здесь, применяются после заголовков, указанных в matching HttpRouteRule HeaderAction и до заголовков в UrlMap.

request_headers_to_add : Заголовки, которые необходимо добавить к соответствующему запросу перед передачей запроса в backendService.

`header_name`
: The name of the header.

`header_value`
: The value of the header to add.

`replace`
: If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

request_headers_to_remove : Список имён заголовков, которые необходимо удалить из запроса перед передачей его в backendService.

response_headers_to_add : Заголовки, которые необходимо добавить к ответу перед отправкой ответа клиенту.

`header_name`
: The name of the header.

`header_value`
: The value of the header to add.

`replace`
: If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

response_headers_to_remove : Список имён заголовков, которые необходимо удалить из ответа перед отправкой его клиенту.

name
Имя, по которому этот PathMatcher ссылается HostRule.
default_url_redirect
Если ни один из указанных hostRules не совпадает, запрос перенаправляется на URL, указанный в defaultUrlRedirect. Если defaultUrlRedirect указан, defaultService или defaultRouteAction не должны быть установлены.

host_redirect : Хост, который будет использоваться в ответе перенаправления вместо того, который был передан в запросе. Значение должно быть между 1 и 255 символами.

https_redirect : Если установлено в true, схема URL в перенаправленном запросе устанавливается в https. Если установлено в false, схема URL перенаправленного запроса останется такой же, как у запроса. Это должно быть установлено только для UrlMaps, используемых в TargetHttpProxys. Установка в true для TargetHttpsProxy запрещена. Значение по умолчанию - false.

path_redirect : Путь, который будет использоваться в ответе перенаправления вместо того, который был передан в запросе. pathRedirect нельзя использовать вместе с prefixRedirect. Укажите один или ни одного. Если ни один не указан, путь исходного запроса будет использоваться для перенаправления. Значение должно быть между 1 и 1024 символами.

prefix_redirect : Префикс, заменяющий prefixMatch, указанный в HttpRouteRuleMatch, сохраняя оставшуюся часть URL перед перенаправлением запроса. prefixRedirect нельзя использовать вместе с pathRedirect. Укажите один или ни одного. Если ни один не указан, путь исходного запроса будет использоваться для перенаправления. Значение должно быть между 1 и 1024 символами.

redirect_response_code : HTTP-код состояния, который нужно использовать для этого RedirectAction. Допустимые значения:

Supported values are:

- MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.
- FOUND, which corresponds to 302.
- SEE_OTHER which corresponds to 303.
- TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.
- PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

strip_query : Если установлено в true, любая сопутствующая часть запроса URL удаляется перед перенаправлением запроса. Если установлено в false, часть запроса URL сохраняется.

tests
Список ожидаемых тестов сопоставления URL. Запрос на обновление UrlMap будет успешным только в том случае, если все тесты пройдут. Вы можете указать не более 100 тестов на UrlMap.

description : Описание этого тестового случая.

host : Часть хоста URL.

path : Часть пути URL.

service : Ожидаемый ресурс BackendService, к которому данный URL должен быть сопоставлен.

default_url_redirect
Если ни один из указанных hostRules не совпадает, запрос перенаправляется на URL, указанный в defaultUrlRedirect. Если defaultUrlRedirect указан, defaultService или defaultRouteAction не должны быть установлены.
host_redirect
Хост, который будет использоваться в ответе перенаправления вместо того, который был передан в запросе. Значение должно быть между 1 и 255 символами.
https_redirect
Если установлено в true, схема URL в перенаправленном запросе устанавливается в https. Если установлено в false, схема URL перенаправленного запроса останется такой же, как у запроса. Это должно быть установлено только для UrlMaps, используемых в TargetHttpProxys. Установка в true для TargetHttpsProxy запрещена. Значение по умолчанию - false.
path_redirect
Путь, который будет использоваться в ответе перенаправления вместо того, который был передан в запросе. pathRedirect нельзя использовать вместе с prefixRedirect. Укажите один или ни одного. Если ни один не указан, путь исходного запроса будет использоваться для перенаправления. Значение должно быть между 1 и 1024 символами.
prefix_redirect
Префикс, заменяющий prefixMatch, указанный в HttpRouteRuleMatch, сохраняя оставшуюся часть URL перед перенаправлением запроса. prefixRedirect нельзя использовать вместе с pathRedirect. Укажите один или ни одного. Если ни один не указан, путь исходного запроса будет использоваться для перенаправления. Значение должно быть между 1 и 1024 символами.
redirect_response_code
HTTP-код состояния, который нужно использовать для этого RedirectAction.

Допустимые значения:

  • MOVED_PERMANENTLY_DEFAULT, значение по умолчанию, соответствует 301.
  • FOUND, соответствует 302.
  • SEE_OTHER соответствует 303.
  • TEMPORARY_REDIRECT, соответствует 307. В этом случае метод запроса будет сохранён.
  • PERMANENT_REDIRECT, соответствует 308. В этом случае метод запроса будет сохранён.
strip_query
Если установлено в true, любая сопутствующая часть запроса URL удаляется перед перенаправлением запроса. Если установлено в false, часть запроса URL сохраняется. Значение по умолчанию - false.

Разрешения GCP

Убедитесь, что API Compute Engine включен для текущего проекта.

© Chef Software, Inc.
Licensed under the Creative Commons Attribution 3.0 Unported License.
The Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission.
We are not affiliated with, endorsed or sponsored by Chef Inc.
https://docs.chef.io/inspec/resources/google_compute_url_map/

Spec-Zone.ru

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