Skip to main content

Services: Node

Kubernetes network proxy

exec kube-proxy --master=http://127.0.0.1:6443
Usage: kube-proxy
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.

Usage:
  kube-proxy [flags]

Flags:
      --bind-address ip                              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. (default 0.0.0.0)
      --bind-address-hard-fail                       If true kube-proxy will treat failure to bind to a port as fatal and exit
      --boot-id-file string                          Comma-separated list of files to check for boot-id. Use the first one that exists. (default "/proc/sys/kernel/random/boot_id")
      --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                  How often configuration from the apiserver is refreshed.  Must be greater than 0. (default 15m0s)
      --conntrack-max-per-core int32                 Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min). (default 32768)
      --conntrack-min int32                          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). (default 131072)
      --conntrack-tcp-timeout-close-wait duration    NAT timeout for TCP connections in the CLOSE_WAIT state (default 1h0m0s)
      --conntrack-tcp-timeout-established duration   Idle timeout for established TCP connections (0 to leave as-is) (default 24h0m0s)
      --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 mapStringBool                  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)
                                                     APISelfSubjectReview=true|false (ALPHA - default=false)
                                                     APIServerIdentity=true|false (BETA - default=true)
                                                     APIServerTracing=true|false (ALPHA - default=false)
                                                     AggregatedDiscoveryEndpoint=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)
                                                     CPUManagerPolicyAlphaOptions=true|false (ALPHA - default=false)
                                                     CPUManagerPolicyBetaOptions=true|false (BETA - default=true)
                                                     CPUManagerPolicyOptions=true|false (BETA - default=true)
                                                     CSIMigrationPortworx=true|false (BETA - default=false)
                                                     CSIMigrationRBD=true|false (ALPHA - default=false)
                                                     CSINodeExpandSecret=true|false (ALPHA - default=false)
                                                     CSIVolumeHealth=true|false (ALPHA - default=false)
                                                     ComponentSLIs=true|false (ALPHA - default=false)
                                                     ContainerCheckpoint=true|false (ALPHA - default=false)
                                                     CronJobTimeZone=true|false (BETA - default=true)
                                                     CrossNamespaceVolumeDataSource=true|false (ALPHA - default=false)
                                                     CustomCPUCFSQuotaPeriod=true|false (ALPHA - default=false)
                                                     CustomResourceValidationExpressions=true|false (BETA - default=true)
                                                     DisableCloudProviders=true|false (ALPHA - default=false)
                                                     DisableKubeletCloudCredentialProviders=true|false (ALPHA - default=false)
                                                     DownwardAPIHugePages=true|false (BETA - default=true)
                                                     DynamicResourceAllocation=true|false (ALPHA - default=false)
                                                     EventedPLEG=true|false (ALPHA - default=false)
                                                     ExpandedDNSConfig=true|false (BETA - default=true)
                                                     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 (BETA - default=true)
                                                     JobReadyPods=true|false (BETA - default=true)
                                                     KMSv2=true|false (ALPHA - default=false)
                                                     KubeletInUserNamespace=true|false (ALPHA - default=false)
                                                     KubeletPodResources=true|false (BETA - default=true)
                                                     KubeletPodResourcesGetAllocatable=true|false (BETA - default=true)
                                                     KubeletTracing=true|false (ALPHA - default=false)
                                                     LegacyServiceAccountTokenTracking=true|false (ALPHA - default=false)
                                                     LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - default=false)
                                                     LogarithmicScaleDown=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)
                                                     MinimizeIPTablesRestore=true|false (ALPHA - default=false)
                                                     MultiCIDRRangeAllocator=true|false (ALPHA - default=false)
                                                     NetworkPolicyStatus=true|false (ALPHA - default=false)
                                                     NodeInclusionPolicyInPodTopologySpread=true|false (BETA - default=true)
                                                     NodeOutOfServiceVolumeDetach=true|false (BETA - default=true)
                                                     NodeSwap=true|false (ALPHA - default=false)
                                                     OpenAPIEnums=true|false (BETA - default=true)
                                                     OpenAPIV3=true|false (BETA - default=true)
                                                     PDBUnhealthyPodEvictionPolicy=true|false (ALPHA - default=false)
                                                     PodAndContainerStatsFromCRI=true|false (ALPHA - default=false)
                                                     PodDeletionCost=true|false (BETA - default=true)
                                                     PodDisruptionConditions=true|false (BETA - default=true)
                                                     PodHasNetworkCondition=true|false (ALPHA - default=false)
                                                     PodSchedulingReadiness=true|false (ALPHA - default=false)
                                                     ProbeTerminationGracePeriod=true|false (BETA - default=true)
                                                     ProcMountType=true|false (ALPHA - default=false)
                                                     ProxyTerminatingEndpoints=true|false (BETA - default=true)
                                                     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 (BETA - default=true)
                                                     RotateKubeletServerCertificate=true|false (BETA - default=true)
                                                     SELinuxMountReadWriteOncePod=true|false (ALPHA - default=false)
                                                     SeccompDefault=true|false (BETA - default=true)
                                                     ServerSideFieldValidation=true|false (BETA - default=true)
                                                     SizeMemoryBackedVolumes=true|false (BETA - default=true)
                                                     StatefulSetAutoDeletePVC=true|false (ALPHA - default=false)
                                                     StatefulSetStartOrdinal=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)
                                                     TopologyManagerPolicyAlphaOptions=true|false (ALPHA - default=false)
                                                     TopologyManagerPolicyBetaOptions=true|false (BETA - default=false)
                                                     TopologyManagerPolicyOptions=true|false (ALPHA - default=false)
                                                     UserNamespacesStatelessPodsSupport=true|false (ALPHA - default=false)
                                                     ValidatingAdmissionPolicy=true|false (ALPHA - default=false)
                                                     VolumeCapacityPriority=true|false (ALPHA - default=false)
                                                     WinDSR=true|false (ALPHA - default=false)
                                                     WinOverlay=true|false (BETA - default=true)
                                                     WindowsHostNetwork=true|false (ALPHA - default=true)
                                                     This parameter is ignored if a config file is specified by --config.
      --healthz-bind-address ipport                  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. (default 0.0.0.0:10256)
  -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                 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. (default true)
      --iptables-masquerade-bit int32                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]. (default 14)
      --iptables-min-sync-period duration            The minimum interval of how often the iptables rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m'). (default 1s)
      --iptables-sync-period duration                The maximum interval of how often iptables rules are refreshed (e.g. '5s', '1m', '2h22m').  Must be greater than 0. (default 30s)
      --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                    The maximum interval of how often ipvs rules are refreshed (e.g. '5s', '1m', '2h22m').  Must be greater than 0. (default 30s)
      --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                         Burst to use while talking with kubernetes apiserver (default 10)
      --kube-api-content-type string                 Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf")
      --kube-api-qps float32                         QPS to use while talking with kubernetes apiserver (default 5)
      --kubeconfig string                            Path to kubeconfig file with authorization information (the master location can be overridden by the master flag).
      --log-flush-frequency duration                 Maximum number of seconds between log flushes (default 5s)
      --machine-id-file string                       Comma-separated list of files to check for machine-id. Use the first one that exists. (default "/etc/machine-id,/var/lib/dbus/machine-id")
      --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                  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. (default 127.0.0.1:10249)
      --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.
      --oom-score-adj int32                          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. (default -999)
      --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.
  -v, --v Level                                      number for the log level verbosity
      --version version[=true]                       Print version information and quit
      --vmodule moduleSpec                           comma-separated list of pattern=N settings for file-filtered logging (only works for the default text log format)
      --write-config-to string                       If set, write the default configuration values to this file and exit.