Documentation

Documentation is always a work in progress… Please report errors via GitHub issues.

Contributing

To contribute to Warewulf, create issues, or contribute to the source tree visit the GitHub page.

Other ways to contact us:

• Mailing List - warewulf@lbl.gov
• Slack - Ask on mailing list for an invite

note: Any new branches or changes to the given structure must be vetted and approved by a primary developer.

---

General Warewulf Overview

• About Warewulf
• Terminology and reference
• Warewulf architecture

Warewulf Subprojects, Components, and Plugins

• Warewulf Common
  • The Warewulf Datastore
• System/Node Provisioning
  • How to provision specific files
  • Runtime scripts that are provisioned automatically
• VNFS (Virtual Node File System) Management
• IBCheck? – Swiss army knife for Infiniband (IB) troubleshooting
• Ipmi Integration?
• Scalable System Monitoring?

Recipes

Warewulf recipes are designed to be brief command based walk throughs of what you would need to type or do to reach a particular endpoint. If you need details of what you are doing, why you are doing it, or how something works, this is not the place! Contributions should be in the form of specific command examples such that somebody can for the most part copy/paste the content to obtain the desired results with only brief explanations (if any).

Setup

• Installing Warewulf fresh
• Upgrading Warewulf on your system
• Warewulf Initialization
• Tab completion in wwsh

Stateless Provisioning

• Stateless provisioning for Red Hat and compatibles
• Stateless provisioning for Debian Linux
• Stateless provisioning for Ubuntu Linux?
• Stateless provisioning for OpenSuSE Linux?

Building a Beowulf style cluster

• Single Master Beowulf?
• Multiple Master Beowulf?

General

• Adding Infiniband support to the VNFS
• User management for provisioned nodes
• Provisioning nodes with multiple submasters
• Stateful provisioning
• IPMI configuration?
• Warewulf for PERCEUS Users - A quick-reference guide to commonly-used PERCEUS commands and their Warewulf equivalents

Development

• A tutorial on writing Warewulf Event Modules.
• Mezzanine is used to build Warewulf from source and create binary RPMS. (this is only needed if you’re building Warewulf from source)
• Information for contributors (help with development, testing, documentation, admin, etc.)
• Building and installing from Source tarballs
• Building and installing from SCM repository (Subversion)

Media

•  SuperComputing 2011 Warewulf Handout