Skip to content

Latest commit

 

History

History
88 lines (67 loc) · 3.11 KB

README.md

File metadata and controls

88 lines (67 loc) · 3.11 KB
Raw

Hubble Homelab

Documentation

This repository contains infrastructure-as-code for the automated deployment and configuration, and management of a Hashicorp (Nomad + Consul + Vault) cluster on Proxmox.

Disclaimer

This project is in alpha status and subject to bugs and breaking changes.

Please do not run any code on your machine without understanding the provisioning flow, in case of data loss. Some playbooks may perform destructive actions that are irreversible!

Overview

This project aims to provision a full Hashicorp cluster in a semi-automated manner. It utilizes Packer, Ansible and Terraform:

  1. Packer creates base Proxmox VM templates from cloud images and ISOs
  2. Terraform provisions cluster nodes by cloning existing VM templates
  3. Ansible installs and configures Vault, Consul, Nomad on cluster nodes

It comprises minimally of one server and one client node with no high availability (HA). The nodes run Vault, Consul and Nomad as a cluster.

To support HA, the setup can be further expanded to at least three server nodes and multiple client nodes hosted on a Proxmox cluster, spanning multiple physical machines.

Features

  • Golden image creation with Packer
  • Declarative configuration of Proxmox VMs and Vault with Terraform
  • Automated post-provisioning with Ansible
  • Nomad container scheduling and orchestration
  • Consul service discovery
  • Secure node communication via mTLS
  • Personal Certificate Authority hosted on Vault
  • Secrets management, retrieval and rotation with Vault
  • Automated certificate management with Vault and consul-template
  • Let's Encrypt certificates on Traefik reverse proxy

Getting Started

See the documentation for more information on the concrete steps to configure and provision the cluster.

Folder Structure

.
├── ansible/
│   ├── roles
│   ├── playbooks
│   ├── inventory    # inventory files
│   └── goss         # goss config
├── bin              # custom scripts
├── packer/
│   ├── base         # VM template from ISO
│   └── base-clone   # VM template from existing template
└── terraform/
    ├── cluster      # config for cluster
    ├── dev          # config where I test changes
    ├── minio        # config for Minio buckets
    ├── modules      # tf modules
    ├── nomad        # nomad jobs
    ├── postgres     # config for Postgres DB users
    ├── proxmox      # config for Proxmox accounts
    └── vault        # config for Vault

Limitations

  • Manual Vault unseal on reboot
  • Inter-job dependencies are not supported in Nomad
  • Vault agent is run as root

See issues for more information.

Acknowledgements