From 4dd64fd62f247b336d45b912a0541c45b7afe7a9 Mon Sep 17 00:00:00 2001 From: Karim Naufal Date: Tue, 25 Jan 2022 21:41:01 +0100 Subject: [PATCH] tweaked readme --- README.md | 2 +- terraform.tfvars.example | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c37a779..27278a4 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ _The Hetzner cli `hcloud` is also useful to have, mainly for debugging without h ### 💡 [Do not skip] Creating the terraform.tfvars file 1. Create a project in your [Hetzner Cloud Console](https://console.hetzner.cloud/), and go to **Security > API Tokens** of that project to grab the API key. Take note of the key! ✅ -2. Either, generate a passphrase-less ed25519 ssh key-pair for your cluster, unless you already have one that you'd like to use. Take note of the respective paths of your private and public keys! Or for a key-pair with passphrase or a device like a Yubikey, make sure you have got an SSH agent running and your key is loaded (`ssh-add -L` to verify) and set `private_key = null`. ✅ +2. Either, generate a passphrase-less ed25519 SSH key-pair for your cluster, unless you already have one that you'd like to use. Take note of the respective paths of your private and public keys. Or, for a key-pair with passphrase or a device like a Yubikey, make sure you have got an SSH agent running and your key is loaded (`ssh-add -L` to verify) and set `private_key = null` in the following step. ✅ 3. Copy `terraform.tfvars.example` to `terraform.tfvars`, and replace the values from steps 1 and 2. ✅ 4. (Optional) There are other variables in `terraform.tfvars` that could be customized, like Hetzner region, and the node counts and sizes. diff --git a/terraform.tfvars.example b/terraform.tfvars.example index 6c2d26f..a0d9e1a 100644 --- a/terraform.tfvars.example +++ b/terraform.tfvars.example @@ -1,6 +1,7 @@ # You need to replace these hcloud_token = "xxxxxxxxxxxxxxxxxxYYYYYYYYYYYYYYYYYYYzzzzzzzzzzzzzzzzzzzzz" public_key = "/home/username/.ssh/id_ed25519.pub" +# Must be "private_key = null" when you want to use ssh-agent, for a Yubikey like device auth or an SSH key-pair with passphrase private_key = "/home/username/.ssh/id_ed25519" # These can be customized, or left with the default values