Skip to content

Add HCS VIP LoadBalancer Service docs in Chinese and English#155

Open
changluyi wants to merge 2 commits intoalauda:mainfrom
changluyi:docs/hcs-vip-lb-service-en
Open

Add HCS VIP LoadBalancer Service docs in Chinese and English#155
changluyi wants to merge 2 commits intoalauda:mainfrom
changluyi:docs/hcs-vip-lb-service-en

Conversation

@changluyi
Copy link
Copy Markdown
Contributor

@changluyi changluyi commented Apr 22, 2026

Summary

  • add a Chinese solution doc for using HCS VM VIPs with LoadBalancer Services
  • add the matching English solution doc
  • align both docs to the current How_to naming style

Summary by CodeRabbit

  • Documentation
    • Added new guides in English and Chinese for using Huawei HCS VM-precreated external VIPs with Kubernetes LoadBalancer Services on ACP 4.2. Documentation includes prerequisites, kube-proxy IPVS configuration steps, MetalLB setup requirements, Service annotation specifications with manifest examples, and verification procedures for testing VIP allocation and external access.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 22, 2026

Walkthrough

Added two new documentation articles in English and Chinese describing how to use Huawei HCS VM pre-created external VIPs with Kubernetes LoadBalancer Services in ACP 4.2, including prerequisites, configuration procedures for kube-proxy IPVS mode and MetalLB address pools, and verification steps.

Changes

Cohort / File(s) Summary
HCS VIP LoadBalancer Documentation
docs/en/solutions/How_to_Use_HCS_VIP_for_LoadBalancer_Service_in_HCS.md, docs/zh/solutions/How_to_Use_HCS_VIP_for_LoadBalancer_Service_in_HCS.md
New solution guides (English and Chinese) documenting integration of Huawei HCS VIP with Kubernetes LoadBalancer Services via MetalLB and kube-proxy IPVS configuration, including architecture overview, prerequisites, step-by-step setup procedures, example manifests, and verification methods.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • fanzy618
  • oilbeater

Poem

📚 A VIP guide hops through the docs today,
For LoadBalancers making their way,
With IPVS and pools in perfect array,
HCS and Kubernetes now gently play! 🐰✨

🚥 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 clearly and concisely summarizes the main change: adding documentation for HCS VIP LoadBalancer Service in both Chinese and English, which matches the file additions.
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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/zh/solutions/How_to_Use_HCS_VIP_for_LoadBalancer_Service_in_HCS.md`:
- Around line 25-46: Add a language tag to the fenced code block that contains
the ASCII architecture diagram so Markdown lint MD040 is satisfied: locate the
triple-backtick fence that opens the diagram (the ASCII art block starting with
"外部客户端") and change the opening fence from ``` to ```text (i.e., add the
language identifier "text") so the diagram block is recognized properly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 71f4594f-9bb6-436c-ae6d-6aa6cb49016f

📥 Commits

Reviewing files that changed from the base of the PR and between c8b7b50 and de038c9.

📒 Files selected for processing (2)
  • docs/en/solutions/How_to_Use_HCS_VIP_for_LoadBalancer_Service_in_HCS.md
  • docs/zh/solutions/How_to_Use_HCS_VIP_for_LoadBalancer_Service_in_HCS.md

Comment on lines +25 to +46
```
外部客户端
↓ 访问 VIP
HCS 虚拟机层网络(负责 VIP 的对外路由)
↓ 流量到达集群节点
┌─────────────────────────────────────────────────────────────┐
│ HCS 集群 │
│ │
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
│ │ Node 1 │ │ Node 2 │ │ Node 3 │ │
│ │ kube-proxy │ │ kube-proxy │ │ kube-proxy │ │
│ │ (IPVS 规则) │ │ (IPVS 规则) │ │ (IPVS 规则) │ │
│ └──────────────┘ └──────────────┘ └──────────────┘ │
│ ↓ ↓ ↓ │
│ ┌────────────────────────────────────────────────────────┐ │
│ │ Service (LoadBalancer) │ │
│ │ ExternalIP (VIP): 10.0.0.100 │ │
│ └────────────────────────────────────────────────────────┘ │
│ ↓ ↓ ↓ │
│ Pod A Pod B Pod C │
└─────────────────────────────────────────────────────────────┘
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

为架构图代码块补充语言标识以通过 Markdown lint。

Line 25 的 fenced code block 缺少语言标识,当前会触发 MD040 警告。建议改为 ```text

✏️ Proposed fix
-```
+```text
 外部客户端
      ↓ 访问 VIP
 HCS 虚拟机层网络(负责 VIP 的对外路由)
@@
-```
+```
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 25-25: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/zh/solutions/How_to_Use_HCS_VIP_for_LoadBalancer_Service_in_HCS.md`
around lines 25 - 46, Add a language tag to the fenced code block that contains
the ASCII architecture diagram so Markdown lint MD040 is satisfied: locate the
triple-backtick fence that opens the diagram (the ASCII art block starting with
"外部客户端") and change the opening fence from ``` to ```text (i.e., add the
language identifier "text") so the diagram block is recognized properly.

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.

1 participant