Skip to content

Commit 138953c

Browse files
committed
Additional notes
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent 311bcb0 commit 138953c

File tree

2 files changed

+31
-18
lines changed

2 files changed

+31
-18
lines changed

docs/install-agent.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,38 +21,47 @@ Make sure you've read the [Actuated EULA](https://github.com/self-actuated/actua
2121

2222
If you missed it in the "Provision a Server" page, we recommend you use Ubuntu 22.04 as the host operating system on your Server.
2323

24-
## Coming soon: Auto Enrollment
24+
## Auto Enrollment
2525

26-
We're working on a feature to make setup quicker and easier:
26+
!!! info "New! Automated agent installation in preview"
2727

28-
* No need to reach out to us about new servers - they enroll themselves via API
29-
* No more DNS records to manage, or Let's Encrypt
30-
* Fully automated setup with a single bash script - for userdata, cloud-init, or manual installs via SSH
28+
As of Oct 2023, there's a new and automated onboarding experience for Actuated's Agent.
3129

32-
You'll need to obtain an enrollment token from us to use this feature.
30+
This is a significant improvement over the previous manual installation process, making it easier and faster to get started with Actuated.
3331

34-
Example to paste into userdata (or manually via SSH):
32+
We're running the Auto Enrollment in parallel with the manual process (see next section) while we gather feedback from users.
33+
34+
You'll need to obtain an *Account API Token* to install your agents using this approach.
35+
36+
Enter the following into cloud-init/userdata or run it manually on the server after connecting with SSH:
3537

3638
```bash
3739
#!/bin/bash
3840

3941
curl -LSsf https://get.actuated.com | LICENSE="" \
4042
TOKEN="" \
41-
DOCKER_USERNAME="" \
42-
DOCKER_PASSWORD="" \
4343
HOME="/root" bash -
4444
```
4545

46-
* `TOKEN` - this is an API token for the enrollment service - reach out and we'll generate this for you
47-
* `LICENSE` - the key you purchased for actuated
48-
* `DOCKER_USERNAME` and `DOCKER_PASSWORD` - your Docker Hub credentials for the pull-through cache. [Create a token here](https://docs.docker.com/security/access-tokens/) or leave empty to cache layers pulled anonymously.
49-
* `HOME` - the home directory of the user running the script - this is required during userdata since HOME is usually an unset variable.
46+
Minimum configuration:
5047

51-
The installation will guess the best place to store VM snapshots, and if a space disk or partition is found, it will be wiped and formatted.
48+
* `TOKEN` - your Account API Token - reach out to us and we'll generate one for you
49+
* `LICENSE` - the key you received when you [purchased an actuated subscription](https://actuated.com/pricing)
50+
cache layers pulled anonymously
51+
* `HOME` - Set this only if using cloud-init/userdata - where HOME is usually unset. Otherwise leave it blank and the script will use the current user's home directory.
52+
53+
Additional configuration:
5254

53-
If the script doesn't find any valid storage, it will provision a loopback file instead which is fine for basic testing. You can specify a specific disk or partition by setting the `VM_DEV` environment variable.
55+
* `DOCKER_USERNAME` and `DOCKER_PASSWORD` - your Docker Hub credentials for the pull-through cache. [Create a token here](https://docs.docker.com/security/access-tokens/) or leave empty to
56+
* `LABELS` - apply a comma-separated list of labels to the agent, e.g. `gce` or `gce,ssd`
57+
58+
Storage configuration:
59+
60+
* `VM_DEV` - a disk or partition to use for VM storage - leave blank for to autodetect a spare disk. If no disk is found, a loopback file will be used.
61+
62+
The installation will guess the best place to store VM snapshots, and if a space disk or partition is found, it will be wiped and formatted.
5463

55-
## Install the Actuated Agent
64+
## Manual Enrollment
5665

5766
!!! info "Do you want a free, expert installation?"
5867

docs/provision-server.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ For the absolute best value in terms of performance and cost, we recommend the f
3232
* *x86_64* - [Hetzner's A102](https://www.hetzner.com/dedicated-rootserver/ax102)
3333
* *Arm64* - [Hetzner's RX170](https://www.hetzner.com/dedicated-rootserver/matrix-rx)
3434

35-
Servers on Hetnzer arrive with a "rescue" system, use it to install Ubuntu 22.04, and make sure you disable software RAID, so that the two NVMe drives are presented as separate devices. One will run the system, the other will be used for filesystems for all the VMs.
35+
Hetzner machines come with a "rescue" system, use it to install Ubuntu 22.04, and make sure you disable software RAID, so that the two NVMe drives are presented as separate devices. One will run the system, the other will be used for filesystems for all the VMs.
3636

3737
## Our research on servers for actuated
3838

@@ -81,7 +81,11 @@ Intel and AMD CPUs can be used interchangeable and are known as `amd64` or `x86_
8181

8282
This option may not have the raw speed and throughput of a dedicated, bare-metal host, but keeps costs low and is convenient for getting started.
8383

84-
We know of at least three providers which have options for nested virtualisation: [DigitalOcean](https://m.do.co/c/8d4e75e9886f), [Google Compute Platform (GCP)](https://cloud.google.com/compute) (new customers get 300 USD free credits from GCP) support nested virtualisation on their Virtual Machines (VMs), and [Azure](https://azure.com/).
84+
We know of at least three providers which have options for nested virtualisation: [DigitalOcean](https://m.do.co/c/8d4e75e9886f), [Google Compute Platform (GCP)](https://cloud.google.com/compute) (new customers get 300 USD free credits from GCP) support nested virtualisation on their Virtual Machines (VMs), and [Azure](https://azure.com/).'
85+
86+
Nested Virtualisation is enabled by default on most clouds, however on GCP you will need to enable it via the `--enable-nested-virtualization` flag when creating a VM via `gcloud` CLI or API. This option is not listed in the GCP's web console.
87+
88+
If your only option is to use AWS EC2 VMs, then we can help you get up and running using Firecracker with KVM backed by Pagetable Isolation, [learn more here](https://blog.alexellis.io/how-to-run-firecracker-without-kvm-on-regular-cloud-vms/).
8589

8690
3. Bare-metal on-premises (cheap, convenient, high performance)
8791

0 commit comments

Comments
 (0)