Copilot commented on code in PR #305: URL: https://github.com/apache/ozone-site/pull/305#discussion_r2745064793
########## docs/03-core-concepts/01-architecture/07-consistency-guarantees.md: ########## @@ -0,0 +1,168 @@ +--- +sidebar_label: Consistency Guarantees +--- + +# Consistency Guarantees + +## OM (Ozone Manager) HA Consistency + +:::info +Notice: Before Ozone 2.2.0 (current is 2.1.0), all operations in OM are linearizable. After [HDDS-14424](https://issues.apache.org/jira/browse/HDDS-14424) is done and released in Ozone 2.2.0, users will have more options to configure the consistency guarantees for OM based on the tradeoff across scalability, throughput and staleness. Review Comment: The parenthetical "(current is 2.1.0)" will become outdated as soon as a new release ships and will require ongoing doc churn. Consider removing the "current is …" portion and phrasing this in terms of version ranges only (e.g., "Prior to Ozone 2.2.0…"). ```suggestion Notice: Before Ozone 2.2.0, all operations in OM are linearizable. After [HDDS-14424](https://issues.apache.org/jira/browse/HDDS-14424) is done and released in Ozone 2.2.0, users will have more options to configure the consistency guarantees for OM based on the tradeoff across scalability, throughput and staleness. ``` ########## docs/03-core-concepts/01-architecture/07-consistency-guarantees.md: ########## @@ -0,0 +1,168 @@ +--- +sidebar_label: Consistency Guarantees +--- + +# Consistency Guarantees + +## OM (Ozone Manager) HA Consistency + +:::info +Notice: Before Ozone 2.2.0 (current is 2.1.0), all operations in OM are linearizable. After [HDDS-14424](https://issues.apache.org/jira/browse/HDDS-14424) is done and released in Ozone 2.2.0, users will have more options to configure the consistency guarantees for OM based on the tradeoff across scalability, throughput and staleness. +::: + +### Default Configuration (Non-Linearizable) (will release in Ozone 2.2) Review Comment: The capitalization is inconsistent between the heading ("Non-Linearizable") and the bullet ("Non-linearizable"). Pick one form and use it consistently throughout this page for easier scanning/searching. ```suggestion ### Default Configuration (Non-linearizable) (will release in Ozone 2.2) ``` ########## docs/03-core-concepts/01-architecture/07-consistency-guarantees.md: ########## @@ -0,0 +1,168 @@ +--- +sidebar_label: Consistency Guarantees +--- + +# Consistency Guarantees + +## OM (Ozone Manager) HA Consistency + +:::info +Notice: Before Ozone 2.2.0 (current is 2.1.0), all operations in OM are linearizable. After [HDDS-14424](https://issues.apache.org/jira/browse/HDDS-14424) is done and released in Ozone 2.2.0, users will have more options to configure the consistency guarantees for OM based on the tradeoff across scalability, throughput and staleness. +::: + +### Default Configuration (Non-Linearizable) (will release in Ozone 2.2) +- **Read Path**: Only the leader serves read requests +- **Mechanism**: Reads query the state machine directly without ReadIndex +- **Guarantee**: **Non-linearizable** - may return stale data during leader transitions +- **Performance**: No heartbeat rounds required for reads, better latency +- **Risk**: Short-period split-brain scenario possible (old leader may serve stale reads during leadership transition) + +### Optional: Linearizable Reads (will release in Ozone 2.2) Review Comment: Version formatting and tense are inconsistent here ("2.2" vs "2.2.0" elsewhere, and repeated "will release" phrasing). To reduce future maintenance and ambiguity, consider using a consistent semantic version (e.g., 2.2.0) and wording like "Starting in Ozone 2.2.0" instead of "will release" in headings. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
