Skip to content

[enterprise-4.19] Add release note for BGP routing #92974

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.

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

Open
wants to merge 1 commit into
base: enterprise-4.19
Choose a base branch
from

Conversation

jab-rh
Copy link
Contributor

@jab-rh jab-rh commented May 2, 2025

Version(s): 4.19

Issue:

Link to docs preview:

Support for the BGP routing protocol

QE review:

  • QE has approved this change.

Additional information:

Refs #88842 & #88826

Build fails until the feature PR is merged, then the xref becomes valid.

@jab-rh jab-rh added this to the Continuous Release milestone May 2, 2025
@jab-rh jab-rh self-assigned this May 2, 2025
@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 2, 2025
@jab-rh jab-rh changed the title Add release note for BGP routing [enterprise-4.19] Add release note for BGP routing May 2, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented May 2, 2025

🤖 Thu May 15 17:53:52 - Prow CI generated the docs preview:

https://92974--ocpdocs-pr.netlify.app/openshift-enterprise/latest/release_notes/ocp-4-19-release-notes.html

@jab-rh
Copy link
Contributor Author

jab-rh commented May 2, 2025

Identical steps confirmed by QE: #88826 (comment)

@jab-rh jab-rh added the peer-review-needed Signifies that the peer review team needs to review this PR label May 2, 2025
@eromanova97
Copy link
Contributor

/remove-label peer-review-needed

/label peer-review-in-progress

@openshift-ci openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels May 5, 2025
@eromanova97
Copy link
Contributor

eromanova97 commented May 5, 2025

Hello @jab-rh there seems to be an issue with the xref (link to logs), can you fix this so that the tests are succesful and the content therefore ready for review? Thanks!

(I will publish my review once the issue is fixed. )

@jab-rh
Copy link
Contributor Author

jab-rh commented May 8, 2025

@eromanova97, I've fixed the build, thanks!

Copy link
Contributor

@eromanova97 eromanova97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello, I have finished my review.
Note to squash the commits before asking for merge.
Thank you!

[id="ocp-4-19-support-for-bgp-routing-protocol_{context}"]
==== Support for the BGP routing protocol

The Cluster Network Operator (CNO) now supports enabling Border Gateway Protocol (BGP) routing. With BGP, you can import and export routes to the underlying provider network and utilize multi-homing, link redundancy, and fast convergence. BGP configuration is managed with the `FRRConfiguration` custom resource (CR).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Cluster Network Operator (CNO) now supports enabling Border Gateway Protocol (BGP) routing. With BGP, you can import and export routes to the underlying provider network and utilize multi-homing, link redundancy, and fast convergence. BGP configuration is managed with the `FRRConfiguration` custom resource (CR).
The Cluster Network Operator (CNO) now supports enabling Border Gateway Protocol (BGP) routing. With BGP, you can import and export routes to the underlying provider network and utilize multi-homing, link redundancy, and fast convergence. You can manage BGP configuration with the `FRRConfiguration` custom resource (CR).

To get rid of passive voice.


The Cluster Network Operator (CNO) now supports enabling Border Gateway Protocol (BGP) routing. With BGP, you can import and export routes to the underlying provider network and utilize multi-homing, link redundancy, and fast convergence. BGP configuration is managed with the `FRRConfiguration` custom resource (CR).

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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
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:

In the docs (link) I see it capitalised like this FRR-K8s:

`MetalLB` generates the `FRR-K8s` configuration corresponding to...

Comment on lines +464 to +488
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 -
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A note about the usage of jq: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#commands-with-jq

Do not use jq in commands (unless it is truly required) ...

here it looks like it is truly required, but I am checking just in case.

Comment on lines +481 to +503
$ oc get frrconfigurations.frrk8s.metallb.io -n openshift-frr-k8s
----
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a possible Example output to show?
https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#code-blocks-command-syntax-and-example-output
Or, if that would be too long, maybe just adding a sentence about what the user should see?

@eromanova97
Copy link
Contributor

/remove-label peer-review-in-progress

/label peer-review-done

@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels May 9, 2025
@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 15, 2025
@jab-rh jab-rh force-pushed the rn-OSDOCS-10810-bgp-419 branch from c0b6f71 to 7165210 Compare May 15, 2025 17:34
@jab-rh jab-rh force-pushed the rn-OSDOCS-10810-bgp-419 branch from 7165210 to 41f61f8 Compare May 15, 2025 17:36
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 15, 2025
Copy link

openshift-ci bot commented May 15, 2025

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.19 peer-review-done Signifies that the peer review team has reviewed this PR size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants