Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions api/devbox.lock
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@
"store_path": "/nix/store/ra19vmkcxdw1c4aq7rb9z8m8n9403rn9-buf-1.34.0"
}
}
},
"github:NixOS/nixpkgs/nixpkgs-unstable": {
"resolved": "github:NixOS/nixpkgs/2d068ae5c6516b2d04562de50a58c682540de9bf?lastModified=1740303746&narHash=sha256-XcdiWLEhjJkMxDLKQJ0CCivmYYCvA5MDxu9pMybM5kM%3D"
}
}
}
124 changes: 122 additions & 2 deletions api/docs/html/pub/sandbox/v1alpha1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,14 @@ <h2>Table of Contents</h2>
</li>


<li>
<a href="#pub.sandbox.v1alpha1.MachineType"><span class="badge">E</span>MachineType</a>
</li>

<li>
<a href="#pub.sandbox.v1alpha1.Mode"><span class="badge">E</span>Mode</a>
</li>

<li>
<a href="#pub.sandbox.v1alpha1.SandboxState"><span class="badge">E</span>SandboxState</a>
</li>
Expand Down Expand Up @@ -323,6 +331,27 @@ <h3 id="pub.sandbox.v1alpha1.CreateSandboxRequest">CreateSandboxRequest</h3>
<td><p>Optional. Project must belong to organization. </p></td>
</tr>

<tr>
<td>machine_type</td>
<td><a href="#pub.sandbox.v1alpha1.MachineType">MachineType</a></td>
<td></td>
<td><p>Optional. The machine type to use for the sandbox. Defaults to MACHINE_TYPE_4CPU_16MEM. </p></td>
</tr>

<tr>
<td>github_token</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>

<tr>
<td>mode</td>
<td><a href="#pub.sandbox.v1alpha1.Mode">Mode</a></td>
<td></td>
<td><p> </p></td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -524,7 +553,8 @@ <h3 id="pub.sandbox.v1alpha1.ListSandboxesRequest">ListSandboxesRequest</h3>
<td>fetch_status_and_url</td>
<td><a href="#bool">bool</a></td>
<td></td>
<td><p> </p></td>
<td><p>fetch_status_and_url could be renamed to `fetch_workstation` to populate fields dependent
on the cloud resource (i.e. Cloud Workstation) </p></td>
</tr>

<tr>
Expand Down Expand Up @@ -593,7 +623,7 @@ <h3 id="pub.sandbox.v1alpha1.Sandbox">Sandbox</h3>
<td>repo</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
<td><p>repo is the github repository that is cloned. This may be user owned, or the template repo. </p></td>
</tr>

<tr>
Expand Down Expand Up @@ -659,6 +689,28 @@ <h3 id="pub.sandbox.v1alpha1.Sandbox">Sandbox</h3>
<td><p>Optional. For sandboxes created with a project_id. </p></td>
</tr>

<tr>
<td>is_trial</td>
<td><a href="#bool">bool</a></td>
<td></td>
<td><p>True if the sandbox is a trial sandbox. Trial sandboxes are deleted after 14 days and
have other restrictions. </p></td>
</tr>

<tr>
<td>mode</td>
<td><a href="#pub.sandbox.v1alpha1.Mode">Mode</a></td>
<td></td>
<td><p> </p></td>
</tr>

<tr>
<td>has_gpu</td>
<td><a href="#bool">bool</a></td>
<td></td>
<td><p> </p></td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -771,6 +823,74 @@ <h3 id="pub.sandbox.v1alpha1.StopSandboxResponse">StopSandboxResponse</h3>



<h3 id="pub.sandbox.v1alpha1.MachineType">MachineType</h3>
<p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>MACHINE_TYPE_UNSPECIFIED</td>
<td>0</td>
<td><p>Do not use.</p></td>
</tr>

<tr>
<td>MACHINE_TYPE_2CPU_8MEM</td>
<td>1</td>
<td><p></p></td>
</tr>

<tr>
<td>MACHINE_TYPE_4CPU_16MEM</td>
<td>2</td>
<td><p></p></td>
</tr>

<tr>
<td>MACHINE_TYPE_4CPU_15MEM_1T4</td>
<td>3</td>
<td><p></p></td>
</tr>

</tbody>
</table>

<h3 id="pub.sandbox.v1alpha1.Mode">Mode</h3>
<p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>MODE_UNSPECIFIED</td>
<td>0</td>
<td><p></p></td>
</tr>

<tr>
<td>MODE_GIT_REPO</td>
<td>1</td>
<td><p>MODE_GIT_REPO sets up a sandbox with the provided git repo (at specified `ref`),
and the working directory set to the `subdir` in the repo.</p></td>
</tr>

<tr>
<td>MODE_TEMPLATE</td>
<td>2</td>
<td><p>MODE_TEMPLATE sets up a sandbox to use a template. The code from the
git repo (at specified `ref`) is checked out and the root of the sandbox
code folder is set to the `subdir` in the repo. The original git repo is
discarded. A new git repo is initialized.</p></td>
</tr>

</tbody>
</table>

<h3 id="pub.sandbox.v1alpha1.SandboxState">SandboxState</h3>
<p>SandboxState represents the state of a sandbox.</p>
<table class="enum-table">
Expand Down
39 changes: 37 additions & 2 deletions api/docs/markdown/pub/sandbox/v1alpha1/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
- [StopSandboxRequest](#pub-sandbox-v1alpha1-StopSandboxRequest)
- [StopSandboxResponse](#pub-sandbox-v1alpha1-StopSandboxResponse)

- [MachineType](#pub-sandbox-v1alpha1-MachineType)
- [Mode](#pub-sandbox-v1alpha1-Mode)
- [SandboxState](#pub-sandbox-v1alpha1-SandboxState)

- [SandboxService](#pub-sandbox-v1alpha1-SandboxService)
Expand Down Expand Up @@ -50,6 +52,9 @@ API to manage Jetify Sandbox environments
| environment_variables | [CreateSandboxRequest.EnvironmentVariablesEntry](#pub-sandbox-v1alpha1-CreateSandboxRequest-EnvironmentVariablesEntry) | repeated | |
| name | [string](#string) | | Optional, human readable name for the sandbox. |
| project_id | [string](#string) | | Optional. Project must belong to organization. |
| machine_type | [MachineType](#pub-sandbox-v1alpha1-MachineType) | | Optional. The machine type to use for the sandbox. Defaults to MACHINE_TYPE_4CPU_16MEM. |
| github_token | [string](#string) | | |
| mode | [Mode](#pub-sandbox-v1alpha1-Mode) | | |



Expand Down Expand Up @@ -168,7 +173,7 @@ API to manage Jetify Sandbox environments

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| fetch_status_and_url | [bool](#bool) | | |
| fetch_status_and_url | [bool](#bool) | | fetch_status_and_url could be renamed to `fetch_workstation` to populate fields dependent on the cloud resource (i.e. Cloud Workstation) |
| filter | [ListSandboxesFilter](#pub-sandbox-v1alpha1-ListSandboxesFilter) | | |


Expand Down Expand Up @@ -201,7 +206,7 @@ API to manage Jetify Sandbox environments
| ----- | ---- | ----- | ----------- |
| id | [string](#string) | | |
| external_billing_tag | [string](#string) | | |
| repo | [string](#string) | | |
| repo | [string](#string) | | repo is the github repository that is cloned. This may be user owned, or the template repo. |
| subdir | [string](#string) | | The subdirectory within the repo to checkout. Defaults to the root of the repo. |
| ref | [string](#string) | | The git ref to checkout. This can be a branch, tag, or commit hash. Defaults to the default branch. |
| url | [string](#string) | | Will be empty if the sandbox is not running. If present, it will contain access token. |
Expand All @@ -211,6 +216,9 @@ API to manage Jetify Sandbox environments
| updated_at | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time the sandbox was last updated. |
| name | [string](#string) | | |
| project_id | [string](#string) | | Optional. For sandboxes created with a project_id. |
| is_trial | [bool](#bool) | | True if the sandbox is a trial sandbox. Trial sandboxes are deleted after 14 days and have other restrictions. |
| mode | [Mode](#pub-sandbox-v1alpha1-Mode) | | |
| has_gpu | [bool](#bool) | | |



Expand Down Expand Up @@ -280,6 +288,33 @@ API to manage Jetify Sandbox environments



<a name="pub-sandbox-v1alpha1-MachineType"></a>

### MachineType


| Name | Number | Description |
| ---- | ------ | ----------- |
| MACHINE_TYPE_UNSPECIFIED | 0 | Do not use. |
| MACHINE_TYPE_2CPU_8MEM | 1 | |
| MACHINE_TYPE_4CPU_16MEM | 2 | |
| MACHINE_TYPE_4CPU_15MEM_1T4 | 3 | |



<a name="pub-sandbox-v1alpha1-Mode"></a>

### Mode


| Name | Number | Description |
| ---- | ------ | ----------- |
| MODE_UNSPECIFIED | 0 | |
| MODE_GIT_REPO | 1 | MODE_GIT_REPO sets up a sandbox with the provided git repo (at specified `ref`), and the working directory set to the `subdir` in the repo. |
| MODE_TEMPLATE | 2 | MODE_TEMPLATE sets up a sandbox to use a template. The code from the git repo (at specified `ref`) is checked out and the root of the sandbox code folder is set to the `subdir` in the repo. The original git repo is discarded. A new git repo is initialized. |



<a name="pub-sandbox-v1alpha1-SandboxState"></a>

### SandboxState
Expand Down
Loading
Loading