Skip to content

Commit ed2f3c6

Browse files
committed
TELCODOCS-2397: Added missing content from original cherry-pick
1 parent 623f733 commit ed2f3c6

File tree

1 file changed

+30
-24
lines changed

1 file changed

+30
-24
lines changed

modules/nw-metallb-frr-k8s-configuration-crd.adoc

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The following section provides reference examples that use the `FRRConfiguration
1212
== The routers field
1313

1414
You can use the `routers` field to configure multiple routers, one for each Virtual Routing and Forwarding (VRF) resource.
15-
For each router, you must define the Autonomous System Number (ASN).
15+
For each router, you must define the Autonomous System Number (ASN).
1616

1717
You can also define a list of Border Gateway Protocol (BGP) neighbors to connect to, as in the following example:
1818

@@ -41,7 +41,7 @@ spec:
4141
[id="nw-metallb-frrconfiguration-crd-toadvertise_{context}"]
4242
== The toAdvertise field
4343

44-
By default, `FRR-K8s` does not advertise the prefixes configured as part of a router configuration.
44+
By default, `FRR-K8s` does not advertise the prefixes configured as part of a router configuration.
4545
In order to advertise them, you use the `toAdvertise` field.
4646

4747
You can advertise a subset of the prefixes, as in the following example:
@@ -104,7 +104,7 @@ spec:
104104
[id="nw-metallb-frrconfiguration-crd-toreceive_{context}"]
105105
== The toReceive field
106106

107-
By default, `FRR-K8s` does not process any prefixes advertised by a neighbor.
107+
By default, `FRR-K8s` does not process any prefixes advertised by a neighbor.
108108
You can use the `toReceive` field to process such addresses.
109109

110110
You can configure for a subset of the prefixes, as in this example:
@@ -161,7 +161,7 @@ spec:
161161
[id="nw-metallb-frrconfiguration-crd-bgp_{context}"]
162162
== The bgp field
163163

164-
You can use the `bgp` field to define various `BFD` profiles and associate them with a neighbor.
164+
You can use the `bgp` field to define various `BFD` profiles and associate them with a neighbor.
165165
In the following example, `BFD` backs up the `BGP` session and `FRR` can detect link failures:
166166

167167
.Example FRRConfiguration CR
@@ -242,30 +242,36 @@ The fields for the `FRRConfiguration` custom resource are described in the follo
242242
|`integer`
243243
|Specifies the ASN to use for the remote end of the session.
244244

245+
|`spec.bgp.routers.neighbors.dynamicASN`
246+
|`string`
247+
|Detects the ASN to use for the remote end of the session without explicitly setting it.
248+
Specify `internal` for a neighbor with the same ASN, or `external` for a neighbor with a different ASN.
249+
If you use this field, you cannot specify a value in the `spec.bgp.routers.neighbors.asn` field.
250+
245251
|`spec.bgp.routers.neighbors.address`
246252
|`string`
247253
|Specifies the IP address to establish the session with.
248254

249255
|`spec.bgp.routers.neighbors.port`
250256
|`integer`
251-
|Specifies the port to dial when establishing the session.
257+
|Specifies the port to dial when establishing the session.
252258
Defaults to 179.
253259

254260
|`spec.bgp.routers.neighbors.password`
255261
|`string`
256-
|Specifies the password to use for establishing the BGP session.
262+
|Specifies the password to use for establishing the BGP session.
257263
`Password` and `PasswordSecret` are mutually exclusive.
258264

259265
|`spec.bgp.routers.neighbors.passwordSecret`
260266
|`string`
261-
|Specifies the name of the authentication secret for the neighbor.
262-
The secret must be of type "kubernetes.io/basic-auth", and in the same namespace as the FRR-K8s daemon.
263-
The key "password" stores the password in the secret.
267+
|Specifies the name of the authentication secret for the neighbor.
268+
The secret must be of type "kubernetes.io/basic-auth", and in the same namespace as the FRR-K8s daemon.
269+
The key "password" stores the password in the secret.
264270
`Password` and `PasswordSecret` are mutually exclusive.
265271

266272
|`spec.bgp.routers.neighbors.holdTime`
267273
|`duration`
268-
|Specifies the requested BGP hold time, per RFC4271.
274+
|Specifies the requested BGP hold time, per RFC4271.
269275
Defaults to 180s.
270276

271277
|`spec.bgp.routers.neighbors.keepaliveTime`
@@ -283,7 +289,7 @@ Defaults to `60s`.
283289

284290
|`spec.bgp.routers.neighbors.bfdProfile`
285291
|`string`
286-
|Specifies the name of the BFD Profile to use for the BFD session associated with the BGP session.
292+
|Specifies the name of the BFD Profile to use for the BFD session associated with the BGP session.
287293
If not set, the BFD session is not set up.
288294

289295
|`spec.bgp.routers.neighbors.toAdvertise.allowed`
@@ -292,18 +298,18 @@ If not set, the BFD session is not set up.
292298

293299
|`spec.bgp.routers.neighbors.toAdvertise.allowed.prefixes`
294300
|`string array`
295-
|Specifies the list of prefixes to advertise to a neighbor.
301+
|Specifies the list of prefixes to advertise to a neighbor.
296302
This list must match the prefixes that you define in the router.
297303

298304
|`spec.bgp.routers.neighbors.toAdvertise.allowed.mode`
299305
|`string`
300-
|Specifies the mode to use when handling the prefixes.
306+
|Specifies the mode to use when handling the prefixes.
301307
You can set to `filtered` to allow only the prefixes in the prefixes list.
302308
You can set to `all` to allow all the prefixes configured on the router.
303309

304310
|`spec.bgp.routers.neighbors.toAdvertise.withLocalPref`
305311
|`array`
306-
|Specifies the prefixes associated with an advertised local preference.
312+
|Specifies the prefixes associated with an advertised local preference.
307313
You must specify the prefixes associated with a local preference in the prefixes allowed to be advertised.
308314

309315
|`spec.bgp.routers.neighbors.toAdvertise.withLocalPref.prefixes`
@@ -341,8 +347,8 @@ You must include the prefixes associated with a local preference in the list of
341347

342348
|`spec.bgp.routers.neighbors.toReceive.allowed.mode`
343349
|`string`
344-
|Specifies the mode to use when handling the prefixes.
345-
When set to `filtered`, only the prefixes in the `prefixes` list are allowed.
350+
|Specifies the mode to use when handling the prefixes.
351+
When set to `filtered`, only the prefixes in the `prefixes` list are allowed.
346352
When set to `all`, all the prefixes configured on the router are allowed.
347353

348354
|`spec.bgp.routers.neighbors.disableMP`
@@ -363,27 +369,27 @@ When set to `all`, all the prefixes configured on the router are allowed.
363369

364370
|`spec.bgp.bfdProfiles.receiveInterval`
365371
|`integer`
366-
|Specifies the minimum interval at which this system can receive control packets, in milliseconds.
372+
|Specifies the minimum interval at which this system can receive control packets, in milliseconds.
367373
Defaults to `300ms`.
368374

369375
|`spec.bgp.bfdProfiles.transmitInterval`
370376
|`integer`
371-
|Specifies the minimum transmission interval, excluding jitter, that this system wants to use to send BFD control packets, in milliseconds.
377+
|Specifies the minimum transmission interval, excluding jitter, that this system wants to use to send BFD control packets, in milliseconds.
372378
Defaults to `300ms`.
373379

374380
|`spec.bgp.bfdProfiles.detectMultiplier`
375381
|`integer`
376-
|Configures the detection multiplier to determine packet loss.
382+
|Configures the detection multiplier to determine packet loss.
377383
To determine the connection loss-detection timer, multiply the remote transmission interval by this value.
378384

379385
|`spec.bgp.bfdProfiles.echoInterval`
380386
|`integer`
381-
|Configures the minimal echo receive transmission-interval that this system can handle, in milliseconds.
387+
|Configures the minimal echo receive transmission-interval that this system can handle, in milliseconds.
382388
Defaults to `50ms`.
383389

384390
|`spec.bgp.bfdProfiles.echoMode`
385391
|`boolean`
386-
|Enables or disables the echo transmission mode.
392+
|Enables or disables the echo transmission mode.
387393
This mode is disabled by default, and not supported on multihop setups.
388394

389395
|`spec.bgp.bfdProfiles.passiveMode`
@@ -392,13 +398,13 @@ This mode is disabled by default, and not supported on multihop setups.
392398

393399
|`spec.bgp.bfdProfiles.MinimumTtl`
394400
|`integer`
395-
|For multihop sessions only.
401+
|For multihop sessions only.
396402
Configures the minimum expected TTL for an incoming BFD control packet.
397403

398404
|`spec.nodeSelector`
399405
|`string`
400-
|Limits the nodes that attempt to apply this configuration.
401-
If specified, only those nodes whose labels match the specified selectors attempt to apply the configuration.
406+
|Limits the nodes that attempt to apply this configuration.
407+
If specified, only those nodes whose labels match the specified selectors attempt to apply the configuration.
402408
If it is not specified, all nodes attempt to apply this configuration.
403409

404410
|`status`

0 commit comments

Comments
 (0)