Skip to content

Commit cad1c7f

Browse files
committed
Revise
1 parent cd6da51 commit cad1c7f

File tree

4 files changed

+20
-18
lines changed

4 files changed

+20
-18
lines changed

modules/nw-bgp-about.adoc

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
// * networking/bgp_routing/about-bgp-routing.adoc
44

55
:_mod-docs-content-type: CONCEPT
6-
[id="nw-bgp-about_{context}"]
6+
[id="nw-bgp-about_routing_{context}"]
77
= About Border Gateway Protocol (BGP) routing
88

9-
{product-title} supports BGP routing through FRRouting (FRR), a free, open source internet routing protocol suite for Linux and UNIX platforms. FRR-K8s is a Kubernetes based daemon set that exposes a subset of the FRR API in a Kubernetes-compliant manner. As a cluster administrator, you can use the FRRConfiguration custom resource (CR) to access FRR services.
9+
{product-title} supports BGP routing through FRRouting (FRR), a free, open source internet routing protocol suite for Linux, UNIX, and similar operating systems. FRR-K8s is a Kubernetes-based daemon set that exposes a subset of the FRR API in a Kubernetes-compliant manner. As a cluster administrator, you can use the `FRRConfiguration` custom resource (CR) to access FRR services.
1010

1111
[id="supported-platforms_{context}"]
1212
== Supported platforms
@@ -16,17 +16,14 @@ BGP routing is supported on the following infrastructure types:
1616
- Bare metal
1717
- {vmw-full} on-premise
1818

19-
[id="prerequisites_{context}"]
20-
== Prerequisites
21-
22-
Use of BGP routing requires that you have properly configured BGP for your network provider. Outages or misconfigurations of your network provider might cause disruptions to your cluster network.
19+
BGP routing requires that you have properly configured BGP for your network provider. Outages or misconfigurations of your network provider might cause disruptions to your cluster network.
2320

2421
[id="considerations-for-use-with-the-metallb-operator_{context}"]
2522
== Considerations for use with the MetalLB Operator
2623

2724
The MetalLB Operator is installed as an add-on to the cluster. Deployment of the MetalLB Operator automatically enables FRR-K8s as an additional routing capability provider and uses the FRR-K8s daemon installed by this feature.
2825

29-
Before upgrading to 4.18, any existing FRRConfiguration in the `metallb-system` namespace not managed by the MetalLB operator (added by a cluster administrator or any other component) needs to be copied to the `openshift-frr-k8s` namespace manually, creating the namespace if necessary.
26+
Before upgrading to 4.18, any existing `FRRConfiguration` in the `metallb-system` namespace not managed by the MetalLB operator (added by a cluster administrator or any other component) needs to be copied to the `openshift-frr-k8s` namespace manually, creating the namespace if necessary.
3027

3128
[IMPORTANT]
3229
====
@@ -38,7 +35,7 @@ If you are using the MetalLB Operator and there are existing `FRRConfiguration`
3835

3936
The Cluster Network Operator API exposes the following API field to configure BGP routing:
4037

41-
- `spec.additionalRoutingCapabilities`: Enables deployment of the FRR-K8S daemon for the cluster, which can be used independently of route advertisements. When enabled, the FRR-K8S daemon is deployed on all nodes.
38+
- `spec.additionalRoutingCapabilities`: Enables deployment of the FRR-K8s daemon for the cluster, which can be used independently of route advertisements. When enabled, the FRR-K8s daemon is deployed on all nodes.
4239

4340
[id="bgp-routing-custom-resources_{context}"]
4441
== BGP routing custom resources

modules/nw-bgp-frr-k8s-migration.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ You can migrate the FRR-K8s custom resources from the `metallb-system` namespace
1010

1111
.Prerequisites
1212

13-
* Install the OpenShift CLI (`oc`).
14-
* Log in to the cluster with a user with `cluster-admin` privileges.
13+
* You have installed the {oc-first}.
14+
* You are logged in to the cluster as a user with the `cluster-admin` role.
1515
1616
.Procedure
1717

@@ -24,7 +24,7 @@ When upgrading from an earlier version of {product-title} with the Metal LB Oper
2424
$ oc create namespace openshift-frr-k8s
2525
----
2626

27-
. To automate the migration, create a `migrate.sh` with the following content:
27+
. To automate the migration, create a shell script named `migrate.sh` with the following contents:
2828
+
2929
[source,bash]
3030
----
@@ -45,7 +45,9 @@ oc get frrconfigurations.frrk8s.metallb.io -n "${OLD_NAMESPACE}" -o json |\
4545
$ bash migrate.sh
4646
----
4747

48-
. To confirm that the migration succeeded, run the following command:
48+
.Verification
49+
50+
* To confirm that the migration succeeded, run the following command:
4951
+
5052
[source,terminal]
5153
----

modules/nw-bgp-routing-config.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ As a cluster administrator, you can enable BGP routing support for your cluster.
1717

1818
.Prerequisites
1919

20-
* Install the OpenShift CLI (`oc`).
21-
* Log in to the cluster with a user with `cluster-admin` privileges.
22-
* Cluster is installed on compatible infrastructure.
20+
* You have installed the {oc-first}.
21+
* You are logged in to the cluster as a user with the `cluster-admin` role.
22+
* The cluster is installed on compatible infrastructure.
2323

2424
.Procedure
2525

@@ -41,9 +41,9 @@ As a cluster administrator, you can disable BGP routing support for your cluster
4141

4242
.Prerequisites
4343

44-
* Install the OpenShift CLI (`oc`).
45-
* Log in to the cluster with a user with `cluster-admin` privileges.
46-
* Cluster is installed on compatible infrastructure.
44+
* You have installed the {oc-first}.
45+
* You are logged in to the cluster as a user with the `cluster-admin` role.
46+
* The cluster is installed on compatible infrastructure.
4747

4848
.Procedure
4949

networking/bgp_routing/about-bgp-routing.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ toc::[]
88

99
This feature provides native Border Gateway Protocol (BGP) routing capabilities for the cluster.
1010

11+
[IMPORTANT]
12+
====
1113
If you are using the MetalLB Operator and there are existing `FRRConfiguration` CRs in the `metallb-system` namespace created by cluster administrators or third-party cluster components other than the MetalLB Operator, you must ensure that they are copied to the `openshift-frr-k8s` namespace or that those third-party cluster components use the new namespace. For more information, see xref:../../networking/bgp_routing/migrating-frr-k8s-resources.adoc#migrating-frr-k8s-resources[Migrating FRR-K8s resources].
14+
====
1215

1316
include::modules/nw-bgp-about.adoc[leveloffset=+1]
1417
include::modules/nw-metallb-frr-k8s-configuration-crd.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)