Skip to content

Commit 9049082

Browse files
committed
Deploying to gh-pages from @ dstackai/dstack@733a17c 🚀
1 parent 95f1e7e commit 9049082

File tree

25 files changed

+293
-153
lines changed

25 files changed

+293
-153
lines changed

docs/concepts/backends.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -929,6 +929,34 @@ projects:
929929
* `sizes` - read
930930
* `ssh_key` - create, read, update,delete
931931

932+
### Crusoe Cloud
933+
934+
Log into your [Crusoe Cloud](https://console.crusoecloud.com/) console and create an API key
935+
under your account settings. Note your project ID from the project settings page.
936+
937+
Then, go ahead and configure the backend:
938+
939+
<div editor-title="~/.dstack/server/config.yml">
940+
941+
```yaml
942+
projects:
943+
- name: main
944+
backends:
945+
- type: crusoe
946+
project_id: your-project-id
947+
creds:
948+
type: access_key
949+
access_key: your-access-key
950+
secret_key: your-secret-key
951+
regions:
952+
- us-east1-a
953+
- us-southcentral1-a
954+
```
955+
956+
</div>
957+
958+
`regions` is optional. If not specified, all available Crusoe regions are used.
959+
932960
### Hot Aisle
933961

934962
Log in to the SSH TUI as described in the [Hot Aisle Quick Start](https://hotaisle.xyz/quick-start/).

docs/concepts/backends/index.html

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1001,6 +1001,19 @@
10011001
</span>
10021002
</a>
10031003

1004+
</li>
1005+
1006+
<li class="md-nav__item">
1007+
<a href="#crusoe-cloud" class="md-nav__link">
1008+
<span class="md-ellipsis">
1009+
1010+
<span class="md-typeset">
1011+
Crusoe Cloud
1012+
</span>
1013+
1014+
</span>
1015+
</a>
1016+
10041017
</li>
10051018

10061019
<li class="md-nav__item">
@@ -4457,6 +4470,19 @@
44574470
</span>
44584471
</a>
44594472

4473+
</li>
4474+
4475+
<li class="md-nav__item">
4476+
<a href="#crusoe-cloud" class="md-nav__link">
4477+
<span class="md-ellipsis">
4478+
4479+
<span class="md-typeset">
4480+
Crusoe Cloud
4481+
</span>
4482+
4483+
</span>
4484+
</a>
4485+
44604486
</li>
44614487

44624488
<li class="md-nav__item">
@@ -5436,6 +5462,29 @@ <h3 id="digital-ocean">Digital Ocean<a class="headerlink" href="#digital-ocean"
54365462
<li><code>ssh_key</code> - create, read, update,delete</li>
54375463
</ul>
54385464
</details>
5465+
<h3 id="crusoe-cloud">Crusoe Cloud<a class="headerlink" href="#crusoe-cloud" title="Permanent link">&para;</a></h3>
5466+
<p>Log into your <a href="https://console.crusoecloud.com/">Crusoe Cloud</a> console and create an API key
5467+
under your account settings. Note your project ID from the project settings page.</p>
5468+
<p>Then, go ahead and configure the backend:</p>
5469+
<div editor-title="~/.dstack/server/config.yml">
5470+
5471+
<div class="highlight"><pre><span></span><code><span class="nt">projects</span><span class="p">:</span>
5472+
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">main</span>
5473+
<span class="w"> </span><span class="nt">backends</span><span class="p">:</span>
5474+
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">crusoe</span>
5475+
<span class="w"> </span><span class="nt">project_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">your-project-id</span>
5476+
<span class="w"> </span><span class="nt">creds</span><span class="p">:</span>
5477+
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">access_key</span>
5478+
<span class="w"> </span><span class="nt">access_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">your-access-key</span>
5479+
<span class="w"> </span><span class="nt">secret_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">your-secret-key</span>
5480+
<span class="w"> </span><span class="nt">regions</span><span class="p">:</span>
5481+
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">us-east1-a</span>
5482+
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">us-southcentral1-a</span>
5483+
</code></pre></div>
5484+
5485+
</div>
5486+
5487+
<p><code>regions</code> is optional. If not specified, all available Crusoe regions are used.</p>
54395488
<h3 id="hot-aisle">Hot Aisle<a class="headerlink" href="#hot-aisle" title="Permanent link">&para;</a></h3>
54405489
<p>Log in to the SSH TUI as described in the <a href="https://hotaisle.xyz/quick-start/">Hot Aisle Quick Start</a>.
54415490
Create a new team and generate an API key for the member in the team.</p>

docs/reference/api/python/index.html

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5839,7 +5839,7 @@ <h6 class="reference-item" id="_volumes"><a href="#volumes"><code>volumes</code>
58395839
<h6 class="reference-item" id="docker"><code>docker</code> - (Optional) <code>bool</code> Use Docker inside the container. Mutually exclusive with <code>image</code>, <code>python</code>, and <code>nvcc</code>. Overrides <code>privileged</code>.<a class="headerlink" href="#docker" title="Permanent link">&para;</a></h6>
58405840
<h6 class="reference-item" id="_repos"><a href="#repos"><code>repos</code></a> - (Optional) <code>list[object]</code> The list of Git repos.<a class="headerlink" href="#_repos" title="Permanent link">&para;</a></h6>
58415841
<h6 class="reference-item" id="_files"><a href="#files"><code>files</code></a> - (Optional) <code>list[object]</code> The local to container file path mappings.<a class="headerlink" href="#_files" title="Permanent link">&para;</a></h6>
5842-
<h6 class="reference-item" id="backends"><code>backends</code> - (Optional) <code>list["amddevcloud" | "aws" | "azure" | "cloudrift" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "kubernetes" | "lambda" | "local" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr"]</code> The backends to consider for provisioning (e.g., <code>[aws, gcp]</code>).<a class="headerlink" href="#backends" title="Permanent link">&para;</a></h6>
5842+
<h6 class="reference-item" id="backends"><code>backends</code> - (Optional) <code>list["amddevcloud" | "aws" | "azure" | "cloudrift" | "crusoe" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "kubernetes" | "lambda" | "local" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr"]</code> The backends to consider for provisioning (e.g., <code>[aws, gcp]</code>).<a class="headerlink" href="#backends" title="Permanent link">&para;</a></h6>
58435843
<h6 class="reference-item" id="regions"><code>regions</code> - (Optional) <code>list[str]</code> The regions to consider for provisioning (e.g., <code>[eu-west-1, us-west4, westeurope]</code>).<a class="headerlink" href="#regions" title="Permanent link">&para;</a></h6>
58445844
<h6 class="reference-item" id="availability_zones"><code>availability_zones</code> - (Optional) <code>list[str]</code> The availability zones to consider for provisioning (e.g., <code>[eu-west-1a, us-west4-a]</code>).<a class="headerlink" href="#availability_zones" title="Permanent link">&para;</a></h6>
58455845
<h6 class="reference-item" id="instance_types"><code>instance_types</code> - (Optional) <code>list[str]</code> The cloud-specific instance types to consider for provisioning (e.g., <code>[p3.8xlarge, n1-standard-4]</code>).<a class="headerlink" href="#instance_types" title="Permanent link">&para;</a></h6>
@@ -5888,7 +5888,7 @@ <h6 class="reference-item" id="_volumes"><a href="#volumes"><code>volumes</code>
58885888
<h6 class="reference-item" id="docker"><code>docker</code> - (Optional) <code>bool</code> Use Docker inside the container. Mutually exclusive with <code>image</code>, <code>python</code>, and <code>nvcc</code>. Overrides <code>privileged</code>.<a class="headerlink" href="#docker" title="Permanent link">&para;</a></h6>
58895889
<h6 class="reference-item" id="_repos"><a href="#repos"><code>repos</code></a> - (Optional) <code>list[object]</code> The list of Git repos.<a class="headerlink" href="#_repos" title="Permanent link">&para;</a></h6>
58905890
<h6 class="reference-item" id="_files"><a href="#files"><code>files</code></a> - (Optional) <code>list[object]</code> The local to container file path mappings.<a class="headerlink" href="#_files" title="Permanent link">&para;</a></h6>
5891-
<h6 class="reference-item" id="backends"><code>backends</code> - (Optional) <code>list["amddevcloud" | "aws" | "azure" | "cloudrift" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "kubernetes" | "lambda" | "local" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr"]</code> The backends to consider for provisioning (e.g., <code>[aws, gcp]</code>).<a class="headerlink" href="#backends" title="Permanent link">&para;</a></h6>
5891+
<h6 class="reference-item" id="backends"><code>backends</code> - (Optional) <code>list["amddevcloud" | "aws" | "azure" | "cloudrift" | "crusoe" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "kubernetes" | "lambda" | "local" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr"]</code> The backends to consider for provisioning (e.g., <code>[aws, gcp]</code>).<a class="headerlink" href="#backends" title="Permanent link">&para;</a></h6>
58925892
<h6 class="reference-item" id="regions"><code>regions</code> - (Optional) <code>list[str]</code> The regions to consider for provisioning (e.g., <code>[eu-west-1, us-west4, westeurope]</code>).<a class="headerlink" href="#regions" title="Permanent link">&para;</a></h6>
58935893
<h6 class="reference-item" id="availability_zones"><code>availability_zones</code> - (Optional) <code>list[str]</code> The availability zones to consider for provisioning (e.g., <code>[eu-west-1a, us-west4-a]</code>).<a class="headerlink" href="#availability_zones" title="Permanent link">&para;</a></h6>
58945894
<h6 class="reference-item" id="instance_types"><code>instance_types</code> - (Optional) <code>list[str]</code> The cloud-specific instance types to consider for provisioning (e.g., <code>[p3.8xlarge, n1-standard-4]</code>).<a class="headerlink" href="#instance_types" title="Permanent link">&para;</a></h6>
@@ -5930,7 +5930,7 @@ <h6 class="reference-item" id="_volumes"><a href="#volumes"><code>volumes</code>
59305930
<h6 class="reference-item" id="docker"><code>docker</code> - (Optional) <code>bool</code> Use Docker inside the container. Mutually exclusive with <code>image</code>, <code>python</code>, and <code>nvcc</code>. Overrides <code>privileged</code>.<a class="headerlink" href="#docker" title="Permanent link">&para;</a></h6>
59315931
<h6 class="reference-item" id="_repos"><a href="#repos"><code>repos</code></a> - (Optional) <code>list[object]</code> The list of Git repos.<a class="headerlink" href="#_repos" title="Permanent link">&para;</a></h6>
59325932
<h6 class="reference-item" id="_files"><a href="#files"><code>files</code></a> - (Optional) <code>list[object]</code> The local to container file path mappings.<a class="headerlink" href="#_files" title="Permanent link">&para;</a></h6>
5933-
<h6 class="reference-item" id="backends"><code>backends</code> - (Optional) <code>list["amddevcloud" | "aws" | "azure" | "cloudrift" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "kubernetes" | "lambda" | "local" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr"]</code> The backends to consider for provisioning (e.g., <code>[aws, gcp]</code>).<a class="headerlink" href="#backends" title="Permanent link">&para;</a></h6>
5933+
<h6 class="reference-item" id="backends"><code>backends</code> - (Optional) <code>list["amddevcloud" | "aws" | "azure" | "cloudrift" | "crusoe" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "kubernetes" | "lambda" | "local" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr"]</code> The backends to consider for provisioning (e.g., <code>[aws, gcp]</code>).<a class="headerlink" href="#backends" title="Permanent link">&para;</a></h6>
59345934
<h6 class="reference-item" id="regions"><code>regions</code> - (Optional) <code>list[str]</code> The regions to consider for provisioning (e.g., <code>[eu-west-1, us-west4, westeurope]</code>).<a class="headerlink" href="#regions" title="Permanent link">&para;</a></h6>
59355935
<h6 class="reference-item" id="availability_zones"><code>availability_zones</code> - (Optional) <code>list[str]</code> The availability zones to consider for provisioning (e.g., <code>[eu-west-1a, us-west4-a]</code>).<a class="headerlink" href="#availability_zones" title="Permanent link">&para;</a></h6>
59365936
<h6 class="reference-item" id="instance_types"><code>instance_types</code> - (Optional) <code>list[str]</code> The cloud-specific instance types to consider for provisioning (e.g., <code>[p3.8xlarge, n1-standard-4]</code>).<a class="headerlink" href="#instance_types" title="Permanent link">&para;</a></h6>
@@ -6840,6 +6840,17 @@ <h3 id="dstack.api.BackendType"><code>dstack.api.BackendType</code><a class="hea
68406840
</div>
68416841
</td>
68426842
</tr>
6843+
<tr class="doc-section-item">
6844+
<td><code><span title="dstack.api.BackendType.CRUSOE">CRUSOE</span></code></td>
6845+
<td>
6846+
<code><span title="dstack._internal.core.models.backends.base.BackendType">BackendType</span></code>
6847+
</td>
6848+
<td>
6849+
<div class="doc-md-description">
6850+
<p>Crusoe Cloud</p>
6851+
</div>
6852+
</td>
6853+
</tr>
68436854
<tr class="doc-section-item">
68446855
<td><code><span title="dstack.api.BackendType.CUDO">CUDO</span></code></td>
68456856
<td>

docs/reference/api/python/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ finally:
108108
###### `docker` - (Optional) `bool` Use Docker inside the container. Mutually exclusive with `image`, `python`, and `nvcc`. Overrides `privileged`. { #docker data-toc-label='docker' class='reference-item' }
109109
###### [`repos`](#repos) - (Optional) `list[object]` The list of Git repos. { #_repos data-toc-label='repos' class='reference-item' }
110110
###### [`files`](#files) - (Optional) `list[object]` The local to container file path mappings. { #_files data-toc-label='files' class='reference-item' }
111-
###### `backends` - (Optional) `list["amddevcloud" | "aws" | "azure" | "cloudrift" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "kubernetes" | "lambda" | "local" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr"]` The backends to consider for provisioning (e.g., `[aws, gcp]`). { #backends data-toc-label='backends' class='reference-item' }
111+
###### `backends` - (Optional) `list["amddevcloud" | "aws" | "azure" | "cloudrift" | "crusoe" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "kubernetes" | "lambda" | "local" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr"]` The backends to consider for provisioning (e.g., `[aws, gcp]`). { #backends data-toc-label='backends' class='reference-item' }
112112
###### `regions` - (Optional) `list[str]` The regions to consider for provisioning (e.g., `[eu-west-1, us-west4, westeurope]`). { #regions data-toc-label='regions' class='reference-item' }
113113
###### `availability_zones` - (Optional) `list[str]` The availability zones to consider for provisioning (e.g., `[eu-west-1a, us-west4-a]`). { #availability_zones data-toc-label='availability_zones' class='reference-item' }
114114
###### `instance_types` - (Optional) `list[str]` The cloud-specific instance types to consider for provisioning (e.g., `[p3.8xlarge, n1-standard-4]`). { #instance_types data-toc-label='instance_types' class='reference-item' }
@@ -160,7 +160,7 @@ finally:
160160
###### `docker` - (Optional) `bool` Use Docker inside the container. Mutually exclusive with `image`, `python`, and `nvcc`. Overrides `privileged`. { #docker data-toc-label='docker' class='reference-item' }
161161
###### [`repos`](#repos) - (Optional) `list[object]` The list of Git repos. { #_repos data-toc-label='repos' class='reference-item' }
162162
###### [`files`](#files) - (Optional) `list[object]` The local to container file path mappings. { #_files data-toc-label='files' class='reference-item' }
163-
###### `backends` - (Optional) `list["amddevcloud" | "aws" | "azure" | "cloudrift" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "kubernetes" | "lambda" | "local" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr"]` The backends to consider for provisioning (e.g., `[aws, gcp]`). { #backends data-toc-label='backends' class='reference-item' }
163+
###### `backends` - (Optional) `list["amddevcloud" | "aws" | "azure" | "cloudrift" | "crusoe" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "kubernetes" | "lambda" | "local" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr"]` The backends to consider for provisioning (e.g., `[aws, gcp]`). { #backends data-toc-label='backends' class='reference-item' }
164164
###### `regions` - (Optional) `list[str]` The regions to consider for provisioning (e.g., `[eu-west-1, us-west4, westeurope]`). { #regions data-toc-label='regions' class='reference-item' }
165165
###### `availability_zones` - (Optional) `list[str]` The availability zones to consider for provisioning (e.g., `[eu-west-1a, us-west4-a]`). { #availability_zones data-toc-label='availability_zones' class='reference-item' }
166166
###### `instance_types` - (Optional) `list[str]` The cloud-specific instance types to consider for provisioning (e.g., `[p3.8xlarge, n1-standard-4]`). { #instance_types data-toc-label='instance_types' class='reference-item' }
@@ -205,7 +205,7 @@ finally:
205205
###### `docker` - (Optional) `bool` Use Docker inside the container. Mutually exclusive with `image`, `python`, and `nvcc`. Overrides `privileged`. { #docker data-toc-label='docker' class='reference-item' }
206206
###### [`repos`](#repos) - (Optional) `list[object]` The list of Git repos. { #_repos data-toc-label='repos' class='reference-item' }
207207
###### [`files`](#files) - (Optional) `list[object]` The local to container file path mappings. { #_files data-toc-label='files' class='reference-item' }
208-
###### `backends` - (Optional) `list["amddevcloud" | "aws" | "azure" | "cloudrift" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "kubernetes" | "lambda" | "local" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr"]` The backends to consider for provisioning (e.g., `[aws, gcp]`). { #backends data-toc-label='backends' class='reference-item' }
208+
###### `backends` - (Optional) `list["amddevcloud" | "aws" | "azure" | "cloudrift" | "crusoe" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "kubernetes" | "lambda" | "local" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr"]` The backends to consider for provisioning (e.g., `[aws, gcp]`). { #backends data-toc-label='backends' class='reference-item' }
209209
###### `regions` - (Optional) `list[str]` The regions to consider for provisioning (e.g., `[eu-west-1, us-west4, westeurope]`). { #regions data-toc-label='regions' class='reference-item' }
210210
###### `availability_zones` - (Optional) `list[str]` The availability zones to consider for provisioning (e.g., `[eu-west-1a, us-west4-a]`). { #availability_zones data-toc-label='availability_zones' class='reference-item' }
211211
###### `instance_types` - (Optional) `list[str]` The cloud-specific instance types to consider for provisioning (e.g., `[p3.8xlarge, n1-standard-4]`). { #instance_types data-toc-label='instance_types' class='reference-item' }

0 commit comments

Comments
 (0)