Стадия жизненного цикла модуля: Общедоступная версия
У модуля есть требования для установки
Deckhouse Platform устанавливает CRD, но не удаляет их при отключении модуля. Если вам больше не нужны созданные CRD, удалите их.
ServiceWithHealthchecks
Короткие имена: swh
Область: Namespaced
Версия: v1alpha1
-
строкаapiVersion
-
строкаkind
-
объектmetadata
-
объектspec
Описывает желаемое состояние ServiceWithHealthchecks.
Чтобы создаваемые балансировщики ServiceWithHealthchecks работали, необходимо выполнение следующих условий:
-
В сетевой политике пользовательского проекта, в котором будет создаваться ServiceWithHealthchecks, должно присутствовать правило, разрешающее входящий трафик из всех подов неймспейса
d8-service-with-healthchecks:ingress: - from: - namespaceSelector: matchLabels: kubernetes.io/metadata.name: d8-service-with-healthchecksПодробнее о сетевых политиках — в разделе «Настройка сетевых политик».
-
Кластерная роль, которая используется в ClusterRoleBinding и RoleBinding при назначении прав пользователям и сервисным аккаунтам, для ресурса ServiceWithHealthchecks должна быть расширена следующими правилами:
getlistwatchcreateupdatepatchdelete.
Подробнее — в разделе «Выдача прав пользователям и сервисным аккаунтам».
-
булевыйspec.allocateLoadBalancerNodePorts
Определяет, следует ли автоматически выделять NodePort для сервисов типа LoadBalancer. Значение по умолчанию —
true. Значение можно установить вfalse, если балансировщик нагрузки кластера не зависит от NodePorts.Если запрашивающая сторона указывает конкретные значения NodePort, эти запросы будут выполнены независимо от значения этого параметра. Данный параметр может быть установлен только для сервисов типа LoadBalancer и автоматически сбрасывается при изменении типа на другой.
-
строкаspec.clusterIP
IP-адрес сервиса.
Обычно, IP-адрес назначается сервису случайным образом. Если IP-адрес указывается вручную, он должен находиться в допустимом диапазоне (заданном конфигурацией системы) и быть свободным для назначения; в противном случае создание сервиса завершится ошибкой.
Поле не подлежит изменению при обновлении, за исключением случаев, когда тип сервиса также изменяется на
ExternalName(в этом случае поле должно быть пустым), или когда тип меняется сExternalName, позволяя задать это поле дополнительно, как указано выше.Допустимые значения:
None, пустая строка (""), или действительный IP-адрес. Установка этого значения вNoneсоздает сервис без виртуального IP, что полезно, когда предпочтительнее прямое подключение к конечным точкам, и проксирование не требуется. Применимо только к типам ClusterIP, NodePort и LoadBalancer. Если это поле указано при создании сервиса типаExternalName, создание завершится неудачей. Подробнее.Внимание. Поле неизменяемое и учитывается только при создании дочернего Service. Используемый адрес приводится в
status.clusterIP. -
массив строкspec.externalIPs
Список IP-адресов, по которым узлы в кластере также будут принимать трафик для этого сервиса. Эти IP-адреса не управляются Kubernetes. Пользователь несет ответственность за обеспечение доставки трафика на узел с этим IP-адресом.
Общий пример — внешние балансировщики нагрузки, которые не являются частью системы Kubernetes.
-
строкаspec.externalNameВнешняя ссылка, которую механизмы обнаружения будут возвращать в качестве псевдонима для этого сервиса (например, DNS-запись CNAME). Проксирование не будет использоваться. Имя должно быть в нижнем регистре и соответствовать стандарту RFC-1123 и требует, чтобы поле
typeбыло установлено вExternalName. -
строкаspec.externalTrafficPolicy
Описывает, как узлы распределяют трафик сервиса, который они получают через один из его “внешне направленных” адресов (NodePorts, ExternalIPs и LoadBalancer IPs). Если установлено значение
Local, прокси настроит сервис таким образом, что внешние балансировщики нагрузки будут управлять распределением трафика между узлами, и каждый узел будет передавать трафик только локальным конечным точкам сервиса, не маскируя исходный IP-адрес клиента. Трафик, ошибочно отправленный на узел без конечных точек, будет отброшен.Значение по умолчанию —
Cluster, при котором используется стандартное поведение равномерной маршрутизации ко всем конечным точкам (возможно, с модификациями на основе топологии и других особенностей).Обратите внимание, что трафик, отправленный на External IP или LoadBalancer IP изнутри кластера, всегда будет использовать семантику
Cluster, но клиенты, отправляющие трафик на NodePort внутри кластера, могут учитывать политику трафика при выборе узла. -
целое числоspec.healthCheckNodePort
Указывает NodePort для проверки состояния сервиса. Это применимо только тогда, когда тип сервиса установлен на LoadBalancer, а параметр
externalTrafficPolicyустановлен наLocal. Если указано значение, оно находится в допустимом диапазоне и не используется, то оно будет применено.Если не указано, значение будет назначено автоматически. Внешние системы (например, балансировщики нагрузки) могут использовать этот порт, чтобы определить, содержит ли узел конечные точки для этого сервиса.
Если это поле указано при создании сервиса, который в этом не нуждается, создание завершится ошибкой. Это поле будет очищено при изменении параметров сервиса, например, при изменении типа.
Внимание. Поле неизменяемое и учитывается только при создании дочернего Service.
-
объектspec.healthcheck
-
целое числоspec.healthcheck.initialDelaySecondsВремя в секундах после страта пода, по истечении которого запускаются пробы.
По умолчанию:
10Допустимые значения:
0 <= X <= 108000 -
целое числоspec.healthcheck.periodSecondsПериод в секундах для повторных запусков проб.
По умолчанию:
10Допустимые значения:
1 <= X <= 108000 -
массив объектовspec.healthcheck.probes
-
целое числоspec.healthcheck.probes.failureThresholdМинимальное количество последовательных неудач, после которых проба будет считаться неудачной.
По умолчанию:
3Допустимые значения:
1 <= X -
объектspec.healthcheck.probes.http
-
строкаspec.healthcheck.probes.http.caCertCA-сертификат для HTTPS соединения.
-
массив целых чиселspec.healthcheck.probes.http.code
Коды состояния ответа, которые считаются успешным результатом пробы.
Если не указано, успешным считается любой код из диапазона 200-399.
-
целое числоspec.healthcheck.probes.http.code.Элемент массива
Допустимые значения:
200 <= X <= 399
-
-
строкаspec.healthcheck.probes.http.hostИмя хоста для подключения, по умолчанию используется IP-адрес пода.
-
массив объектовspec.healthcheck.probes.http.httpHeadersПользовательские заголовки, которые будут добавлены к HTTP-запросу и использованы при выполнении пробы. Разрешены повторяющиеся заголовки.
-
строкаspec.healthcheck.probes.http.httpHeaders.name
Имя заголовка.
При выводе будет приведено к стандартному виду (lowercase), так что заголовки с разным регистром будут распознаваться как одинаковые.
-
строкаspec.healthcheck.probes.http.httpHeaders.valueЗначение заголовка.
-
-
булевыйspec.healthcheck.probes.http.insecureSkipTLSVerifyУказывает, следует ли клиенту пропустить проверку цепочки сертификатов TLS сервера и имени хоста.
По умолчанию:
false -
строкаspec.healthcheck.probes.http.methodМетод, который будет использоваться для запроса.
По умолчанию:
GETДопустимые значения:
GET,HEAD -
строкаspec.healthcheck.probes.http.path
Путь для доступа к HTTP-серверу.
Должен начинаться с
/и не должен содержать символы CR и LF.Шаблон:
^/[^\r\n]*$ -
строкаspec.healthcheck.probes.http.schemeСхема, используемая для подключения к хосту.
По умолчанию:
HTTPДопустимые значения:
HTTP,HTTPS -
целое числоspec.healthcheck.probes.http.targetPort
Обязательный параметр
Номер порта для доступа к контейнеру.Допустимые значения:
1 <= X <= 65535
-
-
строкаspec.healthcheck.probes.modeРежим для проверки.
Допустимые значения:
HTTP,TCP,PostgreSQL -
объектspec.healthcheck.probes.postgreSQL
-
строкаspec.healthcheck.probes.postgreSQL.authSecretName
Имя секрета (Secret), расположенного в том же пространстве имен, что и этот ресурс. Секрет может содержать следующие поля аутентификации:
tlsMode,clientCert,clientKey,caCert,password,user.Внимание. Тип секрета должен быть
network.deckhouse.io/postgresql-credentials. -
строкаspec.healthcheck.probes.postgreSQL.dbNameИмя базы данных, используемое при подключении. Если не указать, то будет использовано имя пользователя.
-
строкаspec.healthcheck.probes.postgreSQL.query
Запрос к PostgreSQL для тестирования.
Чтобы считаться успешным, запрос должен возвращать одно из следующих значений:
TRUE,t,true,y,yes,1.Внимание. Привилегии для пользователя, под которым выполняются запросы, должны быть минимальными.
По умолчанию:
select 1 -
целое числоspec.healthcheck.probes.postgreSQL.targetPort
Обязательный параметр
Номер порта для доступа к контейнеру.Допустимые значения:
1 <= X <= 65535
-
-
целое числоspec.healthcheck.probes.successThresholdМинимальное количество последовательных успешных проверок, после которых проверка считается успешной после предыдущих неудач.
По умолчанию:
1Допустимые значения:
1 <= X -
объектspec.healthcheck.probes.tcp
-
целое числоspec.healthcheck.probes.tcp.targetPort
Обязательный параметр
Номер порта для доступа к контейнеру.Допустимые значения:
1 <= X <= 65535
-
-
целое числоspec.healthcheck.probes.timeoutSecondsЧисло секунд, по истечении которых проверка завершится по таймауту.
По умолчанию:
1Допустимые значения:
1 <= X
-
-
-
строкаspec.internalTrafficPolicy
Описывает, как узлы распределяют трафик сервиса, который они получают через ClusterIP.
Если параметр установлен на
Local, прокси предполагает, что поды взаимодействуют только с конечными точками сервиса, находящимися на том же узле, что и под. Трафик будет отброшен, если на узле нет локальных конечных точек.Значение по умолчанию —
Cluster, при котором используется стандартное поведение маршрутизации ко всем конечным точкам равномерно (возможны изменения в зависимости от топологии и других функций).По умолчанию:
Cluster -
массив строкspec.ipFamilies
Семейство IP-адресов (например, IPv4, IPv6), назначенных сервису. Это поле обычно назначается автоматически на основе конфигурации кластера и поля
ipFamilyPolicy.Если поле указано вручную и запрашиваемое семейство доступно в кластере, а
ipFamilyPolicyэто позволяет, оно будет использовано; в противном случае создание сервиса завершится ошибкой. Это поле можно изменять условно: допускается добавление или удаление вторичного IP-семейства, но нельзя изменить основное семейство IP-адресов сервиса.Допустимые значения —
IPv4иIPv6. Это поле применяется только к сервисам типов ClusterIP, NodePort и LoadBalancer.Это поле будет удалено при обновлении сервиса до типа
ExternalName.Эти семейства должны соответствовать значениям поля
clusterIPs, если оно указано. ПоляclusterIPsиipFamiliesуправляются полемipFamilyPolicy. Поле может содержать максимум два значения.-
строкаspec.ipFamilies.Элемент массиваСемейство IP-адресов —
IPv4илиIPv6.
-
-
строкаspec.ipFamilyPolicy
Требуемая или запрашиваемая поддержка двух стеков для сервиса.
Если значение не указано, это поле будет установлено в
SingleStack. Сервисы могут бытьSingleStack(одно IP-семейство),PreferDualStack(два IP-семейства на кластерах с двойным стеком или одно IP-семейство на кластерах с одним стеком) илиRequireDualStack(два семейства IP-адресов на кластерах с двойным стеком, в противном случае возникнет ошибка).Поля
ipFamiliesиclusterIPsзависят от значения этого поля. Это поле будет очищено при обновлении сервиса до типаExternalName. -
строкаspec.loadBalancerClass
Класс реализации балансировщика нагрузки, к которому принадлежит этот сервис. Если указано, значение этого поля должно быть идентификатором в стиле лейбла с необязательным префиксом, например,
internal-vipилиexample.com/internal-vip. Имена без префикса зарезервированы для конечных пользователей.Это поле может быть установлено только тогда, когда тип сервиса —
LoadBalancer.Если тип не указан, используется реализация балансировщика нагрузки по умолчанию, которая обычно осуществляется через интеграцию с облачным провайдером, но должна применяться для любой реализации по умолчанию.
Если тип указан, предполагается, что реализация балансировщика нагрузки отслеживает сервисы с соответствующим классом. Любая реализация балансировщика нагрузки по умолчанию (например, облачные провайдеры) должна игнорировать сервисы, устанавливающие это поле.
Внимание. Поле неизменяемое. Чтобы использовать другую реализацию балансировщика, пересоздайте ресурс.
-
строкаspec.loadBalancerIP
Адрес, который требуется запросить для балансировщика нагрузки. Применяется только для
type: LoadBalancer.Внимание. Поле объявлено устаревшим в Kubernetes. Реализация может его проигнорировать и выдать другой адрес или не выдать его вовсе. Предпочтительнее аннотация самой реализации: аннотации этого ресурса копируются в дочерний Service.
-
массив строкspec.loadBalancerSourceRanges
Если указано и поддерживается платформой, это ограничит трафик через облачный балансировщик нагрузки только для указанных клиентских IP-адресов.
Это поле будет игнорироваться, если облачный провайдер не поддерживает данную функцию. Подробнее.
-
-
строкаspec.ports.appProtocol
Протокол приложения для данного порта. Служит подсказкой для реализаций, позволяя предложить более расширенное поведение для поддерживаемых протоколов. Это поле следует стандартному синтаксису лейблов Kubernetes. Допустимые значения:
- Именования протоколов без префиксов — зарезервированы для стандартных имён служб IANA, в соответствии с RFC-6335.
- Именования с префиксом, определенные Kubernetes:
- Другие протоколы должны использовать имена с определенными реализациями, например с такими как
mycompany.com/my-custom-protocol.
-
строкаspec.ports.name
Имя этого порта внутри сервиса. Должно соответствовать стандарту
DNS_LABEL.Имена портов должны быть уникальны в пределах сервиса: по этому имени потребитель сопоставляет порт сервиса с портом опубликованного эндпоинта.
Имя можно не указывать, если у сервиса всего один порт. Если портов больше одного, имя обязательно для каждого.
Максимальная длина:
63Шаблон:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ -
целое числоspec.ports.nodePort
Порт на каждом узле, на котором эта служба открыта, когда тип равен NodePort или LoadBalancer. Обычно назначается системой. Если указано значение, оно должно быть в диапазоне и не должно использоваться, иначе операция завершится с ошибкой.
Если не указано, порт будет выделен, если этой службе это требуется.
Если это поле указано при создании службы, которая в этом не нуждается, создание завершится с ошибкой.
Это поле будет очищено при обновлении службы, например, при изменении типа с NodePort на ClusterIP. Подробнее.
-
целое числоspec.ports.portПорт, который будет открыт этой службой.
-
строкаspec.ports.protocolIP-протокол для этого порта. Поддерживает
TCP,UDPиSCTP.По умолчанию:
TCP -
целое числоspec.ports.targetPort
Номер порта для доступа к подам, на которые нацелен сервис.
Это поле игнорируется для сервисов с
clusterIP=Noneи должно быть установлено равным полюport. Подробнее.
-
-
булевыйspec.publishNotReadyAddresses
Указывает, что любые агенты, занимающиеся обработкой конечных точек данного сервиса, должны игнорировать статусы готовности или неготовности. Основное применение этого поля заключается в том, чтобы сервисы
StatefulSetмогли распространять записи SRV DNS для своих подов с целью обнаружения пиров.Контроллеры Kubernetes, которые генерируют ресурсы
EndpointsиEndpointSliceдля сервисов, трактуют это как указание, что все конечные точки следует считать “готовыми”, даже если поды не прошли пробы и не готовы. -
объектspec.selector
Маршрутизирует трафик сервиса к подам, у которых ключи и значения лейблов соответствуют этому селектору. Если параметр не определен, предполагается, что у сервиса есть внешний процесс, управляющий его конечными точками, которые Kubernetes не будет изменять.
Применимо только к типам ClusterIP, NodePort и LoadBalancer.
Игнорируется, если тип — ExternalName. Подробнее.
-
строкаspec.sessionAffinityИспользуется для поддержания сессий с привязкой к клиенту. Должно быть указано значение либо
ClientIP, либоNone. Подробнее. -
объектspec.sessionAffinityConfigСодержит конфигурацию привязки сессий.
-
объектspec.sessionAffinityConfig.clientIPСодержит конфигурацию привязки сессий на основе IP-адреса клиента.
-
целое числоspec.sessionAffinityConfig.clientIP.timeoutSeconds
Указывает время удержания сессии для типа
ClientIPв секундах.Значение должно быть
>0 && <=86400(для 1 дня), еслиServiceAffinity == ClientIP.
-
-
-
строкаspec.trafficDistribution
Позволяет задать предпочтения по распределению трафика между конечными точками сервиса. Реализации могут учитывать это поле как рекомендацию, но не обязаны строго его соблюдать.
Если поле не задано, реализация применяет стратегию маршрутизации по умолчанию. Если установлено значение
PreferClose, реализации должны приоритизировать конечные точки, которые топологически близки (например, в той же зоне). -
строкаspec.type
Определяет доступность сервиса.
По умолчанию используется ClusterIP. Допустимые варианты: ExternalName, ClusterIP, NodePort и LoadBalancer.
ClusterIP выделяет внутренний IP-адрес для балансировки нагрузки между конечными точками. Конечные точки определяются
selectorили, если он не указан, вручную с помощью объектовEndpointsилиEndpointSlice.Если значение
clusterIPустановлено наNone, виртуальный IP не выделяется, и конечные точки публикуются как набор конечных точек, а не как виртуальный IP.NodePort расширяет ClusterIP и выделяет порт на каждом узле, который маршрутизируется к тем же конечным точкам, что и
clusterIP.LoadBalancer расширяет NodePort и создает внешний балансировщик нагрузки (если поддерживается текущим облаком), который маршрутизируется к тем же конечным точкам, что и
clusterIP.ExternalName создает алиас этому сервису на указанный
externalName. Некоторые другие поля не применяются к сервисам типа ExternalName.По умолчанию:
ClusterIP
-
-
объектstatusОпределяет наблюдаемое состояние
ServiceWithHealthchecks.-
строкаstatus.clusterIPАдрес дочернего сервиса: либо запрошенный в
spec.clusterIP, либо выданный кластером. -
массив строкstatus.clusterIPsВсе адреса дочернего сервиса, по одному на каждое семейство IP-адресов.
-
массив объектовstatus.conditions
Текущее состояние сервиса:
ChildServiceReady— удалось ли создать дочерний Service и принадлежит ли он этому ресурсу.LoadBalancerReady— только дляtype: LoadBalancer: выделен ли адрес.Ready— проходят ли пробы все опубликованные эндпоинты.
-
строкаstatus.conditions.lastTransitionTime
Последнее время изменения, когда условие перешло из одного состояния в другое. Это должно соответствовать времени изменения основного условия.
Если время неизвестно, можно использовать время изменения поля API.
-
строкаstatus.conditions.message
Понятное человеку сообщение, указывающее детали перехода.
Это может быть пустая строка.
Максимальная длина:
32768 -
целое числоstatus.conditions.observedGeneration
Значение
.metadata.generation, на основе которого было установлено состояние.Например, если
.metadata.generationравно 12, а.status.conditions[x].observedGenerationравно 9, то состояние устарело по отношению к текущему состоянию экземпляра.Допустимые значения:
0 <= X -
строкаstatus.conditions.reason
Программный идентификатор, указывающий причину последнего перехода состояния. Производители конкретных типов состояний могут определить ожидаемые значения и их значения для этого поля, а также то, считаются ли эти значения гарантированным API.
Значение должно быть строкой в
CamelCase.Это поле не может быть пустым.
Длина:
1..1024Шаблон:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ -
строкаstatus.conditions.statusСостояние условия, одно из значений
True,False,Unknown.Допустимые значения:
True,False,Unknown -
строкаstatus.conditions.type
Тип условия в формате
CamelCaseили в видеfoo.example.com/CamelCase.Многие значения
.condition.typeпоследовательны для различных ресурсов, таких какAvailable, но поскольку произвольные условия могут быть полезными (см..node.status.conditions), важна возможность разрешения конфликтов. Регулярное выражение, которому оно соответствует: (dns1123SubdomainFmt/)?(qualifiedNameFmt)Максимальная длина:
316Шаблон:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
-
массив объектовstatus.endpointStatusesТекущее состояние службы.
-
массив строкstatus.endpointStatuses.failedProbes
Список проб, которые сейчас находятся в состоянии отказа.
Проба попадает в этот список после того, как достигнут её
failureThreshold, и покидает его после того, как достигнут еёsuccessThreshold. Это ровно тот набор проб, из-за которогоprobesSuccessfulравноfalse. -
строкаstatus.endpointStatuses.lastProbeTimeВремя последней проверки пода (обновляется в зависимости от настройки verboseStatus).
-
строкаstatus.endpointStatuses.lastTransitionTimeВремя, когда состояние пробы последний раз перешло из одного статуса в другой.
-
строкаstatus.endpointStatuses.nodeNameУзел, на котором запущен под.
-
строкаstatus.endpointStatuses.podNameИмя проверяемого пода.
-
булевыйstatus.endpointStatuses.probesSuccessfulУказывает, были ли успешными все пользовательские пробы ServiceWithHealthchecks.
-
булевыйstatus.endpointStatuses.ready
Указывает, готов ли эндпоинт: под прошёл стандартные проверки readiness Kubernetes и все пользовательские пробы ServiceWithHealthchecks завершились успешно.
В
readyEndpointsучитываются эндпоинты, отмеченные здесь как готовые. Если значениеfalse, аprobesSuccessfulравноtrue, значит не готов сам под.
-
-
объектstatus.healthcheckConditionСводка результатов проверок (health checks).
-
целое числоstatus.healthcheckCondition.endpointsОбщее количество эндпоинтов (подов), для которых выполняются проверки.
-
целое числоstatus.healthcheckCondition.observedGenerationПоследнее поколение (generation) ресурса, которое наблюдал контроллер.
-
целое числоstatus.healthcheckCondition.readyEndpointsКоличество эндпоинтов (подов), успешно прошедших проверки.
-
-
объектstatus.loadBalancerСодержит текущее состояние балансировщика нагрузки, если он присутствует.
-
массив объектовstatus.loadBalancer.ingressСписок, содержащий точки входа для балансировщика нагрузки. Трафик, предназначенный для сервиса, должен направляться на эти точки входа.
-
строкаstatus.loadBalancer.ingress.hostnameУстанавливается для точек входа балансировщика нагрузки, которые основаны на DNS (обычно балансировщики нагрузки AWS).
-
строкаstatus.loadBalancer.ingress.ipУстанавливается для точек входа балансировщика нагрузки, которые основаны на IP-адресах (обычно балансировщики нагрузки GCE или OpenStack).
-
строкаstatus.loadBalancer.ingress.ipMode
Указывает, как ведет себя IP-адрес балансировщика нагрузки и может быть указан только при указании поля
ip. Установка значенияVIPозначает, что трафик доставляется на узел с назначением, установленным на IP-адрес и порт балансировщика нагрузки. Установка значенияProxyуказывает, что трафик доставляется на узел или под с назначением, установленным на IP-адрес узла и порт узла или IP-адрес пода и порт.Реализации сервиса могут использовать эту информацию для настройки маршрутизации трафика.
-
массив объектовstatus.loadBalancer.ingress.ports
Список записей портов сервиса.
Если используется, каждый порт, определенный в сервисе, должен иметь соответствующую запись в этом списке.
-
строкаstatus.loadBalancer.ingress.ports.errorПроблема, о которой балансировщик сообщил для этого порта, в формулировке его реализации.
Максимальная длина:
316 -
целое числоstatus.loadBalancer.ingress.ports.portНомер порта сервиса, статус которого указан.
-
строкаstatus.loadBalancer.ingress.ports.protocolПротокол порта сервиса, статус которого здесь записан. Поддерживаемые значения:
TCP,UDP,SCTP.По умолчанию:
TCP
-
-
-
-
строкаstatus.portsПорты дочернего сервиса, например
80/TCP,443:31443/TCP.
-