Skip to content

[Docs] Clarified the behavior of idle duration: how run's idle_duration and fleet's idle_duration are applied #3574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
peterschmidt85 merged 1 commit into from
Feb 16, 2026
Merged

[Docs] Clarified the behavior of idle duration: how run's idle_duration and fleet's idle_duration are applied #3574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/docs/concepts/snippets/manage-fleets.ext
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
### Idle duration

If a run provisions a new instance, the instance stays `idle` for 5 minutes by default and can be reused within that time.
If the instance is not reused within this period, it is automatically terminated.
To change the default idle duration, set
[`idle_duration`](../reference/dstack.yml/fleet.md#idle_duration) in the run configuration (e.g., `0s`, `1m`, or `off` for unlimited).
If the run is submitted to a fleet with `nodes` set to a range and a new instance is provisioned,
the shorter of the fleet's and run's `idle_duration` is used.
If the run reuses an existing fleet instance, only the fleet's
[`idle_duration`](../reference/dstack.yml/fleet.md#idle_duration) applies.

If an instance remains `idle`, it is automatically terminated after `idle_duration`.

> Not applied for container-based backends (Kubernetes, Vast.ai, RunPod).
11 changes: 7 additions & 4 deletions docs/docs/guides/protips.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,10 +212,13 @@ Or, set [`creation_policy`](../reference/dstack.yml/dev-environment.md#creation_

### Idle duration

If a run provisions a new instance, the instance stays `idle` for 5 minutes by default and can be reused within that time.
If the instance is not reused within this period, it is automatically terminated.
To change the default idle duration, set
[`idle_duration`](../reference/dstack.yml/fleet.md#idle_duration) in the run configuration (e.g., `0s`, `1m`, or `off` for unlimited).
If the run is submitted to a fleet with `nodes` set to a range and a new instance is provisioned, the shorter of the fleet's and run's `idle_duration` is used.
If the run reuses an existing fleet instance, only the fleet's
[`idle_duration`](../reference/dstack.yml/fleet.md#idle_duration) applies.

If an instance remains `idle`, it is automatically terminated after `idle_duration`.

> Not applied for container-based backends (Kubernetes, Vast.ai, RunPod).

## Volumes

Expand Down
6 changes: 4 additions & 2 deletions src/dstack/_internal/core/models/profiles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,9 +323,11 @@ class ProfileParams(CoreModel):
Field(
description=(
"Time to wait before terminating idle instances."
" Instances are not terminated if the fleet is already at `nodes.min`."
" When the run reuses an existing fleet instance, the fleet's `idle_duration` applies."
" When the run provisions a new instance, the shorter of the fleet's and run's values is used."
" Defaults to `5m` for runs and `3d` for fleets."
" Use `off` for unlimited duration"
" Use `off` for unlimited duration."
" Only applied for VM-based backends"
)
),
] = None
Expand Down