You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/install-agent.md
+29-17Lines changed: 29 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -219,23 +219,6 @@ If you missed it in the "Provision a Server" page, we recommend you use Ubuntu 2
219
219
220
220
Once you've run our test build, you need to run the steps for systemd mentioned above.
221
221
222
-
### Installation options
223
-
224
-
225
-
226
-
| ENV | Description | Default |
227
-
| --- | ----------- | ------- |
228
-
| ZPOOL | Name of the ZFS pool to use or create for ZFS storage. |`actuated_zpool`|
229
-
| ZFS_DATASET | Name of the ZFS dataset to use or create for ZFS .|`${ZPOOL}/snapshots}`|
230
-
231
-
The install script will automatically try to create a ZFS pool and dataset if you have opted forZFS storagein the installation script and they do not already exist.
232
-
233
-
If you have an existing pool or dataset that you want to use or if you want to create them manually you can configure the script to use them
You can now start your first build and see it run on your actuated agent.
@@ -283,3 +266,32 @@ You will need the following ports open:
283
266
We do not recommend restricting outgoing traffic on the server as this will probably cause you issues with your builds.
284
267
285
268
See also: [Troubleshooting your agent](/troubleshooting)
269
+
270
+
### Installation options for the `install.sh` script
271
+
272
+
When no options are given, all the defaults are assumed, which uses devmapper with a loopback file for VM storage, which is suitable for basic exploration or light use.
273
+
274
+
Dedicated disks or partitions with devmapper or ZFS is recommended for production use.
275
+
276
+
General options:
277
+
278
+
| ENV | Description | Default |
279
+
| --- | ----------- | ------- |
280
+
| `VM_DEV` | Disk or partition to use for VM storage. If omitted a loopback file will be created. | `""` |
281
+
| `STORAGE` | Storage backend to use for VM storage. Options are `devmapper` or `zfs`. | `devmapper` |
282
+
| `BASE_SIZE` | Base size of each VM filesystem. | `30GB` |
283
+
284
+
ZFS-specific options:
285
+
286
+
| ENV | Description | Default |
287
+
| --- | ----------- | ------- |
288
+
| `ZPOOL` | Name of the ZFS pool to use or create for ZFS storage. | `actuated_zpool` |
289
+
| `ZFS_DATASET` | Name of the ZFS dataset to use or create for ZFS . | `${ZPOOL}/snapshots}` |
290
+
291
+
The install script will automatically try to create a ZFS pool and dataset if you have opted for ZFS storage in the installation script and they do not already exist.
292
+
293
+
If you have an existing pool or dataset that you want to use or if you want to create them manually you can configure the script to use them
0 commit comments