Skip to content

[Docs] Document pool autoscaling feature#8873

Merged
lloyd-brown merged 4 commits into
masterfrom
lloyd/pools-autoscaling-docs
Feb 25, 2026
Merged

[Docs] Document pool autoscaling feature#8873
lloyd-brown merged 4 commits into
masterfrom
lloyd/pools-autoscaling-docs

Conversation

@lloyd-brown

Copy link
Copy Markdown
Collaborator

Summary

  • Documents the new pool autoscaling feature added in [Pools] Add Support for Autoscaling #8483
  • Adds a new Autoscaling section to the pools docs covering min_workers, max_workers, queue_length_threshold, upscale_delay_seconds, and downscale_delay_seconds
  • Documents scale-to-zero behavior (min_workers: 0) and how to combine a fixed baseline with autoscaling bounds
  • Removes Autoscaling from the Coming Soon admonition since the feature is now shipped

Changes

The new Autoscaling section (added between Scaling and updating a pool and Terminate a pool) covers:

  1. Quick-start example — minimal YAML with min_workers/max_workers and the resulting CLI output showing the autoscaling policy string
  2. Scale-to-zero tip — explains that min_workers: 0 lets the pool shrink to zero workers when idle
  3. Full configuration reference — all five autoscaling fields with inline comments explaining defaults and trade-offs
  4. Job-safety note — clarifies that the autoscaler never terminates a worker that is actively running a job
  5. Fixed-baseline + autoscaling — shows how workers, min_workers, and max_workers interact

Test plan

  • Built docs locally with bash docs/build.sh — build succeeded with no errors or warnings related to the changed file
  • Rendered output reviewed in browser via python3 -m http.server — all code blocks, tips, notes, and admonitions render correctly
  • RST syntax validated by Sphinx during the build

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>
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @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

  • Pool Autoscaling Documentation: Comprehensive documentation for the new pool autoscaling feature has been added, covering its configuration and behavior.
  • New Autoscaling Section: A dedicated "Autoscaling" section was introduced to the pools documentation, detailing min_workers, max_workers, queue_length_threshold, upscale_delay_seconds, and downscale_delay_seconds.
  • Scale-to-Zero and Fixed Baselines: The documentation now explains how to achieve scale-to-zero behavior (min_workers: 0) and how to combine a fixed baseline of workers with autoscaling bounds.
  • Coming Soon Update: The "Autoscaling" entry was removed from the "Coming Soon" admonition, as the feature is now available and documented.

🧠 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
  • docs/source/examples/pools.rst
    • Added a new "Autoscaling" section with detailed explanations and configuration examples.
    • Removed the "Autoscaling" entry from the "Coming Soon" section.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@lloyd-brown lloyd-brown requested review from cg505 and removed request for cg505 February 18, 2026 00:07

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/source/examples/pools.rst Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@lloyd-brown

Copy link
Copy Markdown
Collaborator Author

/build-docs

@github-actions

Copy link
Copy Markdown
Contributor

✅ ReadTheDocs build triggered for branch lloyd/pools-autoscaling-docs

The documentation will be available at: https://docs.skypilot.co/en/lloyd-pools-autoscaling-docs/

@lloyd-brown lloyd-brown requested a review from cg505 February 18, 2026 01:41

@Michaelvll Michaelvll left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @lloyd-brown! Let's get it merged first.

Comment thread docs/source/examples/pools.rst
[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.
@lloyd-brown lloyd-brown merged commit 530f1bd into master Feb 25, 2026
37 of 48 checks passed
@lloyd-brown lloyd-brown deleted the lloyd/pools-autoscaling-docs branch February 25, 2026 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants