Skip to content

add doc about How to Install the GatewayAPI UI Plugin IN 4.2#776

Merged
jing2uo merged 1 commit into
alauda:mainfrom
woodgear:feat/ACP-53049
May 28, 2026
Merged

add doc about How to Install the GatewayAPI UI Plugin IN 4.2#776
jing2uo merged 1 commit into
alauda:mainfrom
woodgear:feat/ACP-53049

Conversation

@woodgear
Copy link
Copy Markdown
Contributor

@woodgear woodgear commented May 28, 2026

Summary by CodeRabbit

  • Documentation
    • Updated documentation organization across multiple guides.
    • Added new guide for installing and using the GatewayAPI UI plugin on ACP 4.2 with Envoy Gateway shared-gateway scenarios, including installation steps, verification procedures, and known limitations.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

Walkthrough

The pull request adds load-balancer solution documentation to a knowledge repository. Four existing guides receive consistent tags: LB metadata, and a new comprehensive GatewayAPI UI installation guide for ACP 4.2 is introduced, covering prerequisites, installation workflow, verification, and known limitations.

Changes

Load-Balancer Solution Documentation

Layer / File(s) Summary
Load-balancer documentation tagging
docs/en/solutions/Alauda_LoadBalancer_with_MetalLB.md, docs/en/solutions/How_to_Enable_OpenTelemetry_for_Ingress_NGINX.md, docs/en/solutions/How_to_Install_EnvoyGatewayOperator_And_UI_Before_ACP_4.2.md, docs/en/solutions/How_to_add_Dashboard_for_EnvoyGateway.md
Four existing solution guides receive consistent tags: LB front-matter metadata to classify them as load-balancer documentation.
GatewayAPI UI installation guide for ACP 4.2
docs/en/solutions/How_to_Install_GatewayAPI_UI_Which_Could_ShareGateway_IN_ACP_4.2.md
New documentation page describes prerequisites, installation workflow (disabling built-in UI via patch, uploading with violet, cluster-specific installation on global), verification steps for cross-namespace listener selection, and documented limitation regarding policy metadata fields.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • alauda/knowledge#758: Adds EnvoyGateway dashboard content that this PR tags with load-balancer metadata.
  • alauda/knowledge#766: Introduces OpenTelemetry instructions for Ingress NGINX that this PR now tags as LB documentation.

Suggested reviewers

  • yangxiaolang

Poem

🐰 A knowledge base grows with careful tags,
Four guides now marked for balanced loads,
GatewayAPI's path unfolds in lines,
Shared gateways dance on ACP's roads,
Metadata blooms, solutions shine bright!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly references the main addition: a new documentation guide about installing the GatewayAPI UI Plugin in ACP 4.2, which aligns with the primary file added in this changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/en/solutions/How_to_Install_GatewayAPI_UI_Which_Could_ShareGateway_IN_ACP_4.2.md (1)

15-17: 💤 Low value

Consider rewording to avoid repetitive sentence structure.

Three consecutive sentences begin with "This", which slightly impacts readability. Consider rephrasing for better flow, for example:

"ACP 4.2 includes a built-in GatewayAPI UI, but that UI was not adapted for Envoy Gateway shared-gateway scenarios. When creating or updating a Route, the built-in page cannot select listeners from Gateways in other namespaces, making it inconvenient to use one Gateway as the shared traffic entry point for Routes from multiple namespaces.

The guide explains how to install the newer GatewayAPI UI plugin on ACP 4.2 and use it instead of the built-in page. The plugin represents the GatewayAPI UI used by later ACP versions and is being installed earlier on ACP 4.2 through this procedure."

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In
`@docs/en/solutions/How_to_Install_GatewayAPI_UI_Which_Could_ShareGateway_IN_ACP_4.2.md`
around lines 15 - 17, Reword the three consecutive sentences that start with
"This" to improve flow and avoid repetition: locate the paragraph containing
"ACP 4.2 includes a built-in GatewayAPI UI, but that UI was not adapted for
Envoy Gateway shared-gateway scenarios." and revise the following two sentences
so they combine clauses and vary sentence openings (e.g., merge the
Route/listener limitation into the first sentence and rephrase the second
sentence to begin with "The guide" or "This guide explains" replaced by "The
guide explains" or "This procedure installs"), following the example phrasing in
the review to ensure clarity and smoother rhythm.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In
`@docs/en/solutions/How_to_Install_GatewayAPI_UI_Which_Could_ShareGateway_IN_ACP_4.2.md`:
- Around line 15-17: Reword the three consecutive sentences that start with
"This" to improve flow and avoid repetition: locate the paragraph containing
"ACP 4.2 includes a built-in GatewayAPI UI, but that UI was not adapted for
Envoy Gateway shared-gateway scenarios." and revise the following two sentences
so they combine clauses and vary sentence openings (e.g., merge the
Route/listener limitation into the first sentence and rephrase the second
sentence to begin with "The guide" or "This guide explains" replaced by "The
guide explains" or "This procedure installs"), following the example phrasing in
the review to ensure clarity and smoother rhythm.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d9494cf8-01ec-425f-a7d6-ea683fb36fd0

📥 Commits

Reviewing files that changed from the base of the PR and between 1727942 and db58d22.

📒 Files selected for processing (5)
  • docs/en/solutions/Alauda_LoadBalancer_with_MetalLB.md
  • docs/en/solutions/How_to_Enable_OpenTelemetry_for_Ingress_NGINX.md
  • docs/en/solutions/How_to_Install_EnvoyGatewayOperator_And_UI_Before_ACP_4.2.md
  • docs/en/solutions/How_to_Install_GatewayAPI_UI_Which_Could_ShareGateway_IN_ACP_4.2.md
  • docs/en/solutions/How_to_add_Dashboard_for_EnvoyGateway.md

@jing2uo jing2uo merged commit aa3dcd4 into alauda:main May 28, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants