add ACP Registry Capacity Planning Guide doc

[zhhray]

Summary by CodeRabbit

• Documentation
  • Added a Capacity Planning Guide for Alauda Container Platform Registry and Registry Gateway, covering component roles, hardware resource profiles, two dynamic load indicators, traffic level definitions, three deployment scenarios with replica and resource recommendations, dedicated-node deployment considerations, and final resource mapping guidance.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Adds a new documentation file Alauda_Container_Platform_Registry_Capacity_Planning_Guide.md that documents component roles, hardware/resource recommendations, dynamic load indicators, traffic level definitions, three deployment scenarios with replica counts and resource specs, and dedicated-node deployment considerations.

Changes

Cohort / File(s)	Summary
Capacity Planning Documentation docs/en/solutions/Alauda_Container_Platform_Registry_Capacity_Planning_Guide.md	New guide detailing component roles, I/O/CPU/memory sensitivity, two dynamic load indicators, traffic operation definitions, three scalability scenarios (replica counts and container resource specs), dedicated-node deployment notes, and final resource recommendations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A fresh guide hops into view,
Registry rules and specs anew,
Three scenarios, metrics bright,
Nodes and resources set just right,
Hooray—capacity plans in flight!

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'add ACP Registry Capacity Planning Guide doc' directly matches the changeset, which adds a single documentation file about capacity planning for Alauda Container Platform Registry.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

---

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: 1

🤖 Fix all issues with AI agents

In `@docs/en/solutions/Alauda_Container_Pltform_Registry_Sizing_Guide.md`:
- Line 10: The file name contains a typo: rename the file from
Alauda_Container_Pltform_Registry_Sizing_Guide.md to
Alauda_Container_Platform_Registry_Sizing_Guide.md so it matches the title
"Alauda Container Platform Registry & Registry Gateway Capacity Planning Guide"
and improves consistency and searchability; update any internal links or
references that point to Alauda_Container_Pltform_Registry_Sizing_Guide.md to
the new filename.

🧹 Nitpick comments (3)

docs/en/solutions/Alauda_Container_Pltform_Registry_Sizing_Guide.md (3)

24-35: Fix unordered list indentation to satisfy markdownlint.

MD007 flags these lists due to extra indentation. Removing the leading spaces will align with the lint rule.

♻️ Proposed fix

-  * **I/O Intensive**: Performance is heavily dependent on storage backend speed (for layer push/pull operations).
-  * **Memory Sensitive**: Requires adequate memory for layer caching during pushes and pulls, and for handling concurrent connections.
-  * **Moderate CPU**: CPU is used for compression, hashing, and request handling.
+* **I/O Intensive**: Performance is heavily dependent on storage backend speed (for layer push/pull operations).
+* **Memory Sensitive**: Requires adequate memory for layer caching during pushes and pulls, and for handling concurrent connections.
+* **Moderate CPU**: CPU is used for compression, hashing, and request handling.
@@
-  * **CPU Intensive**: Due to JSON parsing, size calculation, and request proxying.
-  * **Latency Sensitive**: Performance is tightly coupled with the response time of the backend Registry's tag listing endpoint.
-  * **Memory Sensitive**: Needs buffer for large manifest requests and maintains session cache.
+* **CPU Intensive**: Due to JSON parsing, size calculation, and request proxying.
+* **Latency Sensitive**: Performance is tightly coupled with the response time of the backend Registry's tag listing endpoint.
+* **Memory Sensitive**: Needs buffer for large manifest requests and maintains session cache.

---

39-55: Add blank lines around tables to satisfy markdownlint (MD058).

Each table should be surrounded by blank lines to avoid lint failures.

♻️ Proposed fix

 ### Scenario 1: ~100 Concurrent Pods (Light Usage)
+
 | Component | Recommended Replicas | Container Resources (Requests / Limits) | Notes |
 | --------- | -------------------- | -------------------------------------- | ---------------- |
 | Alauda Container Platform Registry | 1-2 | CPU: `500m` / `1000m` <br> Memory: `512Mi` / `1Gi` | Single replica may suffice. |
 | Registry Gateway | 1-2 | CPU: `200m-300m` / `500m` <br> Memory: `256Mi-512Mi` / `1Gi` | Resources accommodate bursty image pushes requiring manifest parsing. |
+
 
 ### Scenario 2: ~1000 Concurrent Pods (Medium Usage)
+
 | Component | Recommended Replicas | Container Resources (Requests / Limits) | Notes |
 | --------- | -------------------- | -------------------------------------- | ---------------- |
 | Alauda Container Platform Registry | 2-3 | CPU: `1000m` / `2000m` <br> Memory: `1Gi` / `2Gi` | Requires multiple replicas. |
 | Registry Gateway | 2-3 | CPU: `300m-500m` / `1000m-2000m` <br> Memory: `512Mi-1Gi` / `2Gi` | The synchronous tag-list check becomes a primary bottleneck. Higher CPU limits are needed. |
+
 
 ### Scenario 3: ~5000 Concurrent Pods (Large Usage)
+
 | Component | Recommended Replicas | Container Resources (Requests / Limits) | Notes |
 | --------- | -------------------- | -------------------------------------- | ---------------- |
 | Alauda Container Platform Registry | 3-5+ | CPU: `2000m` / `4000m` <br> Memory: `2Gi` / `4Gi` | Requires significant horizontal scaling. |
 | Registry Gateway | 3-5+ | CPU: `500m-1000m` / `2000m-4000m` <br> Memory: `1Gi-2Gi` / `4Gi` | Tag validation latency can cause cascading delays. |
+

---

36-55: Clarify what “Concurrent Pods” means and workload assumptions.

Consider adding a short note clarifying whether “concurrent pods” refers to image pulls, total cluster pods, or peak pod churn, and the assumed push/pull rates. This helps readers choose the right scenario.

[coderabbitai]

Actionable comments posted: 5

🤖 Fix all issues with AI agents

In
`@docs/en/solutions/Alauda_Container_Platform_Registry_Capacity_Planning_Guide.md`:
- Around line 45-50: Add a blank line between the section heading "### Scenario
2: ~1000 Concurrent Pods (Medium Usage)" and the following table so the markdown
renders correctly and passes linting; edit the block containing the table rows
for "Alauda Container Platform Registry" and "Registry Gateway" to insert one
empty line immediately after the heading.
- Line 16: Summary: Fix hyphenation in the "Registry Gateway" bullet so the
compound adjective is consistent. Locate the bullet starting with "Registry
Gateway" (the line containing "CPU and network-latency intensive") and change
"network-latency intensive" to "network-latency-intensive" so the phrase reads
"CPU and network-latency-intensive". Ensure the rest of the bullet remains
unchanged.
- Around line 24-27: The unordered list under the "Resource Profile" heading is
indented by two spaces, which breaks Markdown list parsing; remove the leading
two spaces before each bullet so the three items ("I/O Intensive", "Memory
Sensitive", "Moderate CPU") start at column zero directly under the heading,
ensuring they are rendered as a proper list.
- Around line 31-34: The three bullet lines under the "Resource Profile" heading
("CPU Intensive", "Latency Sensitive", "Memory Sensitive") are indented with two
spaces which breaks standard Markdown list rendering; remove the two leading
spaces so each list item starts at column 0 (i.e., immediately under the
heading) to make the unordered list properly formatted and render as a normal
top-level list.
- Around line 39-44: Add a blank line between the section heading "### Scenario
1: ~100 Concurrent Pods (Light Usage)" and the Markdown table that follows so
the table renders correctly and passes linting; edit the block containing the
table (the Alauda Container Platform Registry / Registry Gateway rows) to insert
one empty line directly after the heading.

♻️ Duplicate comments (1)

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

51-56: Add blank line before table.

Markdown formatting standards require a blank line between the section heading and the table for proper rendering and linting compliance.

📝 Proposed fix

 ### Scenario 3: ~5000 Concurrent Pods (Large Usage)
+
 | Component | Recommended Replicas | Container Resources (Requests / Limits) | Notes |

[coderabbitai]

Actionable comments posted: 3

🤖 Fix all issues with AI agents

In
`@docs/en/solutions/Alauda_Container_Platform_Registry_Capacity_Planning_Guide.md`:
- Around line 44-46: Insert a blank line immediately before the "## Traffic
Level Definitions" heading/table block so the markdown table is separated by an
empty line from the preceding content; locate the "Traffic Level Definitions"
heading and ensure there is a single empty line above the table row that begins
with "| Traffic Level | Daily Pull/Push Operations | Peak Concurrent Pull/Push
Operations | Typical Scenario |" to satisfy markdown rendering and linting
rules.
- Around line 79-81: The three bullet lines under the “Dedicated Node
Deployment” section are indented by two spaces, making them appear as nested
list items; unindent each of these lines (the bullets starting with "**High
Concurrency/Throughput**", "**High Availability & Strict SLA Requirements**",
and "**Resource Isolation & Security Compliance**") so the asterisks are at the
top-level (no leading spaces), ensuring they render as top-level bullets under
that heading.
- Around line 38-42: The bullet list under the "Core Evaluation Dimensions."
section is indented by two spaces which violates markdownlint; open the "Core
Evaluation Dimensions" heading in
docs/en/solutions/Alauda_Container_Platform_Registry_Capacity_Planning_Guide.md
and remove the leading two-space indentation from the top-level bullets (the
lines starting with "* **Daily Average Access Traffic**", "* **Peak Access
Traffic**", "These traffic flows..." and the nested "* **Push Operations**"/"*
**Pull Operations**") so that top-level bullets start at column 0 and nested
bullets remain indented one level only; ensure blank line spacing around the
list is preserved.

♻️ Duplicate comments (1)

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

69-72: Add a blank line before the Scenario 3 table.

Keeps table rendering consistent with markdownlint expectations.

📝 Proposed fix

 ### Scenario 3: High Traffic
 Applicable: Enterprise central registry serving multiple teams and all environments
+
 | Component | Recommended Replicas | Container Resources (Requests / Limits) | Notes |

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In
`@docs/en/solutions/Alauda_Container_Platform_Registry_Capacity_Planning_Guide.md`:
- Around line 85-86: In the "Final Recommendation" section (heading: Final
Recommendation) make the traffic-volume formatting consistent by replacing "over
10k daily operations" with "over 10,000 daily operations" (to match line 80's
use of "10,000") so the document uses the same numeric style throughout.
- Around line 79-83: The markdown list and the following paragraph titled
"**Benefits**" are being parsed together; insert a single blank line between the
end of the bullet list and the "**Benefits**" heading so the heading becomes a
new paragraph (i.e., after the last list item add one empty line before the line
that starts with "**Benefits**") to ensure the list is separated from the
paragraph.

♻️ Duplicate comments (2)

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

16-16: Hyphenate compound adjective.

This was already flagged: make it “CPU- and network-latency-intensive” for consistent compound hyphenation.

---

40-42: Add trailing punctuation.

The sentence ending “network” is missing a period.

📝 Proposed fix

-* **Pull Operations**: Mainly generate pressure on registry I/O and network
+* **Pull Operations**: Mainly generate pressure on registry I/O and network.

[jianliao82]

/lgtm

[jianliao82]

/lgtm