push operator and Network Latency

[chinameok]

Summary by CodeRabbit

• Documentation
  • Revised prerequisites: clarified "within cluster / across clusters" scope and raised within-cluster latency guidance from ≤2 ms to ≤10 ms (across-cluster unchanged).
  • Added explicit warnings and step guidance for upgrading global vs. workload clusters (don’t use the --clusters flag for global upgrades; require --clusters for workload-targeted uploads).
  • Clarified conditional upgrade steps for related extensions when upgrading from 3.16 or 3.18 and restructured workload-cluster upgrade flow for clearer validation and DR guidance.

[coderabbitai]

Walkthrough

Documentation updates: network latency phrasing changed to "within/across clusters" with within-cluster latency raised to ≤10 ms; upgrade and upload docs clarified cluster-targeting behavior for --clusters, plus version-conditioned guidance for Data Services during upgrades.

Changes

Cohort / File(s)	Summary
Prerequisites (network latency) docs/en/install/prepare/prerequisites.mdx	Replaced "same network / across networks" with "within the same cluster / across clusters"; increased within-cluster latency limit from ≤2 ms to ≤10 ms; kept across-clusters limit at ≤100 ms (recommended ≤30 ms).
Global cluster upgrade guidance docs/en/upgrade/upgrade_global_cluster.mdx	Added warning blocks advising not to use --clusters when upgrading the global cluster; clarified that extensions (e.g., Data Services) must be upgraded when coming from 3.16 or 3.18 and linked to upgrade docs.
Workload cluster upgrade guidance docs/en/upgrade/upgrade_workload_cluster.mdx	Reworked pre-upgrade steps into numbered warnings: require --clusters for Create-only CRs targeting workload clusters, added cluster-name validation risk note, and conditioned extension upgrade guidance on source version (3.16/3.18).
Package upload / violet push behavior docs/en/extend/upload_package.mdx	Clarified that omitting --clusters uploads to the global cluster by default; added required --clusters "<cluster_name>" when targeting workload clusters and explicit guidance on global vs workload targets.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant User
  participant CLI as "violet CLI (push)"
  participant Global as "Global Cluster"
  participant Workload as "Workload Cluster"

  Note over User,CLI: User runs violet push / Create-only CRs
  User->>CLI: violet push --packages ... [--clusters <name>?]
  alt No --clusters provided
    CLI->>Global: upload packages / create CRs (default)
    Note over Global: Operators/ModuleInfo placed in Global cluster
  else --clusters provided
    CLI->>Workload: upload packages / create CRs for specified cluster(s)
    Note over Workload: Operators/CRs targeted to workload cluster(s)
  end
  CLI->>User: success / warnings (e.g., cluster-name validation, version notes)

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Pay attention to precise wording around --clusters defaults and when omission targets the global cluster vs workload clusters.
• Verify version-conditioned instructions for Data Services (3.16 / 3.18 → 4.x) and that links point to the correct upgrade docs.
• Check consistency across the three upgrade/upload docs to avoid contradictory guidance.

Possibly related PRs

• Upgrade/violet push #180 — Overlapping edits to violet push / create-only CRs and cluster-targeting guidance.
• install, upgrade for acp 4.1 and fix dr #104 — Similar modifications across upload and upgrade docs regarding --clusters / destination behavior.
• doc: scalability: disk config & workload clusters #248 — Related changes to prerequisites.mdx (network/latency guidance).

Suggested reviewers

• fanzy618

Poem

🐰 Hopped through docs with ears held high,
Ten ms within where small packets fly,
A flag for clusters, clear and neat,
Uploads find homes where they should meet.
Hop on—these notes keep upgrades fleet. 🥕📘

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "push operator and Network Latency" refers to real, substantive aspects of the changeset. "Network Latency" directly corresponds to the updated network latency specifications in prerequisites.mdx, and "push operator" relates to the clarifications about cluster targeting and --clusters parameter behavior found in upload_package.mdx and upgrade_workload_cluster.mdx. However, the title does not fully capture the primary scope of these changes, which includes significant updates to upgrade workflows, operator upgrade guidance, and version-specific upgrade conditions across multiple documentation files. The title reflects a real part of the changeset but is narrower than the main point of the changes.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch AIT-62244

---

📜 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 ae8d2da and e873c41.

📒 Files selected for processing (3)

• docs/en/extend/upload_package.mdx (1 hunks)
• docs/en/upgrade/upgrade_global_cluster.mdx (1 hunks)
• docs/en/upgrade/upgrade_workload_cluster.mdx (1 hunks)

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

• docs/en/extend/upload_package.mdx

🔇 Additional comments (5)

docs/en/upgrade/upgrade_workload_cluster.mdx (3)

25-27: Approve Data Services upgrade guidance; link verified.

The version-conditioned guidance for Data Services (versions 3.16 and 3.18) is consistent across both cluster upgrade files, the referenced documentation file exists, and the relative link is valid.

---

21-23: Anchor verified — no action required.

The anchor #upload_dr_packages exists in docs/en/install/global_dr.mdx at line 266, confirming the documentation link is valid.

---

17-19: No issues found; anchor link and validation messaging are correct.

The anchor reference ../extend/upload_package.mdx#only_create_cr is consistent across both upgrade files and properly defined in the target file. The warning about incorrect cluster names causing upgrade failures is already present and appropriately cautious.

docs/en/upgrade/upgrade_global_cluster.mdx (2)

63-67: Anchor verified — no issues found.

The link to ../extend/upload_package.mdx#only_create_cr is valid. The anchor {#only_create_cr} exists at line 187 in the target file, attached to the heading "Create only CRs from all packages in a directory." The warning is correctly cross-referenced and the guidance is clear.

---

71-75: Link verified successfully.

The file referenced by the link ../appservice/upgrade.mdx exists and is accessible from docs/en/upgrade/upgrade_global_cluster.mdx. The relative path correctly resolves to docs/en/appservice/upgrade.mdx. No issues found.

---

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

🧹 Nitpick comments (1)

docs/en/install/prepare/prerequisites.mdx (1)

160-177: Align network vs. cluster terminology across the Network Configuration table.

The Network Latency row (line 166) now uses cluster-centric terminology ("within the same cluster" / "across clusters"), while the Network Speed row (line 162) still uses network-centric terminology ("same network" / "cross-network"). For consistency and clarity, update the Network Speed requirement to use matching terminology—either both use "cluster" or both use "network" depending on the intended scope.

Consider whether "cluster" or "network" is the more precise boundary for these requirements in your deployment architecture.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 92af003 and ae8d2da.

📒 Files selected for processing (2)

• docs/en/install/prepare/prerequisites.mdx (1 hunks)
• docs/en/upgrade/upgrade_global_cluster.mdx (1 hunks)

🔇 Additional comments (3)

docs/en/install/prepare/prerequisites.mdx (1)

165-167: Verify and clarify the rationale for the within-cluster latency threshold increase.

The within-cluster network latency threshold has been significantly relaxed from ≤2 ms to ≤10 ms. While the terminology shift from "network" to "cluster" improves clarity, the 5x increase in the acceptable latency threshold warrants explicit documentation of the change rationale—whether it reflects updated performance benchmarks, deployment experience, or alignment with realistic infrastructure constraints.

Consider adding a note explaining why this threshold was adjusted to help users understand the change and assess its applicability to their environments.

docs/en/upgrade/upgrade_global_cluster.mdx (2)

63-67: Helpful clarification for multi-cluster upgrade workflows.

The new INFO directive clearly addresses a critical upgrade scenario—ensuring that when using the --clusters parameter with "Create only CRs" action, users understand the behavior when the parameter is omitted. This guidance prevents a common mistake that would leave workload cluster operators unupgraded. The placement immediately following the relevant command context is ideal.

---

63-67: Cross-reference link verified—no issues found.

The anchor #only_create_cr exists at line 187 of docs/en/extend/upload_package.mdx with correct Markdown syntax. The link in the new INFO directive resolves correctly, and the referenced section heading matches the link text. The new guidance is accurate and properly positioned.