mirror of
https://github.com/gogrlx/bootstrap.grlx.dev.git
synced 2026-04-02 02:59:05 -07:00
add bootstrap instructions
This commit is contained in:
42
README.md
Normal file
42
README.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# Quickstart
|
||||
|
||||
Want to get up and running as quickly as possible to see what all the fuss is about?
|
||||
Use our bootstrap scripts!
|
||||
|
||||
1. Download and initialize the command line utility from our releases to your dev machine.
|
||||
```bash
|
||||
# replace 'linux' with darwin if you're on macOS
|
||||
curl -L releases.grlx.dev/linux/amd64/grlx > grlx && chmod +x grlx
|
||||
./grlx init
|
||||
```
|
||||
You'll be asked some questions, such as which interface the `farmer` is listening on, and which ports to use for communication.
|
||||
Set the interface to the domain name or IP address of the `farmer`.
|
||||
Once configured, the CLI prints out your administrator public key, which you'll need for the next step!
|
||||
|
||||
2. On your control server, you'll need to install the `farmer`.
|
||||
```bash
|
||||
# or, just run as root instead of sudo
|
||||
curl -L bootstrap.grlx.dev/latest/farmer | sudo bash
|
||||
```
|
||||
You'll be asked several questions about the interface to listen on, which ports to use, etc.
|
||||
For the quick start, it's recommended to use the default ports (make sure there's no firewall in the way!).
|
||||
You'll be prompted for an admin public key, which you should have gotten from the prior step, and a certificate host name(s).
|
||||
Make sure the certificate host name matches the external-facing interface (a domain or IP address) as it will be used for TLS validation!
|
||||
|
||||
3. On all of your fleet nodes, you'll need to install the `sprout`.
|
||||
```bash
|
||||
# or, just run as root instead of sudo
|
||||
# FARMER_BUS_PORT and FARMER_API_PORT variables are available in case you chose
|
||||
# to use different ports.
|
||||
curl -L bootstrap.grlx.dev/latest/sprout | FARMER_INTERFACE=localhost sudo -E bash
|
||||
```
|
||||
Once the sprout is up and running, return to the CLI.
|
||||
|
||||
4. If all is well, you're ready to `cook`!
|
||||
```bash
|
||||
grlx keys accept -A
|
||||
sleep 15;
|
||||
grlx -T \* test ping
|
||||
grlx -T \* cmd run whoami
|
||||
grlx -T \* cmd run --out json -- uname -a
|
||||
```
|
||||
Reference in New Issue
Block a user