Skip to content

docs: update ac registry cleanup guide#796

Merged
zhhray merged 1 commit into
mainfrom
codex/ac-registry-cleanup-guide
Jun 24, 2026
Merged

docs: update ac registry cleanup guide#796
zhhray merged 1 commit into
mainfrom
codex/ac-registry-cleanup-guide

Conversation

@zhhray

@zhhray zhhray commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Clarified cluster image registry cleanup procedures and parameter configurations
    • Expanded troubleshooting guidance and diagnostic workflows for registry operations
    • Updated RBAC and CronJob best practice examples with improved performance recommendations

@coderabbitai

coderabbitai Bot commented Jun 24, 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: 8aa6b383-a64c-4bea-87c4-f0ec5f85f58b

📥 Commits

Reviewing files that changed from the base of the PR and between 3fca92f and fe49674.

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

Walkthrough

Both the English and Chinese administrator guides for ACP cluster image registry cleanup are updated in parallel. Changes add --catalog-page-size documentation, refine --registry-url descriptions, expand dry-run steps with fallback endpoint examples, revise RBAC rationale and ClusterRole examples to use registry API access instead of Kubernetes custom resources, and extend troubleshooting and diagnostic workflow entries.

Changes

ACP Image Registry Cleanup Guide (EN + ZH)

Layer / File(s) Summary
Terminology and parameter reference updates
docs/en/solutions/How_to_Cleanup_...md, docs/zh/solutions/How_to_Cleanup_...md
"External registry endpoint" is redefined as a manually provided fallback; --registry-url and --catalog-page-size are added to parameter tables with valid range, default, and constraint descriptions in both language variants.
Dry-run execution step expansion
docs/en/solutions/How_to_Cleanup_...md, docs/zh/solutions/How_to_Cleanup_...md
Step 2 is expanded to cover use of --registry-url when the default internal endpoint is unreachable and to recommend --catalog-page-size for large registries, including example commands in both language variants.
RBAC rationale, CronJob example, and ClusterRole revisions
docs/en/solutions/How_to_Cleanup_...md, docs/zh/solutions/How_to_Cleanup_...md
RBAC "Why These Permissions Are Required" section is rewritten to describe direct registry API querying; the runnable ClusterRole example drops registry.alauda.io/images get/delete rules; RBAC scope recommendation bullets are updated for dry-run vs. confirmed modes; --catalog-page-size=1000 is added to CronJob args in both language variants.
Troubleshooting table and diagnostic workflow
docs/en/solutions/How_to_Cleanup_...md, docs/zh/solutions/How_to_Cleanup_...md
"Forbidden/cannot list" and "forbidden when deleting" troubleshooting rows are rewritten to reference registry API/token authorization; best practices table adds -v=4 guidance and --catalog-page-size=1000 to daily-check flags; quick diagnostic workflow gains verbosity rerun and pods/exec/registry Pod availability steps in both language variants.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 A rabbit hops through docs with glee,
Fixing flags for all to see—
--catalog-page-size joins the crew,
RBAC tables fresh and new.
-v=4 reveals the way,
Cleaner registries every day! 🌸

🚥 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: updating documentation for the ac registry cleanup guide with clarifications on parameters, RBAC, and troubleshooting.
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 codex/ac-registry-cleanup-guide

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.

@zhhray

zhhray commented Jun 24, 2026

Copy link
Copy Markdown
Contributor Author

/lgtm

@zhhray zhhray merged commit 44c0113 into main Jun 24, 2026
2 checks passed
@zhhray zhhray deleted the codex/ac-registry-cleanup-guide branch June 24, 2026 04:45
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