OSDOCS-10810: Add BGP routing #88826
Conversation
- https://issues.redhat.com/browse/OSDOCS-10810 Includes BGP only.
jab-rh
added
do-not-merge
openshift-ci-robot
added
the
jira/valid-reference
|
@jab-rh: This pull request references OSDOCS-10810 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.19.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
1 similar comment
|
@jab-rh: This pull request references OSDOCS-10810 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.19.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
bot
added
the
size/XXL
openshift-ci
bot
added
size/L
|
🤖 Wed Feb 19 20:02:49 - Prow CI generated the docs preview: |
|
|
||
| BGP routing is supported on the following infrastructure types: | ||
|
|
||
| - Bare-metal |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'bare metal' rather than 'Bare-metal'. For more information, see RedHat.TermsErrors.
| @@ -0,0 +1 @@ | |||
| // omit | |||
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.
| With route advertisements enabled, {product-title} Networking supports the following features: | ||
|
|
||
| - Importing routes from the provider network | ||
| - Exporting routes into the provider network | ||
| - Supporting multi-homing, link redundancy, and fast convergence for provider network gateways | ||
| //// | ||
| https://github.com/openshift/openshift-docs/pull/85842/files#r1900917285 | ||
| - Improving throughput and reducing packet overhead | ||
| //// |
There was a problem hiding this comment.
I would remove this since it is mentioning the route advertisements feature which is not in scope of this PR.
modules/nw-bgp-about.adoc
Outdated
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| If you are using the MetalLB Operator, you must manually copy any existing `FRRConfiguration` CRs in the `metallb-system` namespace to the `openshift-frr-k8s` namespace. This includes `FRRConfiguration` CRs created by both cluster administrators and by cluster components. |
There was a problem hiding this comment.
This includes FRRConfiguration CRs created by both cluster administrators and by cluster components.
This is not accurate. by cluster components might be understood as metallb operator be included in those components,. I might have suggested this but now does not read well to me.
I would rephrase to
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 they are copied to the `openshift-frr-k8s` namespace or that those third-party cluster components use the new namespace
Also had this instruction in case you want to add it
Before upgrading:
Create namespace:
oc create namespace openshift-frr-k8s
Copy FRRConfigurations from old namespace to new namespace
OLD_NAMESPACE="metallb-system"
NEW_NAMESPACE="openshift-frr-k8s"
# don't copy FRRConfigurations starting with 'metallb-' as those are generated
FILTER_OUT="metallb-"
oc get frrconfigurations.frrk8s.metallb.io -n "${OLD_NAMESPACE}" -o json |\
jq -r '.items[] | select(.metadata.name | test("'"${FILTER_OUT}"'") | not) |\
jq -r '.metadata.namespace = "'"${NEW_NAMESPACE}"'"' |\
oc create -f -
Verify the copied FRRConfigurations are present in the new namespace
oc get frrconfigurations.frrk8s.metallb.io -n openshift-frr-k8s
After upgrading and once the cluster is verified to be healthy, the frrconfigurations in the old namespace can be removed.
| //include::modules/nw-bgp-routeadvertisements-object.adoc[leveloffset=+1] | ||
| //include::modules/nw-bgp-examples.adoc[leveloffset=+1] |
There was a problem hiding this comment.
I guess these two are commented out. nw-bgp-routeadvertisements-object.adoc has an omit but not nw-bgp-examples.adoc. Those are really routeadvertisements examples so they should be omitted as well.
|
|
||
| toc::[] | ||
|
|
||
| This feature provides native BGP routing capabilities for the cluster. Additionally, this feature must be enabled to use the RouteAdvertisements feature of the OVN-Kubernetes network plugin. |
There was a problem hiding this comment.
Leave routeadvertisements out of the PR?
This feature provides native BGP routing capabilities for the cluster.
|
|
||
| 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. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
🤖 [error] Vale.Terms: Use 'MetalLB' instead of 'metallb'.
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| If you are using the MetalLB Operator prior to upgrading to {product-title} 4.18, you must manually copy any existing `FRRConfiguration` CRs in the `metallb-system` namespace to the `openshift-frr-k8s` namespace. This includes `FRRConfiguration` CRs created by both cluster administrators and by cluster components. |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'before' rather than 'prior to'. For more information, see RedHat.TermsErrors.
|
@jab-rh: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Includes BGP only.
Version(s): 4.18.z
Issue:
Link to docs preview:
QE review:
Additional information: