Skip to content

Commit

Permalink
doc(user-guide.md): add info about traffic policies
Browse files Browse the repository at this point in the history
  • Loading branch information
aauren committed Jan 24, 2024
1 parent fcd21b4 commit 98eea79
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,19 @@ Advertising LoadBalancer IPs works by inspecting the services `status.loadBalanc
LoadBalancers like for example MetalLb. This has been successfully tested together with
[MetalLB](https://github.com/google/metallb) in ARP mode.

## Controlling Service Locality / Traffic Policies

Service availability both externally and locally (within the cluster) can be controlled via the Kubernetes standard
[Traffic Policies](https://kubernetes.io/docs/reference/networking/virtual-ips/#traffic-policies) and via the custom
kube-router service annotation: `kube-router.io/service.local: true`.

Refer to the previously linked upstream Kubernetes documentation for more information on `spec.internalTrafficPolicy`
and `spec.externalTrafficPolicy`.

In order to keep backwards compatibility the `kube-router.io/service.local: true` annotation effectively overrides
`spec.internalTrafficPolicy` and `spec.externalTrafficPolicy` and forces kube-router to behave as if both were set to
`Local`.

## Hairpin Mode

Communication from a Pod that is behind a Service to its own ClusterIP:Port is not supported by default. However, it
Expand Down

0 comments on commit 98eea79

Please sign in to comment.