Стадия жизненного цикла модуля: Preview
У модуля есть требования для установки
Deckhouse Kubernetes Platform устанавливает CRD, но не удаляет их при отключении модуля. Если вам больше не нужны созданные CRD, удалите их.
ALBInstance
Scope: Namespaced
Version: v1alpha1
Определяет ресурс ALBInstance для настройки экземпляра ALB в рамках пользовательского неймспейса.
Namespaced-ресурс для Gateway уровня приложения или проекта.
Используйте его, когда:
- команда должна управлять своим Gateway в собственном неймспейсе;
- Gateway выделен под один проект;
- достаточно режима
LoadBalancer.
-
объектspecСпецификация ресурса ALBInstance, определяющая параметры шлюза, точки входа, сетевые ограничения и параметры размещения data-plane.
-
массив строкspec.acceptRequestsFromБелый список источников, которым разрешено отправлять запросы.
-
строкаspec.acceptRequestsFrom.Элемент массива
Шаблон:
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$
-
-
объектspec.additionalHeadersДополнительные заголовки, добавляемые в upstream-запросы.
-
объектspec.basicAuthОпределяет, должна ли быть глобально включена basic-аутентификация.
-
булевыйspec.basicAuth.enabledУказывает, включена ли basic-аутентификация.
-
объектspec.basicAuth.secretОпределяет имя и неймспейс секрета, используемого для basic-аутентификации.
-
строкаspec.basicAuth.secret.name
Обязательный параметр
Имя секрета. -
строкаspec.basicAuth.secret.namespace
Обязательный параметр
Неймспейс секрета.
-
-
-
объектspec.controllerPodsAdditionalAnnotationsДополнительные аннотации для подов контроллера и data-plane.
-
строкаspec.envoyLogLevelОпределяет уровень логирования Envoy-прокси.
По умолчанию:
WarningДопустимые значения:
Off,Critical,Error,Warning,Info,Debug,Trace -
строкаspec.gatewayName
Обязательный параметр
Имя ресурса Gateway, к которому относится данный экземпляр.Минимальная длина:
1 -
объектspec.geoIPКонфигурация загрузчика GeoIP-баз для подов прокси.
-
объектspec.geoIP.headersИмена заголовков ответа, которые заполняет GeoIP-фильтр.
-
строкаspec.geoIP.headers.anonИмя заголовка для признаков анонимного IP.
-
строкаspec.geoIP.headers.asnИмя заголовка для ASN.
-
строкаspec.geoIP.headers.cityИмя заголовка для города.
-
строкаspec.geoIP.headers.countryИмя заголовка для кода страны.
-
строкаspec.geoIP.headers.ispИмя заголовка для названия ISP.
-
строкаspec.geoIP.headers.regionИмя заголовка для региона или административной единицы.
-
-
массив строкspec.geoIP.maxmindEditionIDsСписок редакций баз данных, которые нужно загрузить при старте.
По умолчанию:
[ "GeoLite2-City" ]-
строкаspec.geoIP.maxmindEditionIDs.Элемент массива
Допустимые значения:
GeoIP2-Anonymous-IP,GeoIP2-City,GeoIP2-ISP,GeoIP2-ASN,GeoLite2-ASN,GeoLite2-City
-
-
объектspec.geoIP.maxmindMirror
Конфигурация зеркала для загрузки GeoIP-баз. Если параметр не задан или пуст, используется значение по умолчанию
https://download.maxmind.com.Если зеркало используется для раздачи заранее подготовленных архивов, параметр
licenseKeyможно не указывать.-
булевыйspec.geoIP.maxmindMirror.insecureSkipVerifyПропускает проверку TLS-сертификата зеркала, например при использовании самоподписанных сертификатов.
-
строкаspec.geoIP.maxmindMirror.url
Обязательный параметр
URL для загрузки GeoIP-баз.Шаблон:
^https?://.+$Примеры:
url: https://mirror.localurl: absolute path https://mirror.local/GeoLite2-City.tar.gz
-
-
-
объектspec.inlet
Обязательный параметр
Определяет способ поступления входящего трафика в data-plane.-
массив объектовspec.inlet.additionalPortsДополнительные порты сервиса, публикуемые помимо стандартных 80/443.
-
целочисленныйspec.inlet.additionalPorts.portНомер дополнительного порта сервиса.
Допустимые значения:
1 <= X <= 65535 -
строкаspec.inlet.additionalPorts.protocolСетевой протокол дополнительного порта сервиса. На данный момент поддерживается только
TCP.Допустимые значения:
TCP
-
-
объектspec.inlet.loadBalancerПараметры точки входа
LoadBalancer.По умолчанию:
{}-
объектspec.inlet.loadBalancer.serviceAnnotationsДополнительные аннотации для сервиса типа
LoadBalancer.
-
-
строкаspec.inlet.type
Обязательный параметр
Поддерживаемый тип точки входа.Допустимые значения:
LoadBalancer
-
-
объектspec.istioSidecarПараметры автоматической инъекции Istio-сайдкаров в поды прокси.
-
булевыйspec.istioSidecar.enabledДобавляет аннотации в поды прокси для автоматической инъекции контейнеров Istio-сайдкаров.
-
объектspec.istioSidecar.resourcesНастройки requests и limits ресурсов для инжектируемого контейнера Istio-сайдкара.
-
объектspec.istioSidecar.resources.limitsЛимиты ресурсов.
-
строкаspec.istioSidecar.resources.limits.cpuЛимит CPU.
-
строкаspec.istioSidecar.resources.limits.memoryЛимит памяти.
-
-
объектspec.istioSidecar.resources.requestsЗапрашиваемые ресурсы.
-
строкаspec.istioSidecar.resources.requests.cpuЗапрос CPU.
-
строкаspec.istioSidecar.resources.requests.memoryЗапрос памяти.
-
-
-
-
целочисленныйspec.minReplicasМинимальное количество реплик Envoy Proxy. Если установлено значение больше 1, создается объект PodDisruptionBudget.
По умолчанию:
1Допустимые значения:
1 <= X -
объектspec.nodeSelectorNode selector для подов.
-
объектspec.originalIPDetectionОпределяет должен ли Envoy Proxy использовать заголовки при вычислении исходного IP-адреса клиента.
-
строкаspec.originalIPDetection.realIPHeaderОпределяет заголовок используемый для вычисления исходного IP-адреса клиента.
По умолчанию:
X-Forwarded-ForПример:
realIPHeader: X-Real-IP -
массив строкspec.originalIPDetection.setRealIPFrom
Обязательный параметр
Определяет диапазоны CIDR, которым разрешено передавать заголовки для определения исходного IP-адреса клиента.-
строкаspec.originalIPDetection.setRealIPFrom.Элемент массива
Шаблон:
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$
-
-
-
объектspec.resourcesManagementНастройки requests и limits CPU и памяти для pod’ов контроллера.
-
строкаspec.resourcesManagement.mode
Обязательный параметр
Режим управления ресурсами.По умолчанию:
VPAДопустимые значения:
VPA,Static -
объектspec.resourcesManagement.staticНастройки статического режима.
-
объектspec.resourcesManagement.static.limitsЛимиты ресурсов.
По умолчанию:
{}-
строкаspec.resourcesManagement.static.limits.cpuЛимит CPU.
-
строкаspec.resourcesManagement.static.limits.memoryЛимит памяти.
-
-
объектspec.resourcesManagement.static.requestsЗапрашиваемые ресурсы.
По умолчанию:
{}-
строкаspec.resourcesManagement.static.requests.cpuЗапрос CPU.
По умолчанию:
350m -
строкаspec.resourcesManagement.static.requests.memoryЗапрос памяти.
По умолчанию:
500Mi
-
-
-
объектspec.resourcesManagement.vpaНастройки управления ресурсами для режима VPA.
-
объектspec.resourcesManagement.vpa.cpuНастройки VPA, связанные с CPU.
По умолчанию:
{}-
числоspec.resourcesManagement.vpa.cpu.limitRatio
Отношение limits/request CPU.
Если задано, limits рассчитываются на основе requests и указанного коэффициента.
-
строкаspec.resourcesManagement.vpa.cpu.maxМаксимальное значение request CPU, которое VPA может выставить.
По умолчанию:
1500m -
строкаspec.resourcesManagement.vpa.cpu.minМинимальное значение request CPU, которое VPA может выставить.
По умолчанию:
100m
-
-
объектspec.resourcesManagement.vpa.memoryНастройки VPA, связанные с памятью.
По умолчанию:
{}-
числоspec.resourcesManagement.vpa.memory.limitRatio
Отношение limits/request памяти.
Если задано, limits рассчитываются на основе requests и указанного коэффициента.
-
строкаspec.resourcesManagement.vpa.memory.maxМаксимальное значение request памяти, которое VPA может выставить.
По умолчанию:
2000Mi -
строкаspec.resourcesManagement.vpa.memory.minМинимальное значение request памяти, которое VPA может выставить.
По умолчанию:
500Mi
-
-
строкаspec.resourcesManagement.vpa.modeРежим работы VPA.
По умолчанию:
InitialДопустимые значения:
Initial,InPlaceOrRecreate
-
-
-
массив объектовspec.tolerationsTolerations для подов.
-
строкаspec.tolerations.effect
Допустимые значения:
NoSchedule,PreferNoSchedule,NoExecute -
строкаspec.tolerations.key
-
строкаspec.tolerations.operator
Допустимые значения:
Exists,Equal -
целочисленныйspec.tolerations.tolerationSeconds
Допустимые значения:
0 <= X -
строкаspec.tolerations.value
-
-
булевыйspec.useProxyProtocolВключает поддержку PROXY protocol.
-
-
объектstatusСтатус ресурса ALBInstance, отражающий фактическое состояние связанного Gateway и data-plane.
-
булевыйstatus.conflictPorts
true, еслиadditionalPortsэтого экземпляра игнорируются, потому что авторитетным является другой, более старый экземпляр с тем жеgatewayName. -
строкаstatus.conflictPortsOwnerСсылка на более старый экземпляр, который определяет фактические
additionalPortsдля данногоgatewayName. -
строкаstatus.gatewayФактическое имя Gateway, обслуживаемого данным экземпляром.
-
целочисленныйstatus.observedGenerationНомер поколения ресурса, обработанного контроллером.
Допустимые значения:
0 <= X -
булевыйstatus.ready
true, если экземпляр готов обслуживать трафик. -
булевыйstatus.synced
true, если желаемое и фактическое состояние ресурсов синхронизированы.
-
ClusterALBInstance
Scope: Cluster
Version: v1alpha1
Определяет ресурс ClusterALBInstance для настройки экземпляра ALB на уровне кластера, расположенный в системном пространстве имен.
Cluster-scoped ресурс для общих или платформенных Gateway.
Используйте его, когда:
- Gateway должен находиться в неймспейсе контроллера;
- Gateway разделяется между несколькими приложениями или командами;
- нужен режим
HostPort; - нужны возможности уровня кластера вроде default Deckhouse Gateway.
-
объектspecСпецификация ресурса ClusterALBInstance, определяющая параметры шлюза, точки входа, сетевые ограничения и параметры размещения data-plane.
-
массив строкspec.acceptRequestsFromБелый список источников, которым разрешено отправлять запросы.
-
строкаspec.acceptRequestsFrom.Элемент массива
Шаблон:
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$
-
-
объектspec.additionalHeadersДополнительные HTTP-заголовки, добавляемые к запросам.
-
объектspec.basicAuthОпределяет, должна ли быть глобально включена basic-аутентификация.
-
булевыйspec.basicAuth.enabledУказывает, включена ли basic-аутентификация.
-
объектspec.basicAuth.secretОпределяет имя и неймспейс секрета, используемого для basic-аутентификации.
-
строкаspec.basicAuth.secret.name
Обязательный параметр
Имя секрета. -
строкаspec.basicAuth.secret.namespace
Обязательный параметр
Неймспейс секрета.
-
-
-
объектspec.controllerPodsAdditionalAnnotationsДополнительные аннотации для подов контроллера и data-plane.
-
булевыйspec.defaultDeckhouseGateway
Помечает шлюз как шлюз Deckhouse по умолчанию в кластере. Такой шлюз используется для публикации HTTP/HTTPS-эндпоинтов Deckhouse.
Внимание: если несколько шлюзов помечены как default, будет выбран самый старый.
-
строкаspec.envoyLogLevelОпределяет уровень логирования Envoy-прокси.
По умолчанию:
WarningДопустимые значения:
Off,Critical,Error,Warning,Info,Debug,Trace -
строкаspec.gatewayName
Обязательный параметр
Имя ресурса Gateway, к которому относится данный экземпляр.Минимальная длина:
1 -
объектspec.geoIPКонфигурация загрузчика GeoIP-баз для подов прокси.
-
объектspec.geoIP.headersИмена HTTP-заголовков запроса, которые заполняет GeoIP-фильтр (добавляются к запросам к upstream).
-
строкаspec.geoIP.headers.anonИмя заголовка для признаков анонимного IP.
-
строкаspec.geoIP.headers.asnИмя заголовка для ASN.
-
строкаspec.geoIP.headers.cityИмя заголовка для города.
-
строкаspec.geoIP.headers.countryИмя заголовка для кода страны.
-
строкаspec.geoIP.headers.ispИмя заголовка для названия ISP.
-
строкаspec.geoIP.headers.regionИмя заголовка для региона или административной единицы.
-
-
массив строкspec.geoIP.maxmindEditionIDsСписок редакций баз данных, которые нужно загрузить при старте.
По умолчанию:
[ "GeoLite2-City" ]-
строкаspec.geoIP.maxmindEditionIDs.Элемент массива
Допустимые значения:
GeoIP2-Anonymous-IP,GeoIP2-City,GeoIP2-ISP,GeoIP2-ASN,GeoLite2-ASN,GeoLite2-City
-
-
объектspec.geoIP.maxmindMirror
Конфигурация зеркала для загрузки GeoIP-баз. Если параметр не задан или пуст, используется значение по умолчанию
https://download.maxmind.com.Если зеркало раздаёт заранее подготовленные архивы, параметр
licenseKeyможно не указывать.-
булевыйspec.geoIP.maxmindMirror.insecureSkipVerifyПропускает проверку TLS-сертификата зеркала, например при использовании самоподписанных сертификатов.
-
строкаspec.geoIP.maxmindMirror.url
Обязательный параметр
URL для загрузки GeoIP-баз.Шаблон:
^https?://.+$Примеры:
url: https://mirror.localurl: https://mirror.local/GeoLite2-City.tar.gz
-
-
-
объектspec.inlet
Обязательный параметр
Определяет способ поступления входящего трафика в data-plane.-
массив объектовspec.inlet.additionalPortsДополнительные порты сервиса, публикуемые помимо стандартных 80/443. Для точек входа
HostPortэти порты также пробрасываются какhostPortна управляемом DaemonSet.-
целочисленныйspec.inlet.additionalPorts.portНомер дополнительного порта сервиса.
Допустимые значения:
1 <= X <= 65535 -
строкаspec.inlet.additionalPorts.protocolСетевой протокол дополнительного порта сервиса. На данный момент поддерживается только
TCP.Допустимые значения:
TCP
-
-
объектspec.inlet.hostPortПараметры точки входа
HostPort.-
целочисленныйspec.inlet.hostPort.httpPort
Порт для небезопасных HTTP-соединений.
Если параметр не задан, нельзя установить соединение по HTTP.
Этот параметр обязателен, если не задан
httpsPort. -
целочисленныйspec.inlet.hostPort.httpsPort
Порт для защищённых HTTPS-соединений.
Если параметр не задан, нельзя установить соединение по HTTPS.
Этот параметр обязателен, если не задан
httpPort.
-
-
объектspec.inlet.loadBalancerПараметры точки входа
LoadBalancer.-
объектspec.inlet.loadBalancer.serviceAnnotationsДополнительные аннотации для сервиса типа
LoadBalancer.
-
-
строкаspec.inlet.type
Обязательный параметр
Поддерживаемый тип точки входа.Допустимые значения:
LoadBalancer,HostPort
-
-
объектspec.istioSidecarПараметры автоматической инъекции Istio-сайдкаров в поды прокси.
-
булевыйspec.istioSidecar.enabledДобавляет аннотации в поды прокси для автоматической инъекции контейнеров Istio-сайдкаров.
-
объектspec.istioSidecar.resourcesНастройки requests и limits ресурсов для инжектируемого контейнера Istio-сайдкара.
-
объектspec.istioSidecar.resources.limitsЛимиты ресурсов.
-
строкаspec.istioSidecar.resources.limits.cpuЛимит CPU.
-
строкаspec.istioSidecar.resources.limits.memoryЛимит памяти.
-
-
объектspec.istioSidecar.resources.requestsЗапрашиваемые ресурсы.
-
строкаspec.istioSidecar.resources.requests.cpuЗапрос CPU.
-
строкаspec.istioSidecar.resources.requests.memoryЗапрос памяти.
-
-
-
-
объектspec.nodeSelectorNode selector для подов.
-
объектspec.originalIPDetectionОпределяет должен ли Envoy Proxy использовать заголовки при вычислении исходного IP-адреса клиента.
-
строкаspec.originalIPDetection.realIPHeaderОпределяет заголовок используемый для вычисления исходного IP-адреса клиента.
По умолчанию:
X-Forwarded-ForПример:
realIPHeader: X-Real-IP -
массив строкspec.originalIPDetection.setRealIPFrom
Обязательный параметр
Определяет диапазоны CIDR, которым разрешено передавать заголовки для определения исходного IP-адреса клиента.-
строкаspec.originalIPDetection.setRealIPFrom.Элемент массива
Шаблон:
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$
-
-
-
объектspec.resourcesManagementНастройки requests и limits CPU и памяти для pod’ов контроллера.
-
строкаspec.resourcesManagement.mode
Обязательный параметр
Режим управления ресурсами.По умолчанию:
VPAДопустимые значения:
VPA,Static -
объектspec.resourcesManagement.staticНастройки статического режима.
-
объектspec.resourcesManagement.static.limitsЛимиты ресурсов.
По умолчанию:
{}-
строкаspec.resourcesManagement.static.limits.cpuЛимит CPU.
-
строкаspec.resourcesManagement.static.limits.memoryЛимит памяти.
-
-
объектspec.resourcesManagement.static.requestsЗапрашиваемые ресурсы.
По умолчанию:
{}-
строкаspec.resourcesManagement.static.requests.cpuЗапрос CPU.
По умолчанию:
350m -
строкаspec.resourcesManagement.static.requests.memoryЗапрос памяти.
По умолчанию:
500Mi
-
-
-
объектspec.resourcesManagement.vpaНастройки управления ресурсами для режима VPA.
-
объектspec.resourcesManagement.vpa.cpuНастройки VPA, связанные с CPU.
По умолчанию:
{}-
числоspec.resourcesManagement.vpa.cpu.limitRatio
Отношение limits/request CPU.
Если задано, limits рассчитываются на основе requests и указанного коэффициента.
-
строкаspec.resourcesManagement.vpa.cpu.maxМаксимальное значение request CPU, которое VPA может выставить.
По умолчанию:
1500m -
строкаspec.resourcesManagement.vpa.cpu.minМинимальное значение request CPU, которое VPA может выставить.
По умолчанию:
100m
-
-
объектspec.resourcesManagement.vpa.memoryНастройки VPA, связанные с памятью.
По умолчанию:
{}-
числоspec.resourcesManagement.vpa.memory.limitRatio
Отношение limits/request памяти.
Если задано, limits рассчитываются на основе requests и указанного коэффициента.
-
строкаspec.resourcesManagement.vpa.memory.maxМаксимальное значение request памяти, которое VPA может выставить.
По умолчанию:
2000Mi -
строкаspec.resourcesManagement.vpa.memory.minМинимальное значение request памяти, которое VPA может выставить.
По умолчанию:
500Mi
-
-
строкаspec.resourcesManagement.vpa.modeРежим работы VPA.
По умолчанию:
InitialДопустимые значения:
Initial,InPlaceOrRecreate
-
-
-
массив объектовspec.tolerationsTolerations для подов.
-
строкаspec.tolerations.effect
Допустимые значения:
NoSchedule,PreferNoSchedule,NoExecute -
строкаspec.tolerations.key
-
строкаspec.tolerations.operator
Допустимые значения:
Exists,Equal -
целочисленныйspec.tolerations.tolerationSeconds
Допустимые значения:
0 <= X -
строкаspec.tolerations.value
-
-
булевыйspec.useProxyProtocolВключает поддержку PROXY protocol.
-
-
объектstatusСтатус ресурса ClusterALBInstance, отражающий фактическое состояние связанного Gateway и data-plane.
-
булевыйstatus.conflictPorts
true, еслиadditionalPortsэтого экземпляра игнорируются, потому что авторитетным является другой, более старый экземпляр с тем жеgatewayName. -
строкаstatus.conflictPortsOwnerСсылка на более старый экземпляр, который определяет фактические
additionalPortsдля данногоgatewayName. -
булевыйstatus.defaultGateway
true, если этот кластерный ClusterALBInstance выбран в качестве источника шлюза по умолчанию. -
строкаstatus.gatewayФактическое имя Gateway, обслуживаемого данным экземпляром.
-
целочисленныйstatus.observedGenerationНомер поколения ресурса, обработанного контроллером.
Допустимые значения:
0 <= X -
булевыйstatus.ready
true, если экземпляр готов обслуживать трафик. -
булевыйstatus.synced
true, если желаемое и фактическое состояние ресурсов синхронизированы.
-