[Docs] Document pool autoscaling feature#8873
Conversation
Add documentation for the new autoscaling support in pools (PR #8483). - Add "Autoscaling" section covering min_workers/max_workers YAML syntax - Document all autoscaling options: queue_length_threshold, upscale_delay_seconds, downscale_delay_seconds - Explain scale-to-zero behavior (min_workers: 0) - Document how to combine a fixed baseline with autoscaling bounds - Remove "Autoscaling" from the Coming Soon admonition Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
Summary of ChangesHello @lloyd-brown, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces comprehensive documentation for the recently released pool autoscaling feature. It provides users with detailed guidance on configuring worker pools to automatically adjust their size based on job queue demand, including examples for scale-to-zero and combining fixed worker counts with dynamic scaling, ensuring efficient resource utilization and cost management. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request adds comprehensive documentation for the new pool autoscaling feature. The changes are well-structured and clear. I've found one minor point of ambiguity in the explanation of the queue_length_threshold logic and suggested a clarification to make it more precise for users. Overall, this is a great addition to the documentation.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
/build-docs |
|
✅ ReadTheDocs build triggered for branch The documentation will be available at: https://docs.skypilot.co/en/lloyd-pools-autoscaling-docs/ |
Michaelvll
left a comment
There was a problem hiding this comment.
Thanks @lloyd-brown! Let's get it merged first.
[Docs] Add pool section to task YAML spec reference Adds documentation for the pool top-level field and its autoscaling sub-fields (workers, min_workers, max_workers, queue_length_threshold, upscale_delay_seconds, downscale_delay_seconds) to the YAML spec reference, matching the existing SkyServe Service section format.
Change :ref: target from 'job-pool' to 'pool' to match the label defined in pools.rst, fixing the doc build warning.
Summary
min_workers,max_workers,queue_length_threshold,upscale_delay_seconds, anddownscale_delay_secondsmin_workers: 0) and how to combine a fixed baseline with autoscaling boundsChanges
The new Autoscaling section (added between Scaling and updating a pool and Terminate a pool) covers:
min_workers/max_workersand the resulting CLI output showing the autoscaling policy stringmin_workers: 0lets the pool shrink to zero workers when idleworkers,min_workers, andmax_workersinteractTest plan
bash docs/build.sh— build succeeded with no errors or warnings related to the changed filepython3 -m http.server— all code blocks, tips, notes, and admonitions render correctly