Add basic readme

This commit is contained in:
IamTheFij 2023-07-11 17:32:50 +00:00
parent 2e7dc0315e
commit 72c30d4d74
1 changed files with 21 additions and 0 deletions

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# Homelab Nomad
My configuration for creating my home Nomad cluster and deploying services to it.
## Running
make all
## Design
Both Ansible and Terraform are used as part of this configuration. All hosts must be reachable over SSH prior to running any of this configuration.
To begin, Ansible runs a playbook to setup the cluster. This includes installing Nomad, bootstrapping the cluster and ACLs, setting up NFS shares, creating Nomad Host Volumes, and setting up Wesher as a Wireguard mesh between hosts.
After this is complete, Ansible variables must be set for services to access and configure correctly. This depends on variables to be set based on the sample file.
Finally, the Terraform configuration can be applied setting up all services deployed on the cluster.
## What does it do?
## Step by step