Hayden's Lab

Welcome to the documentation for my homelab. Here, I will store information and notes in relation to all aspects of how the lab runs. It mostly serves as a reference for me, but maybe someone will find it interesting too.

Right now, this documentation is very incomplete. I am currently working towards restructuring my homelab and will document things as I get to them. In future, I hope to be able to use these notes alongside a NetBox instance to fully document my networks.

This website is generated by mdBook and is hosted by Vercel.

htbrown.com

Backups

Entities

Domains

Locations

Network Appliances

Server Nodes

Incidents & Planned Work

Network

Standards & Conventions

Names

A number of naming conventions are used throughout the network to designate different kinds of entity.

Guidelines

In order to keep things from being confusing, here are a few guidelines that should be followed when naming entities.

1. Names should be permanent.

   Once a name has been assigned to an entity, it should not be changed and it should not be used elsewhere. This is to ensure names are consistent and reliable. The only exception to this rule is if an entity changes significantly, at which point it is no longer the same entity and requires a new name.

2. Names should not be sequential.

   Given the first rule, sequential names become confusing and arbitrary when entities are no longer needed. For example, if devices are named htb-n where n is the sequential number it was introduced, then when devices retire the pool of active devices no longer starts at zero or one.

3. Names should not overlap.

   This is fairly easy to grasp. Again, I want to ensure consistency and reliability and having naming schemes which are too close to one another could make things confusing.

Currently-Used Conventions

A list of currently-used naming conventions follows, in order of scope.