Skip to content

docs: generalize LocalDNS config management for OS neutrality#848

Merged
changluyi merged 2 commits into
masterfrom
docs/update-localdns-config-doc
Jun 3, 2026
Merged

docs: generalize LocalDNS config management for OS neutrality#848
changluyi merged 2 commits into
masterfrom
docs/update-localdns-config-doc

Conversation

@changluyi

@changluyi changluyi commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • 移除 NodeLocal DNSCache 文档中特定操作系统产品名称(MicroOS)
  • 将升级场景描述改为通用的「通过重建节点升级」,不绑定特定操作系统

Related Issue

ACP-53148

Changes

Before After
MicroOS Cluster Upgrade: For MicroOS clusters, upgrades are performed by rebuilding the cluster... Cluster Upgrade via Rebuilding: If the cluster is upgraded by rebuilding nodes (re-provisioning)...

Checklist

  • 文档描述不绑定特定操作系统
  • 文档中不出现特定操作系统产品名称
  • 配置步骤和注意事项保持一致

Summary by CodeRabbit

  • Documentation
    • Updated cluster upgrade guidance to include instructions for configuring node local DNS using the --cluster-dns parameter to preserve kubelet settings during node rebuilding.

Remove specific OS product name (MicroOS) from NodeLocal DNSCache
documentation. Describe upgrade scenario by behavior (rebuilding nodes)
instead of tying it to a particular operating system.

ACP-53148
@coderabbitai

coderabbitai Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7990b4bc-e8e1-4ac7-b215-076f6de087b3

📥 Commits

Reviewing files that changed from the base of the PR and between 54a889f and 6cdabf9.

📒 Files selected for processing (1)
  • docs/en/networking/functions/configure_node_local_dns.mdx
💤 Files with no reviewable changes (1)
  • docs/en/networking/functions/configure_node_local_dns.mdx

Walkthrough

Documentation update to the NodeLocal DNSCache configuration guide clarifying that node-rebuild cluster upgrades discard kubelet configuration. Users are instructed to persist NodeLocal DNS settings by adding the --cluster-dns parameter to kubeletExtraArgs in three specified cluster-template locations.

Changes

NodeLocal DNS upgrade persistence guidance

Layer / File(s) Summary
NodeLocal DNS kubeletExtraArgs persistence guidance
docs/en/networking/functions/configure_node_local_dns.mdx
Updated the "Important Notes" section to generalize the upgrade warning from "Alauda OS Cluster Upgrade" to "Cluster Upgrade via Rebuilding" and added guidance explaining that rebuilding-based upgrades discard kubelet configuration changes. Users are instructed to persist NodeLocal DNS configuration by adding --cluster-dns to kubeletExtraArgs in three template locations: KubeadmControlPlane init/join and KubeadmConfigTemplate join sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • alauda/acp-docs#836: Mirrors the same configure_node_local_dns.mdx update, generalizing the kubelet-delta/upgrade warning to "Cluster Upgrade via Rebuilding" and instructing persistence of NodeLocal DNS via kubeletExtraArgs --cluster-dns in three template locations.

Poem

🐰 A DNS path through nodes so fine,
When clusters rebuild and realign,
Add --cluster-dns to persist and keep,
Your NodeLocal magic, configured deep!
🌟

🚥 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 accurately summarizes the main change: generalizing LocalDNS configuration documentation to be OS-neutral by removing MicroOS-specific references.
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
  • Commit unit tests in branch docs/update-localdns-config-doc

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.

@changluyi changluyi requested a review from fanzy618 June 2, 2026 02:13
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying alauda-container-platform with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6cdabf9
Status: ✅  Deploy successful!
Preview URL: https://44bf75b8.alauda-container-platform.pages.dev
Branch Preview URL: https://docs-update-localdns-config.alauda-container-platform.pages.dev

View logs

@changluyi changluyi merged commit 03a7b17 into master Jun 3, 2026
3 checks passed
@changluyi changluyi deleted the docs/update-localdns-config-doc branch June 3, 2026 07:49
changluyi added a commit that referenced this pull request Jun 3, 2026
Remove specific OS product name (MicroOS) from NodeLocal DNSCache
documentation. Describe upgrade scenario by behavior (rebuilding nodes)
instead of tying it to a particular operating system.

ACP-53148
changluyi added a commit that referenced this pull request Jun 3, 2026
Remove specific OS product name (MicroOS) from NodeLocal DNSCache
documentation. Describe upgrade scenario by behavior (rebuilding nodes)
instead of tying it to a particular operating system.

ACP-53148
changluyi added a commit that referenced this pull request Jun 3, 2026
…860)

Remove specific OS product name (MicroOS) from NodeLocal DNSCache
documentation. Describe upgrade scenario by behavior (rebuilding nodes)
instead of tying it to a particular operating system.

ACP-53148
changluyi added a commit that referenced this pull request Jun 3, 2026
…861)

Remove specific OS product name (MicroOS) from NodeLocal DNSCache
documentation. Describe upgrade scenario by behavior (rebuilding nodes)
instead of tying it to a particular operating system.

ACP-53148
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