Loading...

XML

Word

Printable

Type: Bug
Resolution: Done
Priority: Minor
Fix Version/s: None
Affects Version/s: 4.14
Component/s: Documentation / CNF
Labels:
None

Activity Type:
Quality / Stability / Reliability
Blocked:
False
Blocked Reason:

Hide

None

Show
None
Story Points:
1
Severity:
None
Regression:
None

Target Backport Versions:
None
Target Version:
None
Release Blocker:
None
Sprint:
T&PS 2025 #1
sprint_count:
1

SFDC Cases Counter:
SFDC Cases Open:
SFDC Cases Links:

Release Note Status:
None
Release Note Type:
None
Release Note Text:
None

Escape Reason:
None
Escape Impact:
None
Corrective Measures:
None
SDLC stage when should've been found:
None

Description of problem:

Incorrect values in the optional field spec.Peers for the BGPAdvertisement CR can block advertisement of IPs

Version-Release number of selected component (if applicable):

How reproducible:

    Consistently and seen on a customer site

Steps to Reproduce:

    1. Install MetalLB Operator.
    2. Create IPAddressPool, BPGPeer, and BGPAdvertisement CR
    3. Add an ip address to BGPAdvertisement CR instead of the name of the BPGPeer
    4. IPs will fail to be advertised

The failure is likely expected, but the documentation should provide a warning or specific guidance about what needs to be in the field. For example in the area link about configuring bgp peers we have an example of how to create a BGPAdvertisement with the spec.peers name defined. https://docs.openshift.com/container-platform/4.14/networking/metallb/metallb-configure-bgp-peers.html. 

However, in the section specific to advertisement this same guidance is not there even though the API detail is present. Similar guidance/examples in the Advertisement section can help avoid the scenario that cause advertisement to fail on a customer site. https://docs.openshift.com/container-platform/4.14/networking/metallb/about-advertising-ipaddresspool.html

Actual results:

Expected results:

Additional info: