1. Manuals
  2. Tumbleweed
  3. kubernetes1.25-proxy
  4. kube-proxy(1)

Scroll to navigation

KUBERNETES(1)(kubernetes) KUBERNETES(1)(kubernetes)

NAME

kube-proxy - Provides network proxy services.

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.

kube-proxy [flags]

OPTIONS



  --allow_dynamic_housekeeping                                 Whether to allow the housekeeping interval to be dynamic (default true)


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


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

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


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


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


  --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)


  --container_hints string                                     location of the container hints file (default "/etc/cadvisor/container_hints.json")


  --containerd string                                          containerd endpoint (default "/run/containerd/containerd.sock")


  --containerd-namespace string                                containerd namespace (default "k8s.io")

--containerd_env_metadata_whitelist 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 int 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 300)

--default-unreachable-toleration-seconds int 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. (default 300)



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


  --disable_root_cgroup_stats                                  Disable collecting root Cgroup stats


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


  --enable_load_reader                                         Whether to enable cpu load reader

--event_storage_age_limit string 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 (default "default=0")

--event_storage_event_limit string 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 (default "default=0")

--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)


                                                               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)


                                                               UnauthenticatedHTTP2DOSMitigation=true|false (BETA - default=false)


                                                               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 duration                      Interval between global housekeepings (default 1m0s)

--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.
--housekeeping_interval duration Interval between container housekeepings (default 10s)
--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_cadvisor_usage Whether to log the usage of the cAdvisor container
--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)
--max_housekeeping_interval duration Largest interval to allow between container housekeepings (default 1m0s) --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 '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 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 uint 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 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 ., 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 duration                    Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction (default 1m0s)


  --storage_driver_db string                                   database name (default "cadvisor")

--storage_driver_host string database host port (default "localhost:8086")



  --storage_driver_password string                             database password (default "root")


  --storage_driver_secure                                      use secure connection with database


  --storage_driver_table string                                table name (default "stats")


  --storage_driver_user string                                 database username (default "root")


  --udp-timeout duration                                       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 (default 250ms)


  --update_machine_info_interval duration                      Interval between machine info updates. (default 5m0s)


  --version version[=true]                                     Print version information and quit


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

EXAMPLES

/usr/bin/kube-proxy --logtostderr=true --v=0 --master=http://127.0.0.1:8080

User Manuals