Skip to content

Fix indents for parameter descriptions #111150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jab-rh merged 1 commit into from
May 5, 2026
+18 −6
Merged

Fix indents for parameter descriptions #111150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions modules/nw-metallb-frr-k8s-configuration-crd.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ To customize routing behavior beyond standard MetalLB capabilities, configure th
The following reference examples demonstrate how to define specific FRRouting (FRR) parameters to enable advanced services, such as receiving routes:

The `routers` parameter::

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

You can also define a list of Border Gateway Protocol (BGP) neighbors to connect to, as in the following example:
Expand All @@ -39,9 +40,11 @@ spec:
port: 179
# ...
----
--

The `toAdvertise` parameter::

+
--
By default, `FRR-K8s` does not advertise the prefixes configured as part of a router configuration. To advertise the prefixes, you use the `toAdvertise` parameter.

You can advertise a subset of the prefixes, as in the following example:
Expand Down Expand Up @@ -102,9 +105,11 @@ spec:
# ...
----
* `allowed.mode`: Advertises all prefixes.
--

The `toReceive` parameter::

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

You can configure for a subset of the prefixes, as in this example:
Expand Down Expand Up @@ -159,9 +164,11 @@ spec:
mode: all
# ...
----
--

The `bgp` parameter::

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

.Example FRRConfiguration CR
Expand All @@ -185,9 +192,11 @@ spec:
- name: defaultprofile
# ...
----
--

The `nodeSelector` parameter::

+
--
By default, `FRR-K8s` applies the configuration to all nodes where the daemon is running.
You can use the `nodeSelector` parameter to specify the nodes to which you want to apply the configuration. For example:

Expand All @@ -208,9 +217,11 @@ spec:
foo: "bar"
# ...
----
--

The `interface` parameter::

+
--
You can use the `interface` parameter to configure unnumbered BGP peering by using the following example configuration:

.Example `FRRConfiguration` CR
Expand Down Expand Up @@ -255,6 +266,7 @@ To use the `interface` parameter, you must establish a point-to-point, layer 2 c

If you use this parameter, you cannot specify a value in the `spec.bgp.routers.neighbors.address` parameter.
====
--

The parameters for the `FRRConfiguration` custom resource are described in the following table:

Expand Down