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
  • Stateless Provisioning
• Control Server Setup
  • Operating System Installation
  • Network
  • Addressing
• Warewulf Installation
  • Binary RPMs
  • Compiled Source code
• Warewulf Configuration
  • warewulf.conf
  • nodes.conf
  • defaults.conf
  • Directories
• Controlling Warewulf (wwctl)
  • Hostlists
• Warewulf Initialization
  • System Services
  • Warewulf Service
• Container Management
  • Container Tools
  • Importing Containers
  • Syncuser
  • Listing All Imported Containers
  • Making Changes To Containers
  • Creating Containers From Scratch
  • Container Size Considerations
  • Duplicating a container
• Kernel Management
  • Node Kernels
  • Kernel Overrides
• Node Configuration
  • The Node Configuration DB
  • Adding a New Node
  • Listing Nodes
  • Setting Node Attributes
  • Configuring the Node’s Container Image
  • Un-setting Node Attributes
• Node Profiles
  • An Introduction To Profiles
  • Multiple Profiles
  • Cascading Profiles
  • Overriding Profiles
  • How To Use Profiles Effectively
• Warewulf Overlays
  • Defined Overlays
  • Combining Overlays
  • Templates
  • Using Overlays
• Node Provisioning
  • Node Hardware Setup
  • The Provisioning Process
  • Node status
• IPMI
  • IPMI Settings
  • Reviewing Settings
  • Power Commands
  • Console
• Disk Management
  • Storage objects
  • Ignition Implementation
  • Example
• Security
  • SELinux
  • Provisioning Security
  • Summary
• Templating
  • Examples

Quickstart

• EL7 (CentOS and RHEL)
  • Install Warewulf and dependencies
  • Configure firewalld
  • Configure the controller
  • Start and enable the Warewulf service
  • Configure system services automatically
  • Pull and build the VNFS container and kernel
  • Set up the default node profile
  • Add a node
• EL8 (Rocky Linux and RHEL)
  • Install Warewulf and dependencies
  • Configure firewalld
  • Configure the controller
  • Start and enable the Warewulf service
  • Configure system services automatically
  • Pull and build the VNFS container (including the kernel)
  • Set up the default node profile
  • Add a node
• EL9 (Rocky Linux and RHEL)
  • Install Warewulf and dependencies
  • Configure firewalld
  • Configure the controller
  • Start and enable the Warewulf service
  • Configure system services automatically
  • Pull and build the VNFS container (including the kernel)
  • Set up the default node profile
  • Add a node
• 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 VNFS container and kernel
  • Set up the default node profile
  • Add a node
  • Warewulf Overlays

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 (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