Skip to content

Commit d875c62

Browse files
committed
Update
1 parent e3d3b10 commit d875c62

File tree

8 files changed

+69
-17
lines changed

8 files changed

+69
-17
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1728,6 +1728,8 @@ Topics:
17281728
File: about-bgp-routing
17291729
- Name: Configuring BGP routing
17301730
File: configuring-bgp-routing
1731+
- Name: Migrating FRR-K8s custom resources
1732+
File: migrating-frr-k8s-resources
17311733
---
17321734
Name: Storage
17331735
Dir: storage

modules/nw-bgp-about.adoc

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,7 @@
66
[id="nw-bgp-about_{context}"]
77
= About Border Gateway Protocol (BGP) routing
88

9-
With route advertisements enabled, {product-title} Networking supports the following features:
10-
11-
- Importing routes from the provider network
12-
- Exporting routes into the provider network
13-
- Supporting multi-homing, link redundancy, and fast convergence for provider network gateways
14-
////
15-
https://github.com/openshift/openshift-docs/pull/85842/files#r1900917285
16-
- Improving throughput and reducing packet overhead
17-
////
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.
1810

1911
[id="supported-platforms_{context}"]
2012
== Supported platforms

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

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/bgp_routing/migrating-frr-k8s-resources.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="nw-bgp-frr-k8s-migration_{context}"]
7+
= Migrating FRR-K8s resources
8+
9+
You can migrate the FRR-K8s resources from the `openshift-frr-k8s` namespace to the `openshift-ovn-kubernetes` namespace.
10+
11+
.Prerequisites
12+
13+
* Install the OpenShift CLI (`oc`).
14+
* Log in to the cluster with a user with `cluster-admin` privileges.
15+
16+
.Procedure
17+
18+
When upgrading from an earlier version of {product-title} with the Metal LB Operator deployed, you must manually migrate your custom frr-k8s configurations from the `metallb-system` namespace to the `openshift-frr-k8s` namespace. To move these CRs, enter the following commands:
19+
20+
. To create the `openshift-frr-k8s` namespace, enter the following command:
21+
+
22+
[source,terminal]
23+
----
24+
$ oc create namespace openshift-frr-k8s
25+
----
26+
27+
. To automate the migration, create a `migrate.sh` with the following content:
28+
+
29+
[source,bash]
30+
----
31+
#!/bin/bash
32+
OLD_NAMESPACE="metallb-system"
33+
NEW_NAMESPACE="openshift-frr-k8s"
34+
FILTER_OUT="metallb-"
35+
oc get frrconfigurations.frrk8s.metallb.io -n "${OLD_NAMESPACE}" -o json |\
36+
jq -r '.items[] | select(.metadata.name | test("'"${FILTER_OUT}"'") | not)' |\
37+
jq -r '.metadata.namespace = "'"${NEW_NAMESPACE}"'"' |\
38+
oc create -f -
39+
----
40+
41+
. To execute the migration, run the following command:
42+
+
43+
[source,terminal]
44+
----
45+
$ bash migrate.sh
46+
----
47+
48+
. To confirm that the migration succeeded, run the following command:
49+
+
50+
[source,terminal]
51+
----
52+
$ oc get frrconfigurations.frrk8s.metallb.io -n openshift-frr-k8s
53+
----

modules/nw-bgp-routing-config.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ $ oc patch network.operator cluster -p '{
3535
----
3636

3737
[id="disabling-bgp-routing-support_{context}"]
38-
== Disabling Border Gateway Protocol (BGP) routing support
38+
== Disabling BGP routing support
3939

4040
As a cluster administrator, you can disable BGP routing support for your cluster.
4141

networking/bgp_routing/about-bgp-routing.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ toc::[]
88

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

11-
////
12-
Additionally, this feature must be enabled to use the RouteAdvertisements feature of the OVN-Kubernetes network plugin.
13-
////
11+
If you have any FRR-K8s custom resources that you created in the `metallb-system` namespace, you must migrate them to the `openshift-frr-k8s` namespace. For more information, see xref:../../networking/bgp_routing/migrating-frr-k8s-resources.adoc#migrating-frr-k8s-resources[Migrating FRR-K8s resources].
1412

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

networking/bgp_routing/configuring-bgp-routing.adoc

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

99
As a cluster administrator, you can configure OVN-Kubernetes Border Gateway Protocol (BGP) routing support for your cluster.
1010

11-
////
12-
If you want to use route advertisements, you must enable BGP routing support. For more information, see xref!../../networking/route_advertisements/about-route-advertisements.adoc#about-route-advertisements[About route advertisements].
13-
////
14-
1511
include::modules/nw-bgp-routing-config.adoc[leveloffset=+1]
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="migrating-frr-k8s-resources"]
3+
= Migrating FRR-K8s resources
4+
include::_attributes/common-attributes.adoc[]
5+
:context: migrating-frr-k8s-resources
6+
7+
toc::[]
8+
9+
All user-created FRR-K8s custom resources (CRs) in the `metallb-system` namespace under {product-title} 4.17 and earlier releases must be migrated to the `openshift-frr-k8s` namespace. As a cluster administrator, complete the steps in this procedure to migrate your FRR-K8s custom resources.
10+
11+
include::modules/nw-bgp-frr-k8s-migration.adoc[leveloffset=+1]

networking/bgp_routing/mv-to-this-dir.txt

Whitespace-only changes.

0 commit comments

Comments
 (0)