Skip to content

Commit 051930f

Browse files
committed
Reformat storage options
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent 3acb983 commit 051930f

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

docs/install-agent.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,21 +61,27 @@ If you missed it in the "Provision a Server" page, we recommend you use Ubuntu 2
6161
)
6262
```
6363
64-
Run the setup.sh script which will install all the required dependencies like containerd, CNI and Firecracker.
64+
The install.sh script installs required dependencies such as: containerd, CNI plugins, and the Firecracker binary.
6565
6666
**For best performance**, a dedicated drive, volume or partition is required to store the filesystems for running VMs. If you do not have a volume or extra drive attached, then you can shrink the root partition, and use the resulting free space.
6767
68-
Two storage backends are supported. By default the agent uses device mapper. Alternatively the agent can use ZFS volumes within a ZFS pool.
68+
Two storage backends are supported. By default the agent uses [Device mapper](https://en.wikipedia.org/wiki/Device_mapper). Alternatively the agent can use ZFS volumes within a ZFS pool.
69+
70+
The disk space allocated to job runners can be configured by setting the `BASE_SIZE` environment variable. The default is `30GB` which is generally sufficient for most teams.
6971
7072
=== "Devmapper (recommended)"
7173
74+
The `VM_DEV` variable should be set with a disk or partition that can be formatted for VM storage.
75+
7276
```bash
7377
(
7478
cd agent
7579
VM_DEV=/dev/nvme0n2 sudo -E ./install.sh
7680
)
7781
```
7882
83+
=== "Devmapper loopback"
84+
7985
If you do not have additional storage available at this time you can omit the `VM_DEV` variable and the installer will generate a loopback filesystem for you.
8086
8187
```bash
@@ -85,16 +91,22 @@ If you missed it in the "Provision a Server" page, we recommend you use Ubuntu 2
8591
)
8692
```
8793
94+
The default size of the loopback file is `200GB` which is stored at `/var/lib/containerd/devmapper`.
95+
8896
=== "ZFS"
8997
98+
The script will create a ZFS pool and dataset for you. If you want to manually setup ZFS or use an existing ZFS pool or dataset see [ZFS Configuration](#installation-options).
99+
100+
The `VM_DEV` variable should be set with a disk or partition that can be formatted for ZFS storage.
101+
90102
```bash
91103
(
92104
cd agent
93105
VM_DEV=/dev/nvme0n2 STORAGE=zfs sudo -E ./install.sh
94106
)
95107
```
96108
97-
The install script will create a ZFS pool and dataset for you. If you want to manually setup ZFS or use an existing ZFS pool or dataset see [ZFS Configuration](#installation-options).
109+
=== "ZFS loopback"
98110
99111
If you do not have additional storage available at this time you can omit the `VM_DEV` variable and the installer will generate a loopback filesystem for you.
100112
@@ -105,8 +117,6 @@ If you missed it in the "Provision a Server" page, we recommend you use Ubuntu 2
105117
)
106118
```
107119
108-
The disk space allocated to job runners can be configured by setting the `BASE_SIZE` environment variable. The default is `30GB`.
109-
110120
3. Generate your enrollment file
111121
112122
You'll need to create a DNS A or CNAME record for each server you add to actuated, this could be something like `server1.example.com` for instance.

0 commit comments

Comments
 (0)