kube-proxy Configuration (v1alpha1)

    KubeProxyConfiguration

    DetectLocalConfiguration

    Appears in:

    DetectLocalConfiguration contains optional settings related to DetectLocalMode option

    FieldDescription
    bridgeInterface [Required]
    string

    BridgeInterface is a string argument which represents a single bridge interface name. Kube-proxy considers traffic as local if originating from this given bridge. This argument should be set if DetectLocalMode is set to LocalModeBridgeInterface.

    interfaceNamePrefix [Required]
    string

    InterfaceNamePrefix is a string argument which represents a single interface prefix name. Kube-proxy considers traffic as local if originating from one or more interfaces which match the given prefix. This argument should be set if DetectLocalMode is set to LocalModeInterfaceNamePrefix.

    KubeProxyConntrackConfiguration

    Appears in:

    KubeProxyConntrackConfiguration contains conntrack settings for the Kubernetes proxy server.

    FieldDescription
    maxPerCore [Required]
    int32

    maxPerCore is the maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore min).

    min [Required]
    int32

    min is the minimum value of connect-tracking records to allocate, regardless of conntrackMaxPerCore (set maxPerCore=0 to leave the limit as-is).

    tcpEstablishedTimeout [Required]

    tcpEstablishedTimeout is how long an idle TCP connection will be kept open (e.g. ‘2s’). Must be greater than 0 to set.

    tcpCloseWaitTimeout [Required]
    meta/v1.Duration

    tcpCloseWaitTimeout is how long an idle conntrack entry in CLOSE_WAIT state will remain in the conntrack table. (e.g. ‘60s’). Must be greater than 0 to set.

    KubeProxyIPTablesConfiguration contains iptables-related configuration details for the Kubernetes proxy server.

    KubeProxyIPVSConfiguration

    Appears in:

    KubeProxyIPVSConfiguration contains ipvs-related configuration details for the Kubernetes proxy server.

    FieldDescription
    syncPeriod [Required]

    syncPeriod is the period that ipvs rules are refreshed (e.g. ‘5s’, ‘1m’, ‘2h22m’). Must be greater than 0.

    minSyncPeriod [Required]
    meta/v1.Duration

    minSyncPeriod is the minimum period that ipvs rules are refreshed (e.g. ‘5s’, ‘1m’, ‘2h22m’).

    scheduler [Required]
    string

    ipvs scheduler

    excludeCIDRs [Required]
    []string

    excludeCIDRs is a list of CIDR’s which the ipvs proxier should not touch when cleaning up ipvs services.

    strictARP [Required]
    bool

    strict ARP configure arp_ignore and arp_announce to avoid answering ARP queries from kube-ipvs0 interface

    tcpTimeout [Required]

    tcpTimeout is the timeout value used for idle IPVS TCP sessions. The default value is 0, which preserves the current timeout value on the system.

    tcpFinTimeout [Required]
    meta/v1.Duration

    tcpFinTimeout is the timeout value used for IPVS TCP sessions after receiving a FIN. The default value is 0, which preserves the current timeout value on the system.

    udpTimeout [Required]

    udpTimeout is the timeout value used for IPVS UDP packets. The default value is 0, which preserves the current timeout value on the system.

    KubeProxyWinkernelConfiguration

    Appears in:

    KubeProxyWinkernelConfiguration contains Windows/HNS settings for the Kubernetes proxy server.

    FieldDescription
    networkName [Required]

    networkName is the name of the network kube-proxy will use to create endpoints and policies

    sourceVip [Required]
    string

    sourceVip is the IP address of the source VIP endoint used for NAT when loadbalancing

    enableDSR [Required]
    bool

    enableDSR tells kube-proxy whether HNS policies should be created with DSR

    rootHnsEndpointName [Required]
    string

    RootHnsEndpointName is the name of hnsendpoint that is attached to l2bridge for root network namespace

    forwardHealthCheckVip [Required]
    bool

    ForwardHealthCheckVip forwards service VIP for health check port on Windows

    LocalMode

    (Alias of string)

    Appears in:

    LocalMode represents modes to detect local traffic from the node

    (Alias of string)

    Appears in:

    ProxyMode represents modes used by the Kubernetes proxy server.

    Currently, two modes of proxy are available on Linux platforms: ‘iptables’ and ‘ipvs’. One mode of proxy is available on Windows platforms: ‘kernelspace’.

    If the proxy mode is unspecified, the best-available proxy mode will be used (currently this is iptables on Linux and kernelspace on Windows). If the selected proxy mode cannot be used (due to lack of kernel support, missing userspace components, etc) then kube-proxy will exit with an error.

    ClientConnectionConfiguration

    ClientConnectionConfiguration contains details for constructing a client.

    DebuggingConfiguration

    Appears in:

    DebuggingConfiguration holds configuration for Debugging related features.

    FieldDescription
    enableProfiling [Required]
    bool

    enableProfiling enables profiling via web interface host:port/debug/pprof/

    enableContentionProfiling [Required]
    bool

    enableContentionProfiling enables lock contention profiling, if enableProfiling is true.

    LeaderElectionConfiguration

    Appears in:

    LeaderElectionConfiguration defines the configuration of leader election clients for components that can run with leader election enabled.

    FieldDescription
    leaderElect [Required]
    bool

    leaderElect enables a leader election client to gain leadership before executing the main loop. Enable this when running replicated components for high availability.

    leaseDuration [Required]
    meta/v1.Duration

    leaseDuration is the duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.

    renewDeadline [Required]

    renewDeadline is the interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.

    retryPeriod [Required]
    meta/v1.Duration

    retryPeriod is the duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.

    resourceLock [Required]
    string

    resourceLock indicates the resource object type that will be used to lock during leader election cycles.

    resourceName [Required]
    string

    resourceName indicates the name of resource object that will be used to lock during leader election cycles.

    resourceNamespace [Required]