Skip to content

Commit 0d7d747

Browse files
committed
Add kube-proxy config reference
This is a reference for kube-proxy config generated from kubernetes-sigs/reference-docs/genref tool. More specifically, it is generated using the following command: ./genref -include kube-proxy
1 parent d79edc1 commit 0d7d747

File tree

5 files changed

+561
-9
lines changed

5 files changed

+561
-9
lines changed

content/en/docs/concepts/services-networking/service.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -513,8 +513,13 @@ allocates a port from a range specified by `--service-node-port-range` flag (def
513513
Each node proxies that port (the same port number on every Node) into your Service.
514514
Your Service reports the allocated port in its `.spec.ports[*].nodePort` field.
515515

516-
If you want to specify particular IP(s) to proxy the port, you can set the `--nodeport-addresses` flag in kube-proxy to particular IP block(s); this is supported since Kubernetes v1.10.
517-
This flag takes a comma-delimited list of IP blocks (e.g. 10.0.0.0/8, 192.0.2.0/25) to specify IP address ranges that kube-proxy should consider as local to this node.
516+
If you want to specify particular IP(s) to proxy the port, you can set the
517+
`--nodeport-addresses` flag for kube-proxy or the equivalent `nodePortAddresses`
518+
field of the
519+
[kube-proxy configuration file](/docs/reference/config-api/kube-proxy-config.v1alpha1/)
520+
to particular IP block(s).
521+
522+
This flag takes a comma-delimited list of IP blocks (e.g. `10.0.0.0/8`, `192.0.2.0/25`) to specify IP address ranges that kube-proxy should consider as local to this node.
518523

519524
For example, if you start kube-proxy with the `--nodeport-addresses=127.0.0.0/8` flag, kube-proxy only selects the loopback interface for NodePort Services. The default for `--nodeport-addresses` is an empty list. This means that kube-proxy should consider all available network interfaces for NodePort. (That's also compatible with earlier Kubernetes releases).
520525

@@ -530,7 +535,9 @@ to configure environments that are not fully supported by Kubernetes, or even
530535
to just expose one or more nodes' IPs directly.
531536

532537
Note that this Service is visible as `<NodeIP>:spec.ports[*].nodePort`
533-
and `.spec.clusterIP:spec.ports[*].port`. (If the `--nodeport-addresses` flag in kube-proxy is set, <NodeIP> would be filtered NodeIP(s).)
538+
and `.spec.clusterIP:spec.ports[*].port`.
539+
If the `--nodeport-addresses` flag for kube-proxy or the equivalent field
540+
in the kube-proxy configuration file is set, `<NodeIP>` would be filtered node IP(s).
534541

535542
For example:
536543

content/en/docs/reference/_index.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,17 @@ client libraries:
5454
* [kubelet](/docs/reference/command-line-tools-reference/kubelet/) - The primary *node agent* that runs on each node. The kubelet takes a set of PodSpecs and ensures that the described containers are running and healthy.
5555
* [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/) - REST API that validates and configures data for API objects such as pods, services, replication controllers.
5656
* [kube-controller-manager](/docs/reference/command-line-tools-reference/kube-controller-manager/) - Daemon that embeds the core control loops shipped with Kubernetes.
57-
* [kube-proxy](/docs/reference/command-line-tools-reference/kube-proxy/) - Can do simple TCP/UDP stream forwarding or round-robin TCP/UDP forwarding across a set of back-ends.
58-
* [kube-scheduler](/docs/reference/command-line-tools-reference/kube-scheduler/) - Scheduler that manages availability, performance, and capacity.
57+
* [kube-proxy](/docs/reference/command-line-tools-reference/kube-proxy/) - Can
58+
do simple TCP/UDP stream forwarding or round-robin TCP/UDP forwarding across
59+
a set of back-ends.
60+
* [kube-scheduler](/docs/reference/command-line-tools-reference/kube-scheduler/) - Scheduler that manages availability, performance, and capacity.
5961

60-
## Scheduling
62+
* [Scheduler Policies](/docs/reference/scheduling/policies)
63+
* [Scheduler Profiles](/docs/reference/scheduling/config#profiles)
6164

62-
* [Scheduler Policies](/docs/reference/scheduling/policies)
63-
* [Scheduler Profiles](/docs/reference/scheduling/config#profiles)
65+
## Config APIs
6466

67+
* [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/)
6568

6669
## Design Docs
6770

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Configuration APIs
3+
weight: 65
4+
---
5+

0 commit comments

Comments
 (0)