User Guide

Welcome to the Warewulf User Guide!

Contents

• Introduction
  • The Warewulf Vision
  • About Warewulf
  • Features
• Background
• Stateless Provisioning
  • Why is Provisioning Important
  • Provisioning Overview
  • Why Stateless Provisioning
• Control Server Setup
  • Operating System Installation
  • Network
  • Addressing
  • Multiple networks
• Warewulf Installation
  • Binary RPMs
  • Container images
  • Compiled Source code
• Warewulf Configuration
  • warewulf.conf
  • nodes.conf
  • Directories
  • FirewallD
  • nftables
• Upgrading Warewulf
• Controlling Warewulf (wwctl)
  • Hostlists
• Warewulf Initialization
  • System Services
  • Warewulf Service
• Image Management
  • Tools
  • Structure
  • Importing Images
  • Syncuser
  • Listing All Imported Images
  • Making Changes To Images
  • Creating Images From Scratch
  • Duplicating an image
  • Multi-arch image management
  • Read-only images
• Kernel Management
  • Kernel Version
• Boot Management
  • Booting with iPXE
  • Booting with GRUB
  • Booting with dracut
• Node Configuration
  • The Node Configuration DB
  • Adding a New Node
  • Listing Nodes
  • Setting Node Attributes
  • Setting list values
  • Un-setting Node Attributes
  • Resources
• Node Profiles
  • An Introduction To Profiles
  • Multiple Profiles
  • Cascading Profiles
  • Overriding Profiles
  • Negating Profiles
  • How To Use Profiles Effectively
• Warewulf Overlays
  • Structure
  • System and runtime overlays
  • Distribution and site overlays
  • Combining and overriding overlays
  • Templates
  • Template functions
  • Managing overlays
• Node Provisioning
  • Node Hardware Setup
  • The Provisioning Process
  • Node status
• IPMI
  • IPMI Settings
  • Reviewing Settings
  • Power Commands
  • Console
  • Ipmi template
• Disk Management
  • Requirements
  • Storage objects
  • Ignition Implementation
  • Example disk configuration
  • Wiping disks
  • Troubleshooting
• Security
  • SELinux
  • Provisioning Security
  • Summary
• Templating
  • Examples
• dnsmasq
  • Usage
• Troubleshooting
  • warewulfd
  • iPXE
  • GRUB
• Known issues
  • SELinux and IPMI write not working when using two-stage boot
  • Images are read-only
  • Image sockets cause build failures
  • Image Size Considerations

Quickstart

• Enterprise Linux (Rocky Linux, CentOS, and RHEL)
  • Install Warewulf
  • Configure firewalld
  • Configure Warewulf
  • Enable and start the Warewulf service
  • Configure system services automatically
  • Add a base node image
  • Configure the default node profile
  • Add a node
  • Build overlays
  • Boot
• openSUSE Leap and SLES 15
  • Install Warewulf and dependencies
  • Install Warewulf from the open build service
  • Configure the controller
  • Start and enable the Warewulf service
  • Configure system services automatically
  • Pull and build the image
  • Set up the default node profile
  • Add a node
  • Warewulf Overlays
• Debian 12
  • Install the basic services
  • Install Warewulf and dependencies
  • Configure firewalld
  • Configure the controller
  • Start and enable the Warewulf service
  • Configure system services automatically
  • Pull and build the image
  • Set up the default node profile
  • Add a node

Contributing

• Contributing
  • Join the community
  • Raise an Issue
  • Contribute to the code
• Debugging
  • Validating the code with vet
  • Running the full test suite
  • Using delve
• Documentation
• Development Environment (Dev Container/VSC)
  • Using a Dev Container for development
• Development Environment (Vagrant)
  • Host system requirements
  • Setup development environment on Rocky Linux 9
  • Vagrant box and Vagrantfile for Warewulf sandbox
  • Spin up head node
  • Spin up compute nodes
• Development Environment (KVM)
  • Create CentOS 7 development virtual machine under KVM
  • Turn off default network dhcp on server master1
  • Build and install Warewulf on wwdev
• Development Environment (VirtualBox)
• Glossary

Command Reference

• wwctl
• wwctl clean
• wwctl configure
• wwctl configure dhcp
• wwctl configure hostfile
• wwctl configure nfs
• wwctl configure ssh
• wwctl configure tftp
• wwctl image
• wwctl image build
• wwctl image copy
• wwctl image delete
• wwctl image exec
• wwctl image import
• wwctl image kernels
• wwctl image list
• wwctl image rename
• wwctl image shell
• wwctl image show
• wwctl image syncuser
• wwctl node
• wwctl node add
• wwctl node console
• wwctl node delete
• wwctl node edit
• wwctl node export
• wwctl node import
• wwctl node list
• wwctl node sensors
• wwctl node set
• wwctl node status
• wwctl overlay
• wwctl overlay build
• wwctl overlay chmod
• wwctl overlay chown
• wwctl overlay create
• wwctl overlay delete
• wwctl overlay edit
• wwctl overlay import
• wwctl overlay list
• wwctl overlay mkdir
• wwctl overlay show
• wwctl power
• wwctl power cycle
• wwctl power off
• wwctl power on
• wwctl power reset
• wwctl power soft
• wwctl power status
• wwctl profile
• wwctl profile add
• wwctl profile delete
• wwctl profile edit
• wwctl profile list
• wwctl profile set
• wwctl server
• wwctl ssh
• wwctl upgrade
• wwctl upgrade config
• wwctl upgrade nodes
• wwctl version

Configuration Reference

• nodes.conf(5)
• warewulf.conf(5)