Spec-Zone.ru › Chef 16

Ресурс google_compute_health_check

Синтаксис

A google_compute_health_check is used to test a Google HealthCheck resource

Бета-ресурс

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

Примеры

describe google_compute_health_check(project: 'chef-gcp-inspec', name: 'inspec-gcp-health-check') do
  it { should exist }
  its('timeout_sec') { should eq '10' }
  its('tcp_health_check.port') { should eq '80' }
end

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

Свойства

Свойства, доступные из ресурса google_compute_health_check:

check_interval_sec
Как часто (в секундах) отправлять проверку работоспособности. Значение по умолчанию — 5 секунд.
creation_timestamp
Метка времени создания в текстовом формате RFC3339.
description
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
healthy_threshold
Нерабочий экземпляр будет помечен как работоспособный после такого количества последовательных успехов. Значение по умолчанию — 2.
id
Уникальный идентификатор ресурса. Этот идентификатор определяется сервером.
name
Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению [a-z]([-a-z0-9]*[a-z0-9])?, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
timeout_sec
Как долго (в секундах) ждать, прежде чем заявить об ошибке. Значение по умолчанию — 5 секунд. Недопустимо, чтобы значение timeoutSec было больше, чем checkIntervalSec.
unhealthy_threshold
Рабочий экземпляр будет помечен как нерабочий после такого количества последовательных сбоев. Значение по умолчанию — 2.
type
Указывает тип healthCheck, либо TCP, SSL, HTTP или HTTPS. Если не указано, значение по умолчанию — TCP. Должно быть указано ровно одно из полей проверки работоспособности, специфичных для протокола, которое должно соответствовать полю type.

Возможные значения:

  • TCP
  • SSL
  • HTTP
  • HTTPS
  • HTTP2
http_health_check
Вложенный объектный ресурс
host
Значение заголовка host в запросе проверки работоспособности HTTP. Если оставить пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности.
request_path
Путь запроса в запросе проверки работоспособности HTTP. Значение по умолчанию — /.
response
Байты для сопоставления с началом данных ответа. Если оставить пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII.
port
Номер TCP-порта для запроса проверки работоспособности HTTP. Значение по умолчанию — 80.
port_name
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port.
proxy_header
Указывает тип заголовка прокси-сервера для добавления перед отправкой данных на бэкэнд.

Возможные значения:

  • NONE
  • PROXY_V1
port_specification
Указывает, как выбирается порт для проверки работоспособности, может иметь одно из следующих значений:
USE_FIXED_PORT
Номер порта в port используется для проверки работоспособности.
USE_NAMED_PORT
portName используется для проверки работоспособности.
USE_SERVING_PORT
Для NetworkEndpointGroup для проверки работоспособности используется номер порта, указанный для каждой конечной точки сети. Для других бэкэндов для проверки работоспособности используется порт или именованный порт, указанный в службе бэкэнда. Если не указано, проверка работоспособности HTTP следует поведению, указанному в полях port и portName.
https_health_check
Вложенный объектный ресурс
host
Значение заголовка host в запросе проверки работоспособности HTTPS. Если оставить пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности.
request_path
Путь запроса в запросе проверки работоспособности HTTPS. Значение по умолчанию — /.
response
Байты для сопоставления с началом данных ответа. Если оставить пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII.
port
Номер TCP-порта для запроса проверки работоспособности HTTPS. Значение по умолчанию — 443.
port_name
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port.
proxy_header
Указывает тип заголовка прокси-сервера для добавления перед отправкой данных на бэкэнд.

Возможные значения:

  • NONE
  • PROXY_V1
port_specification
Указывает, как выбирается порт для проверки работоспособности, может иметь одно из следующих значений:
USE_FIXED_PORT
Номер порта в port используется для проверки работоспособности.
USE_NAMED_PORT
portName используется для проверки работоспособности.
USE_SERVING_PORT
Для NetworkEndpointGroup для проверки работоспособности используется номер порта, указанный для каждой конечной точки сети. Для других бэкэндов для проверки работоспособности используется порт или именованный порт, указанный в службе бэкэнда. Если не указано, проверка работоспособности HTTPS следует поведению, указанному в полях port и portName.
tcp_health_check
Вложенный объектный ресурс
request
Прикладные данные для отправки после установления TCP-соединения (значение по умолчанию пустое). Если и запрос, и ответ пусты, само установление соединения будет указывать на работоспособность. Данные запроса могут быть только ASCII.
response
Байты для сопоставления с началом данных ответа. Если оставить пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII.
port
Номер TCP-порта для запроса проверки работоспособности TCP. Значение по умолчанию — 443.
port_name
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port.
proxy_header
Указывает тип заголовка прокси-сервера для добавления перед отправкой данных на бэкэнд.

Возможные значения:

  • NONE
  • PROXY_V1
port_specification
Указывает, как выбирается порт для проверки работоспособности, может иметь одно из следующих значений:
USE_FIXED_PORT
Номер порта в port используется для проверки работоспособности.
USE_NAMED_PORT
portName используется для проверки работоспособности.
USE_SERVING_PORT
Для NetworkEndpointGroup для проверки работоспособности используется номер порта, указанный для каждой конечной точки сети. Для других бэкэндов для проверки работоспособности используется порт или именованный порт, указанный в службе бэкэнда. Если не указано, проверка работоспособности TCP следует поведению, указанному в полях port и portName.
ssl_health_check
Вложенный объектный ресурс
request
Прикладные данные для отправки после установления SSL-соединения (значение по умолчанию пустое). Если и запрос, и ответ пусты, само установление соединения будет указывать на работоспособность. Данные запроса могут быть только ASCII.
response
Байты для сопоставления с началом данных ответа. Если оставить пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII.
port
Номер TCP-порта для запроса проверки работоспособности SSL. Значение по умолчанию — 443.
port_name
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port.
proxy_header
Указывает тип заголовка прокси-сервера для добавления перед отправкой данных на бэкэнд.

Возможные значения:

  • NONE
  • PROXY_V1
port_specification
Указывает, как выбирается порт для проверки работоспособности, может иметь одно из следующих значений:
USE_FIXED_PORT
Номер порта в port используется для проверки работоспособности.
USE_NAMED_PORT
portName используется для проверки работоспособности.
USE_SERVING_PORT
Для NetworkEndpointGroup для проверки работоспособности используется номер порта, указанный для каждой конечной точки сети. Для других бэкэндов для проверки работоспособности используется порт или именованный порт, указанный в службе бэкэнда. Если не указано, проверка работоспособности SSL следует поведению, указанному в полях port и portName.
http2_health_check
Вложенный объектный ресурс
host
Значение заголовка host в запросе проверки работоспособности HTTP2. Если оставить пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности.
request_path
Путь запроса в запросе проверки работоспособности HTTP2. Значение по умолчанию — /.
response
Байты для сопоставления с началом данных ответа. Если оставить пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII.
port
Номер TCP-порта для запроса проверки работоспособности HTTP2. Значение по умолчанию — 443.
port_name
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port.
proxy_header
Указывает тип заголовка прокси-сервера для добавления перед отправкой данных на бэкэнд.

Возможные значения:

  • NONE
  • PROXY_V1
port_specification
Указывает, как выбирается порт для проверки работоспособности, может иметь одно из следующих значений:
USE_FIXED_PORT
Номер порта в port используется для проверки работоспособности.
USE_NAMED_PORT
portName используется для проверки работоспособности.
USE_SERVING_PORT
Для NetworkEndpointGroup для проверки работоспособности используется номер порта, указанный для каждой конечной точки сети. Для других бэкэндов для проверки работоспособности используется порт или именованный порт, указанный в службе бэкэнда. Если не указано, проверка работоспособности HTTP2 следует поведению, указанному в полях port и portName.
log_config
(Только бета-версия) Настройка ведения журнала для этой проверки работоспособности.

enable : Указывает, следует ли экспортировать журналы. По умолчанию это значение 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_health_check/

Spec-Zone.ru

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