You are viewing documentation for Kubernetes version: v1.30
Kubernetes v1.30 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 | |
Overrides kube-proxy's idea of what its node's primary IP is. Note that the name is a historical artifact, and kube-proxy does not actually bind any sockets to this IP. 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 |
|
| --cleanup | |
If true cleanup iptables and ipvs rules and exit. |
|
| --cluster-cidr string | |
The CIDR range of the pods in the cluster. (For dual-stack clusters, this can be a comma-separated dual-stack pair of CIDR ranges.). When --detect-local-mode is set to ClusterCIDR, kube-proxy will consider traffic to be local if its source IP is in this range. (Otherwise it is not used.) 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-be-liberal | |
Enable liberal mode for tracking TCP packets by setting nf_conntrack_tcp_be_liberal to 1 |
|
| --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) |
|
| --conntrack-udp-timeout duration | |
Idle timeout for UNREPLIED UDP connections (0 to leave as-is) |
|
| --conntrack-udp-timeout-stream duration | |
Idle timeout for ASSURED UDP 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 and port for the health check server to serve on, defaulting to "0.0.0.0:10256" (if --bind-address is unset or IPv4), or "[::]:10256" (if --bind-address is IPv6). 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 be used as the name of the Node that kube-proxy is running on. If unset, the node name is assumed to be the same as the node's hostname. |
|
| --init-only | |
If true, perform any initialization steps that must be done with full root privileges, and then exit. After doing this, you can run kube-proxy again with only the CAP_NET_ADMIN capability. |
|
| --iptables-localhost-nodeports Default: true | |
If false, kube-proxy will disable the legacy behavior of allowing NodePort services to be accessed via localhost. (Applies only to iptables mode and IPv4; localhost NodePorts are never allowed with other proxy modes or with IPv6.) |
|
| --iptables-masquerade-bit int32 Default: 14 | |
If using the iptables or ipvs proxy mode, 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 period between iptables rule resyncs (e.g. '5s', '1m', '2h22m'). A value of 0 means every Service or EndpointSlice change will result in an immediate iptables resync. |
|
| --iptables-sync-period duration Default: 30s | |
An interval (e.g. '5s', '1m', '2h22m') indicating how frequently various re-synchronizing and cleanup operations are performed. Must be greater than 0. |
|
| --ipvs-exclude-cidrs strings | |
A comma-separated list of CIDRs which the ipvs proxier should not touch when cleaning up IPVS rules. |
|
| --ipvs-min-sync-period duration | |
The minimum period between IPVS rule resyncs (e.g. '5s', '1m', '2h22m'). A value of 0 means every Service or EndpointSlice change will result in an immediate IPVS resync. |
|
| --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 | |
An interval (e.g. '5s', '1m', '2h22m') indicating how frequently various re-synchronizing and cleanup operations are performed. 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-flush-frequency duration Default: 5s | |
Maximum number of seconds between log flushes |
|
| --log-text-info-buffer-size quantity | |
[Alpha] In text format with split output streams, the info messages can be buffered for a while to increase performance. The default value of zero bytes disables buffering. The size can be specified as number of bytes (512), multiples of 1000 (1K), multiples of 1024 (2Ki), or powers of those (3M, 4G, 5Mi, 6Gi). Enable the LoggingAlphaOptions feature gate to use this. |
|
| --log-text-split-stream | |
[Alpha] In text format, write error messages to stderr and info messages to stdout. The default is to write a single stream to stdout. Enable the LoggingAlphaOptions feature gate to use this. |
|
| --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. |
|
| --logging-format string Default: "text" | |
Sets the log format. Permitted formats: "text". |
|
| --logtostderr Default: true | |
log to standard error instead of files |
|
| --masquerade-all | |
If using the iptables or ipvs proxy mode, SNAT all traffic sent via Service cluster IPs. This may be required with some CNI plugins. |
|
| --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 and port for the metrics server to serve on, defaulting to "127.0.0.1:10249" (if --bind-address is unset or IPv4), or "[::1]:10249" (if --bind-address is IPv6). (Set to "0.0.0.0:10249" / "[::]:10249" to bind on all interfaces.) Set empty to disable. This parameter is ignored if a config file is specified by --config. |
|
| --nodeport-addresses strings | |
A list of CIDR ranges that contain valid node IPs. If set, connections to NodePort services will only be accepted on node IPs in one of the indicated ranges. If unset, NodePort connections will be accepted on all local IPs. 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. When --detect-local-mode is set to BridgeInterface, kube-proxy will consider traffic to be local if it originates from this bridge. |
|
| --pod-interface-name-prefix string | |
An interface name prefix. When --detect-local-mode is set to InterfaceNamePrefix, kube-proxy will consider traffic to be local if it originates from any interface whose name begins with this prefix. |
|
| --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. |
|
| --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=true) |
|
| -v, --v int | |
number for the log level verbosity |
|
| --version version[=true] | |
--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version |
|
| --vmodule pattern=N,... | |
comma-separated list of pattern=N settings for file-filtered logging (only works for text log format) |
|
| --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.