kube-proxy - Man Page

Eric Paris Jan 2015

Synopsis

kube-proxy [Options]

Description

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.

Options

--allow_dynamic_housekeeping=true Whether to allow the housekeeping interval to be dynamic

--application_metrics_count_limit=100 Max number of application metrics to store (per container)

--azure-container-registry-config="" Path to the file containing Azure container registry configuration information.

--bind-address=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=false If true kube-proxy will treat failure to bind to a port as fatal and exit

--boot_id_file="/proc/sys/kernel/random/boot_id" Comma-separated list of files to check for boot-id. Use the first one that exists.

--cleanup=false If true cleanup iptables and ipvs rules and exit.

--cloud-provider-gce-l7lb-src-cidrs=130.211.0.0/22,35.191.0.0/16 CIDRs opened in GCE firewall for L7 LB traffic proxy & health checks

--cloud-provider-gce-lb-src-cidrs=130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16 CIDRs opened in GCE firewall for L4 LB traffic proxy & health checks

--cluster-cidr="" 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="" The path to the configuration file.

--config-sync-period=15m0s How often configuration from the apiserver is refreshed.  Must be greater than 0.

--conntrack-max-per-core=32768 Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min).

--conntrack-min=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=1h0m0s NAT timeout for TCP connections in the CLOSE_WAIT state

--conntrack-tcp-timeout-established=24h0m0s Idle timeout for established TCP connections (0 to leave as-is)

--container_hints="/etc/cadvisor/container_hints.json" location of the container hints file

--containerd="/run/containerd/containerd.sock" containerd endpoint

--containerd-namespace="k8s.io" containerd namespace

--containerd_env_metadata_whitelist="" DEPRECATED: this flag will be removed, please use
env_metadata_whitelist. A comma-separated list of environment variable keys matched with specified prefix that needs to be collected for containerd containers

--default-not-ready-toleration-seconds=300 Indicates the tolerationSeconds of the toleration for notReady:NoExecute that is added by default to every pod that does not already have such a toleration.

--default-unreachable-toleration-seconds=300 Indicates the tolerationSeconds of the toleration for unreachable:NoExecute that is added by default to every pod that does not already have such a toleration.

--detect-local-mode= Mode to use to detect local traffic. This parameter is ignored if a config file is specified by --config.

--disable_root_cgroup_stats=false Disable collecting root Cgroup stats

--docker_only=false Only report docker containers in addition to root stats

--enable_load_reader=false Whether to enable cpu load reader

--event_storage_age_limit="default=0" Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types

--event_storage_event_limit="default=0" Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types

--feature-gates= A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: APIListChunking=true|false (BETA - default=true) APIPriorityAndFairness=true|false (BETA - default=true) APIResponseCompression=true|false (BETA - default=true) APIServerIdentity=true|false (ALPHA - default=false) APIServerTracing=true|false (ALPHA - default=false) AllAlpha=true|false (ALPHA - default=false) AllBeta=true|false (BETA - default=false) AnyVolumeDataSource=true|false (BETA - default=true) AppArmor=true|false (BETA - default=true) CPUManager=true|false (BETA - default=true) CPUManagerPolicyAlphaOptions=true|false (ALPHA - default=false) CPUManagerPolicyBetaOptions=true|false (BETA - default=true) CPUManagerPolicyOptions=true|false (BETA - default=true) CSIMigrationAzureFile=true|false (BETA - default=true) CSIMigrationPortworx=true|false (BETA - default=false) CSIMigrationRBD=true|false (ALPHA - default=false) CSIMigrationvSphere=true|false (BETA - default=true) CSINodeExpandSecret=true|false (ALPHA - default=false) CSIVolumeHealth=true|false (ALPHA - default=false) ContainerCheckpoint=true|false (ALPHA - default=false) ContextualLogging=true|false (ALPHA - default=false) CronJobTimeZone=true|false (BETA - default=true) CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false) CustomResourceValidationExpressions=true|false (BETA - default=true) DelegateFSGroupToCSIDriver=true|false (BETA - default=true) DevicePlugins=true|false (BETA - default=true) DisableCloudProviders=true|false (ALPHA - default=false) DisableKubeletCloudCredentialProviders=true|false (ALPHA - default=false) DownwardAPIHugePages=true|false (BETA - default=true) EndpointSliceTerminatingCondition=true|false (BETA - default=true) ExpandedDNSConfig=true|false (ALPHA - default=false) ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false) GRPCContainerProbe=true|false (BETA - default=true) GracefulNodeShutdown=true|false (BETA - default=true) GracefulNodeShutdownBasedOnPodPriority=true|false (BETA - default=true) HPAContainerMetrics=true|false (ALPHA - default=false) HPAScaleToZero=true|false (ALPHA - default=false) HonorPVReclaimPolicy=true|false (ALPHA - default=false) IPTablesOwnershipCleanup=true|false (ALPHA - default=false) InTreePluginAWSUnregister=true|false (ALPHA - default=false) InTreePluginAzureDiskUnregister=true|false (ALPHA - default=false) InTreePluginAzureFileUnregister=true|false (ALPHA - default=false) InTreePluginGCEUnregister=true|false (ALPHA - default=false) InTreePluginOpenStackUnregister=true|false (ALPHA - default=false) InTreePluginPortworxUnregister=true|false (ALPHA - default=false) InTreePluginRBDUnregister=true|false (ALPHA - default=false) InTreePluginvSphereUnregister=true|false (ALPHA - default=false) JobMutableNodeSchedulingDirectives=true|false (BETA - default=true) JobPodFailurePolicy=true|false (ALPHA - default=false) JobReadyPods=true|false (BETA - default=true) JobTrackingWithFinalizers=true|false (BETA - default=true) KMSv2=true|false (ALPHA - default=false) KubeletCredentialProviders=true|false (BETA - default=true) KubeletInUserNamespace=true|false (ALPHA - default=false) KubeletPodResources=true|false (BETA - default=true) KubeletPodResourcesGetAllocatable=true|false (BETA - default=true) KubeletTracing=true|false (ALPHA - default=false) LegacyServiceAccountTokenNoAutoGeneration=true|false (BETA - default=true) LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false) LogarithmicScaleDown=true|false (BETA - default=true) LoggingAlphaOptions=true|false (ALPHA - default=false) LoggingBetaOptions=true|false (BETA - default=true) MatchLabelKeysInPodTopologySpread=true|false (ALPHA - default=false) MaxUnavailableStatefulSet=true|false (ALPHA - default=false) MemoryManager=true|false (BETA - default=true) MemoryQoS=true|false (ALPHA - default=false) MinDomainsInPodTopologySpread=true|false (BETA - default=false) MixedProtocolLBService=true|false (BETA - default=true) MultiCIDRRangeAllocator=true|false (ALPHA - default=false) NetworkPolicyStatus=true|false (ALPHA - default=false) NodeInclusionPolicyInPodTopologySpread=true|false (ALPHA - default=false) NodeOutOfServiceVolumeDetach=true|false (ALPHA - default=false) NodeSwap=true|false (ALPHA - default=false) OpenAPIEnums=true|false (BETA - default=true) OpenAPIV3=true|false (BETA - default=true) PodAndContainerStatsFromCRI=true|false (ALPHA - default=false) PodDeletionCost=true|false (BETA - default=true) PodDisruptionConditions=true|false (ALPHA - default=false) PodHasNetworkCondition=true|false (ALPHA - default=false) ProbeTerminationGracePeriod=true|false (BETA - default=true) ProcMountType=true|false (ALPHA - default=false) ProxyTerminatingEndpoints=true|false (ALPHA - default=false) QOSReserved=true|false (ALPHA - default=false) ReadWriteOncePod=true|false (ALPHA - default=false) RecoverVolumeExpansionFailure=true|false (ALPHA - default=false) RemainingItemCount=true|false (BETA - default=true) RetroactiveDefaultStorageClass=true|false (ALPHA - default=false) RotateKubeletServerCertificate=true|false (BETA - default=true) SELinuxMountReadWriteOncePod=true|false (ALPHA - default=false) SeccompDefault=true|false (BETA - default=true) ServerSideFieldValidation=true|false (BETA - default=true) ServiceIPStaticSubrange=true|false (BETA - default=true) ServiceInternalTrafficPolicy=true|false (BETA - default=true) SizeMemoryBackedVolumes=true|false (BETA - default=true) StatefulSetAutoDeletePVC=true|false (ALPHA - default=false) StorageVersionAPI=true|false (ALPHA - default=false) StorageVersionHash=true|false (BETA - default=true) TopologyAwareHints=true|false (BETA - default=true) TopologyManager=true|false (BETA - default=true) UserNamespacesStatelessPodsSupport=true|false (ALPHA - default=false) VolumeCapacityPriority=true|false (ALPHA - default=false) WinDSR=true|false (ALPHA - default=false) WinOverlay=true|false (BETA - default=true) WindowsHostProcessContainers=true|false (BETA - default=true)This parameter is ignored if a config file is specified by --config.

--global_housekeeping_interval=1m0s Interval between global housekeepings

--healthz-bind-address=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.

--healthz-port=10256 The port to bind the health check server. Use 0 to disable.

--hostname-override="" If non-empty, will use this string as identification instead of the actual hostname.

--housekeeping_interval=10s Interval between container housekeepings

--iptables-masquerade-bit=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=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=30s The maximum interval of how often iptables rules are refreshed (e.g. '5s', '1m', '2h22m').  Must be greater than 0.

--ipvs-exclude-cidrs=[] A comma-separated list of CIDR's which the ipvs proxier should not touch when cleaning up IPVS rules.

--ipvs-min-sync-period=0s The minimum interval of how often the ipvs rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m').

--ipvs-scheduler="" The ipvs scheduler type when proxy mode is ipvs

--ipvs-strict-arp=false Enable strict ARP by setting arp_ignore to 1 and arp_announce to 2

--ipvs-sync-period=30s The maximum interval of how often ipvs rules are refreshed (e.g. '5s', '1m', '2h22m').  Must be greater than 0.

--ipvs-tcp-timeout=0s The timeout for idle IPVS TCP connections, 0 to leave as-is. (e.g. '5s', '1m', '2h22m').

--ipvs-tcpfin-timeout=0s The timeout for IPVS TCP connections after receiving a FIN packet, 0 to leave as-is. (e.g. '5s', '1m', '2h22m').

--ipvs-udp-timeout=0s The timeout for IPVS UDP packets, 0 to leave as-is. (e.g. '5s', '1m', '2h22m').

--kube-api-burst=10 Burst to use while talking with kubernetes apiserver

--kube-api-content-type="application/vnd.kubernetes.protobuf" Content type of requests sent to apiserver.

--kube-api-qps=5 QPS to use while talking with kubernetes apiserver

--kubeconfig="" Path to kubeconfig file with authorization information (the master location can be overridden by the master flag).

--log_cadvisor_usage=false Whether to log the usage of the cAdvisor container

--machine_id_file="/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=false If using the pure iptables proxy, SNAT all traffic sent via Service cluster IPs (this not commonly needed)

--master="" The address of the Kubernetes API server (overrides any value in kubeconfig)

--max_housekeeping_interval=1m0s Largest interval to allow between container housekeepings

--metrics-bind-address=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.

--metrics-port=10249 The port to bind the metrics server. Use 0 to disable.

--nodeport-addresses=[] 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.

--oom-score-adj=-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="" 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="" 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=false 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= Which proxy mode to use: 'iptables' (Linux-only), 'ipvs' (Linux-only), 'kernelspace' (Windows-only), or 'userspace' (Linux/Windows, deprecated). The default value is 'iptables' on Linux and 'userspace' on Windows(will be 'kernelspace' in a future release).This parameter is ignored if a config file is specified by --config.

--proxy-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.

--referenced_reset_interval=0 Reset interval for referenced bytes (container_referenced_bytes metric), number of measurement cycles after which referenced bytes are cleared, if set to 0 referenced bytes are never cleared (default: 0)

--show-hidden-metrics-for-version="" 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 ., 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.

--storage_driver_buffer_duration=1m0s Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction

--storage_driver_db="cadvisor" database name

--storage_driver_host="localhost:8086" database host:port

--storage_driver_password="root" database password

--storage_driver_secure=false use secure connection with database

--storage_driver_table="stats" table name

--storage_driver_user="root" database username

--udp-timeout=250ms How long an idle UDP connection will be kept open (e.g. '250ms', '2s').  Must be greater than 0. Only applicable for proxy-mode=userspace

--update_machine_info_interval=5m0s Interval between machine info updates.

--version=false Print version information and quit

--write-config-to="" If set, write the default configuration values to this file and exit.

History

January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

Info

User Manuals