HOWTO: Run the Authoritative On-Prem Foundation¶
Purpose: Execute the full on-prem foundation blueprint in the correct dependency order and validate each layer before proceeding.
Difficulty: Advanced
Track: IPAM-Driven Infrastructure
Overview¶
Runs onprem/authoritative-foundation@v1. The network foundation is established
before the inventory authority. Optional platform steps require the logical
primary_ipam authority with capability inventory_ipam; the shipped
blueprint binds it to NetBox. A partial run retains its completed state and run
records for safe continuation.
1. Blueprint Overview¶
- Blueprint ID:
blueprints/onprem/authoritative-foundation. - Layers: network foundation, inventory authority, optional platform VMs.
- Logical requirement, selected binding, and dependency gates.
2. Authority Contract¶
- Declaring
primary_ipamonce at blueprint level. - Requiring
inventory_ipamfrom dependent operations. - Reading the selected binding and verified state from the authority receipt.
3. Prerequisites¶
- Proxmox host with VLAN-aware bridge configured.
- Management network reachable from the operator workstation.
- Secrets manager with bootstrap credentials populated.
4. Layer 1: Network Foundation¶
- Module:
core/onprem/network-sdn. - What it configures and what validation it produces.
- Gate condition for proceeding to authority deployment.
5. Layer 2: Inventory Authority¶
- Establishing the authority selected by the blueprint binding.
- Populating the intended prefixes and inventory records.
- Validation: authority ready, prefix coverage complete, no conflicts.
6. Layer 3: Optional Platform Expansion¶
- Authority-gated control-plane, PostgreSQL, and platform VM steps.
- Preflight admission before each dependent operation.
- Module-specific addressing and readiness checks after admission.
7. Run Records and Continuation¶
- Authority receipt in blueprint preflight and dependent step records.
- Linked module records and cross-layer references.
- Resuming a partial blueprint run after a failure.
References¶
- Operation authority contract
- HOWTO: Deploy NetBox Authoritative
- HOWTO: Provision Control Node
- HOWTO: Allocate IPs from NetBox
License: MIT-0 for code, CC-BY-4.0 for documentation unless otherwise stated.