You are viewing documentation for Kubernetes version: v1.26
Kubernetes v1.26 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date information, see the latest version.
kube-proxy
Synopsis
The Kubernetes network proxy runs on each node. This reflects services as defined in the Kubernetes API on each node and can do simple TCP, UDP, and SCTP stream forwarding or round robin TCP, UDP, and SCTP forwarding across a set of backends. Service cluster IPs and ports are currently found through Docker-links-compatible environment variables specifying ports opened by the service proxy. There is an optional addon that provides cluster DNS for these cluster IPs. The user must create a service with the apiserver API to configure the proxy.
kube-proxy [flags]
Options
| --add_dir_header | |
If true, adds the file directory to the header of the log messages | |
| --alsologtostderr | |
log to standard error as well as files (no effect when -logtostderr=true) | |
| --bind-address string Default: 0.0.0.0 | |
The IP address for the proxy server to serve on (set to '0.0.0.0' for all IPv4 interfaces and '::' for all IPv6 interfaces). This parameter is ignored if a config file is specified by --config. | |
| --bind-address-hard-fail | |
If true kube-proxy will treat failure to bind to a port as fatal and exit | |
| --boot_id_file string Default: "/proc/sys/kernel/random/boot_id" | |
Comma-separated list of files to check for boot-id. Use the first one that exists. | |
| --cleanup | |
If true cleanup iptables and ipvs rules and exit. | |
| --cluster-cidr string | |
The CIDR range of pods in the cluster. When configured, traffic sent to a Service cluster IP from outside this range will be masqueraded and traffic sent from pods to an external LoadBalancer IP will be directed to the respective cluster IP instead. For dual-stack clusters, a comma-separated list is accepted with at least one CIDR per IP family (IPv4 and IPv6). This parameter is ignored if a config file is specified by --config. | |
| --config string | |
The path to the configuration file. | |
| --config-sync-period duration Default: 15m0s | |
How often configuration from the apiserver is refreshed. Must be greater than 0. | |
| --conntrack-max-per-core int32 Default: 32768 | |
Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min). | |
| --conntrack-min int32 Default: 131072 | |
Minimum number of conntrack entries to allocate, regardless of conntrack-max-per-core (set conntrack-max-per-core=0 to leave the limit as-is). | |
| --conntrack-tcp-timeout-close-wait duration Default: 1h0m0s | |
NAT timeout for TCP connections in the CLOSE_WAIT state | |
| --conntrack-tcp-timeout-established duration Default: 24h0m0s | |
Idle timeout for established TCP connections (0 to leave as-is) | |
| --detect-local-mode LocalMode | |
Mode to use to detect local traffic. This parameter is ignored if a config file is specified by --config. | |
| --feature-gates <comma-separated 'key=True|False' pairs> | |
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: | |
| --healthz-bind-address ipport Default: 0.0.0.0:10256 | |
The IP address with port for the health check server to serve on (set to '0.0.0.0:10256' for all IPv4 interfaces and '[::]:10256' for all IPv6 interfaces). Set empty to disable. This parameter is ignored if a config file is specified by --config. | |
| -h, --help | |
help for kube-proxy | |
| --hostname-override string | |
If non-empty, will use this string as identification instead of the actual hostname. | |
| --iptables-localhost-nodeports Default: true | |
If false Kube-proxy will disable the legacy behavior of allowing NodePort services to be accessed via localhost, This only applies to iptables mode and ipv4. | |
| --iptables-masquerade-bit int32 Default: 14 | |
If using the pure iptables proxy, the bit of the fwmark space to mark packets requiring SNAT with. Must be within the range [0, 31]. | |
| --iptables-min-sync-period duration Default: 1s | |
The minimum interval of how often the iptables rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m'). | |
| --iptables-sync-period duration Default: 30s | |
The maximum interval of how often iptables rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0. | |
| --ipvs-exclude-cidrs strings | |
A comma-separated list of CIDR's which the ipvs proxier should not touch when cleaning up IPVS rules. | |
| --ipvs-min-sync-period duration | |
The minimum interval of how often the ipvs rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m'). | |
| --ipvs-scheduler string | |
The ipvs scheduler type when proxy mode is ipvs | |
| --ipvs-strict-arp | |
Enable strict ARP by setting arp_ignore to 1 and arp_announce to 2 | |
| --ipvs-sync-period duration Default: 30s | |
The maximum interval of how often ipvs rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0. | |
| --ipvs-tcp-timeout duration | |
The timeout for idle IPVS TCP connections, 0 to leave as-is. (e.g. '5s', '1m', '2h22m'). | |
| --ipvs-tcpfin-timeout duration | |
The timeout for IPVS TCP connections after receiving a FIN packet, 0 to leave as-is. (e.g. '5s', '1m', '2h22m'). | |
| --ipvs-udp-timeout duration | |
The timeout for IPVS UDP packets, 0 to leave as-is. (e.g. '5s', '1m', '2h22m'). | |
| --kube-api-burst int32 Default: 10 | |
Burst to use while talking with kubernetes apiserver | |
| --kube-api-content-type string Default: "application/vnd.kubernetes.protobuf" | |
Content type of requests sent to apiserver. | |
| --kube-api-qps float Default: 5 | |
QPS to use while talking with kubernetes apiserver | |
| --kubeconfig string | |
Path to kubeconfig file with authorization information (the master location can be overridden by the master flag). | |
| --log_backtrace_at <a string in the form 'file:N'> Default: :0 | |
when logging hits line file:N, emit a stack trace | |
| --log_dir string | |
If non-empty, write log files in this directory (no effect when -logtostderr=true) | |
| --log_file string | |
If non-empty, use this log file (no effect when -logtostderr=true) | |
| --log_file_max_size uint Default: 1800 | |
Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. | |
| --logtostderr Default: true | |
log to standard error instead of files | |
| --machine_id_file string Default: "/etc/machine-id,/var/lib/dbus/machine-id" | |
Comma-separated list of files to check for machine-id. Use the first one that exists. | |
| --masquerade-all | |
If using the pure iptables proxy, SNAT all traffic sent via Service cluster IPs (this not commonly needed) | |
| --master string | |
The address of the Kubernetes API server (overrides any value in kubeconfig) | |
| --metrics-bind-address ipport Default: 127.0.0.1:10249 | |
The IP address with port for the metrics server to serve on (set to '0.0.0.0:10249' for all IPv4 interfaces and '[::]:10249' for all IPv6 interfaces). Set empty to disable. This parameter is ignored if a config file is specified by --config. | |
| --nodeport-addresses strings | |
A string slice of values which specify the addresses to use for NodePorts. Values may be valid IP blocks (e.g. 1.2.3.0/24, 1.2.3.4/32). The default empty string slice ([]) means to use all local addresses. This parameter is ignored if a config file is specified by --config. | |
| --one_output | |
If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true) | |
| --oom-score-adj int32 Default: -999 | |
The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000]. This parameter is ignored if a config file is specified by --config. | |
| --pod-bridge-interface string | |
A bridge interface name in the cluster. Kube-proxy considers traffic as local if originating from an interface which matches the value. This argument should be set if DetectLocalMode is set to BridgeInterface. | |
| --pod-interface-name-prefix string | |
An interface prefix in the cluster. Kube-proxy considers traffic as local if originating from interfaces that match the given prefix. This argument should be set if DetectLocalMode is set to InterfaceNamePrefix. | |
| --profiling | |
If true enables profiling via web interface on /debug/pprof handler. This parameter is ignored if a config file is specified by --config. | |
| --proxy-mode ProxyMode | |
Which proxy mode to use: on Linux this can be 'iptables' (default) or 'ipvs'. On Windows the only supported value is 'kernelspace'.This parameter is ignored if a config file is specified by --config. | |
| --proxy-port-range port-range | |
Range of host ports (beginPort-endPort, single port or beginPort+offset, inclusive) that may be consumed in order to proxy service traffic. If (unspecified, 0, or 0-0) then ports will be randomly chosen. | |
| --show-hidden-metrics-for-version string | |
The previous version for which you want to show hidden metrics. Only the previous minor version is meaningful, other values will not be allowed. The format is <major>.<minor>, e.g.: '1.16'. The purpose of this format is make sure you have the opportunity to notice if the next release hides additional metrics, rather than being surprised when they are permanently removed in the release after that. This parameter is ignored if a config file is specified by --config. | |
| --skip_headers | |
If true, avoid header prefixes in the log messages | |
| --skip_log_headers | |
If true, avoid headers when opening log files (no effect when -logtostderr=true) | |
| --stderrthreshold int Default: 2 | |
logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=false) | |
| -v, --v int | |
number for the log level verbosity | |
| --version version[=true] | |
Print version information and quit | |
| --vmodule <comma-separated 'pattern=N' settings> | |
comma-separated list of pattern=N settings for file-filtered logging | |
| --write-config-to string | |
If set, write the default configuration values to this file and exit. | |
This page is automatically generated.
If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.