Skip to content

Fix MetalLB procedure gaps found by live cluster verification#111440

Open
kquinn1204 wants to merge 1 commit intoopenshift:mainfrom
kquinn1204:demo-install-configure-metallb-ai-2
Open

Fix MetalLB procedure gaps found by live cluster verification#111440
kquinn1204 wants to merge 1 commit intoopenshift:mainfrom
kquinn1204:demo-install-configure-metallb-ai-2

Conversation

@kquinn1204
Copy link
Copy Markdown
Contributor

Summary

  • Tested all four MetalLB install/configure procedures on a live OCP 4.21 cluster
  • Fixed 19 documentation gaps (1 critical, 6 high, 5 medium, 7 low)
  • Converted "save to file" patterns to inline cat << EOF | oc apply -f - for consistency and automation
  • Replaced unusable 4.4.4.0/24 example IP range with RFC 5737 documentation range (203.0.113.200-203.0.113.210)
  • Added concrete deployment + LoadBalancer service example to replace entirely abstract procedure
  • Added missing wait steps, prerequisites, and verification sections

Files changed

File Changes
modules/nw-metallb-installing-operator-cli.adoc Inline Subscription CR, fix CSV version prefix
modules/nw-metallb-operator-initial-config.adoc Add oc wait step, fix metdata typo
modules/nw-metallb-configure-l2-advertisement.adoc Inline apply, fix IP range, add prereq + verification
modules/nw-metallb-configure-svc.adoc Complete rewrite with concrete working example

Test plan

  • Verified all four procedures end-to-end on a live OCP 4.21 single-node cluster
  • MetalLB Operator installed and controller/speaker running
  • IPAddressPool and L2Advertisement created successfully
  • LoadBalancer service assigned external IP from pool
  • Application reachable via MetalLB-assigned IP (curl returned "Hello OpenShift!")

🤖 Generated with Claude Code

Tested all four MetalLB procedures on a live OCP 4.21 cluster and
fixed 19 documentation gaps including magic steps, missing wait
commands, unusable example IPs, and an entirely abstract service
configuration procedure.

Key changes:
- Convert save-to-file patterns to inline cat << EOF | oc apply
- Add wait step before MetalLB controller verification
- Replace unusable 4.4.4.0/24 with RFC 5737 documentation range
- Add concrete deployment + LoadBalancer service example
- Add missing prerequisites and verification sections
- Fix typos (metdata, CSV version prefix, pool name mismatch)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 8, 2026
$ oc apply -f ipaddresspool.yaml
EOF
----
<1> Replace the address range with addresses that are appropriate for your network.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

protocol: TCP
EOF
----
<1> The `metallb.io/address-pool` annotation is required when the address pool has `autoAssign` set to `false`. Replace `doc-example-l2` with the name of your address pool.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 8, 2026

@kquinn1204: all tests passed!

Full PR test history. Your PR dashboard.

Details

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

size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants