From 802f390f61300db2401f671524ad42977cd5bfc6 Mon Sep 17 00:00:00 2001 From: Devin Buhl Date: Sat, 15 Jul 2023 14:30:26 -0400 Subject: [PATCH] chore: apply feedback on readme and vars Signed-off-by: Devin Buhl --- README.md | 17 ++++++++--------- bootstrap/vars/addons.sample.yaml | 2 +- bootstrap/vars/config.sample.yaml | 4 ++-- 3 files changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3d5ab676..52529b52 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,6 @@ There is a decent guide [here](https://www.linuxtechi.com/how-to-install-debian- - Choose "All files in one partition" - Delete Swap partition - Uncheck all Debian desktop environment options - - Keep ssh server checked ``` 2. [Post install] Remove CD/DVD as apt source @@ -78,7 +77,7 @@ There is a decent guide [here](https://www.linuxtechi.com/how-to-install-debian- su - apt install sudo usermod -aG sudo ${username} - echo "${username} ALL=(ALL) NOPASSWD:ALL" | tee /etc/sudoers.d/${username} + echo "${username} ALL=(ALL) NOPASSWD:ALL" | tee /etc/sudoers.d/${username} exit newgrp sudo sudo apt update @@ -99,10 +98,10 @@ If you choose to use a Raspberry Pi for the cluster, it is recommended to have a According to the documentation [here](https://raspi.debian.net/defaults-and-settings/), after you have flashed the image onto a SSD/NVMe you must mount the drive and do the following. -1. Edit the `sysconf.txt` -2. Add/change `root_authorized_key` to your desired public SSH key -3. Add/change `root_pw` to your desired root password -4. Add/change `hostname` to your desired hostname +1. Edit `sysconf.txt` +2. Change `root_authorized_key` to your desired public SSH key. +3. Change `root_pw` to your desired root password. +4. Change `hostname` to your desired hostname. ## 🚀 Lets go @@ -136,15 +135,15 @@ Clone **your new repo** to you local workstation and `cd` into it. ### 🔐 Setting up Age -📍 Here we will create a Age Private and Public key. Using [SOPS](https://github.com/mozilla/sops) with [Age](https://github.com/FiloSottile/age) allows us to encrypt secrets and use them in Ansible and Flux. +📍 Using [SOPS](https://github.com/mozilla/sops) with [Age](https://github.com/FiloSottile/age) allows us to encrypt secrets and use them in Ansible and Flux. -1. Create a Age Private / Public Key +1. Create a Age private / public key ```sh age-keygen -o age.agekey ``` -2. Set up the directory for the Age key and move the Age file to it +2. Create the directory for the Age key and move the Age file to it ```sh mkdir -p ~/.config/sops/age diff --git a/bootstrap/vars/addons.sample.yaml b/bootstrap/vars/addons.sample.yaml index 8281c989..fcba9b92 100644 --- a/bootstrap/vars/addons.sample.yaml +++ b/bootstrap/vars/addons.sample.yaml @@ -28,7 +28,7 @@ weave_gitops: # https://github.com/kubernetes-csi/csi-driver-nfs csi_driver_nfs: enabled: false - storage_class: [] + storage_class: # - name: # name of the storage class (must match [a-z0-9-]+) # server: # dns name or ip address of nfs server # share: # exported share (path) diff --git a/bootstrap/vars/config.sample.yaml b/bootstrap/vars/config.sample.yaml index 16affec4..5d665d46 100644 --- a/bootstrap/vars/config.sample.yaml +++ b/bootstrap/vars/config.sample.yaml @@ -43,13 +43,13 @@ bootstrap_service_cidr: 10.43.0.0/16 # Node information bootstrap_nodes: # Use only 1, 3 or more odd master nodes, recommended is 3 - master: [] + master: # - name: # name of the master node (must match [a-z0-9-]+) # address: # ip address of the master node # username: # ssh username of the master node # password: # password of ssh username for the master node # ... - worker: [] + worker: # - name: # name of the worker node (must match [a-z0-9-]+) # address: # ip address of the worker node # username: # ssh username of the worker node