Skip to content

Commit 65ad3ea

Browse files
dangrakcmartin
andauthored
Document persist_rootfs option (#2236)
* Document rootfs persistence * Update reference/configuration.html.markerb Co-authored-by: Kristin Martin <[email protected]> * Update machines/api/machines-resource.html.markerb Co-authored-by: Kristin Martin <[email protected]> --------- Co-authored-by: Kristin Martin <[email protected]>
1 parent cf6c138 commit 65ad3ea

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

machines/api/machines-resource.html.markerb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1182,8 +1182,9 @@ Properties of the `config` object for Machine configuration. See [Machine proper
11821182
- `host_dedication_id`: The ID of the host dedication (group of dedicated hosts) on which to create this Machine. (beta)
11831183
- `cpus`: int (nil) - The number of CPU cores this Machine should occupy when it runs. (default `1`)
11841184
- `gpus`: int (nil) - The number of GPU cores this Machine should occupy when it runs. (default `1`)
1185-
- `kernel_args`: Optional array of strings. Arguments passed to the kernel.
11861185
- `memory_mb`: int (nil) - Memory in megabytes as multiples of 256 (default `256`)
1186+
- `kernel_args`: Optional array of strings. Arguments passed to the kernel.
1187+
- `persist_rootfs`: string (nil) - The root filesystem will be persisted across restarts and updates. Possible values are `never` (default), `restart`, and `always`.
11871188

11881189
---
11891190

reference/configuration.html.markerb

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -840,6 +840,7 @@ All keys are optional and `size` has lower precedence than all other keys.
840840
gpu_kind = "a100-pcie-40gb"
841841
kernel_args = "no-hlt=true"
842842
host_dedication_id = "customer-id"
843+
persist_rootfs = "never"
843844
processes = ["app"]
844845
```
845846

@@ -881,6 +882,14 @@ Additional kernel parameters provided to the kernel when booting the VM.
881882

882883
In the case of having a dedicated host, this is the value to set so Machines are launched on dedicated hardware.
883884

885+
### persist_rootfs
886+
887+
The persistence of the root filesystem across restarts and updates. Valid values are `never` (default), `restart`, and `always`.
888+
889+
- `never`: The root filesystem is ephemeral and will not be persisted across restarts or updates.
890+
- `restart`: The root filesystem is persisted across restarts, but not across updates.
891+
- `always`: The root filesystem is persisted across restarts and updates.
892+
884893
### `processes`
885894

886895
Optionally, you can specify a list of [processes](#the-processes-section) to limit by process group. You can even specify two different `[[vm]]` sections to have different compute requirements per process group. Note the need to use double brackets if there are multiple `[[vm]]` sections defined.

0 commit comments

Comments
 (0)