Server Naming Conventions and Documentation Best Practices

Why Naming Conventions Matter

Clear, consistent server names reduce confusion and prevent costly mistakes. When your team manages dozens of Breezes, a well-designed naming scheme lets anyone quickly identify a server's purpose, location, and environment.

Common Naming Schemes

Functional Naming

Encode the server's role directly in its name:

web-prod-01      # Production web server 1
db-staging-01    # Staging database server
cache-prod-01    # Production cache server
worker-prod-03   # Production background worker 3

Pattern Components

• Role: web, db, cache, worker, lb, monitor
• Environment: prod, staging, dev, test
• Sequence: 01, 02, 03 (zero-padded for sorting)

Hostname Configuration

Set the hostname on each Breeze to match your convention:

sudo hostnamectl set-hostname web-prod-01
# Verify
hostnamectl

Update /etc/hosts to include the new hostname:

127.0.1.1   web-prod-01

Documentation Best Practices

Server Inventory

Maintain a spreadsheet or database with these fields for every Breeze:

• Hostname, IP address, and OS version
• Purpose and services running
• Owner or responsible team
• Provisioning date and last update date
• SSH access details and credentials location

Runbooks

Document standard operating procedures for each server type. Include startup/shutdown procedures, backup schedules, and troubleshooting steps. Store runbooks in version control alongside your infrastructure code.

Change Log

Record every significant change with date, author, and description. This audit trail is invaluable when diagnosing issues that emerge days after a change.