Skip to content

Commit 71dd5e5

Browse files
committed
OSDOCS-5702:updates ovn-k docs to include egressIP config object
1 parent 4b70f53 commit 71dd5e5

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/ovn_kubernetes_network_provider/assigning-egress-ips-ovn.adoc
4+
5+
[id="nw-egress-ips-config-object_{context}"]
6+
= EgressIPconfig object
7+
As a feature of egress IP, the `reachabilityTotalTimeoutSeconds` parameter configures the total timeout for checks that are sent by probes to egress IP nodes. The `egressIPConfig` object allows users to set the `reachabilityTotalTimeoutSeconds` `spec`. If the EgressIP node cannot be reached within this timeout, the node is declared down.
8+
9+
You can increase this value if your network is not stable enough to handle the current default value of 1 second.
10+
11+
The following YAML describes changing the `reachabilityTotalTimeoutSeconds` from the default 1 second probes to 5 second probes:
12+
13+
[source,yaml]
14+
----
15+
apiVersion: k8s.ovn.org/v1
16+
kind: EgressIP
17+
name: networks.operator.openshift.io
18+
spec:
19+
clusterNetwork:
20+
- cidr: 10.128.0.0/14
21+
hostPrefix: 23
22+
defaultNetwork:
23+
ovnKubernetesConfig:
24+
egressIPConfig: <1>
25+
reachabilityTotalTimeoutSeconds: 5 <2>
26+
gatewayConfig:
27+
routingViaHost: false
28+
genevePort: 6081
29+
----
30+
<1> The `egressIPConfig` holds the configurations for the options of the `EgressIP` object. Changing these configurations allows you to extend the `EgressIP` object.
31+
32+
<2> The value for `reachabilityTotalTimeoutSeconds` accepts integer values from `0` to `60`. A value of 0 disables the reachability check of the egressIP node. Values of `1` to `60` correspond to the duration in seconds between probes sending the reachability check for the node.
33+
34+

networking/ovn_kubernetes_network_provider/configuring-egress-ips-ovn.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ include::modules/nw-egress-ips-about.adoc[leveloffset=+1]
1212

1313
include::modules/nw-egress-ips-object.adoc[leveloffset=+1]
1414

15+
include::modules/nw-egress-ips-config-object.adoc[leveloffset=+1]
16+
1517
include::modules/nw-egress-ips-node.adoc[leveloffset=+1]
1618

1719
[id="configuring-egress-ips-next-steps"]

0 commit comments

Comments
 (0)