Поделиться через


Шлюз приложений спецификации API контейнеров для Kubernetes

Packages

Пакет версии 1 — это версия 1 API.

alb.networking.azure.io/v1

Этот документ определяет каждый из типов ресурсов для alb.networking.azure.io/v1.

Типы ресурсов:

AffinityType (string псевдоним)

(Отображается в:SessionAffinity)

AffinityType определяет тип сходства для службы

значение Описание

"application-cookie"

AffinityTypeApplicationCookie — это тип сопоставления сеансов для файла cookie приложения

"managed-cookie"

AffinityTypeManagedCookie — это тип сопоставления сеансов для управляемого файла cookie

AlbConditionReason (string псевдоним)

AlbConditionReason определяет набор причин, объясняющих, почему определенный тип условия вызывается Шлюз приложений для ресурса контейнеров.

значение Описание

"Принято"

AlbReasonAccepted указывает, что ресурс Шлюз приложений для контейнеров принимается контроллером.

"Готово"

AlbReasonDeploymentReady указывает Шлюз приложений для состояния развертывания ресурсов контейнеров.

"InProgress"

AlbReasonInProgresss указывает, находится ли ресурс Шлюз приложений для контейнеров в процессе создания, обновления или удаления.

AlbConditionType (string псевдоним)

AlbConditionType — это тип условия, связанного с ресурсом Шлюз приложений для контейнеров. Этот тип следует использовать с полем AlbStatus.Conditions.

значение Описание

"Принято"

AlbConditionTypeAccepted указывает, принимает ли Шлюз приложений для ресурса контейнеров контроллер.

"Развертывание"

AlbConditionTypeDeployment указывает состояние развертывания Шлюз приложений ресурса контейнеров.

AlbSpec

(Отображается в:ApplicationLoadBalancer)

AlbSpec определяет спецификации для ресурса Шлюз приложений для контейнеров.

Поле Description
associations
[]string

Связи — это идентификаторы ресурсов подсети, с которыми связаны Шлюз приложений для ресурса контейнеров.

AlbStatus

(Отображается в:ApplicationLoadBalancer)

AlbStatus определяет наблюдаемое состояние Шлюз приложений ресурса контейнеров.

Поле Description
conditions
[]Kubernetes meta/v1. Состояние
(Необязательно)

Известные типы условий:

  • “Принятый”
  • “Готово”

ApplicationLoadBalancer

ApplicationLoadBalancer — это схема для ресурса Шлюз приложений для контейнеров.

Поле Description
metadata
Meta/v1 Kubernetes. ObjectMeta
(Необязательно)

Метаданные объекта’.

Ознакомьтесь с документацией по API Kubernetes для полей metadata поля поля.
spec
AlbSpec

Спецификация — это спецификации для ресурса контейнеров Шлюз приложений.



associations
[]string

Связи — это идентификаторы ресурсов подсети, с которыми связаны Шлюз приложений для ресурса контейнеров.

status
AlbStatus

Состояние определяет текущее состояние Шлюз приложений ресурса контейнеров.

BackendTLSPolicy

BackendTLSPolicy — это схема для API BackendTLSPolicys.

Поле Description
metadata
Meta/v1 Kubernetes. ObjectMeta
(Необязательно)

Метаданные объекта’.

Ознакомьтесь с документацией по API Kubernetes для полей metadata поля поля.
spec
BackendTLSPolicySpec

Спецификация BackendTLSPolicy.



targetRef
CustomTargetRef

TargetRef определяет объект API для применения политики.

override
BackendTLSPolicyConfig
(Необязательно)

Переопределение определяет конфигурацию политики, которая должна переопределить конфигурацию политики, подключенную под целевым ресурсом в иерархии.

Примечание. Переопределение в настоящее время не поддерживается и приводит к ошибке проверки. Поддержка Переопределения будет добавлена в будущий выпуск.

default
BackendTLSPolicyConfig
(Необязательно)

По умолчанию определяется конфигурация политики по умолчанию для целевого ресурса.

status
BackendTLSPolicyStatus

Состояние определяет текущее состояние BackendTLSPolicy.

BackendTLSPolicyConditionReason (string псевдоним)

BackendTLSPolicyConditionReason определяет набор причин, объясняющих, почему вызывается конкретный тип условия BackendTLSPolicy.

значение Описание

"Принято"

Серверная служба BackendTLSPolicyReasonAccepted используется для задания значения BackendTLSPolicyConditionReason accepted При правильной настройке заданного backendTLSPolicy

"InvalidBackendTLSPolicy"

BackendTLSPolicyReasonInvalid является причиной, когда backendTLSPolicy’не принимается

"InvalidCertificateRef"

BackendTLSPolicyReasonInvalidCertificateRef используется при ссылке на недопустимый сертификат

"InvalidGroup"

BackendTLSPolicyReasonInvalidGroup используется, когда группа недопустима

"InvalidKind"

BackendTLSPolicyReasonInvalidKind используется, если тип или группа недопустим

"InvalidName"

BackendTLSPolicyReasonInvalidName используется, если имя недопустимо

"InvalidSecret"

Серверная частьTLSPolicyReasonInvalidSecret используется, если секрет недопустим

"InvalidService"

Серверная служба BackendTLSPolicyReasonInvalidService используется, если служба недопустима

NoTargetReference

BackendTLSPolicyReasonNoTargetReference используется при’отсутствии целевой ссылки

"OverrideNotSupported"

BackendTLSPolicyReasonOverrideNotSupported используется, когда переопределение не поддерживается’

"RefNotPermitted"

BackendTLSPolicyReasonRefNotPermitted используется, если ссылка’не разрешена

SectionNamesNotPermitted

BackendTLSPolicyReasonSectionNamesNotPermitted используется, если имена’разделов не разрешены

BackendTLSPolicyConditionType (string псевдоним)

BackendTLSPolicyConditionType — это тип условия, связанного с backendTLSPolicy. Этот тип следует использовать с полем BackendTLSPolicyStatus.Conditions.

значение Описание

"Принято"

BackendTLSPolicyConditionAccepted используется для задания значения BackendTLSPolicyConditionType на Accepted

"ResolvedRefs"

Серверная служба BackendTLSPolicyConditionResolvedRefs используется для задания значения BackendTLSPolicyCondition в ResolvedRefs

BackendTLSPolicyConfig

(Отображается в:BackendTLSPolicySpec)

BackendTLSPolicyConfig определяет спецификацию политики для внутренней политики TLS.

Поле Description
CommonTLSPolicy
CommonTLSPolicy

(Члены CommonTLSPolicy внедрены в этот тип.)

sni
струна
(Необязательно)

Sni — это имя сервера, используемое для подключения TLS к серверной части.

ports
[]BackendTLSPolicyPort

Порты указывают список портов, в которых применяется политика.

clientCertificateRef
API шлюза. SecretObjectReference
(Необязательно)

ClientCertificateRef — это ссылка на сертификат клиента, используемый для подключения TLS к серверной части.

BackendTLSPolicyPort

(Отображается в:BackendTLSPolicyConfig)

BackendTLSPolicyPort определяет порт, используемый для подключения TLS к серверной части.

Поле Description
port
int

Порт — это порт, используемый для подключения TLS к серверной части.

BackendTLSPolicySpec

(Отображается в:BackendTLSPolicy)

BackendTLSPolicySpec определяет требуемое состояние BackendTLSPolicy.

Поле Description
targetRef
CustomTargetRef

TargetRef определяет объект API для применения политики.

override
BackendTLSPolicyConfig
(Необязательно)

Переопределение определяет конфигурацию политики, которая должна переопределить конфигурацию политики, подключенную под целевым ресурсом в иерархии.

Примечание. Переопределение в настоящее время не поддерживается и приводит к ошибке проверки. Поддержка Переопределения будет добавлена в будущий выпуск.

default
BackendTLSPolicyConfig
(Необязательно)

По умолчанию определяется конфигурация политики по умолчанию для целевого ресурса.

BackendTLSPolicyStatus

(Отображается в:BackendTLSPolicy)

BackendTLSPolicyStatus определяет наблюдаемое состояние BackendTLSPolicy.

Поле Description
conditions
[]Kubernetes meta/v1. Состояние
(Необязательно)

Условия описывают текущие условия backendTLSPolicy.

Реализации должны предпочесть выразить условия BackendTLSPolicy с помощью BackendTLSPolicyConditionType констант и операторов, чтобы операторы и BackendTLSPolicyConditionReason средства могли конвергентировать общий словарь для описания состояния BackendTLSPolicy.

Известные типы условий:

  • “Принятый”

CommonTLSPolicy

(Отображается в:BackendTLSPolicyConfig)

CommonTLSPolicy — это схема для API CommonTLSPolicy.

Поле Description
verify
CommonTLSPolicyVerify
(Необязательно)

Проверьте параметры проверки однорангового сертификата.

CommonTLSPolicyVerify

(Отображается в:CommonTLSPolicy)

CommonTLSPolicyVerify определяет схему для API CommonTLSPolicyVerify.

Поле Description
caCertificateRef
API шлюза. SecretObjectReference

CaCertificateRef — это сертификат ЦС, используемый для проверки однорангового сертификата.

subjectAltName
струна
(Необязательно)

SubjectAltName — это альтернативное имя субъекта, используемое для проверки однорангового сертификата.

CustomTargetRef

(Отображается в:BackendTLSPolicySpec, FrontendTLSPolicySpec, HealthCheckPolicySpec, RoutePolicySpec)

CustomTargetRef — это ссылка на пользовательский ресурс, который не является’частью основного API Kubernetes.

Поле Description
NamespacedPolicyTargetReference
API шлюза альфа2. NamespacedPolicyTargetReference

(Члены NamespacedPolicyTargetReference внедрены в этот тип.)

sectionNames
[]string
(Необязательно)

SectionNames — это имя раздела в целевом ресурсе. Если этот целевой объект не указан, он предназначен для всего ресурса. В следующих ресурсах имя раздела интерпретируется следующим образом:

  • Шлюз: имя прослушивателя
  • Служба: имя порта

Если параметр SectionNames указан, но’не существует в целевом объекте, политика не сможет подключиться, а реализация политики записывает ResolvedRefs или аналогичное условие в состоянии политики’.

FrontendTLSPolicy

FrontendTLSPolicy — это схема ДЛЯ API FrontendTLSPolicy

Поле Description
metadata
Meta/v1 Kubernetes. ObjectMeta
(Необязательно)

Метаданные объекта’.

Ознакомьтесь с документацией по API Kubernetes для полей metadata поля поля.
spec
FrontendTLSPolicySpec

Спецификация FrontendTLSPolicy.



targetRef
CustomTargetRef

TargetRef определяет объект API для применения политики.

default
FrontendTLSPolicyConfig
(Необязательно)

По умолчанию определяется конфигурация политики по умолчанию для целевого ресурса.

override
FrontendTLSPolicyConfig
(Необязательно)

Переопределение определяет конфигурацию политики, которая должна переопределить конфигурацию политики, подключенную под целевым ресурсом в иерархии.

Примечание. Переопределение в настоящее время не поддерживается и приводит к ошибке проверки. Поддержка Переопределения будет добавлена в будущий выпуск.

status
FrontendTLSPolicyStatus

Состояние определяет текущее состояние FrontendTLSPolicy.

FrontendTLSPolicyConditionReason (string псевдоним)

FrontendTLSPolicyConditionReason определяет набор причин, объясняющих, почему вызывается конкретный тип условия FrontendTLSPolicy.

значение Описание

"Принято"

FrontendTLSPolicyReasonAccepted используется для задания значения FrontendTLSPolicyConditionReason accepted, если заданный frontendTLSPolicy правильно настроен

"InvalidFrontendTLSPolicy"

FrontendTLSPolicyReasonInvalid является причиной, когда FrontendTLSPolicy’не принимается

"InvalidCertificateRef"

FrontendTLSPolicyReasonInvalidCertificateRef используется при ссылке на недопустимый сертификат

"InvalidDefault"

FrontendTLSPolicyReasonInvalidDefault используется, если значение по умолчанию недопустимо

"InvalidGateway"

FrontendTLSPolicyReasonInvalidGateway используется, если шлюз недопустим

"InvalidGroup"

FrontendTLSPolicyReasonInvalidGroup используется, когда группа недопустима

"InvalidKind"

FrontendTLSPolicyReasonInvalidKind используется, если тип или группа недопустим

"InvalidName"

FrontendTLSPolicyReasonInvalidName используется, если имя недопустимо

"InvalidPolicyName"

FrontendTLSPolicyReasonInvalidPolicyName используется, если имя политики недопустимо

"InvalidPolicyType"

FrontendTLSPolicyReasonInvalidPolicyType используется при недопустимом типе политики

"InvalidTargetReference"

FrontendTLSPolicyReasonInvalidTargetReference используется, если целевая ссылка недопустима

NoTargetReference

FrontendTLSPolicyReasonNoTargetReference используется при’отсутствии целевой ссылки

"OverrideNotSupported"

FrontendTLSPolicyReasonOverrideNotSupported используется, когда переопределение не поддерживается’

"RefNotPermitted"

FrontendTLSPolicyReasonRefNotPermitted используется, если ссылка’не разрешена

SectionNamesNotPermitted

FrontendTLSPolicyReasonSectionNamesNotPermitted используется, если имена’разделов не разрешены

FrontendTLSPolicyConditionType (string псевдоним)

FrontendTLSPolicyConditionType — это тип условия, связанного с FrontendTLSPolicy. Этот тип следует использовать с полем FrontendTLSPolicyStatus.Conditions.

значение Описание

"Принято"

FrontendTLSPolicyConditionAccepted используется для задания значения FrontendTLSPolicyCondition для accepted

"ResolvedRefs"

FrontendTLSPolicyConditionRe resolveRefs используется для задания frontendTLSPolicyCondition значение ResolvedRefs

FrontendTLSPolicyConfig

(Отображается в:FrontendTLSPolicySpec)

FrontendTLSPolicyConfig определяет спецификацию политики для политики frontend TLS.

Поле Description
verify
MTLSPolicyVerify
(Необязательно)

Проверьте параметры проверки однорангового сертификата.

policyType
PolicyType
(Необязательно)

Тип политики.

FrontendTLSPolicySpec

(Отображается в:FrontendTLSPolicy)

FrontendTLSPolicySpec определяет требуемое состояние FrontendTLSPolicy

Поле Description
targetRef
CustomTargetRef

TargetRef определяет объект API для применения политики.

default
FrontendTLSPolicyConfig
(Необязательно)

По умолчанию определяется конфигурация политики по умолчанию для целевого ресурса.

override
FrontendTLSPolicyConfig
(Необязательно)

Переопределение определяет конфигурацию политики, которая должна переопределить конфигурацию политики, подключенную под целевым ресурсом в иерархии.

Примечание. Переопределение в настоящее время не поддерживается и приводит к ошибке проверки. Поддержка Переопределения будет добавлена в будущий выпуск.

FrontendTLSPolicyStatus

(Отображается в:FrontendTLSPolicy)

FrontendTLSPolicyStatus определяет наблюдаемое состояние FrontendTLSPolicy.

Поле Description
conditions
[]Kubernetes meta/v1. Состояние
(Необязательно)

Условия описывают текущие условия FrontendTLSPolicy.

Реализации должны предпочесть выражение условий FrontendTLSPolicy с помощью FrontendTLSPolicyConditionType и констант, чтобы операторы и FrontendTLSPolicyConditionReason средства могли конвергентировать общий словарь для описания состояния FrontendTLSPolicy.

Известные типы условий:

  • “Принятый”

FrontendTLSPolicyType (string псевдоним)

(Отображается в:PolicyType)

FrontendTLSPolicyType — это тип политики FRONTend TLS.

значение Описание

"предопределено"

PredefinedFrontendTLSPolicyType — это тип предопределенной политики TLS frontend.

FrontendTLSPolicyTypeName (string псевдоним)

(Отображается в:PolicyType)

FrontendTLSPolicyTypeName — это имя политики TLS frontend.

значение Описание

"2023-06"

PredefinedPolicy202306 — это имя предопределенной политики ПРОТОКОЛА TLS для политики “2023-06”.

"2023-06-S"

PredefinedPolicy202306Strict — это имя предопределенной политики TLS frontend для политики “2023-06-S”. Это строгая версия политики “2023-06”.

GRPCSpecifiers

(Отображается в:HealthCheckPolicyConfig)

GrPCSpecifiers определяет схему для GRPC HealthCheck.

Поле Description
authority
струна
(Необязательно)

Центр, если присутствует, используется в качестве значения заголовка центра в проверке работоспособности.

service
струна
(Необязательно)

Служба позволяет настроить проверку работоспособности, зарегистрированную под другим именем службы.

HTTPHeader

(Отображается в:HeaderFilter)

HTTPHeader представляет имя и значение заголовка HTTP, определенное RFC 7230.

Поле Description
name
HTTPHeaderName

Имя — это имя совпадающего заголовка HTTP. Сопоставление имен должно быть нечувствительным к регистру. (См. ).https://tools.ietf.org/html/rfc7230#section-3.2

Если несколько записей указывают эквивалентные имена заголовков, первая запись с эквивалентным именем должна быть рассмотрена для сопоставления. Последующие записи с эквивалентным именем заголовка должны игнорироваться. Из-за нечувствительности регистра имена заголовков, “foo и “Foo”” считаются эквивалентными.

value
струна

Значение — это значение соответствующего заголовка HTTP.

HTTPHeaderName (string псевдоним)

(Отображается в:HTTPHeader)

HTTPHeaderName — это имя заголовка HTTP.

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

  • “Авторизация”
  • “Set-Cookie”

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

  • ”:method” — недопустимый “” символ. Это означает, что псевдоколонтитулы’HTTP/2 в настоящее время не поддерживаются этим типом.
  • ”/invalid - / ” “является недопустимым” символом

HTTPMatch

(Отображается в:HTTPSpecifiers)

HTTPMatch определяет совпадения HTTP, используемые для проверок HealthCheck.

Поле Description
body
струна
(Необязательно)

Текст определяет сопоставления текста HTTP для проверки работоспособности.

statusCodes
[]StatusCodes
(Необязательно)

StatusCodes определяет сопоставления кода состояния HTTP для проверки работоспособности.

HTTPPathModifier

(Отображается в:Redirect, URLRewriteFilter)

HTTPPathModifier определяет конфигурацию для модификаторов путей.

Поле Description
type
HTTPPathModifierType

Тип определяет тип модификатора пути. Дополнительные типы могут быть добавлены в будущий выпуск API.

Значения могут быть добавлены в эту перечисление, реализации должны гарантировать, что неизвестные значения не вызывают’сбой.

Неизвестные значения здесь должны привести к настройке принятого условия для того, чтобы правило было false

replaceFullPath
струна
(Необязательно)

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

replacePrefixMatch
струна
(Необязательно)

ReplacePrefixMatch указывает значение, с помощью которого необходимо заменить соответствие префикса запроса во время перезаписи или перенаправления. Например, запрос на “/foo/bar” со совпадением “префикса /foo” и ReplacePrefixMatch “/xyz” будет изменен на “/xyz/bar”.

Это соответствует поведению типа сопоставления PathPrefix. Это соответствует элементам полного пути. Элемент path ссылается на список меток в пути, разделенный / разделителем. При указании конечная строка / игнорируется. Например, пути /abcи /abc//abc/def все будут соответствовать префиксу/abc, но путь /abcd не будет’.

ReplacePrefixMatch совместим только с PathPrefix HTTPRouteMatch. Использование любого другого типа HTTPRouteMatch в том же HTTPRouteRule приводит к установке условия status: Falseпринятия маршрута.

Путь запроса Сопоставление префикса Замена префикса Измененный путь
/foo/bar /foo /xyz /xyz/bar
/foo/bar /foo /xyz/ /xyz/bar
/foo/bar /foo/ /xyz /xyz/bar
/foo/bar /foo/ /xyz/ /xyz/bar
/foo /foo /xyz /xyz
/foo/ /foo /xyz /xyz/
/foo/bar /foo /бар
/foo/ /foo /
/foo /foo /
/foo/ /foo / /
/foo /foo / /

HTTPPathModifierType (string псевдоним)

(Отображается в:HTTPPathModifier)

HTTPPathModifierType определяет тип перенаправления пути или перезаписи.

значение Описание

"ReplaceFullPath"

FullPathHTTPPathModifier заменяет полный путь указанным значением.

"ReplacePrefixMatch"

ПрефиксMatchHTTPPathModifier заменяет любой путь префикса значением подстановки. Например, путь со совпадением “префикса /foo” и подстановкой ReplacePrefixMatch “/bar” замените “/foo” на “/bar” в соответствующих запросах.

Это соответствует поведению типа сопоставления PathPrefix. Это соответствует элементам полного пути. Элемент path ссылается на список меток в пути, разделенный / разделителем. При указании конечная строка / игнорируется. Например, пути /abcи /abc//abc/def все будут соответствовать префиксу/abc, но путь /abcd не будет’.

HTTPSpecifiers

(Отображается в:HealthCheckPolicyConfig)

HTTPSpecifiers определяет схему для спецификации проверки работоспособности HTTP.

Поле Description
host
струна
(Необязательно)

Узел — это значение заголовка узла, используемое для проверок HealthCheck.

path
струна
(Необязательно)

Путь — это путь к использованию для проверок HealthCheck.

match
HTTPMatch
(Необязательно)

Сопоставление определяет соответствующих протоколов HTTP, используемых для проверок HealthCheck.

HeaderFilter

(Отображается в:IngressRewrites)

HeaderFilter определяет фильтр, который изменяет заголовки HTTP-запроса или ответа. Разрешено только одно действие для заданного имени заголовка. Фильтры, указывающие несколько действий одного или другого типа для любого имени заголовка, недопустимы и отклонены. Конфигурация для задания или добавления нескольких значений заголовка должна использовать форматирование значений заголовка RFC 7230, разделяя каждое значение запятой.

Поле Description
set
[]HTTPHeader
(Необязательно)

Задание перезаписывает запрос с заданным заголовком (именем, значением) перед действием.

Входные данные: GET /foo HTTP/1.1 my-header: foo

Config: set: - name: my-header” value: bar ““”

Выходные данные: GET /foo HTTP/1.1 my-header: bar

add
[]HTTPHeader
(Необязательно)

Добавьте указанные заголовки (имя, значение) в запрос перед действием. Он добавляется к существующим значениям, связанным с именем заголовка.

Входные данные: GET /foo HTTP/1.1 my-header: foo

Config: add: - name: my-header” value: ““bar,baz”

Выходные данные: GET /foo HTTP/1.1 my-header: foo,bar,baz

remove
[]string
(Необязательно)

Удалите заданные заголовки из HTTP-запроса перед действием. Значение Remove — это список имен заголовков HTTP. Имена заголовков являются нечувствительными к регистру (см. раздел https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).

Входные данные: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz

Конфигурация: remove: [“my-header1”, “my-header3”]

Выходные данные: GET /foo HTTP/1.1 my-header2: bar

HeaderName (string псевдоним)

HeaderName — это имя параметра заголовка или запроса.

HealthCheckPolicy

HealthCheckPolicy — это схема ДЛЯ API HealthCheckPolicy.

Поле Description
metadata
Meta/v1 Kubernetes. ObjectMeta
(Необязательно)

Метаданные объекта’.

Ознакомьтесь с документацией по API Kubernetes для полей metadata поля поля.
spec
HealthCheckPolicySpec

Спецификация HealthCheckPolicy — это спецификация HealthCheckPolicy.



targetRef
CustomTargetRef

TargetRef определяет объект API для применения политики.

override
HealthCheckPolicyConfig
(Необязательно)

Переопределение определяет конфигурацию политики, которая должна переопределить конфигурацию политики, подключенную под целевым ресурсом в иерархии.

Примечание. Переопределение в настоящее время не поддерживается и приведет к ошибке проверки. Поддержка Переопределения будет добавлена в будущий выпуск.

default
HealthCheckPolicyConfig
(Необязательно)

По умолчанию определяется конфигурация политики по умолчанию для целевого ресурса.

status
HealthCheckPolicyStatus

Состояние определяет текущее состояние HealthCheckPolicy.

HealthCheckPolicyConditionReason (string псевдоним)

HealthCheckPolicyConditionReason определяет набор причин, объясняющих, почему вызывается определенный тип условия HealthCheckPolicy.

значение Описание

BackendTLSPolicyNotFound

BackendTLSPolicyConditionNotFound используется, когда серверная часть backendTLSPolicy не найдена для службы.

"Принято"

HealthCheckPolicyReasonAccepted используется для задания значения HealthCheckPolicyConditionReason. Если данный параметр HealthCheckPolicy правильно настроен.

"InvalidHealthCheckPolicy"

HealthCheckPolicyReasonInvalid является причиной, когда HealthCheckPolicy’не принимается.

"InvalidGroup"

HealthCheckPolicyReasonInvalidGroup используется, если группа недопустима.

"InvalidKind"

HealthCheckPolicyReasonInvalidKind используется при недопустимом типе или группе.

"InvalidName"

HealthCheckPolicyReasonInvalidName используется при недопустимом имени.

"InvalidPort"

HealthCheckPolicyReasonInvalidPort используется, если порт недопустим.

"InvalidService"

HealthCheckPolicyReasonInvalidService используется, если служба недопустима.

NoTargetReference

HealthCheckPolicyReasonNoTargetReference используется при’отсутствии целевой ссылки.

"OverrideNotSupported"

HealthCheckPolicyReasonOverrideNotSupported используется, когда переопределение не поддерживается’.

"RefNotPermitted"

HealthCheckPolicyReasonRefNotPermitted используется, если ссылка’не разрешена.

SectionNamesNotPermitted

HealthCheckPolicyReasonSectionNamesNotPermitted используется, если имена’разделов не разрешены.

HealthCheckPolicyConditionType (string псевдоним)

HealthCheckPolicyConditionType — это тип условия, связанного с HealthCheckPolicy. Этот тип следует использовать с полем HealthCheckPolicyStatus.Conditions.

значение Описание

"Принято"

HealthCheckPolicyConditionAccepted используется для задания Значения HealthCheckPolicyConditionType.

"ResolvedRefs"

HealthCheckPolicyConditionRe resolveRefs используется для задания значения HealthCheckPolicyCondition в ResolvedRefs.

HealthCheckPolicyConfig

(Отображается в:HealthCheckPolicySpec)

HealthCheckPolicyConfig определяет схему для спецификации проверки HealthCheck.

Поле Description
interval
Meta/v1 Kubernetes. Длительность
(Необязательно)

Интервал — это количество секунд между проверками HealthCheck.

timeout
Meta/v1 Kubernetes. Длительность
(Необязательно)

Время ожидания — это количество секунд, после которого проверка работоспособности считается неудачной.

port
int32
(Необязательно)

Порт — это порт, используемый для проверок HealthCheck.

unhealthyThreshold
int32
(Необязательно)

НеработоспособныйThreshold — это количество последовательных проверок работоспособности.

healthyThreshold
int32
(Необязательно)

HealthyThreshold — это число последовательных успешных проверок HealthCheck.

useTLS
bool
(Необязательно)

UseTLS указывает, должна ли проверка работоспособности применять TLS. По умолчанию проверка работоспособности будет использовать тот же протокол, что и служба, если для проверки работоспособности используется тот же порт. Если порт отличается, проверка работоспособности будет открытой.

http
HTTPSpecifiers
(Необязательно)

HTTP определяет спецификацию ограничения HTTP для проверки работоспособности целевого ресурса.

grpc
GRPCSpecifiers

GRPC настраивает gRPC версии 1 HealthCheck (https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto) для целевого ресурса.

HealthCheckPolicySpec

(Отображается в:HealthCheckPolicy)

HealthCheckPolicySpec определяет требуемое состояние HealthCheckPolicy.

Поле Description
targetRef
CustomTargetRef

TargetRef определяет объект API для применения политики.

override
HealthCheckPolicyConfig
(Необязательно)

Переопределение определяет конфигурацию политики, которая должна переопределить конфигурацию политики, подключенную под целевым ресурсом в иерархии.

Примечание. Переопределение в настоящее время не поддерживается и приведет к ошибке проверки. Поддержка Переопределения будет добавлена в будущий выпуск.

default
HealthCheckPolicyConfig
(Необязательно)

По умолчанию определяется конфигурация политики по умолчанию для целевого ресурса.

HealthCheckPolicyStatus

(Отображается в:HealthCheckPolicy)

HealthCheckPolicyStatus определяет наблюдаемое состояние HealthCheckPolicy.

Поле Description
conditions
[]Kubernetes meta/v1. Состояние
(Необязательно)

Условия описывают текущие условия HealthCheckPolicy.

Реализации должны предпочесть выразить условия HealthCheckPolicy с помощью HealthCheckPolicyConditionType констант и констант, чтобы операторы и HealthCheckPolicyConditionReason средства могли конвергентировать общий словарь для описания состояния HealthCheckPolicy.

Известные типы условий:

  • “Принятый”

IngressBackendPort

(Отображается в:IngressBackendSettings)

IngressBackendPort описывает порт на серверной части. Необходимо определить только одно из имен или номеров.

Поле Description
port
int32
(Необязательно)

Порт указывает порт на серверной службе.

name
струна
(Необязательно)

Имя должно ссылаться на имя порта в серверной службе.

protocol
Протокол

Протокол должен быть одним из “HTTP”, “HTTPS”

IngressBackendSettingStatus

(Отображается в:IngressExtensionStatus)

IngressBackendSettingStatus описывает состояние backendSetting

Поле Description
service
струна

Служба определяет backendSetting, описывающую это состояние.

validationErrors
[]string
(Необязательно)

Ошибки — это список ошибок, связанных с этим параметром.

valid
bool

Допустимо указывает, что в этом backendSetting отсутствуют ошибки проверки.

IngressBackendSettings

(Отображается в:IngressExtensionSpec)

IngressBackendSettings предоставляет расширенные параметры конфигурации для серверной службы

Поле Description
service
струна

Служба — это имя серверной службы, к которым применяется эта конфигурация.

ports
[]IngressBackendPort
(Необязательно)

Порты можно использовать для указания того, прослушивает ли серверная служба HTTP или HTTPS.

trustedRootCertificate
струна
(Необязательно)

TrustedRootCertificate можно использовать для предоставления сертификата для шлюза для доверия при обмене данными с серверной частью на порте, указанном как https

sessionAffinity
SessionAffinity
(Необязательно)

SessionAffinity позволяет постоянно отправлять клиентские запросы в одну серверную часть.

timeouts
IngressTimeouts
(Необязательно)

Тайм-ауты определяют набор параметров времени ожидания, применяемых к входящего трафика

IngressExtension

IngressExtension — это схема ДЛЯ API IngressExtension

Поле Description
metadata
Meta/v1 Kubernetes. ObjectMeta
(Необязательно)

Метаданные объекта’.

Ознакомьтесь с документацией по API Kubernetes для полей metadata поля поля.
spec
IngressExtensionSpec

Спецификация IngressExtension — это спецификация IngressExtension.



rules
[]IngressRuleSetting
(Необязательно)

Правила определяют правила на узел

backendSettings
[]IngressBackendSettings
(Необязательно)

BackendSettings определяет набор параметров конфигурации для серверных серверных служб входящего трафика

status
IngressExtensionStatus

IngressExtensionConditionReason (string псевдоним)

IngressExtensionConditionReason определяет набор причин, объясняющих, почему возникает определенный тип условия IngressExtension.

значение Описание

"Принято"

IngressExtensionReasonAccepted используется для задания значения IngressExtensionConditionAccepted на Accepted

"HasValidationErrors"

IngressExtensionReasonHasErrors указывает на наличие некоторых ошибок проверки

"NoValidationErrors"

IngressExtensionReasonNoErrors указывает на отсутствие ошибок проверки

"PartiallyAcceptedWithErrors"

IngressExtensionReasonPartiallyAccepted используется для задания значения IngressExtensionConditionAccepted to Accepted, но при возникновении ошибок проверки нефаталных

IngressExtensionConditionType (string псевдоним)

IngressExtensionConditionType — это тип условия, связанного с IngressExtension. Этот тип следует использовать с полем IngressExtensionStatus.Conditions.

значение Описание

"Принято"

IngressExtensionConditionAccepted указывает, принимает ли IngressExtension (примиряется) контроллером.

"Ошибки"

IngressExtensionConditionErrors указывает, существуют ли ошибки проверки или сборки в расширении

IngressExtensionSpec

(Отображается в:IngressExtension)

IngressExtensionSpec определяет нужную конфигурацию IngressExtension

Поле Description
rules
[]IngressRuleSetting
(Необязательно)

Правила определяют правила на узел

backendSettings
[]IngressBackendSettings
(Необязательно)

BackendSettings определяет набор параметров конфигурации для серверных серверных служб входящего трафика

IngressExtensionStatus

(Отображается в:IngressExtension)

IngressExtensionStatus описывает текущее состояние IngressExtension

Поле Description
rules
[]IngressRuleStatus
(Необязательно)

Правила содержат подробные сведения о состоянии каждого правила

backendSettings
[]IngressBackendSettingStatus
(Необязательно)

BackendSettings содержит подробные сведения о состоянии каждого backendSettings

conditions
[]Kubernetes meta/v1. Состояние
(Необязательно)

Условия описывают текущие условия IngressExtension. Известные типы условий:

  • “Принятый”
  • “ошибки”

IngressRewrites

(Отображается в:IngressRuleSetting)

IngressRewrites предоставляет различные перезаписи, поддерживаемые правилом.

Поле Description
type
ПерезаписьType

Тип определяет тип перезаписи

requestHeaderModifier
HeaderFilter
(Необязательно)

RequestHeaderModifier определяет схему, которая изменяет заголовки запросов.

responseHeaderModifier
HeaderFilter
(Необязательно)

RequestHeaderModifier определяет схему, которая изменяет заголовки ответа.

urlRewrite
URLRewriteFilter
(Необязательно)

URLRewrite определяет схему, которая изменяет запрос во время пересылки.

IngressRuleSetting

(Отображается в:IngressExtensionSpec)

IngressRuleSetting предоставляет параметры конфигурации для правил

Поле Description
host
струна

Узел используется для сопоставления с правилами входящего трафика с тем же именем узла, чтобы определить, какие правила влияют на эти параметры.

additionalHostnames
[]string
(Необязательно)

AdditionalHostnames указывает больше имен узлов для прослушивания

rewrites
[]IngressRewrites
(Необязательно)

Перезаписи определяют перезаписи для правила

requestRedirect
Перенаправить
(Необязательно)

RequestRedirect определяет поведение перенаправления для правила

IngressRuleStatus

(Отображается в:IngressExtensionStatus)

IngressRuleStatus описывает состояние правила

Поле Description
host
струна

Узел определяет правило, описываемого состоянием

validationErrors
[]string
(Необязательно)

Ошибки — это список ошибок, связанных с этим параметром.

valid
bool
(Необязательно)

Допустимо указывает, что в этом правиле отсутствуют ошибки проверки

IngressTimeouts

(Отображается в:IngressBackendSettings)

IngressTimeouts можно использовать для настройки свойств времени ожидания для входящего трафика

Поле Description
requestTimeout
Meta/v1 Kubernetes. Длительность
(Необязательно)

RequestTimeout определяет время ожидания, используемое подсистемой балансировки нагрузки при пересылке запросов в серверную службу.

MTLSPolicyVerify

(Отображается в:FrontendTLSPolicyConfig)

MTLSPolicyVerify определяет схему ДЛЯ API MTLSPolicyVerify.

Поле Description
caCertificateRef
API шлюза. SecretObjectReference

CaCertificateRef — это сертификат ЦС, используемый для проверки однорангового сертификата.

subjectAltNames
[]string
(Необязательно)

SubjectAltNames — это список альтернативных имен субъектов, используемых для проверки однорангового сертификата.

PolicyType

(Отображается в:FrontendTLSPolicyConfig)

PolicyType — это тип политики.

Поле Description
name
FrontendTLSPolicyTypeName

Имя политики— это имя политики.

type
FrontendTLSPolicyType

PredefinedFrontendTLSPolicyType — это тип предопределенной политики TLS frontend.

PortNumber (int32 псевдоним)

(Отображается в:Redirect)

PortNumber определяет сетевой порт.

PreciseHostname (string псевдоним)

(Отображается в:Redirect, URLRewriteFilter)

PreciseHostname — это полное доменное имя сетевого узла. Это соответствует определению имени узла RFC 1123 с одним заметным исключением, что числовые IP-адреса не допускаются’.

Для каждого RFC1035 и RFC1123 метка должна состоять из буквенно-цифровых символов нижнего регистра или ‘-’, и должна начинаться и заканчиваться буквенно-цифровым символом. Другие знаки препинания не допускаются.

Протокол (string псевдоним)

(Отображается в:IngressBackendPort)

Протокол определяет протокол, используемый для определенных свойств. Допустимые значения протокола:

  • HTTP
  • HTTPS
  • TCP
значение Описание

HTTP

ПротоколHTTP подразумевает, что служба использует HTTP.

"HTTPS"

ProtocolHTTPS подразумевает, что служба использует HTTPS.

"TCP"

ProtocolTCP подразумевает, что служба использует обычный TCP.

Перенаправить

(Отображается в:IngressRuleSetting)

Перенаправление определяет фильтр, который перенаправляет запрос. Это не должно использоваться в том же правиле, которое также имеет URLRewriteFilter.

Поле Description
scheme
струна
(Необязательно)

Схема — это схема, используемая в значении заголовка Location в ответе. При пустом используется схема запроса.

hostname
Точное имяhostname
(Необязательно)

Имя узла — это имя узла, которое будет использоваться в значении заголовка Location в ответе. При пустом имени узла в Host заголовке запроса используется.

path
HTTPPathModifier
(Необязательно)

Путь определяет параметры, используемые для изменения пути входящего запроса. Затем измененный путь используется для создания заголовка Location . Если пуст, путь запроса используется как есть.

port
Номер порта
(Необязательно)

Порт — это порт, используемый в значении заголовка Location в ответе.

Если порт не указан, порт перенаправления должен быть производным с помощью следующих правил:

  • Если схема перенаправления не пуста, порт перенаправления должен быть хорошо известным портом, связанным с схемой перенаправления. “В частности http” для порта 80 и “https” в порт 443. Если в схеме’перенаправления нет известного порта, следует использовать прослушиватель шлюза.
  • Если схема перенаправления пуста, порт перенаправления должен быть портом прослушивателя шлюза.

Реализации НЕ ДОЛЖНЫ добавлять номер порта в ‘заголовок Location’ в следующих случаях:

  • Заголовок location, использующий HTTP (определяется ли он с помощью протокола прослушивателя или поля схемы) и использует порт 80.
  • Заголовок location, использующий ПРОТОКОЛ HTTPS (определяется через протокол прослушивателя или поле схемы) и использует порт 443.
statusCode
int
(Необязательно)

StatusCode — это код состояния HTTP, используемый в ответе.

Значения могут быть добавлены в эту перечисление, реализации должны гарантировать, что неизвестные значения не вызывают’сбой.

RewriteType (string псевдоним)

(Отображается в:IngressRewrites)

RewriteType определяет тип перезаписи

значение Описание

"RequestHeaderModifier"

RequestHeaderModifier можно использовать для добавления или удаления заголовка HTTP из HTTP-запроса перед’отправкой в вышестоящий целевой объект.

"ResponseHeaderModifier"

ResponseHeaderModifier можно использовать для добавления или удаления заголовка HTTP из HTTP-ответа перед’отправкой клиенту.

URLRewrite

URLRewrite можно использовать для изменения запроса во время пересылки.

RoutePolicy

RoutePolicy — это схема ДЛЯ API RoutePolicy.

Поле Description
metadata
Meta/v1 Kubernetes. ObjectMeta
(Необязательно)

Метаданные объекта’.

Ознакомьтесь с документацией по API Kubernetes для полей metadata поля поля.
spec
RoutePolicySpec

Спецификация RoutePolicy — это спецификация RoutePolicy.



targetRef
CustomTargetRef

TargetRef определяет объект API для применения политики.

override
RoutePolicyConfig
(Необязательно)

Переопределение определяет конфигурацию политики, которая должна переопределить конфигурацию политики, подключенную под целевым ресурсом в иерархии.

Примечание. Переопределение в настоящее время не поддерживается и приводит к ошибке проверки. Поддержка Переопределения будет добавлена в будущий выпуск.

default
RoutePolicyConfig
(Необязательно)

По умолчанию определяется конфигурация политики по умолчанию для целевого ресурса.

status
RoutePolicyStatus

Состояние определяет текущее состояние RoutePolicy.

RoutePolicyConditionReason (string псевдоним)

RoutePolicyConditionReason определяет набор причин, объясняющих, почему вызывается определенный тип условия RoutePolicy.

значение Описание

"Принято"

RoutePolicyReasonAccepted используется для задания Значения RoutePolicyConditionReason, если заданный routePolicy настроен правильно.

"InvalidRoutePolicy"

RoutePolicyReasonInvalid является причиной, когда RoutePolicy’не принимается

"InvalidGRPCRoute"

RoutePolicyReasonInvalidGRPCRoute используется, когда GRPCRoute недопустим

"InvalidGroup"

RoutePolicyReasonInvalidGroup используется, если группа недопустима

"InvalidHTTPRoute"

RoutePolicyReasonInvalidHTTPRoute используется, когда HTTPRoute недопустим

"InvalidKind"

RoutePolicyReasonInvalidKind используется, если тип или группа недопустимы

"InvalidName"

RoutePolicyReasonInvalidName используется, если имя недопустимо

NoTargetReference

RoutePolicyReasonNoTargetReference используется при’отсутствии целевой ссылки

"OverrideNotSupported"

RoutePolicyReasonOverrideNotSupported используется, когда переопределение не поддерживается’

"RefNotPermitted"

RoutePolicyReasonRefNotPermitted используется, если ссылка’не разрешена

SectionNamesNotPermitted

RoutePolicyReasonSectionNamesNotPermitted используется, если имена’разделов не разрешены

RoutePolicyConditionType (string псевдоним)

RoutePolicyConditionType — это тип условия, связанного с RoutePolicy. Этот тип следует использовать с полем RoutePolicyStatus.Conditions.

значение Описание

"Принято"

RoutePolicyConditionAccepted используется для задания Типа RoutePolicyConditionType на Accepted

"ResolvedRefs"

RoutePolicyConditionRe resolveRefs используется для задания routePolicyCondition для ResolvedRefs

RoutePolicyConfig

(Отображается в:RoutePolicySpec)

RoutePolicyConfig определяет схему для спецификации RoutePolicy. Это позволяет спецификации следующих атрибутов: * Timeouts * Session Affinity

Поле Description
timeouts
RouteTimeouts
(Необязательно)

Время ожидания пользовательских тайм-аутов для целевого ресурса.

sessionAffinity
SessionAffinity

SessionAffinity определяет схему для спецификации сопоставления сеансов

RoutePolicySpec

(Отображается в:RoutePolicy)

RoutePolicySpec определяет требуемое состояние RoutePolicy.

Поле Description
targetRef
CustomTargetRef

TargetRef определяет объект API для применения политики.

override
RoutePolicyConfig
(Необязательно)

Переопределение определяет конфигурацию политики, которая должна переопределить конфигурацию политики, подключенную под целевым ресурсом в иерархии.

Примечание. Переопределение в настоящее время не поддерживается и приводит к ошибке проверки. Поддержка Переопределения будет добавлена в будущий выпуск.

default
RoutePolicyConfig
(Необязательно)

По умолчанию определяется конфигурация политики по умолчанию для целевого ресурса.

RoutePolicyStatus

(Отображается в:RoutePolicy)

RoutePolicyStatus определяет наблюдаемое состояние RoutePolicy.

Поле Description
conditions
[]Kubernetes meta/v1. Состояние
(Необязательно)

Условия описывают текущие условия RoutePolicy.

Реализации должны предпочитать экспресс-условия RoutePolicy с помощью RoutePolicyConditionType констант и констант, чтобы операторы и RoutePolicyConditionReason средства могли конвергентироваться в общем словаре для описания состояния RoutePolicy.

Известные типы условий:

  • “Принятый”

RouteTimeouts

(Отображается в:RoutePolicyConfig)

RouteTimeouts определяет схему для спецификации Timeouts.

Поле Description
routeTimeout
Meta/v1 Kubernetes. Длительность
(Необязательно)

RouteTimeout — это время ожидания маршрута.

SessionAffinity

(Отображается в:IngressBackendSettings, RoutePolicyConfig)

SessionAffinity определяет схему для спецификации сопоставления сеансов.

Поле Description
affinityType
AffinityType
cookieName
струна
(Необязательно)
cookieDuration
Meta/v1 Kubernetes. Длительность
(Необязательно)

StatusCodes

(Отображается в:HTTPMatch)

StatusCodes определяет сопоставления кода состояния HTTP для проверки работоспособности.

Поле Description
start
int32
(Необязательно)

Start определяет начало диапазона кодов состояния, используемых для проверок HealthCheck. Это инклюзивно.

end
int32
(Необязательно)

End определяет конец диапазона кодов состояния, используемых для проверок HealthCheck. Это инклюзивно.

URLRewriteFilter

(Отображается в:IngressRewrites)

URLRewriteFilter определяет фильтр, который изменяет запрос во время пересылки. По крайней мере один из этих фильтров может использоваться в правиле. Это не должно использоваться в том же правиле с sslRedirect.

Поле Description
hostname
Точное имяhostname
(Необязательно)

Имя узла — это значение, которое будет использоваться для замены значения заголовка узла во время пересылки.

path
HTTPPathModifier
(Необязательно)

Путь определяет перезапись пути.