Skip to content

Commit 343659b

Browse files
committed
Fixup
1 parent cad1c7f commit 343659b

File tree

8 files changed

+69
-44
lines changed

8 files changed

+69
-44
lines changed

_topic_maps/_topic_map.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1726,8 +1726,10 @@ Topics:
17261726
Topics:
17271727
- Name: About BGP routing
17281728
File: about-bgp-routing
1729-
- Name: Configuring BGP routing
1730-
File: configuring-bgp-routing
1729+
- Name: Enabling BGP routing
1730+
File: enabling-bgp-routing
1731+
- Name: Disabling BGP routing
1732+
File: disabling-bgp-routing
17311733
- Name: Migrating FRR-K8s custom resources
17321734
File: migrating-frr-k8s-resources
17331735
---

modules/nw-bgp-about.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@ Before upgrading to 4.18, any existing `FRRConfiguration` in the `metallb-system
2727

2828
[IMPORTANT]
2929
====
30-
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 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.
30+
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 MetalLB Operator, you must:
31+
32+
- Ensure that these existing `FRRConfiguration` CRs are copied to the `openshift-frr-k8s` namespace.
33+
- Ensure that the third-party cluster components use the new namespace for the `FRRConfiguration` CRs that they create.
3134
====
3235

3336
[id="cluster-network-operator_{context}"]

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="nw-bgp-frr-k8s-migration_{context}"]
77
= Migrating FRR-K8s resources
88

9-
You can migrate the FRR-K8s custom resources from the `metallb-system` namespace to the `openshift-frr-k8s` namespace.
9+
You can migrate the FRR-K8s `FRRConfiguration` custom resources from the `metallb-system` namespace to the `openshift-frr-k8s` namespace.
1010

1111
.Prerequisites
1212

@@ -15,7 +15,7 @@ You can migrate the FRR-K8s custom resources from the `metallb-system` namespace
1515
1616
.Procedure
1717

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:
18+
When upgrading from an earlier version of {product-title} with the Metal LB Operator deployed, you must manually migrate your custom `FRRConfiguration` configurations from the `metallb-system` namespace to the `openshift-frr-k8s` namespace. To move these CRs, enter the following commands:
1919

2020
. To create the `openshift-frr-k8s` namespace, enter the following command:
2121
+
@@ -54,4 +54,4 @@ $ bash migrate.sh
5454
$ oc get frrconfigurations.frrk8s.metallb.io -n openshift-frr-k8s
5555
----
5656
57-
After the migration is complete, you can remove the FRR-K8s custom resources from the `metallb-system` namespace.
57+
After the migration is complete, you can remove the `FRRConfiguration` custom resources from the `metallb-system` namespace.

modules/nw-bgp-routing-disable.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/bgp_routing/disabling-bgp-routing.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="nw-bgp-routing-config_{context}"]
7+
= Disabling Border Gateway Protocol (BGP) routing
8+
9+
As a cluster administrator, you can disable Border Gateway Protocol (BGP) routing support for your cluster on bare-metal infrastructure.
10+
11+
[id="enabling-bgp-routing-support_{context}"]
12+
== Enabling BGP routing support
13+
14+
As a cluster administrator, you can disable BGP routing support for your cluster.
15+
16+
.Prerequisites
17+
18+
* You have installed the {oc-first}.
19+
* You are logged in to the cluster as a user with the `cluster-admin` role.
20+
* The cluster is installed on compatible infrastructure.
21+
22+
.Procedure
23+
24+
* To disable dynamic routing, enter the following command:
25+
+
26+
[source,terminal]
27+
----
28+
$ oc patch network.operator cluster -p '{
29+
"spec": {
30+
"additionalRoutingCapabilities": null
31+
}
32+
}'
33+
----
Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
// Module included in the following assemblies:
22
//
3-
// * networking/bgp_routing/configuring-bgp-routing.adoc
3+
// * networking/bgp_routing/enabling-bgp-routing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="nw-bgp-routing-config_{context}"]
7-
= Configuring Border Gateway Protocol (BGP) routing
7+
= Enabling Border Gateway Protocol (BGP) routing
88

9-
As a cluster administrator, you can enable or disable Border Gateway Protocol (BGP) routing support for your cluster on bare-metal infrastructure.
9+
As a cluster administrator, you can enable Border Gateway Protocol (BGP) routing support for your cluster on bare-metal infrastructure.
1010

1111
If you are using BGP routing in conjunction with the MetalLB Operator, the necessary BGP routing support is enabled automatically. You do not need to manually enable BGP routing support.
1212

@@ -33,27 +33,3 @@ $ oc patch network.operator cluster -p '{
3333
}
3434
}'
3535
----
36-
37-
[id="disabling-bgp-routing-support_{context}"]
38-
== Disabling BGP routing support
39-
40-
As a cluster administrator, you can disable BGP routing support for your cluster.
41-
42-
.Prerequisites
43-
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.
47-
48-
.Procedure
49-
50-
* To disable dynamic routing, enter the following command:
51-
+
52-
[source,terminal]
53-
----
54-
$ oc patch network.operator cluster -p '{
55-
"spec": {
56-
"additionalRoutingCapabilities": null
57-
}
58-
}'
59-
----

networking/bgp_routing/configuring-bgp-routing.adoc

Lines changed: 0 additions & 11 deletions
This file was deleted.
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="disabling-bgp-routing"]
3+
= Disabling BGP routing
4+
include::_attributes/common-attributes.adoc[]
5+
:context: disable-bgp-routing
6+
7+
toc::[]
8+
9+
As a cluster administrator, you can enable OVN-Kubernetes Border Gateway Protocol (BGP) routing support for your cluster.
10+
11+
include::modules/nw-bgp-routing-disable.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="enabling-bgp-routing"]
3+
= Enabling BGP routing
4+
include::_attributes/common-attributes.adoc[]
5+
:context: enabling-bgp-routing
6+
7+
toc::[]
8+
9+
As a cluster administrator, you can enable OVN-Kubernetes Border Gateway Protocol (BGP) routing support for your cluster.
10+
11+
include::modules/nw-bgp-routing-enable.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)