mkdocs.yml
Rama master · réplica de lectura del repositorio original.
# Project information
site_name: dstack
site_url: https://dstack.ai
site_author: dstack GmbH
site_description: >-
dstack is a unified control plane for GPU provisioning and orchestration that works with any GPU cloud, Kubernetes, or on-prem clusters.
# Repository
repo_url: https://github.com/dstackai/dstack
repo_name: dstackai/dstack
edit_uri: edit/master/mkdocs/
#Copyright
copyright: © 2026, dstack Inc. All rights reserved.
# Source directory for site content
docs_dir: mkdocs
hooks:
- scripts/docs/hooks.py
# Configuration
theme:
name: material
custom_dir: mkdocs/overrides
logo: assets/images/dstack-logo-notext.svg
favicon: assets/images/dstack-fav-32.ico
icon:
repo: custom/github
edit: material/pencil
annotation: material/arrow-right-circle
font:
text: Source Sans Pro
code: IBM Plex Mono
# Light (default) + dark (slate) schemes WITH toggles — Material needs the toggle radios so its
# palette JS honors the stored __palette and applies it during parse (flash-free). We HIDE the
# toggle buttons via CSS (cloudscape-docs.css) and drive the choice from the shared `dstack-theme`
# localStorage key (website/src/theme.ts), translated into __palette in main.html's extrahead.
palette:
- scheme: default
primary: white
accent: lilac
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
primary: white
accent: lilac
toggle:
icon: material/weather-sunny
name: Switch to light mode
features:
- content.tooltips
- navigation.path
- content.code.copy
- content.action.edit
# - navigation.indexes
- navigation.tabs
# - navigation.instant
# - toc.integrate
# Comment to switch to sections in sidebar
- navigation.sections
# - navigation.expand
- navigation.top
# announce.dismiss removed — /old's banner has no dismiss (×) button
- navigation.tracking
- navigation.footer
# Plugins
plugins:
- blog:
blog_dir: blog
post_url_format: "{slug}"
blog_toc: true
categories_url_format: "{slug}"
archive: false
categories_name: Blog
categories_sort_reverse: true
- social:
cards_layout_options:
background_color: "black"
color: "#FFFFFF"
font_family: "Roboto"
# debug: true
cards_layout_dir: mkdocs/layouts
cards_layout: custom
- search
- redirects:
redirect_maps:
"blog/2024/02/08/resources-authentication-and-more.md": "https://github.com/dstackai/dstack/releases/0.15.0"
"blog/2024/01/19/openai-endpoints-preview.md": "https://github.com/dstackai/dstack/releases/0.14.0"
"blog/2023/12/22/disk-size-cuda-12-1-mixtral-and-more.md": "https://github.com/dstackai/dstack/releases/0.13.0"
"blog/2023/11/21/vastai.md": "https://github.com/dstackai/dstack/releases/0.12.3"
"blog/2023/10/31/tensordock.md": "https://github.com/dstackai/dstack/releases/0.12.2"
"blog/2023/10/18/simplified-cloud-setup.md": "https://github.com/dstackai/dstack/releases/0.12.0"
"blog/2023/08/22/multiple-clouds.md": "https://github.com/dstackai/dstack/releases/0.11"
"blog/2023/08/07/services-preview.md": "https://github.com/dstackai/dstack/releases/0.10.7"
"blog/2023/07/14/lambda-cloud-ga-and-docker-support.md": "https://github.com/dstackai/dstack/releases/0.10.5"
"blog/2023/05/22/azure-support-better-ui-and-more.md": "https://github.com/dstackai/dstack/releases/0.9.1"
"blog/2023/03/13/gcp-support-just-landed.md": "https://github.com/dstackai/dstack/releases/0.2"
"blog/dstack-research.md": "https://dstack.ai/#get-started"
"docs/dev-environments.md": "docs/concepts/dev-environments.md"
"docs/tasks.md": "docs/concepts/tasks.md"
"docs/services.md": "docs/concepts/services.md"
"docs/fleets.md": "docs/concepts/fleets.md"
"docs/concepts/endpoints.md": "docs/concepts/presets.md"
"docs/reference/cli/dstack/endpoint.md": "docs/reference/cli/dstack/preset.md"
"docs/examples/llms/llama31.md": "docs/examples/inference/vllm.md"
"docs/examples/llms/llama32.md": "docs/examples/inference/vllm.md"
"docs/examples/llms/qwen36.md": "docs/examples/inference/sglang.md"
"examples/llms/llama31/index.md": "docs/examples/inference/vllm.md"
"examples/llms/llama32/index.md": "docs/examples/inference/vllm.md"
"examples/llms/qwen36/index.md": "docs/examples/inference/sglang.md"
"docs/examples/deployment/nim/index.md": "docs/examples/inference/nim.md"
"docs/examples/deployment/vllm/index.md": "docs/examples/inference/vllm.md"
"docs/examples/models/qwen36.md": "docs/examples/inference/sglang.md"
"docs/examples/models/deepseek-v4.md": "docs/examples/inference/sglang.md"
"docs/examples/models/wan22/index.md": "docs/examples.md"
"docs/examples/accelerators/intel/index.md": "docs/examples.md"
"docs/examples/llms/deepseek/index.md": "docs/examples/inference/sglang.md"
"docs/examples/llms/llama/index.md": "docs/examples/inference/vllm.md"
"docs/examples/misc/docker-compose/index.md": "docs/concepts/dev-environments.md#docker-in-docker"
"backends.md": "docs/concepts/backends.md"
"blog/monitoring-gpu-usage.md": "blog/posts/dstack-metrics.md"
"blog/inactive-dev-environments-auto-shutdown.md": "blog/posts/inactivity-duration.md"
"blog/data-centers-and-private-clouds.md": "blog/posts/gpu-blocks-and-proxy-jump.md"
"blog/distributed-training-with-aws-efa.md": "docs/examples/clusters/aws.md"
"blog/dstack-stats.md": "blog/posts/dstack-metrics.md"
"docs/guides/metrics.md": "docs/concepts/metrics.md"
"docs/guides/monitoring.md": "docs/concepts/metrics.md"
"blog/nvidia-and-amd-on-vultr.md.md": "blog/posts/nvidia-and-amd-on-vultr.md"
"examples/misc/nccl-tests/index.md": "docs/examples/clusters/nccl-rccl-tests.md"
"examples/misc/a3high-clusters/index.md": "docs/examples/clusters/gcp.md"
"examples/misc/a3mega-clusters/index.md": "docs/examples/clusters/gcp.md"
"examples/distributed-training/nccl-tests/index.md": "docs/examples/clusters/nccl-rccl-tests.md"
"examples/distributed-training/rccl-tests/index.md": "docs/examples/clusters/nccl-rccl-tests.md"
"examples/deployment/nim/index.md": "docs/examples/inference/nim.md"
"examples/deployment/vllm/index.md": "docs/examples/inference/vllm.md"
"examples/deployment/sglang/index.md": "docs/examples/inference/sglang.md"
"examples/deployment/trtllm/index.md": "docs/examples/inference/trtllm.md"
"examples/fine-tuning/trl/index.md": "docs/examples/training/trl.md"
"examples/fine-tuning/axolotl/index.md": "docs/examples/training/axolotl.md"
"blog/efa.md": "docs/examples/clusters/aws.md"
"docs/concepts/repos.md": "docs/concepts/dev-environments.md#repos"
"examples/clusters/a3high/index.md": "docs/examples/clusters/gcp.md"
"examples/clusters/a3mega/index.md": "docs/examples/clusters/gcp.md"
"examples/clusters/a4/index.md": "docs/examples/clusters/gcp.md"
"examples/clusters/efa/index.md": "docs/examples/clusters/aws.md"
"docs/guides/migration.md": "docs/guides/upgrade.md"
"docs/reference/api/rest/index.md": "docs/reference/http/index.md"
"docs/reference/api/http/index.md": "docs/reference/http/index.md"
"docs/reference/api/http/auth.md": "docs/reference/http/authentication.md"
"docs/reference/api/http/backends.md": "docs/reference/http/backends.md"
"docs/reference/api/http/default.md": "docs/reference/http/default.md"
"docs/reference/api/http/events.md": "docs/reference/http/events.md"
"docs/reference/api/http/exports.md": "docs/reference/http/exports.md"
"docs/reference/api/http/files.md": "docs/reference/http/files.md"
"docs/reference/api/http/fleets.md": "docs/reference/http/fleets.md"
"docs/reference/api/http/gateways.md": "docs/reference/http/gateways.md"
"docs/reference/api/http/gpus.md": "docs/reference/http/gpus.md"
"docs/reference/api/http/imports.md": "docs/reference/http/exports.md"
"docs/reference/api/http/instances.md": "docs/reference/http/fleets.md"
"docs/reference/api/http/logs.md": "docs/reference/http/logs.md"
"docs/reference/api/http/metrics.md": "docs/reference/http/metrics.md"
"docs/reference/api/http/model-proxy.md": "docs/reference/http/proxy.md"
"docs/reference/api/http/projects.md": "docs/reference/http/projects.md"
"docs/reference/api/http/prometheus.md": "docs/reference/http/metrics.md"
"docs/reference/api/http/repos.md": "docs/reference/http/repos.md"
"docs/reference/api/http/runs.md": "docs/reference/http/runs.md"
"docs/reference/api/http/secrets.md": "docs/reference/http/secrets.md"
"docs/reference/api/http/server.md": "docs/reference/http/server.md"
"docs/reference/api/http/service-proxy.md": "docs/reference/http/proxy.md"
"docs/reference/api/http/sshproxy.md": "docs/reference/http/proxy.md"
"docs/reference/api/http/templates.md": "docs/reference/http/templates.md"
"docs/reference/api/http/user-public-keys.md": "docs/reference/http/users.md"
"docs/reference/api/http/users.md": "docs/reference/http/users.md"
"docs/reference/api/http/volumes.md": "docs/reference/http/volumes.md"
# Examples moved from /examples/ to /docs/examples/
"examples.md": "docs/examples.md"
"examples/single-node-training/trl.md": "docs/examples/training/trl.md"
"examples/single-node-training/axolotl.md": "docs/examples/training/axolotl.md"
"examples/distributed-training/trl.md": "docs/examples/training/trl.md"
"examples/distributed-training/axolotl.md": "docs/examples/training/axolotl.md"
"examples/distributed-training/ray-ragen.md": "docs/examples/training/ray-ragen.md"
"examples/distributed-training/miles.md": "docs/examples/training/miles.md"
# Single-node and distributed training merged under Training
"docs/examples/single-node-training/trl.md": "docs/examples/training/trl.md"
"docs/examples/single-node-training/axolotl.md": "docs/examples/training/axolotl.md"
"docs/examples/distributed-training/trl.md": "docs/examples/training/trl.md"
"docs/examples/distributed-training/axolotl.md": "docs/examples/training/axolotl.md"
"docs/examples/distributed-training/ray-ragen.md": "docs/examples/training/ray-ragen.md"
"docs/examples/distributed-training/miles.md": "docs/examples/training/miles.md"
"examples/clusters/aws.md": "docs/examples/clusters/aws.md"
"examples/clusters/gcp.md": "docs/examples/clusters/gcp.md"
"examples/clusters/lambda.md": "docs/examples/clusters/lambda.md"
"examples/clusters/crusoe.md": "docs/examples/clusters/crusoe.md"
"examples/clusters/nebius.md": "docs/examples/clusters/nebius.md"
"examples/clusters/nccl-rccl-tests.md": "docs/examples/clusters/nccl-rccl-tests.md"
"examples/inference/sglang.md": "docs/examples/inference/sglang.md"
"examples/inference/vllm.md": "docs/examples/inference/vllm.md"
"examples/inference/nim.md": "docs/examples/inference/nim.md"
"examples/inference/trtllm.md": "docs/examples/inference/trtllm.md"
"examples/models/deepseek-v4.md": "docs/examples/inference/sglang.md"
"examples/models/qwen36.md": "docs/examples/inference/sglang.md"
"examples/accelerators/amd.md": "docs/examples/accelerators/amd.md"
"examples/accelerators/tpu.md": "docs/examples/accelerators/tpu.md"
"examples/accelerators/tenstorrent.md": "docs/examples/accelerators/tenstorrent.md"
- typeset
- gen-files:
# TODO: convert these to hooks (schema reference migrated)
scripts: # always relative to mkdocs.yml
- scripts/docs/gen_cli_reference.py
- scripts/docs/gen_openapi_reference.py
- scripts/docs/gen_rest_plugin_spec_reference.py
- mkdocstrings:
handlers:
python:
options:
docstring_style: google
show_source: false
# Extensions
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- attr_list
- def_list
- admonition
- pymdownx.highlight
- pymdownx.details
- pymdownx.superfences
- pymdownx.snippets:
base_path: ["mkdocs"]
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- toc:
toc_depth: 3
permalink: true
- attr_list
- md_in_html
- footnotes
- tables
# Customization
extra_css:
- https://unpkg.com/swagger-ui-dist@5.32.0/swagger-ui.css
- assets/stylesheets/extra.css
- assets/stylesheets/swagger.css
- assets/stylesheets/termynal.css
- assets/stylesheets/landing.css
- assets/stylesheets/pricing.css
- assets/stylesheets/cloudscape-docs.css
extra_javascript:
- https://unpkg.com/swagger-ui-dist@5.32.0/swagger-ui-bundle.js
- assets/javascripts/swagger.js
- assets/javascripts/extra.js
- assets/javascripts/pricing.js
extra:
homepage: /
generator: false
analytics:
provider: google
property: G-JX21114P7B
social:
# - icon: /fontawesome/brands/python
# link: https://pypi.org/project/dstack
# - icon: /fontawesome/brands/docker
# link: https://hub.docker.com/r/dstackai/dstack
- icon: /fontawesome/brands/github
link: https://github.com/dstackai/dstack
- icon: /fontawesome/brands/discord
link: https://discord.gg/u8SmfwPpMd
- icon: /simple/x
link: https://x.com/dstackai
- icon: /fontawesome/brands/linkedin
link: https://www.linkedin.com/company/dstackai
status:
new: Recently added
# Page tree
nav:
- Home: index.md
- Docs:
- Getting started:
- Overview: docs/index.md
- Installation: docs/installation.md
- Quickstart: docs/quickstart.md
- Concepts:
- Backends: docs/concepts/backends.md
- Fleets: docs/concepts/fleets.md
- Dev environments: docs/concepts/dev-environments.md
- Tasks: docs/concepts/tasks.md
- Services: docs/concepts/services.md
- Presets: docs/concepts/presets.md
- More:
- Volumes: docs/concepts/volumes.md
- Gateways: docs/concepts/gateways.md
- Secrets: docs/concepts/secrets.md
- Projects: docs/concepts/projects.md
- Metrics: docs/concepts/metrics.md
- Events: docs/concepts/events.md
- Exports: docs/concepts/exports.md
- Guides:
- CLI & API: docs/guides/cli-api.md
- Server deployment: docs/guides/server-deployment.md
- Troubleshooting: docs/guides/troubleshooting.md
- More:
- Protips: docs/guides/protips.md
- Tenant isolation: docs/guides/tenant-isolation.md
- Upgrade: docs/guides/upgrade.md
- Migration:
- Slurm: docs/guides/migration/slurm.md
- Examples:
- Training:
- TRL: docs/examples/training/trl.md
- Axolotl: docs/examples/training/axolotl.md
- Ray+RAGEN: docs/examples/training/ray-ragen.md
- Miles: docs/examples/training/miles.md
- Clusters:
- AWS: docs/examples/clusters/aws.md
- GCP: docs/examples/clusters/gcp.md
- Lambda: docs/examples/clusters/lambda.md
- Crusoe: docs/examples/clusters/crusoe.md
- Nebius: docs/examples/clusters/nebius.md
- NCCL/RCCL tests: docs/examples/clusters/nccl-rccl-tests.md
- Inference:
- SGLang: docs/examples/inference/sglang.md
- Dynamo: docs/examples/inference/dynamo.md
- vLLM: docs/examples/inference/vllm.md
- NIM: docs/examples/inference/nim.md
- TensorRT-LLM: docs/examples/inference/trtllm.md
- Accelerators:
- AMD: docs/examples/accelerators/amd.md
- Tenstorrent: docs/examples/accelerators/tenstorrent.md
- TPU: docs/examples/accelerators/tpu.md
- Reference:
- .dstack.yml:
- dev-environment: docs/reference/dstack.yml/dev-environment.md
- task: docs/reference/dstack.yml/task.md
- service: docs/reference/dstack.yml/service.md
- fleet: docs/reference/dstack.yml/fleet.md
- gateway: docs/reference/dstack.yml/gateway.md
- volume: docs/reference/dstack.yml/volume.md
- preset: docs/reference/dstack.yml/preset.md
- server/config.yml: docs/reference/server/config.yml.md
- CLI:
- dstack server: docs/reference/cli/dstack/server.md
- dstack init: docs/reference/cli/dstack/init.md
- dstack apply: docs/reference/cli/dstack/apply.md
- dstack delete: docs/reference/cli/dstack/delete.md
- dstack ps: docs/reference/cli/dstack/ps.md
- dstack stop: docs/reference/cli/dstack/stop.md
- dstack attach: docs/reference/cli/dstack/attach.md
- dstack login: docs/reference/cli/dstack/login.md
- dstack logs: docs/reference/cli/dstack/logs.md
- dstack metrics: docs/reference/cli/dstack/metrics.md
- dstack event: docs/reference/cli/dstack/event.md
- dstack project: docs/reference/cli/dstack/project.md
- dstack fleet: docs/reference/cli/dstack/fleet.md
- dstack offer: docs/reference/cli/dstack/offer.md
- dstack volume: docs/reference/cli/dstack/volume.md
- dstack gateway: docs/reference/cli/dstack/gateway.md
- dstack secret: docs/reference/cli/dstack/secret.md
- dstack preset: docs/reference/cli/dstack/preset.md
- dstack export: docs/reference/cli/dstack/export.md
- dstack import: docs/reference/cli/dstack/import.md
- HTTP API:
- users: docs/reference/http/users.md
- projects: docs/reference/http/projects.md
- backends: docs/reference/http/backends.md
- fleets: docs/reference/http/fleets.md
- runs: docs/reference/http/runs.md
- gateways: docs/reference/http/gateways.md
- volumes: docs/reference/http/volumes.md
- logs: docs/reference/http/logs.md
- events: docs/reference/http/events.md
- repos: docs/reference/http/repos.md
- files: docs/reference/http/files.md
- secrets: docs/reference/http/secrets.md
- exports: docs/reference/http/exports.md
- metrics: docs/reference/http/metrics.md
- gpus: docs/reference/http/gpus.md
- templates: docs/reference/http/templates.md
- proxy: docs/reference/http/proxy.md
- authentication: docs/reference/http/authentication.md
- server: docs/reference/http/server.md
- Environment variables: docs/reference/env.md
- More:
- .dstack/profiles.yml: docs/reference/profiles.yml.md
- Plugins:
- Python API: docs/reference/plugins/python/index.md
- REST API: docs/reference/plugins/rest/index.md
- llms-full.txt: https://dstack.ai/llms-full.txt
- skill.md: https://dstack.ai/skill.md
- Benchmarks: blog/benchmarks.md
- Case studies: blog/case-studies.md
- Blog:
- blog/index.md
# - Changelog: https://github.com/dstackai/dstack/releases" target="_blank
# - GitHub: https://github.com/dstackai/dstack" target="_blank
# - Sign in: https://sky.dstack.ai" target="_blank