Skip to content

Playbook and tag map

Use the release checkout as the executable reference. Prefer narrowly scoped tags after inspecting a failed subsystem; do not use a broad deployment as routine troubleshooting.

Workflow Primary entry point
Fresh hub installation scripts/install-hub.sh / hub-install.yml
Hub teardown scripts/teardown-hub.sh
Inventory validation scripts/preflight-hub-inventory.sh
Secret validation scripts/preflight-v1.sh
Hub verification scripts/verify-hub-install.sh
Fleet verification scripts/verify-fleet.sh
Fleet image build harbor.yml with harbor_push_fleet
Hub backup scripts/backup-hub.sh
Hub restore scripts/restore-hub.sh
fleet-site CRDs and controller fleet-site-crd.yml, fleet-site-controller.yml
fleet-edge CRDs and controller fleet-edge-crd.yml, fleet-edge-controller.yml
Chart publish scripts/fleet-chart.sh
App install flow playbooks/flows/app-install.yml
Cluster delete (default detach) playbooks/flows/cluster-delete.yml
Cluster node operations playbooks/flows/cluster-node-op.yml
KubeVirt LAN enable playbooks/flows/cluster-enable-kubevirt-lan.yml
Site YAIDAP provision playbooks/flows/site-provision-yaidap.yml
Site provision connector site-provision-connector.yml

Run from the YAIDAP checkout on the site jumphost (cd $yaidapRoot && ansible-playbook …). UMKIM connector jobs invoke these via site-provision-connector.yml. See Provisioning workflows and UMKIM integration.

Playbook Tag Purpose
discover-hosts.yml check_host_details SSH hardware draft → generated/host_vars/
configure-tempxe.yml configure_tempxe, tempxe_start/stop, collect_discovery TempXE PXE arm/disarm, BM install, PXE discovery
configure-hypervisors.yml prepare, prepare_gpu_passthrough HV bridges, storage pools
plan-vm-placement.yml plan Dry-run vm_location: least-utilized scheduling
provision-vms.yml create, destroy Guest VM lifecycle
validate-all.yml validate Inventory schema check (no remote changes)
validate-integration.yml validate_integration Structured validate JSON (YAIDAP_RESULT when -e yaidap_emit_result=true)
install-bare-metal.yml install_bm TempXE bare-metal OS install composite (hub install_bm action)
discover-pxe.yml discover_pxe TempXE PXE discovery composite (hub discover_pxe action)
configure-routers.yml configure_router OpenWrt DynDNS, reverse proxy, ACME (standalone)

Flow playbooks under playbooks/flows/ automate selected FleetSite, FleetClusterJoin, and FleetApp API workflows. fleet_flow_cluster_name is required for app install flows; there is no placement engine.

Use the authenticated console or approved clients for public management operations. Internal flow playbooks are not a substitute for authenticated public API documentation.

v0.2 removed DCM (fleet-dcm.yml) and provider-install playbooks.