add How_to_add_healthcheck_for_acp_clusters.md

[woodgear]

Summary by CodeRabbit

• Documentation
  • Added a solution guide for configuring ALB/VIP-based health checks for ACP clusters.
  • Details VIP prerequisites (including port forwarding) and recommended settings: ALB address, Port 11782 (global) or 1936 (business), Protocol TCP, Response Timeout 2s, Check Interval 5s, Unhealthy Threshold 3.
  • Includes a configuration table for quick setup.

[coderabbitai]

Walkthrough

Added a new solution document that describes configuring ALB VIP-based health checks for Alauda Container Platform (ACP) clusters, specifying the ALB health-check port (11782), recommended protocol (TCP), timeouts, intervals, unhealthy threshold, and VIP port-forwarding prerequisite.

Changes

Cohort / File(s)	Change Summary
Docs: ACP ALB health-check solution docs/en/solutions/How_to_add_healthcheck_for_acp_clusters.md	Added a solution document detailing how to configure a VIP-based ALB health check for ACP clusters, using ALB health-check port 11782 (global) or 1936 (business), recommending TCP, and specifying Response Timeout: 2s, Check Interval: 5s, Unhealthy Threshold: 3. Notes that VIP access requires port forwarding for the health-check port.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Admin as Admin
  participant ALB as ALB
  participant VIP as VIP (optional)
  participant Cluster as ACP Cluster

  Admin->>ALB: Configure health check\n(Address, Port=11782, Protocol=TCP, Timeout=2s, Interval=5s, Unhealthy=3)
  note over ALB: Port 11782 (global) or 1936 (business)

  alt ALB via VIP
    ALB->>VIP: TCP health probe
    VIP->>Cluster: Port-forward to health port
    Cluster-->>VIP: Health response
    VIP-->>ALB: Health response
  else Direct ALB to Cluster
    ALB->>Cluster: TCP health probe
    Cluster-->>ALB: Health response
  end

  note over ALB,Cluster: Interval: 5s • Timeout: 2s • Unhealthy threshold: 3

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks (2 passed, 1 warning)

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The pull request lacks any descriptive body explaining the purpose or content of the changes, providing no context for reviewers.	Please add a clear description summarizing what the new documentation covers and why this change is needed to give reviewers proper context.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title clearly references the addition of the new healthcheck documentation file for ACP clusters, which aligns with the primary change in the pull request.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Poem

I hop to the load balancer, ears up and keen,
Port 11782 gleams like a carrot green.
TCP knocks, quick timeout—two,
Five-second checks keep the burrow true.
Three misses and we hop to fix the scene. 🥕

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8be1747 and d216b4b.

📒 Files selected for processing (1)

• docs/en/solutions/How_to_add_healthcheck_for_acp_clusters.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• docs/en/solutions/How_to_add_healthcheck_for_acp_clusters.md

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 4

🧹 Nitpick comments (2)

docs/en/solutions/How_to_add_healthcheck_for_acp_clusters.md (2)

12-13: Rename section and fix “VIP” casing

Align with standard terminology.

-## Config Vip Health Check
-Refer to the following table to configure the VIP health check parameters:
+## Configure VIP health check
+Refer to the following table to configure the VIP health‑check parameters:

---

22-22: Add a short security note

1936 is commonly an admin/stats port; advise restricting exposure.

+> Note: Do not expose the health‑check ports publicly. Restrict access (ACLs/firewalls) and prefer TCP connect checks over HTTP to avoid leaking stats or admin endpoints.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 879cb5b and 8be1747.

📒 Files selected for processing (1)

• docs/en/solutions/How_to_add_healthcheck_for_acp_clusters.md (1 hunks)

🔇 Additional comments (1)

docs/en/solutions/How_to_add_healthcheck_for_acp_clusters.md (1)

1-6: Front-matter schema: confirm if title: is required for solution docs
The front matter in docs/en/solutions/How_to_add_healthcheck_for_acp_clusters.md (and other solution guides) currently only lists products and kind. Please verify against our documentation or template whether a title: key must be included.