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
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,21 +61,27 @@ If you missed it in the "Provision a Server" page, we recommend you use Ubuntu 2
61
61
)
62
62
```
63
63
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.
65
65
66
66
**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.
67
67
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.
69
71
70
72
=== "Devmapper (recommended)"
71
73
74
+
The `VM_DEV` variable should be set with a disk or partition that can be formatted for VM storage.
75
+
72
76
```bash
73
77
(
74
78
cd agent
75
79
VM_DEV=/dev/nvme0n2 sudo -E ./install.sh
76
80
)
77
81
```
78
82
83
+
=== "Devmapper loopback"
84
+
79
85
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.
80
86
81
87
```bash
@@ -85,16 +91,22 @@ If you missed it in the "Provision a Server" page, we recommend you use Ubuntu 2
85
91
)
86
92
```
87
93
94
+
The default size of the loopback file is `200GB` which is stored at `/var/lib/containerd/devmapper`.
95
+
88
96
=== "ZFS"
89
97
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.
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"
98
110
99
111
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.
100
112
@@ -105,8 +117,6 @@ If you missed it in the "Provision a Server" page, we recommend you use Ubuntu 2
105
117
)
106
118
```
107
119
108
-
The disk space allocated to job runners can be configured by setting the `BASE_SIZE` environment variable. The default is `30GB`.
109
-
110
120
3. Generate your enrollment file
111
121
112
122
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