ServiceWithHealthchecks
Scope: Namespaced
Version: v1alpha1
Модуль ServiceWithHealthchecks
- булевый
Определяет, следует ли автоматически выделять NodePort для сервисов типа LoadBalancer. Значение по умолчанию —
true
. Значение можно установить вfalse
, если балансировщик нагрузки кластера не зависит от NodePorts.Если запрашивающая сторона указывает конкретные значения NodePort, эти запросы будут выполнены независимо от значения этого параметра. Данный параметр может быть установлен только для сервисов типа LoadBalancer и автоматически сбрасывается при изменении типа на другой.
- строка
IP-адрес сервиса.
Обычно, IP-адрес назначается сервису случайным образом. Если IP-адрес указывается вручную, он должен находиться в допустимом диапазоне (заданном конфигурацией системы) и быть свободным для назначения; в противном случае создание сервиса завершится ошибкой.
Поле не подлежит изменению при обновлении, за исключением случаев, когда тип сервиса также изменяется на
ExternalName
(в этом случае поле должно быть пустым), или когда тип меняется сExternalName
, позволяя задать это поле дополнительно, как указано выше.Допустимые значения:
None
, пустая строка (“”), или действительный IP-адрес. Установка этого значения вNone
создает сервис без виртуального IP, что полезно, когда предпочтительнее прямое подключение к конечным точкам, и проксирование не требуется. Применимо только к типам ClusterIP, NodePort и LoadBalancer. Если это поле указано при создании сервиса типаExternalName
, создание завершится неудачей. Подробнее. - массив строк
Список IP-адресов, по которым узлы в кластере также будут принимать трафик для этого сервиса. Эти IP-адреса не управляются Kubernetes. Пользователь несет ответственность за обеспечение доставки трафика на узел с этим IP-адресом.
Общий пример — внешние балансировщики нагрузки, которые не являются частью системы Kubernetes.
- строка
Внешняя ссылка, которую механизмы обнаружения будут возвращать в качестве псевдонима для этого сервиса (например, DNS-запись CNAME). Проксирование не будет использоваться. Имя должно быть в нижнем регистре и соответствовать стандарту RFC-1123 и требует, чтобы поле
type
было установлено вExternalName
. - строка
Описывает, как узлы распределяют трафик сервиса, который они получают через один из его “внешне направленных” адресов (NodePorts, ExternalIPs и LoadBalancer IPs). Если установлено значение
Local
, прокси настроит сервис таким образом, что внешние балансировщики нагрузки будут управлять распределением трафика между узлами, и каждый узел будет передавать трафик только локальным конечным точкам сервиса, не маскируя исходный IP-адрес клиента. Трафик, ошибочно отправленный на узел без конечных точек, будет отброшен.Значение по умолчанию —
Cluster
, при котором используется стандартное поведение равномерной маршрутизации ко всем конечным точкам (возможно, с модификациями на основе топологии и других особенностей).Обратите внимание, что трафик, отправленный на External IP или LoadBalancer IP изнутри кластера, всегда будет использовать семантику
Cluster
, но клиенты, отправляющие трафик на NodePort внутри кластера, могут учитывать политику трафика при выборе узла. - целочисленный
Указывает NodePort для проверки состояния сервиса. Это применимо только тогда, когда тип сервиса установлен на LoadBalancer, а параметр
externalTrafficPolicy
установлен наLocal
. Если указано значение, оно находится в допустимом диапазоне и не используется, то оно будет применено.Если не указано, значение будет назначено автоматически. Внешние системы (например, балансировщики нагрузки) могут использовать этот порт, чтобы определить, содержит ли узел конечные точки для этого сервиса.
Если это поле указано при создании сервиса, который в этом не нуждается, создание завершится ошибкой. Это поле будет очищено при изменении параметров сервиса, например, при изменении типа.
Это поле не может быть обновлено после установки.
- массив объектов
Пользовательские заголовки, которые будут добавлены к HTTP-запросу и использованы при выполнении пробы. Разрешены повторяющиеся заголовки.
- строка
Имя секрета (Secret), расположенного в том же пространстве имен, что и этот ресурс. Секрет может содержать следующие поля аутентификации:
tlsMode
,clientCert
,clientKey
,aCert
,password
,user
.Внимание. Тип секрета должен быть
network.deckhouse.io/postgresql-credentials
. - строка
Запрос к PostgreSQL для тестирования.
Чтобы считаться успешным, запрос должен возвращать одно из следующих значений:
TRUE
,t
,true
,y
,yes
,1
.Внимание. Привилегии для пользователя, под которым выполняются запросы, должны быть минимальными.
По умолчанию:
"select 1"
- строка
Описывает, как узлы распределяют трафик сервиса, который они получают через ClusterIP.
Если параметр установлен на
Local
, прокси предполагает, что поды взаимодействуют только с конечными точками сервиса, находящимися на том же узле, что и под. Трафик будет отброшен, если на узле нет локальных конечных точек.Значение по умолчанию —
Cluster
, при котором используется стандартное поведение маршрутизации ко всем конечным точкам равномерно (возможны изменения в зависимости от топологии и других функций). - массив строк
Семейство IP-адресов (например, IPv4, IPv6), назначенных сервису. Это поле обычно назначается автоматически на основе конфигурации кластера и поля
ipFamilyPolicy
.Если поле указано вручную и запрашиваемое семейство доступно в кластере, а
ipFamilyPolicy
это позволяет, оно будет использовано; в противном случае создание сервиса завершится ошибкой. Это поле можно изменять условно: допускается добавление или удаление вторичного IP-семейства, но нельзя изменить основное семейство IP-адресов сервиса.Допустимые значения —
IPv4
иIPv6
. Это поле применяется только к сервисам типов ClusterIP, NodePort и LoadBalancer.Это поле будет удалено при обновлении сервиса до типа
ExternalName
.Эти семейства должны соответствовать значениям поля
clusterIPs
, если оно указано. ПоляclusterIPs
иipFamilies
управляются полемipFamilyPolicy
. Поле может содержать максимум два значения. - строка
Требуемая или запрашиваемая поддержка двух стеков для сервиса.
Если значение не указано, это поле будет установлено в
SingleStack
. Сервисы могут бытьSingleStack
(одно IP-семейство),PreferDualStack
(два IP-семейства на кластерах с двойным стеком или одно IP-семейство на кластерах с одним стеком) илиRequireDualStack
(два семейства IP-адресов на кластерах с двойным стеком, в противном случае возникнет ошибка).Поля
ipFamilies
иclusterIPs
зависят от значения этого поля. Это поле будет очищено при обновлении сервиса до типаExternalName
. - строка
Класс реализации балансировщика нагрузки, к которому принадлежит этот сервис. Если указано, значение этого поля должно быть идентификатором в стиле метки с необязательным префиксом, например,
internal-vip
илиexample.com/internal-vip
. Имена без префикса зарезервированы для конечных пользователей.Это поле может быть установлено только тогда, когда тип сервиса —
LoadBalancer
.Если тип не указан, используется реализация балансировщика нагрузки по умолчанию, которая обычно осуществляется через интеграцию с облачным провайдером, но должна применяться для любой реализации по умолчанию.
Если тип указан, предполагается, что реализация балансировщика нагрузки отслеживает сервисы с соответствующим классом. Любая реализация балансировщика нагрузки по умолчанию (например, облачные провайдеры) должна игнорировать сервисы, устанавливающие это поле. Это поле может быть установлено только при создании или обновлении сервиса до типа
LoadBalancer
.После установки его нельзя изменить. Это поле будет очищено, когда сервис будет обновлен до типа, отличного от
LoadBalancer
. - массив строк
Если указано и поддерживается платформой, это ограничит трафик через облачный балансировщик нагрузки только для указанных клиентских IP-адресов.
Это поле будет игнорироваться, если облачный провайдер не поддерживает данную функцию. Подробнее.
- массив объектов
Список портов, которые открыты этим сервисом. Подробнее.
ServicePort содержит информацию о порте сервиса.
- строка
Протокол приложения для данного порта. Служит подсказкой для реализаций, позволяя предложить более расширенное поведение для поддерживаемых протоколов. Это поле следует стандартному синтаксису меток Kubernetes. Допустимые значения:
- Именования протоколов без префиксов — зарезервированы для стандартных имён служб IANA, в соответствии с RFC-6335.
- Именования с префиксом, определенные Kubernetes:
- Другие протоколы должны использовать имена с определенными реализациями, например с такими как
mycompany.com/my-custom-protocol
.
- строка
Имя этого порта внутри службы соответствует стандарту
DNS_LABEL
.Все порты внутри ServiceSpec должны иметь уникальные имена. При рассмотрении конечных точек для службы имя должно совпадать с полем
name
вEndpointPort
. Имя не должно совпадать с полемname
, если в этой службе определен только одинServicePort
. - целочисленный
Порт на каждом узле, на котором эта служба открыта, когда тип равен NodePort или LoadBalancer. Обычно назначается системой. Если указано значение, оно должно быть в диапазоне и не должно использоваться, иначе операция завершится с ошибкой.
Если не указано, порт будет выделен, если этой службе это требуется.
Если это поле указано при создании службы, которая в этом не нуждается, создание завершится с ошибкой.
Это поле будет очищено при обновлении службы, например, при изменении типа с NodePort на ClusterIP. Подробнее.
- целочисленный
Номер порта для доступа к подам, на которые нацелен сервис.
Это поле игнорируется для сервисов с
clusterIP=None
и должно быть установлено равным полюport
. Подробнее.
- булевый
Указывает, что любые агенты, занимающиеся обработкой конечных точек данного сервиса, должны игнорировать статусы готовности или неготовности. Основное применение этого поля заключается в том, чтобы сервисы
StatefulSet
могли распространять записи SRV DNS для своих подов с целью обнаружения пиров.Контроллеры Kubernetes, которые генерируют ресурсы
Endpoints
иEndpointSlice
для сервисов, трактуют это как указание, что все конечные точки следует считать “готовыми”, даже если поды не прошли пробы и не готовы. - объект
Маршрутизирует трафик сервиса к подам, у которых ключи и значения меток соответствуют этому селектору. Если параметр не определен, предполагается, что у сервиса есть внешний процесс, управляющий его конечными точками, которые Kubernetes не будет изменять.
Применимо только к типам ClusterIP, NodePort и LoadBalancer.
Игнорируется, если тип — ExternalName. Подробнее.
- строка
Используется для поддержания сессий с привязкой к клиенту. Должно быть указано значение либо
ClientIP
, либоNone
. Подробнее. - объект
Содержит конфигурацию привязки сессий на основе IP-адреса клиента.
- строка
Позволяет задать предпочтения по распределению трафика между конечными точками сервиса. Реализации могут учитывать это поле как рекомендацию, но не обязаны строго его соблюдать.
Если поле не задано, реализация применяет стратегию маршрутизации по умолчанию. Если установлено значение
PreferClose
, реализации должны приоритизировать конечные точки, которые топологически близки (например, в той же зоне). - строка
Определяет доступность сервиса.
По умолчанию используется ClusterIP. Допустимые варианты: ExternalName, ClusterIP, NodePort и LoadBalancer.
ClusterIP выделяет внутренний IP-адрес для балансировки нагрузки между конечными точками. Конечные точки определяются
selector
или, если он не указан, вручную с помощью объектовEndpoints
илиEndpointSlice
.Если значение
clusterIP
установлено наNone
, виртуальный IP не выделяется, и конечные точки публикуются как набор конечных точек, а не как виртуальный IP.NodePort расширяет ClusterIP и выделяет порт на каждом узле, который маршрутизируется к тем же конечным точкам, что и
clusterIP
.LoadBalancer расширяет NodePort и создает внешний балансировщик нагрузки (если поддерживается текущим облаком), который маршрутизируется к тем же конечным точкам, что и
clusterIP
.ExternalName создает алиас этому сервису на указанный
externalName
. Некоторые другие поля не применяются к сервисам типа ExternalName.