docs(compression-coordinator): Add a user guide for using compression-coordinator. - #2456
Draft
LinZhihao-723 wants to merge 6 commits into
Draft
docs(compression-coordinator): Add a user guide for using compression-coordinator.#2456LinZhihao-723 wants to merge 6 commits into
compression-coordinator.#2456LinZhihao-723 wants to merge 6 commits into
Conversation
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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. Comment |
LinZhihao-723
commented
Aug 5, 2026
Comment on lines
+17
to
+39
| Compared with `compression-scheduler`, `compression-coordinator` provides the following improvements | ||
| to the user experience, reliability, and performance: | ||
|
|
||
| * **Automatic failure recovery**: If a service fails or restarts, `compression-coordinator` | ||
| automatically resumes previously submitted jobs. Users do not need to restart them manually. | ||
| * **Improved resource utilization**: Compression jobs run in a Spider-managed execution environment, | ||
| allowing computational resources to be shared more effectively across all configured workers. | ||
| * **Configurable retries for compression failures**: `compression-coordinator` allows users to | ||
| configure a simple retry policy for failed compression tasks. Automatic retries can help recover | ||
| from transient issues, such as temporary network interruptions, without requiring user | ||
| intervention. | ||
| * TODO: Configure retry policy through <LINK> | ||
| * **Improved fairness across concurrent compression jobs**: `compression-coordinator` provides | ||
| two levels of concurrency control to improve fairness among compression jobs running concurrently: | ||
| * Coordinator-side rate limit: TODO, depends on #2435. | ||
| * Spider-side active job limit: Controls the maximum number of jobs that can make progress | ||
| concurrently while sharing compute resources in Spider. Jobs are admitted on a first-come, | ||
| first-served basis. | ||
| * **Data integrity**: Compression jobs coordinated by `compression-coordinator` publish their | ||
| results to the rest of the system through a dedicated commit stage. The commit operation is both | ||
| transactional and idempotent. | ||
| * A job-level failure does not result in partial updates. | ||
| * Internal retries do not result in duplicate updates |
Member
Author
There was a problem hiding this comment.
@junhaoliao Can you review this section to check if it makes sense (since it compares to the existing scheduling)?
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR depends on #2455.
Checklist
breaking change.
Validation performed