kube-proxy 配置 (v1alpha1)

资源类型

FormatOptions

出现位置

FormatOptions 包含不同日志格式的选项。

字段描述
text [必需]
TextOptions

[Alpha] Text 包含“text”日志格式的选项。仅在启用 LoggingAlphaOptions 特性门控时可用。

json [必需]
JSONOptions

[Alpha] JSON 包含“json”日志格式的选项。仅在启用 LoggingAlphaOptions 特性门控时可用。

JSONOptions

出现位置

JSONOptions 包含“json”日志格式的选项。

字段描述
OutputRoutingOptions [必需]
OutputRoutingOptions
OutputRoutingOptions 的成员嵌入到此类型中。)未提供描述。

LogFormatFactory

LogFormatFactory 为某种非默认的额外日志格式提供支持。

LoggingConfiguration

出现位置

LoggingConfiguration 包含日志选项。

字段描述
format [必需]
string

Format 标志指定日志消息的结构。format 的默认值为 text

flushFrequency [必需]
TimeOrMetaDuration

日志刷新的最大间隔时间。如果为字符串,则解析为持续时间(例如,“1s”)。如果为整数,则表示最大纳秒数(例如,1s = 1000000000)。如果选定的日志后端不缓冲日志消息直接写入,则忽略此字段。

verbosity [必需]
VerbosityLevel

Verbosity 是确定哪些日志消息被记录的阈值。默认值为零,仅记录最重要的消息。更高的值会启用附加消息。错误消息始终被记录。

vmodule [必需]
VModuleConfiguration

VModule 为单个文件或模式覆盖详细度阈值。仅支持“text”日志格式。

options [必需]
FormatOptions

[Alpha] Options 保存不同日志格式特有的附加参数。仅使用选定格式的选项,但所有选项都会被校验。仅在启用 LoggingAlphaOptions 特性门控时可用。

LoggingOptions

LoggingOptions 可与 ValidateAndApplyWithOptions 一起使用,以覆盖某些全局默认值。

字段描述
ErrorStream [必需]
io.Writer

ErrorStream 可用于覆盖默认的 os.Stderr。

InfoStream [必需]
io.Writer

InfoStream 可用于覆盖默认的 os.Stdout。

OutputRoutingOptions

出现位置

OutputRoutingOptions 包含“text”和“json”都支持的选项。

字段描述
splitStream [必需]
bool

[Alpha] SplitStream 将错误消息重定向到 stderr,而 info 消息则重定向到 stdout,并带有缓冲。默认是将两者都写入 stdout,不进行缓冲。仅在启用 LoggingAlphaOptions 特性门控时可用。

infoBufferSize [必需]
k8s.io/apimachinery/pkg/api/resource.QuantityValue

[Alpha] InfoBufferSize 设置在使用分流时 info 流的大小。默认值为零,表示禁用缓冲。仅在启用 LoggingAlphaOptions 特性门控时可用。

TextOptions

出现位置

TextOptions 包含“text”日志格式的选项。

字段描述
OutputRoutingOptions [必需]
OutputRoutingOptions
OutputRoutingOptions 的成员嵌入到此类型中。)未提供描述。

TimeOrMetaDuration

出现位置

TimeOrMetaDuration 仅为 flushFrequency 字段的向后兼容而存在,新字段应使用 metav1.Duration。

字段描述
Duration [必需]
meta/v1.Duration

Duration 保存持续时间

- [必需]
bool

SerializeAsString 控制值是序列化为字符串还是整数

VModuleConfiguration

[]k8s.io/component-base/logs/api/v1.VModuleItem 的别名)

出现位置

VModuleConfiguration 是单个文件名或模式及其对应详细度阈值的集合。

VerbosityLevel

uint32 的别名)

出现位置

VerbosityLevel 表示 klog 或 logr 详细度阈值。

ClientConnectionConfiguration

出现位置

ClientConnectionConfiguration 包含构建客户端的详细信息。

字段描述
kubeconfig [必需]
string

kubeconfig 是 KubeConfig 文件的路径。

acceptContentTypes [必需]
string

acceptContentTypes 定义客户端连接到服务器时发送的 Accept 头,覆盖默认值 'application/json'。此字段将控制特定客户端使用的所有连接。

contentType [必需]
string

contentType 是此客户端向服务器发送数据时使用的内容类型。

qps [必需]
float32

qps 控制此连接每秒允许的查询数。

burst [必需]
int32

burst 允许客户端超出其速率时累积额外的查询。

DebuggingConfiguration

出现位置

DebuggingConfiguration 保存调试相关功能的配置。

字段描述
enableProfiling [必需]
bool

enableProfiling 通过 web 界面 host:port/debug/pprof/ 启用性能分析

enableContentionProfiling [必需]
bool

enableContentionProfiling 在 enableProfiling 为 true 时启用阻塞性能分析。

LeaderElectionConfiguration

出现位置

LeaderElectionConfiguration 定义了启用领导者选举的组件的领导者选举客户端配置。

字段描述
leaderElect [必需]
bool

leaderElect 使得领导者选举客户端在执行主循环之前获得领导权。当运行高可用性所需的副本组件时启用此选项。

leaseDuration [必需]
meta/v1.Duration

leaseDuration 是非领导者候选者在观察到领导权续约后,在尝试获取被领导但未续约的领导者席位之前等待的持续时间。这实际上是领导者在被另一个候选者取代之前可以停止的最大持续时间。这仅在启用领导者选举时适用。

renewDeadline [必需]
meta/v1.Duration

renewDeadline 是当前主节点在停止领导之前尝试续约领导者席位的时间间隔。此值必须小于或等于 leaseDuration。这仅在启用领导者选举时适用。

retryPeriod [必需]
meta/v1.Duration

retryPeriod 是客户端在尝试获取和续约领导权之间应等待的持续时间。这仅在启用领导者选举时适用。

resourceLock [必需]
string

resourceLock 表示在领导者选举周期中将用于锁定的资源对象类型。

resourceName [必需]
string

resourceName 表示在领导者选举周期中将用于锁定的资源对象的名称。

resourceNamespace [必需]
string

resourceNamespace 表示在领导者选举周期中将用于锁定的资源对象的命名空间。

KubeProxyConfiguration

KubeProxyConfiguration 包含配置 Kubernetes 代理服务器所需的一切。

字段描述
apiVersion
string
kubeproxy.config.k8s.io/v1alpha1
kind
string
KubeProxyConfiguration
featureGates [必需]
map[string]bool

featureGates 是特性名称到布尔值的映射,用于启用或禁用 Alpha/实验性特性。

clientConnection [必需]
ClientConnectionConfiguration

clientConnection 指定 kube-proxy 服务器与 apiserver 通信时使用的 kubeconfig 文件和客户端连接设置。

logging [必需]
LoggingConfiguration

logging 指定日志记录的选项。有关详细信息,请参阅日志选项

hostnameOverride [必需]
string

hostnameOverride,如果非空,将用作 kube-proxy 运行的节点的名称。如果未设置,则假定节点名称与节点的主机名相同。

bindAddress [必需]
string

bindAddress 可用于覆盖 kube-proxy 对其节点主 IP 的认知。请注意,名称是历史遗留,kube-proxy 实际上并未将任何套接字绑定到此 IP。

healthzBindAddress [必需]
string

healthzBindAddress 是健康检查服务器监听的 IP 地址和端口,默认为 "0.0.0.0:10256"(如果 bindAddress 未设置或为 IPv4),或 "[::]:10256"(如果 bindAddress 为 IPv6)。

metricsBindAddress [必需]
string

metricsBindAddress 是指标服务器监听的 IP 地址和端口,默认为 "127.0.0.1:10249"(如果 bindAddress 未设置或为 IPv4),或 "[::1]:10249"(如果 bindAddress 为 IPv6)。(设置为 "0.0.0.0:10249" / "[::]:10249" 可绑定到所有接口。)

bindAddressHardFail [必需]
bool

bindAddressHardFail,如果为 true,则告诉 kube-proxy 将绑定端口失败视为致命错误并退出。

enableProfiling [必需]
bool

enableProfiling 通过 /debug/pprof 处理程序上的 web 界面启用性能分析。性能分析处理程序将由指标服务器处理。

showHiddenMetricsForVersion [必需]
string

showHiddenMetricsForVersion 是你想要显示隐藏指标的版本。

mode [必需]
ProxyMode

mode 指定使用哪种代理模式。

iptables [必需]
KubeProxyIPTablesConfiguration

iptables 包含与 iptables 相关的配置选项。

ipvs [必需]
KubeProxyIPVSConfiguration

ipvs 包含与 ipvs 相关的配置选项。

nftables [必需]
KubeProxyNFTablesConfiguration

nftables 包含与 nftables 相关的配置选项。

winkernel [必需]
KubeProxyWinkernelConfiguration

winkernel 包含与 winkernel 相关的配置选项。

detectLocalMode [必需]
LocalMode

detectLocalMode 确定用于检测本地流量的模式,默认为 ClusterCIDR

detectLocal [必需]
DetectLocalConfiguration

detectLocal 包含与 DetectLocalMode 相关的可选配置设置。

clusterCIDR [必需]
string

clusterCIDR 是集群中 Pod 的 CIDR 范围。(对于双栈集群,这可以是逗号分隔的双栈 CIDR 范围对。)当 DetectLocalMode 设置为 ClusterCIDR 时,如果流量的源 IP 在此范围内,则 kube-proxy 将认为它是本地流量。(否则不使用此字段。)

nodePortAddresses [必需]
[]string

nodePortAddresses 是包含有效节点 IP 的 CIDR 范围列表,或者是一个字符串 'primary'。如果设置为 CIDR 列表,则对 NodePort 服务的连接将仅在指示范围内的节点 IP 上接受。如果设置为 'primary',则 NodePort 服务将仅根据 Node 对象在节点的主 IPv4 和/或 IPv6 地址上接受。如果未设置,则 NodePort 连接将在所有本地 IP 上接受。

oomScoreAdj [必需]
int32

oomScoreAdj 是 kube-proxy 进程的 oom-score-adj 值。值必须在 [-1000, 1000] 范围内。

conntrack [必需]
KubeProxyConntrackConfiguration

conntrack 包含与连接跟踪相关的配置选项。

configSyncPeriod [必需]
meta/v1.Duration

configSyncPeriod 是从 apiserver 刷新配置的频率。必须大于 0。

portRange [必需]
string

portRange 之前用于配置 userspace proxy,但现在已不再使用。

windowsRunAsService [必需]
bool

windowsRunAsService,如果为 true,则启用 Windows 服务控制管理器 API 集成。

DetectLocalConfiguration

出现位置

DetectLocalConfiguration 包含与 DetectLocalMode 选项相关的可选设置

字段描述
bridgeInterface [必需]
string

bridgeInterface 是一个网桥接口名称。当 DetectLocalMode 设置为 LocalModeBridgeInterface 时,如果流量源自此网桥,则 kube-proxy 将认为它是本地流量。

interfaceNamePrefix [必需]
string

interfaceNamePrefix 是一个接口名称前缀。当 DetectLocalMode 设置为 LocalModeInterfaceNamePrefix 时,如果流量源自名称以此前缀开头的任何接口,则 kube-proxy 将认为它是本地流量。

KubeProxyConntrackConfiguration

出现位置

KubeProxyConntrackConfiguration 包含 Kubernetes 代理服务器的连接跟踪设置。

字段描述
maxPerCore [必需]
int32

maxPerCore 是每个 CPU 核心跟踪的最大 NAT 连接数(0 表示保持现有限制并忽略 min)。

min [必需]
int32

min 是无论 maxPerCore 如何,分配的连接跟踪记录的最小值(设置 maxPerCore=0 以保持现有限制)。

tcpEstablishedTimeout [必需]
meta/v1.Duration

tcpEstablishedTimeout 是空闲 TCP 连接保持打开的时间(例如,“2s”)。必须大于 0 才能设置。

tcpCloseWaitTimeout [必需]
meta/v1.Duration

tcpCloseWaitTimeout 是处于 CLOSE_WAIT 状态的空闲连接跟踪条目在连接跟踪表中保留的时间(例如,“60s”)。必须大于 0 才能设置。

tcpBeLiberal [必需]
bool

tcpBeLiberal,如果为 true,则 kube-proxy 将配置连接跟踪以自由模式运行 TCP 连接,并且序列号乱序的数据包不会被标记为 INVALID。

udpTimeout [必需]
meta/v1.Duration

udpTimeout 是处于 UNREPLIED 状态的空闲 UDP 连接跟踪条目在连接跟踪表中保留的时间(例如,“30s”)。必须大于 0 才能设置。

udpStreamTimeout [必需]
meta/v1.Duration

udpStreamTimeout 是处于 ASSURED 状态的空闲 UDP 连接跟踪条目在连接跟踪表中保留的时间(例如,“300s”)。必须大于 0 才能设置。

KubeProxyIPTablesConfiguration

出现位置

KubeProxyIPTablesConfiguration 包含 Kubernetes 代理服务器的 iptables 相关配置详细信息。

字段描述
masqueradeBit [必需]
int32

masqueradeBit 是在使用 iptables 或 ipvs 代理模式时用于 SNAT 的 iptables fwmark 空间的位。值必须在 [0, 31] 范围内。

masqueradeAll [必需]
bool

masqueradeAll 告诉 kube-proxy 在使用 iptables 或 ipvs 代理模式时,将发送到 Service 集群 IP 的所有流量进行 SNAT。某些 CNI 插件可能需要此设置。

localhostNodePorts [必需]
bool

localhostNodePorts,如果为 false,则告诉 kube-proxy 禁用通过 localhost 访问 NodePort 服务的旧有行为。(仅适用于 iptables 模式和 IPv4;localhost NodePort 在其他代理模式或 IPv6 中永远不允许。)

syncPeriod [必需]
meta/v1.Duration

syncPeriod 是一个间隔(例如,“5s”,“1m”,“2h22m”),表示执行各种重新同步和清理操作的频率。必须大于 0。

minSyncPeriod [必需]
meta/v1.Duration

minSyncPeriod 是 iptables 规则重新同步之间的最小周期(例如,“5s”,“1m”,“2h22m”)。值为 0 意味着每个 Service 或 EndpointSlice 更改都会导致立即进行 iptables 重新同步。

KubeProxyIPVSConfiguration

出现位置

KubeProxyIPVSConfiguration 包含 Kubernetes 代理服务器的 ipvs 相关配置详细信息。

字段描述
syncPeriod [必需]
meta/v1.Duration

syncPeriod 是一个间隔(例如,“5s”,“1m”,“2h22m”),表示执行各种重新同步和清理操作的频率。必须大于 0。

minSyncPeriod [必需]
meta/v1.Duration

minSyncPeriod 是 IPVS 规则重新同步之间的最小周期(例如,“5s”,“1m”,“2h22m”)。值为 0 意味着每个 Service 或 EndpointSlice 更改都会导致立即进行 IPVS 重新同步。

scheduler [必需]
string

scheduler 是要使用的 IPVS 调度器

excludeCIDRs [必需]
[]string

excludeCIDRs 是 ipvs proxier 在清理 ipvs service 时不应触及的 CIDR 列表。

strictARP [必需]
bool

strictARP 配置 arp_ignore 和 arp_announce 以避免响应来自 kube-ipvs0 接口的 ARP 查询。

tcpTimeout [必需]
meta/v1.Duration

tcpTimeout 是用于空闲 IPVS TCP 会话的超时值。默认值为 0,保留系统上的当前超时值。

tcpFinTimeout [必需]
meta/v1.Duration

tcpFinTimeout 是接收到 FIN 后 IPVS TCP 会话的超时值。默认值为 0,保留系统上的当前超时值。

udpTimeout [必需]
meta/v1.Duration

udpTimeout 是用于空闲 IPVS UDP 数据包的超时值。默认值为 0,保留系统上的当前超时值。

KubeProxyNFTablesConfiguration

出现位置

KubeProxyNFTablesConfiguration 包含 Kubernetes 代理服务器的 nftables 相关配置详细信息。

字段描述
masqueradeBit [必需]
int32

masqueradeBit 是在使用 nftables 代理模式时用于 SNAT 的 iptables fwmark 空间的位。值必须在 [0, 31] 范围内。

masqueradeAll [必需]
bool

masqueradeAll 告诉 kube-proxy 在使用 nftables 模式时,将发送到 Service 集群 IP 的所有流量进行 SNAT。某些 CNI 插件可能需要此设置。

syncPeriod [必需]
meta/v1.Duration

syncPeriod 是一个间隔(例如,“5s”,“1m”,“2h22m”),表示执行各种重新同步和清理操作的频率。必须大于 0。

minSyncPeriod [必需]
meta/v1.Duration

minSyncPeriod 是 iptables 规则重新同步之间的最小周期(例如,“5s”,“1m”,“2h22m”)。值为 0 意味着每个 Service 或 EndpointSlice 更改都会导致立即进行 iptables 重新同步。

KubeProxyWinkernelConfiguration

出现位置

KubeProxyWinkernelConfiguration 包含 Kubernetes 代理服务器的 Windows/HNS 设置。

字段描述
networkName [必需]
string

networkName 是 kube-proxy 将用于创建端点和策略的网络名称。

sourceVip [必需]
string

sourceVip 是负载均衡时用于 NAT 的源 VIP 端点的 IP 地址。

enableDSR [必需]
bool

enableDSR 告诉 kube-proxy HNS 策略是否应使用 DSR 创建。

rootHnsEndpointName [必需]
string

rootHnsEndpointName 是连接到 l2bridge 以用于根网络命名空间的 hnsendpoint 名称。

forwardHealthCheckVip [必需]
bool

forwardHealthCheckVip 在 Windows 上转发健康检查端口的 Service VIP。

LocalMode

string 的别名)

出现位置

LocalMode 表示检测来自节点的本地流量的模式。

ProxyMode

string 的别名)

出现位置

ProxyMode 表示 Kubernetes 代理服务器使用的模式。

目前,Linux 平台上有两种代理模式可用:“iptables”和“ipvs”。Windows 平台上有一种代理模式可用:“kernelspace”。

如果未指定代理模式,将使用最佳可用代理模式(目前 Linux 上是 iptables,Windows 上是 kernelspace)。如果无法使用选定的代理模式(由于缺少内核支持、用户空间组件缺失等),kube-proxy 将会因错误退出。

本页面自动生成。

如果你打算报告本页面的问题,请在你的 Issue 描述中提及本页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

最后修改时间 2024 年 12 月 12 日 下午 5:37 PST: 更新 v1.32 的配置 API (2914668152)