Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/starcraft66/infrastructure

Infrastructure as code for my servers
https://github.com/starcraft66/infrastructure

homelab kubernetes nixos terraform

Last synced: 10 days ago
JSON representation

Infrastructure as code for my servers

Awesome Lists containing this project

README 

        
= Infrastructure

Tristan Gosselin-Hane 

:description: The document's description. 

:url-repo: https://git.tdude.co/tristan/infrastructure

:toc:

:toclevels: 3

:imagesdir: .gitlab/images

:source-highlighter: rouge



ifdef::env-github[]

WARNING: It appears that you are reading this document on GitHub. I urge you to https://git.tdude.co/tristan/infrastructure/[click on this link] to read the same document on GitLab which has far superior README formatting and rendering capabilities.

endif::[]



== Introduction



[.text-justify]

Welcome to my infrastructure repository. The goal of this repo is to document and make freely available the configuration and deployment tooling used to support most of my personal computer infrastructure, from networking to servers and applications.



[.text-justify]

This is my journey of constant experimentation in learning new tools and technologies to manage the lifecycle of infrastructure and applications in a way that burdens as little as possible while letting me iterate quickly and safely. The landscape is constantly evolving and I try to stay up to date with best practices as I see fit.



== The Landscape



I use a few different tools and methodologies to achieve my goals outlined above, here are some important ones.



=== 🔧 Tools



[cols="20h,~"]

|===

| Tool | Description



| https://nixos.org/[Nix] | Declarative package manager providing a development environment for this repo.

| https://nixos.org/[NixOS] | Declarative Nix-based linux distribution I run kubernetes and other services on.

| https://vyos.io/[VyOS] | Declaratively-configured network OS for all of my routing/firewalling needs.

| https://www.truenas.com/[TrueNAS Core] | Rock solid storage operating system for my NASes powered by OpenZFS.

| https://www.terraform.io/[Terraform] | Infrastructure as code tool I use to manage all of my cloud resources.

| https://min.io/[MinIO] | S3-compatible object storage running on TrueNAS I use to store my Terraform state files.

| https://kubernetes.io/[Kubernetes] | Production-grade container orchestrator I use to run most of my services.

| https://argoproj.github.io/[Argo Project] | Open source tools for Kubernetes I use to run workflows, manage my cluster, and do GitOps right.

| https://gitlab.com/[GitLab] | My self-hosted Git collaboration software of choice, deployed by and hosting this repository.

| https://github.com/mozilla/sops[SOPS] | SOPS allows me to encrypt sensitive information in this repository at rest and decrypt it at runtime.

|=== 



=== 🧠 Methodologies



[cols="15h,~"]

|===

| Methodology | Description



| https://opengitops.dev/[GitOps] | Versioned, Immutable, Declarative configuration being automatically applied and continuously reconciled.

|===



=== 🖥️ Inventory



Listing of relevant hardware configuration in this repository is applied to.



[cols="~,~,~,~"]

|===

| Hardware | Hostname | Purpose | Specifications



| HP T730 | 235-gw | Internet Gateway | 8GB RAM, 2x Ge

| HP T620 | 260-gw | Internet Gateway | 4GB RAM, 4x Ge

| HP T730 | 305-1700-gw | Internet Gateway | 8GB RAM, 2x Ge

| HPE SL250S G8 | soarin | NixOS Host #1 | 2x E5-2670, 128 GB RAM

| HPE DL380p G8 | sassaflash | NixOS Host #2 | 2x E5-2670, 128 GB RAM

| HPE DL380p G8 | stormfeather | NixOS Host #3 | 2x E5-2670, 128 GB RAM

| Supermicro X9 | spitfire | NAS #1 | 2x E5-2620, 128 GB RAM, 132 TB ZFS

| Supermicro X9 | firestreak | NAS #2 | 2x E5-2620, 64 GB RAM, 24 TB ZFS

| Brocade ICX-6610 | Router | Switch/Router | 2x 40Ge, 16x 10Ge, 48x 1Ge

| Hetzner EX-52 | bedrock | Cloud Dedicated Server | i7 8700, 128 GB RAM

| OVH VPS | stone | Cloud VPS | 1 vCore , 2 GB RAM

|===



=== 🌐 Network Topology



[.text-justify]

My network is quite vast and spans many physical sites. The network diagram below will give you a good visual feel for it. All of my internet gateways are re-purposed thin clients running the purpose-built VyOS Linux distribution. My entire network is dual-stacked running native IPv4 and native IPv6 where possible with fallback to tunnel brokers. I interconnect my physical sites using WireGuard tunnels and run OSPFv2/3 over those tunnels to propagate routing tables. My core Brocade switch connects my kubernetes cluster to the internet via BGP using the Calico CNI on the kubernetes side to advertise all of the relevant subnets living in the cluster. Everything on the kubernetes side is pure layer-3 networking, there are no overlays or tunnels between nodes. Finally, my network is divided into several VLANs to isolate different types of traffic, such as home traffic, lab traffic, storage traffic, kubernetes traffic and OOB management traffic.



[.text-justify]

I am currently in the process of obtaining a personal ASN as well as my own PA and possibly PI IPv6 address space as part of a project to learn more about BGP and more importantly to avoid relying on unstable residential ISP-supplied PA prefixes. This will probably involve running BGP sessions on a VPS from a cloud provider that allows BGP peering and tunnelling that home. Unless I can convince my residential ISPs to let me establish a BGP session with them but that it more likely to be a pipe dream.



=== 🗺️ Diagrams

.Click to expand

[%collapsible]

====

.Example diagram; will change

image::diagram.png[]

====



=== ❄️ Nix



[.text-justify]

To be complete, this repo needs to be as self-contained as possible. What I mean by this is that to manipulate or apply any kind of configuration in this repo, you shouldn't need anything on your system other than `git` to clone it and the Nix package manager. The repo contains a https://www.tweag.io/blog/2020-05-25-flakes/[flake] at the root, `flake.nix` which defines apps and development shells that are immediately accessible via Nix and don't perform or require any alteration to the state of the system the repo is cloned onto. The development shell makes available to the user all of the CLI tools required to interact with the repository. It also decrypts and makes available in the environment all of the relevant secrets required to authenticate with the infrastructure, given that the user can provide private key material to decrypt them.



[.text-justify]

To enter the development shell, either have https://direnv.net/[`direnv`] configured for your shell and run `direnv allow` in the root of the project or else run `nix develop`. You may need to enter your PIN and touch your Yubikey to decrypt secrets during the shell hook execution.



== The Repository itself



=== 📂 Repository structure



[.text-justify]

This listing intentionally doesn't cover the entire structure of the repo, it is meant to be a high-level overview of where various components are located.



[source,console]

----

./

├── dns/            # Terraform files for misc. dns zones and records

├── k8s-235/        # All files related to my kubernetes cluster

│  └── apps/        # Applications deployed on k8s using ArgoCD and Kustomize

├── nixos/          # All Nix modules and configurations for my NixOS hosts including kubernetes

├── secrets/        # Secrets encrypted with SOPS

└── flake.nix       # The Nix flake containing all tools and development shells to work with the contents of this repo

----



=== 🔐 SOPS



[.text-justify]

You might notice at a glance that it appears that this repository is full of secret things like API keys and stuff that shouldn't be publicly available. That is partially correct. This repository contains a variety of sensitive values but none of them are committed in plain text. Instead, they are encrypted with https://github.com/mozilla/sops[SOPS], which protects them from prying eyes at rest. However, with the right decryption keys, these secrets can be decrypted at runtime. Activating this project's nix shell using `nix develop` or via `direnv` will automatically decrypt the secrets and place them in the appropriate environment variable to be used by tools and config in the repo.



[.text-justify]

The `.sops.yaml` file at the root of the repo defines creation rules for secrets to be encrypted with sops. Any files matching the defined creation rule paths will be encrypted with the PGP fingerprints specified. The user encrypting new files mut have all of the PGP public keys included in their keyring in order to encrypt the secret.



// workaround for top level document not having +1 depth, we don't want this in the toc

[discrete]

==== Encrypting with SOPS



[.text-justify]

To encrypt a new file or edit an existing one in `$EDITOR`, run `sops `. To encrypt a file in place, run `sops -i -e `.



WARNING: New files must match the creation rules in `.sops.yaml` or they will fail to create.



// workaround for top level document not having +1 depth, we don't want this in the toc

[discrete]

==== Re-keying with SOPS



[.text-justify]

Occasionally, we might want to add a collaborator to the project, or a new tool that needs to be able to decrypt secrets. In that case, it will be necessary to re-key all existing files to encrypt them with the new public key after adding it to `.sops.yaml`. The following snippet can be used for this purpose.



.Re-key snippet

[%collapsible]

====

[source,bash]

----

#!/usr/bin/env bash

find **/secrets/*.yaml -name '*.yaml' | xargs -i sops updatekeys -y {}

find k8s/**/secrets/*.yaml -name '*.yaml' | xargs -i sops updatekeys -y {}

----

====



// DNS chapter

include::dns/README.adoc[leveloffset=+1]



// Kubernetes chapter

include::k8s-235/README.adoc[leveloffset=+1]