Skip to content

Commit 39d5ec4

Browse files
committed
Merge branch 'master' into issue_3328_cli_oauth
2 parents a616a52 + 12d182e commit 39d5ec4

File tree

79 files changed

+2806
-791
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+2806
-791
lines changed

docs/blog/posts/0_20.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
---
2+
title: "dstack 0.20 GA: Fleet-first UX and other important changes"
3+
date: 2025-12-18
4+
description: "TBA"
5+
slug: "0_20"
6+
image: https://dstack.ai/static-assets/static-assets/images/dstack-0_20.png
7+
categories:
8+
- Changelog
9+
links:
10+
- Release notes: https://github.com/dstackai/dstack/releases/tag/0.20.0
11+
- Migration guide: https://dstack.ai/docs/guides/migration/#0_20
12+
---
13+
14+
# dstack 0.20 GA: Fleet-first UX and other important changes
15+
16+
We’re releasing `dstack` 0.20.0, a major update that improves how teams orchestrate GPU workloads for development, training, and inference. Most `dstack` updates are incremental and backward compatible, but this version introduces a few major changes to how you work with `dstack`.
17+
18+
In `dstack` 0.20.0, fleets are now a first-class concept, giving you more explicit control over how GPU capacity is provisioned and managed. We’ve also added *Events*, which record important system activity—such as scheduling decisions, run status changes, and resource lifecycle updates—so it’s easier to understand what’s happening without digging through server logs.
19+
20+
<img src="https://dstack.ai/static-assets/static-assets/images/dstack-0_20.png" width="630" />
21+
22+
This post goes through the changes in detail and explains how to upgrade and migrate your existing setup.
23+
24+
<!-- more -->
25+
26+
## Fleets
27+
28+
In earlier versions, submitting a run that didn’t match any existing fleet would cause `dstack` to automatically create one. While this reduced setup overhead, it also made capacity provisioning implicit and less predictable.
29+
30+
With `dstack` 0.20.0, fleets must be created explicitly and treated as first-class resources. This shift makes capacity provisioning declarative, improving control over resource limits, instance lifecycles, and overall fleet behavior.
31+
32+
For users who previously relied on auto-created fleets, similar behavior can be achieved by defining an elastic fleet, for example:
33+
34+
<div editor-title="fleet.dstack.yml">
35+
36+
```yaml
37+
type: fleet
38+
# The name is optional, if not specified, generated randomly
39+
name: default
40+
41+
# Can be a range or a fixed number
42+
# Allow to provision up to 2 instances
43+
nodes: 0..2
44+
45+
# Uncomment to ensure instances are inter-connected
46+
#placement: cluster
47+
48+
# Deprovision instances above the minimum if they remain idle
49+
idle_duration: 1h
50+
51+
resources:
52+
# Allow to provision up to 8 GPUs
53+
gpu: 0..8
54+
```
55+
56+
</div>
57+
58+
If the `nodes` range starts above `0`, `dstack` provisions the initial capacity upfront and scales additional instances on demand, enabling more predictable capacity planning.
59+
60+
When a run does not explicitly reference a fleet (via the [`fleets`](../../docs/reference/dstack.yml/dev-environment.md#fleets) property), `dstack` automatically selects one that satisfies the run’s requirements.
61+
62+
## Events
63+
64+
Previously, when `dstack` changed the state of a run or other resource, that information was written only to the server logs. This worked for admins, but it made it hard for users to understand what happened or why.
65+
66+
Starting with version `0.20.0`, `dstack` exposes these events directly to users.
67+
68+
Each resource now includes an `Events` tab in the UI, showing related events in real time:
69+
70+
<img src="https://dstack.ai/static-assets/static-assets/images/dstack-event-ui-run.png" width="750" />
71+
72+
There is also a dedicated `Events` page that aggregates events across resources. You can filter by project, user, run, or job to quickly narrow down what you’re looking for:
73+
74+
<img src="https://dstack.ai/static-assets/static-assets/images/dstack-event-ui-all.png" width="750" />
75+
76+
The same information is available through the CLI:
77+
78+
<img src="https://dstack.ai/static-assets/static-assets/images/dstack-event-cli.png" width="750" />
79+
80+
This makes it easier to track state changes, debug issues, and review past actions without needing access to server logs.
81+
82+
## Runs
83+
84+
This release updates several defaults related to run configuration. The goal is to reduce implicit assumptions and make it more convenient.
85+
86+
### Working directory
87+
88+
Previously, the `working_dir` property defaulted to `/workflow`. Now, the default working directory is always taken from the Docker image.
89+
90+
The working directory in the default Docker images (if you don't specify `image`) is now set to `/dstack/run`.
91+
92+
### Repo directory
93+
94+
Previously, if you didn't specify a repo path, the repo was cloned to `/workflow`. Now, in that case the repo will be cloned to the working directory.
95+
96+
<div editor-title="examples/.dstack.yml">
97+
98+
```yaml
99+
type: dev-environment
100+
name: vscode
101+
102+
repos:
103+
# Clones the repo from the parent directory (`examples/..`) to `<working dir>`
104+
- ..
105+
106+
ide: vscode
107+
```
108+
109+
</div>
110+
111+
Also, now if the repo directory is not empty, the run will fail with an error.
112+
113+
## Backward compatibility
114+
115+
While the update introduces breaking changes, 0.19.* CLIs remain compatible with 0.20.* servers.
116+
117+
> Note, the 0.20.* CLI only works with a 0.20.* server.
118+
119+
!!! warning "Breaking changes"
120+
This release introduces breaking changes that may affect existing setups. Before upgrading either the CLI or the server, review the [migration guide](https://dstack.ai/docs/guides/migration/#0_20).
121+
122+
## What's next
123+
124+
1. Follow the [Installation](../../docs/installation/index.md) guide
125+
2. Try the [Quickstart](../../docs/quickstart.md)
126+
3. Report issues on [GitHub](https://github.com/dstackai/dstack/issues)
127+
4. Ask questions on [Discord](https://discord.gg/u8SmfwPpMd)

docs/docs/concepts/dev-environments.md

Lines changed: 32 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -301,11 +301,11 @@ If you don't assign a value to an environment variable (see `HF_TOKEN` above),
301301

302302
### Working directory
303303

304-
If `working_dir` is not specified, it defaults to `/workflow`.
304+
If `working_dir` is not specified, it defaults to the working directory set in the Docker image. For example, the [default image](#default-image) uses `/dstack/run` as its working directory.
305305

306-
The `working_dir` must be an absolute path. The tilde (`~`) is supported (e.g., `~/my-working-dir`).
306+
If the Docker image does not have a working directory set, `dstack` uses `/` as the `working_dir`.
307307

308-
<!-- TODO: In a future version, the default working directory will be taken from `image`. -->
308+
The `working_dir` must be an absolute path. The tilde (`~`) is supported (e.g., `~/my-working-dir`).
309309

310310
<!-- TODO: Elaborate on `entrypoint` -->
311311

@@ -320,7 +320,7 @@ type: dev-environment
320320
name: vscode
321321
322322
files:
323-
- .:examples # Maps the directory where `.dstack.yml` to `/workflow/examples`
323+
- .:examples # Maps the directory with `.dstack.yml` to `<working dir>/examples`
324324
- ~/.ssh/id_rsa:/root/.ssh/id_rsa # Maps `~/.ssh/id_rsa` to `/root/.ssh/id_rsa`
325325

326326
ide: vscode
@@ -329,7 +329,7 @@ ide: vscode
329329
</div>
330330
331331
If the local path is relative, it’s resolved relative to the configuration file.
332-
If the container path is relative, it’s resolved relative to `/workflow`.
332+
If the container path is relative, it’s resolved relative to the [working directory](#working-directory).
333333
334334
The container path is optional. If not specified, it will be automatically calculated:
335335
@@ -340,7 +340,7 @@ type: dev-environment
340340
name: vscode
341341

342342
files:
343-
- ../examples # Maps `examples` (the parent directory of `.dstack.yml`) to `/workflow/examples`
343+
- ../examples # Maps the parent directory of `.dstack.yml` to `<working dir>/../examples`
344344
- ~/.ssh/id_rsa # Maps `~/.ssh/id_rsa` to `/root/.ssh/id_rsa`
345345

346346
ide: vscode
@@ -355,9 +355,9 @@ ide: vscode
355355

356356
### Repos
357357

358-
Sometimes, you may want to mount an entire Git repo inside the container.
358+
Sometimes, you may want to clone an entire Git repo inside the container.
359359

360-
Imagine you have a cloned Git repo containing an `examples` subdirectory with a `.dstack.yml` file:
360+
Imagine you have a Git repo (clonned locally) containing an `examples` subdirectory with a `.dstack.yml` file:
361361

362362
<div editor-title="examples/.dstack.yml">
363363

@@ -366,24 +366,21 @@ type: dev-environment
366366
name: vscode
367367
368368
repos:
369-
# Mounts the parent directory of `examples` (must be a Git repo)
370-
# to `/workflow` (the default working directory)
369+
# Clones the repo from the parent directory (`examples/..`) to `<working dir>`
371370
- ..
372371

373372
ide: vscode
374373
```
375374
376375
</div>
377376
378-
When you run it, `dstack` fetches the repo on the instance, applies your local changes, and mounts it—so the container matches your local repo.
377+
When you run it, `dstack` clones the repo on the instance, applies your local changes, and mounts it—so the container matches your local repo.
379378

380379
The local path can be either relative to the configuration file or absolute.
381380

382381
??? info "Repo directory"
383-
By default, `dstack` mounts the repo to `/workflow` (the default working directory).
382+
By default, `dstack` clones the repo to the [working directory](#working-directory).
384383

385-
<!-- TODO: In a future version, the default working directory will come from the image, so this should be revisited. -->
386-
387384
You can override the repo directory using either a relative or an absolute path:
388385

389386
<div editor-title="examples/.dstack.yml">
@@ -393,16 +390,30 @@ The local path can be either relative to the configuration file or absolute.
393390
name: vscode
394391
395392
repos:
396-
# Mounts the parent directory of `examples` (must be a Git repo)
397-
# to `/my-repo`
393+
# Clones the repo in the parent directory (`examples/..`) to `/my-repo`
398394
- ..:/my-repo
399395

400396
ide: vscode
401397
```
402398
403399
</div>
404400
405-
If the path is relative, it is resolved against [working directory](#working-directory).
401+
> If the repo directory is relative, it is resolved against [working directory](#working-directory).
402+
403+
If the repo directory is not empty, the run will fail with a runner error.
404+
To override this behavior, you can set `if_exists` to `skip`:
405+
406+
```yaml
407+
type: dev-environment
408+
name: vscode
409+
410+
repos:
411+
- local_path: ..
412+
path: /my-repo
413+
if_exists: skip
414+
415+
ide: vscode
416+
```
406417

407418

408419
??? info "Repo size"
@@ -411,7 +422,7 @@ The local path can be either relative to the configuration file or absolute.
411422
You can increase the 2MB limit by setting the `DSTACK_SERVER_CODE_UPLOAD_LIMIT` environment variable.
412423

413424
??? info "Repo URL"
414-
Sometimes you may want to mount a Git repo without cloning it locally. In this case, simply provide a URL in `repos`:
425+
Sometimes you may want to clone a Git repo within the container without cloning it locally. In this case, simply provide a URL in `repos`:
415426

416427
<div editor-title="examples/.dstack.yml">
417428

@@ -420,7 +431,7 @@ The local path can be either relative to the configuration file or absolute.
420431
name: vscode
421432
422433
repos:
423-
# Clone the specified repo to `/workflow` (the default working directory)
434+
# Clone the repo to `<working dir>`
424435
- https://github.com/dstackai/dstack
425436

426437
ide: vscode
@@ -432,9 +443,9 @@ The local path can be either relative to the configuration file or absolute.
432443
If a Git repo is private, `dstack` will automatically try to use your default Git credentials (from
433444
`~/.ssh/config` or `~/.config/gh/hosts.yml`).
434445

435-
If you want to use custom credentials, you can provide them with [`dstack init`](../reference/cli/dstack/init.md).
446+
> If you want to use custom credentials, ensure to pass them via [`dstack init`](../reference/cli/dstack/init.md) before submitting a run.
436447

437-
> Currently, you can configure up to one repo per run configuration.
448+
Currently, you can configure up to one repo per run configuration.
438449

439450
### Retry policy
440451

0 commit comments

Comments
 (0)