Documentation

From Linux-HA

Manual pages

Heartbeat (from 3.0.2 forward) comes with extensive manual pages for system administration commands and configuration files. To retrieve an annotated list of supported options in the ha.cf file, for example, issue the following command:

man ha.cf

The OCF Resource Agents (from 1.0.2 forward) also come with a manual page for each individual resource agent. These man pages are found in manual section 7 and are named ocf_heartbeat_agent. For example, to retrieve information about the supported parameters and actions for the IPaddr2 resource agent, issue this command:

man ocf_heartbeat_IPaddr2

User's Guide

The reference documentation for Heartbeat 3.0 is the Heartbeat User's Guide. The User's Guide is designed to address many of the documentation shortcomings the project has previously had, and serve as the definitive reference guide and handbook for all Linux-HA users.

Florian acts as the principal editor and publishes User's Guide builds at http://www.linux-ha.org/doc.

This web site

Examples, informal HOWTOs, information pertaining to legacy releases, and other documentation not considered "reference" material, are available from this web site.