SUSE Linux Enterprise High Availability Extension 11 SP3

SLEHA 11 SP3

High Availability Guide

Publication Date 14 Oct 2013

AuthorsTanja Roth, Thomas Schraitle

Copyright © 2006– 2013 SUSE LLC and contributors. All rights reserved.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or (at your option) version 1.3; with the Invariant Section being this copyright notice and license. A copy of the license version 1.2 is included in the section entitled GNU Free Documentation License.

For SUSE or Novell trademarks, see the Novell Trademark and Service Mark list http://www.novell.com/company/legal/trademarks/tmlist.html. All other third party trademarks are the property of their respective owners. A trademark symbol (®, ™ etc.) denotes a SUSE or Novell trademark; an asterisk (*) denotes a third party trademark.

All information found in this book has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither SUSE LLC, its affiliates, the authors nor the translators shall be held liable for possible errors or the consequences thereof.


Contents

About This Guide
1. Feedback
2. Documentation Conventions
3. About the Making of This Manual
I. Installation and Setup
1. Product Overview
1.1. Key Features
1.2. Benefits
1.3. Cluster Configurations: Storage
1.4. Architecture
2. System Requirements
2.1. Hardware Requirements
2.2. Software Requirements
2.3. Shared Disk System Requirements
2.4. Other Requirements
3. Installation and Basic Setup
3.1. Definition of Terms
3.2. Overview
3.3. Installation as Add-on
3.4. Automatic Cluster Setup (sleha-bootstrap)
3.5. Manual Cluster Setup (YaST)
3.6. Mass Deployment with AutoYaST
II. Configuration and Administration
4. Configuration and Administration Basics
4.1. Global Cluster Options
4.2. Cluster Resources
4.3. Resource Monitoring
4.4. Monitoring System Health
4.5. Resource Constraints
4.6. For More Information
5. Configuring and Managing Cluster Resources (Web Interface)
5.1. Hawk—Overview
5.2. Configuring Global Cluster Options
5.3. Configuring Cluster Resources
5.4. Managing Cluster Resources
5.5. Multi-Site Clusters (Geo Clusters)
5.6. Monitoring Multiple Clusters
5.7. Troubleshooting
6. Configuring and Managing Cluster Resources (GUI)
6.1. Pacemaker GUI—Overview
6.2. Configuring Global Cluster Options
6.3. Configuring Cluster Resources
6.4. Managing Cluster Resources
7. Configuring and Managing Cluster Resources (Command Line)
7.1. crm Shell—Overview
7.2. Configuring Global Cluster Options
7.3. Configuring Cluster Resources
7.4. Managing Cluster Resources
7.5. Setting Passwords Independent of cib.xml
7.6. Retrieving History Information
7.7. For More Information
8. Adding or Modifying Resource Agents
8.1. STONITH Agents
8.2. Writing OCF Resource Agents
8.3. OCF Return Codes and Failure Recovery
9. Fencing and STONITH
9.1. Classes of Fencing
9.2. Node Level Fencing
9.3. STONITH Configuration
9.4. Monitoring Fencing Devices
9.5. Special Fencing Devices
9.6. Basic Recommendations
9.7. For More Information
10. Access Control Lists
10.1. Requirements and Prerequisites
10.2. The Basics of ACLs
10.3. Configuring ACLs with the Pacemaker GUI
10.4. Configuring ACLs with the crm Shell
10.5. For More Information
11. Network Device Bonding
11.1. Configuring Bonding Devices with YaST
11.2. Hotplugging of Bonding Slaves
11.3. For More Information
12. Load Balancing with Linux Virtual Server
12.1. Conceptual Overview
12.2. Configuring IP Load Balancing with YaST
12.3. Further Setup
12.4. For More Information
13. Multi-Site Clusters (Geo Clusters)
13.1. Challenges for Multi-Site Clusters
13.2. Conceptual Overview
13.3. Requirements
13.4. Basic Setup
13.5. Managing Multi-Site Clusters
13.6. Troubleshooting
III. Storage and Data Replication
14. OCFS2
14.1. Features and Benefits
14.2. OCFS2 Packages and Management Utilities
14.3. Configuring OCFS2 Services and a STONITH Resource
14.4. Creating OCFS2 Volumes
14.5. Mounting OCFS2 Volumes
14.6. Using Quotas on OCFS2 File Systems
14.7. For More Information
15. Distributed Replicated Block Device (DRBD)
15.1. Conceptual Overview
15.2. Installing DRBD Services
15.3. Configuring the DRBD Service
15.4. Testing the DRBD Service
15.5. Tuning DRBD
15.6. Troubleshooting DRBD
15.7. For More Information
16. Cluster Logical Volume Manager (cLVM)
16.1. Conceptual Overview
16.2. Configuration of cLVM
16.3. Configuring Eligible LVM2 Devices Explicitly
16.4. For More Information
17. Storage Protection
17.1. Storage-based Fencing
17.2. Ensuring Exclusive Storage Activation
17.3. For More Information
18. Samba Clustering
18.1. Conceptual Overview
18.2. Basic Configuration
18.3. Joining an Active Directory Domain
18.4. Debugging and Testing Clustered Samba
18.5. For More Information
19. Disaster Recovery with ReaR
19.1. Conceptual Overview
19.2. Preparing for the Worst Scenarios: Disaster Recovery Plans
19.3. Setting Up ReaR
19.4. Using the YaST ReaR Module
19.5. Setting Up rear-SUSE with AutoYaST
19.6. For More Information
IV. Troubleshooting and Reference
20. Troubleshooting
20.1. Installation and First Steps
20.2. Logging
20.3. Resources
20.4. STONITH and Fencing
20.5. Miscellaneous
20.6. Fore More Information
21. HA OCF Agents
ocf:anything — Manages an arbitrary service
ocf:AoEtarget — Manages ATA-over-Ethernet (AoE) target exports
ocf:apache — Manages an Apache web server instance
ocf:asterisk — Manages an Asterisk PBX
ocf:AudibleAlarm — Emits audible beeps at a configurable interval
ocf:ClusterMon — Runs crm_mon in the background, recording the cluster status to an HTML file
ocf:conntrackd — This resource agent manages conntrackd
ocf:CTDB — CTDB Resource Agent
ocf:db2 — Resource Agent that manages an IBM DB2 LUW databases in Standard role as primitive or in HADR roles as master/slave configuration. Multiple partitions are supported.
ocf:Delay — Waits for a defined timespan
ocf:dhcpd — Chrooted ISC DHCP Server resource agent.
ocf:drbd — Manages a DRBD resource (deprecated)
ocf:Dummy — Example stateless resource agent
ocf:eDir88 — Manages a Novell eDirectory directory server
ocf:ethmonitor — Monitors network interfaces
ocf:Evmsd — Controls clustered EVMS volume management (deprecated)
ocf:EvmsSCC — Manages EVMS Shared Cluster Containers (SCCs) (deprecated)
ocf:exportfs — Manages NFS exports
ocf:Filesystem — Manages filesystem mounts
ocf:fio — fio IO load generator
ocf:ICP — Manages an ICP Vortex clustered host drive
ocf:ids — Manages an Informix Dynamic Server (IDS) instance
ocf:IPaddr2 — Manages virtual IPv4 addresses (Linux specific version)
ocf:IPaddr — Manages virtual IPv4 addresses (portable version)
ocf:IPsrcaddr — Manages the preferred source address for outgoing IP packets
ocf:IPv6addr — Manages IPv6 aliases
ocf:iSCSILogicalUnit — Manages iSCSI Logical Units (LUs)
ocf:iSCSITarget — iSCSI target export agent
ocf:iscsi — Manages a local iSCSI initiator and its connections to iSCSI targets
ocf:jboss — Manages a JBoss application server instance
ocf:ldirectord — Wrapper OCF Resource Agent for ldirectord
ocf:LinuxSCSI — Enables and disables SCSI devices through the kernel SCSI hot-plug subsystem (deprecated)
ocf:LVM — Controls the availability of an LVM Volume Group
ocf:lxc — Manages LXC containers
ocf:MailTo — Notifies recipients by email in the event of resource takeover
ocf:ManageRAID — Manages RAID devices
ocf:ManageVE — Manages an OpenVZ Virtual Environment (VE)
ocf:mysql-proxy — Manages a MySQL Proxy instance
ocf:mysql — Manages a MySQL database instance
ocf:named — Manages a named server
ocf:nfsserver — Manages an NFS server
ocf:nginx — Manages an Nginx web/proxy server instance
ocf:oracle — Manages an Oracle Database instance
ocf:oralsnr — Manages an Oracle TNS listener
ocf:pgsql — Manages a PostgreSQL database instance
ocf:pingd — Monitors connectivity to specific hosts or IP addresses ("ping nodes") (deprecated)
ocf:portblock — Block and unblocks access to TCP and UDP ports
ocf:postfix — Manages a highly available Postfix mail server instance
ocf:pound — Manage a Pound instance
ocf:proftpd — OCF Resource Agent compliant FTP script.
ocf:Pure-FTPd — Manages a Pure-FTPd FTP server instance
ocf:Raid1 — Manages Linux software RAID (MD) devices on shared storage
ocf:Route — Manages network routes
ocf:rsyncd — Manages an rsync daemon
ocf:rsyslog — rsyslog resource agent
ocf:scsi2reservation — scsi-2 reservation
ocf:SendArp — Broadcasts unsolicited ARP announcements
ocf:ServeRAID — Enables and disables shared ServeRAID merge groups
ocf:sfex — Manages exclusive access to shared storage using Shared Disk File EXclusiveness (SF-EX)
ocf:slapd — Manages a Stand-alone LDAP Daemon (slapd) instance
ocf:SphinxSearchDaemon — Manages the Sphinx search daemon.
ocf:Squid — Manages a Squid proxy server instance
ocf:Stateful — Example stateful resource agent
ocf:symlink — Manages a symbolic link
ocf:SysInfo — Records various node attributes in the CIB
ocf:syslog-ng — Syslog-ng resource agent
ocf:tomcat — Manages a Tomcat servlet environment instance
ocf:varnish — Manage a Varnish instance
ocf:VIPArip — Manages a virtual IP address through RIP2
ocf:VirtualDomain — Manages virtual domains through the libvirt virtualization framework
ocf:vmware — Manages VMWare Server 2.0 virtual machines
ocf:WAS6 — Manages a WebSphere Application Server 6 instance
ocf:WAS — Manages a WebSphere Application Server instance
ocf:WinPopup — Sends an SMB notification message to selected hosts
ocf:Xen — Manages Xen unprivileged domains (DomUs)
ocf:Xinetd — Manages a service of Xinetd
ocf:zabbixserver — Zabbix server resource agent
V. Appendix
A. Example of Setting Up a Simple Testing Resource
A.1. Configuring a Resource with the GUI
A.2. Configuring a Resource Manually
B. Example Configuration for OCFS2 and cLVM
C. Cluster Management Tools
D. Upgrading Your Cluster to the Latest Product Version
D.1. Upgrading from SLES 10 to SLE HA 11
D.2. Upgrading from SLE HA 11 to SLE HA 11 SP1
D.3. Upgrading from SLE HA 11 SP1 to SLE HA 11 SP2
D.4. Upgrading from SLE HA 11 SP2 to SLE HA 11 SP3
D.5. For More Information
E. What's New?
E.1. Version 10 SP3 to Version 11
E.2. Version 11 to Version 11 SP1
E.3. Version 11 SP1 to Version 11 SP2
E.4. Version 11 SP2 to Version 11 SP3
Terminology
F. GNU Licenses
F.1. GNU Free Documentation License

List of Figures

1.1. Three-Server Cluster
1.2. Three-Server Cluster after One Server Fails
1.3. Typical Fibre Channel Cluster Configuration
1.4. Typical iSCSI Cluster Configuration
1.5. Typical Cluster Configuration Without Shared Storage
1.6. Architecture
3.1. YaST Cluster Module—Overview
3.2. YaST Cluster—Multicast Configuration
3.3. YaST Cluster—Unicast Configuration
3.4. YaST Cluster—Security
3.5. YaST Cluster—Csync2
3.6. YaST Cluster—conntrackd
3.7. YaST Cluster—Services
4.1. Group Resource
5.1. Hawk—Cluster Status (Summary View)
5.2. Hawk—Cluster Diagram
5.3. Hawk—Cluster Configuration
5.4. Hawk—Setup Wizard
5.5. Hawk—Primitive Resource
5.6. Hawk—Resource Template
5.7. Hawk—Location Constraint
5.8. Hawk—Colocation Constraint
5.9. Hawk—Viewing a Node's Capacity Values
5.10. Hawk—Resource Group
5.11. Hawk—Clone Resource
5.12. Viewing a Resource's Details
5.13. Hawk—History Report
5.14. Hawk History Report—Transition Graph
5.15. Hawk—Simulator with Injected Events
5.16. Hawk—Simulator in Final State
5.17. Hawk Cluster Status (Summary View)—Ticket Details
5.18. Hawk—Example Ticket Dependency
5.19. HawkSimulator—Tickets
5.20. Hawk—Cluster Dashboard
6.1. Connecting to the Cluster
6.2. Pacemaker GUI - Main Window
6.3. Pacemaker GUI - Constraints
6.4. Example Configuration for Node Capacity
6.5. Example Configuration for Resource Capacity
6.6. Viewing a Resource's Failcount
6.7. Pacemaker GUI - Groups
6.8. Pacemaker GUI - Management
12.1. YaST IP Load Balancing—Global Parameters
12.2. YaST IP Load Balancing—Virtual Services
13.1. Example Scenario: A Two-Site Cluster (4 Nodes + Arbitrator)
15.1. Position of DRBD within Linux
15.2. Start-up Configuration
15.3. Resource Configuration
16.1. Setup of iSCSI with cLVM
18.1. Structure of a CTDB Cluster

List of Tables

4.1. Options for a Primitive Resource
4.2. Resource Operation Properties
8.1. Failure Recovery Types
8.2. OCF Return Codes
10.1. Types and XPath Expression for an Operator Role
14.1. OCFS2 Utilities
14.2. Important OCFS2 Parameters
15.1. DRBD RPM Packages

List of Examples

4.1. Resource Group for a Web Server
4.2. Migration Threshold—Process Flow
4.3. Example Configuration for Load-Balanced Placing
4.4. Configuring Resources for Nagios Plug-ins
9.1. Testing Configuration
9.2. Testing Configuration
9.3. Testing Configuration
9.4. Configuration of an IBM RSA Lights-out Device
9.5. Configuration of an UPS Fencing Device
10.1. Excerpt of a Cluster Configuration in XML
12.1. Simple ldirectord Configuration
13.1. Example Booth Configuration File
20.1. Stopped Resources
B.1. Cluster Configuration for OCFS2 and cLVM

About This Guide

SUSE® Linux Enterprise High Availability Extension is an integrated suite of open source clustering technologies that enables you to implement highly available physical and virtual Linux clusters. For quick and efficient configuration and administration, the High Availability Extension includes both a graphical user interface (GUI) and a command line interface (CLI). Additionally, it comes with the HA Web Konsole (Hawk), allowing you to administer your Linux cluster also via a Web interface.

This guide is intended for administrators who need to set up, configure, and maintain High Availability (HA) clusters. Both approaches (GUI and CLI) are covered in detail to help the administrators choose the appropriate tool that matches their needs for performing the key tasks.

This guide is divided into the following parts:

Installation and Setup

Before starting to install and configure your cluster, make yourself familiar with cluster fundamentals and architecture, get an overview of the key features and benefits. Learn which hardware and software requirements must be met and what preparations to take before executing the next steps. Perform the installation and basic setup of your HA cluster using YaST.

Configuration and Administration

Add, configure and manage cluster resources, using either the graphical user interface (Pacemaker GUI), the Web interface (HA Web Konsole), or the command line interface (crm shell). To avoid unauthorized access to the cluster configuration, define roles and assign them to certain users for fine-grained control. Learn how to make use of load balancing and fencing or how to set up a multi-site cluster. In case you consider writing your own resource agents or modifying existing ones, get some background information on how to create different types of resource agents.

Storage and Data Replication

SUSE Linux Enterprise High Availability Extension ships with a cluster-aware file system and volume manager: Oracle Cluster File System (OCFS2) and the clustered Logical Volume Manager (cLVM). For replication of your data, use DRBD* (Distributed Replicated Block Device) to mirror the data of a High Availability service from the active node of a cluster to its standby node. Furthermore, a clustered Samba server also provides a High Availability solution for heterogeneous environments.

Troubleshooting and Reference

Managing your own cluster requires you to perform a certain amount of troubleshooting. Learn about the most common problems and how to fix them. Find a comprehensive reference of the OCF agents shipped with this product.

Appendix

Lists the new features and behavior changes of the High Availability Extension since the last release. Learn how to migrate your cluster to the most recent release version and find an example of setting up a simple testing resource.

Many chapters in this manual contain links to additional documentation resources. These include additional documentation that is available on the system as well as documentation available on the Internet.

For an overview of the documentation available for your product and the latest documentation updates, refer to http://www.suse.com/doc/sle_ha.

1. Feedback

Several feedback channels are available:

Bugs and Enhancement Requests

For services and support options available for your product, refer to http://www.suse.com/support/.

To report bugs for a product component, log into the Novell Customer Center from http://www.suse.com/support/ and select My Support+Service Request.

User Comments

We want to hear your comments about and suggestions for this manual and the other documentation included with this product. Use the User Comments feature at the bottom of each page in the online documentation or go to http://www.suse.com/doc/feedback.html and enter your comments there.

Mail

For feedback on the documentation of this product, you can also send a mail to doc-team@suse.de. Make sure to include the document title, the product version, and the publication date of the documentation. To report errors or suggest enhancements, provide a concise description of the problem and refer to the respective section number and page (or URL).

2. Documentation Conventions

The following typographical conventions are used in this manual:

  • /etc/passwd: directory names and filenames

  • placeholder: replace placeholder with the actual value

  • PATH: the environment variable PATH

  • ls, --help: commands, options, and parameters

  • user: users or groups

  • Alt, Alt+F1: a key to press or a key combination; keys are shown in uppercase as on a keyboard

  • File, File+Save As: menu items, buttons

  • ►amd64 em64t: This paragraph is only relevant for the architectures amd64, em64t, and ipf. The arrows mark the beginning and the end of the text block.

  • Dancing Penguins (Chapter Penguins, ↑Another Manual): This is a reference to a chapter in another manual.

3. About the Making of This Manual

This book is written in Novdoc, a subset of DocBook (see http://www.docbook.org). The XML source files were validated by xmllint, processed by xsltproc, and converted into XSL-FO using a customized version of Norman Walsh's stylesheets. The final PDF is formatted through XEP from RenderX.

Part I. Installation and Setup

Chapter 1. Product Overview

Abstract

SUSE® Linux Enterprise High Availability Extension is an integrated suite of open source clustering technologies that enables you to implement highly available physical and virtual Linux clusters, and to eliminate single points of failure. It ensures the high availability and manageability of critical network resources including data, applications, and services. Thus, it helps you maintain business continuity, protect data integrity, and reduce unplanned downtime for your mission-critical Linux workloads.

It ships with essential monitoring, messaging, and cluster resource management functionality (supporting failover, failback, and migration (load balancing) of individually managed cluster resources). The High Availability Extension is available as add-on to SUSE Linux Enterprise Server 11 SP3.

This chapter introduces the main product features and benefits of the High Availability Extension. Inside you will find several example clusters and learn about the components making up a cluster. The last section provides an overview of the architecture, describing the individual architecture layers and processes within the cluster.

For explanations of some common terms used in the context of High Availability clusters, refer to Terminology.

1.1. Key Features

SUSE® Linux Enterprise High Availability Extension helps you ensure and manage the availability of your network resources. The following sections highlight some of the key features:

1.1.1. Wide Range of Clustering Scenarios

The High Availability Extension supports the following scenarios:

  • Active/active configurations

  • Active/passive configurations: N+1, N+M, N to 1, N to M

  • Hybrid physical and virtual clusters, allowing virtual servers to be clustered with physical servers. This improves service availability and resource utilization.

  • Local clusters

  • Metro clusters (stretched local clusters)

  • Multi-site clusters (geographically dispersed clusters)

Your cluster can contain up to 32 Linux servers. Any server in the cluster can restart resources (applications, services, IP addresses, and file systems) from a failed server in the cluster.

1.1.2. Flexibility

The High Availability Extension ships with Corosync/OpenAIS messaging and membership layer and Pacemaker Cluster Resource Manager. Using Pacemaker, administrators can continually monitor the health and status of their resources, manage dependencies, and automatically stop and start services based on highly configurable rules and policies. The High Availability Extension allows you to tailor a cluster to the specific applications and hardware infrastructure that fit your organization. Time-dependent configuration enables services to automatically migrate back to repaired nodes at specified times.

1.1.3. Storage and Data Replication

With the High Availability Extension you can dynamically assign and reassign server storage as needed. It supports Fibre Channel or iSCSI storage area networks (SANs). Shared disk systems are also supported, but they are not a requirement. SUSE Linux Enterprise High Availability Extension also comes with a cluster-aware file system and volume manager: Oracle Cluster File System (OCFS2) and the clustered Logical Volume Manager (cLVM). For replication of your data, you can use DRBD* (Distributed Replicated Block Device) to mirror the data of an High Availability service from the active node of a cluster to its standby node. Furthermore, SUSE Linux Enterprise High Availability Extension also supports CTDB (Clustered Trivial Database), a technology for Samba clustering.

1.1.4. Support for Virtualized Environments

SUSE Linux Enterprise High Availability Extension supports the mixed clustering of both physical and virtual Linux servers. SUSE Linux Enterprise Server 11 SP3 ships with Xen, an open source virtualization hypervisor and with KVM (Kernel-based Virtual Machine), a virtualization software for Linux which is based on hardware virtualization extensions. The cluster resource manager in the High Availability Extension is able to recognize, monitor and manage services running within virtual servers, as well as services running in physical servers. Guest systems can be managed as services by the cluster.

1.1.5. Support of Local, Metro, and Multi-Site Clusters

SUSE Linux Enterprise High Availability Extension has been extended to support different geographical scenarios. Support for multi-site clusters is available as a separate option to SUSE Linux Enterprise High Availability Extension.

Local Clusters

A single cluster in one location (for example, all nodes are located in one data center). The cluster uses multicast or unicast for communication between the nodes and manages failover internally. Network latency can be neglected. Storage is typically accessed synchronously by all nodes.

Metro Clusters

A single cluster that can stretch over multiple buildings or data centers, with all sites connected by fibre channel. The cluster uses multicast or unicast for communication between the nodes and manages failover internally. Network latency is usually low (<5 ms for distances of approximately 20 miles). Storage is frequently replicated (mirroring or synchronous replication).

Multi-Site Clusters (Geo Clusters)

Multiple, geographically dispersed sites with a local cluster each. The sites communicate via IP. Failover across the sites is coordinated by a higher-level entity. Multi-site clusters have to cope with limited network bandwidth and high latency. Storage is replicated asynchronously.

The greater the geographical distance between individual cluster nodes, the more factors may potentially disturb the high availability of services the cluster provides. Network latency, limited bandwidth and access to storage are the main challenges for long-distance clusters.

1.1.6. Resource Agents

SUSE Linux Enterprise High Availability Extension includes a huge number of resource agents to manage resources such as Apache, IPv4, IPv6 and many more. It also ships with resource agents for popular third party applications such as IBM WebSphere Application Server. For a reference of Open Cluster Framework (OCF) resource agents included with your product, refer to Chapter 21, HA OCF Agents.

1.1.7. User-friendly Administration Tools

The High Availability Extension ships with a set of powerful tools for basic installation and setup of your cluster as well as effective configuration and administration:

YaST

A graphical user interface for general system installation and administration. Use it to install the High Availability Extension on top of SUSE Linux Enterprise Server as described in Section 3.3, “Installation as Add-on”. YaST also provides the following modules in the High Availability category to help configure your cluster or individual components:

Pacemaker GUI

Installable graphical user interface for easy configuration and administration of your cluster. Guides you through the creation and configuration of resources and lets you execute management tasks like starting, stopping or migrating resources. For details, refer to Chapter 6, Configuring and Managing Cluster Resources (GUI).

HA Web Konsole (Hawk)

A Web-based user interface with which you can administer your Linux cluster from non-Linux machines. It is also an ideal solution in case your system does not provide a graphical user interface. It guides you through the creation and configuration of resources and lets you execute management tasks like starting, stopping or migrating resources. For details, refer to Chapter 5, Configuring and Managing Cluster Resources (Web Interface).

crm Shell

A powerful unified command line interface to configure resources and execute all monitoring or administration tasks. For details, refer to Chapter 7, Configuring and Managing Cluster Resources (Command Line).

1.2. Benefits

The High Availability Extension allows you to configure up to 32 Linux servers into a high-availability cluster (HA cluster), where resources can be dynamically switched or moved to any server in the cluster. Resources can be configured to automatically migrate in the event of a server failure, or they can be moved manually to troubleshoot hardware or balance the workload.

The High Availability Extension provides high availability from commodity components. Lower costs are obtained through the consolidation of applications and operations onto a cluster. The High Availability Extension also allows you to centrally manage the complete cluster and to adjust resources to meet changing workload requirements (thus, manually load balance the cluster). Allowing clusters of more than two nodes also provides savings by allowing several nodes to share a hot spare.

An equally important benefit is the potential reduction of unplanned service outages as well as planned outages for software and hardware maintenance and upgrades.

Reasons that you would want to implement a cluster include:

  • Increased availability

  • Improved performance

  • Low cost of operation

  • Scalability

  • Disaster recovery

  • Data protection

  • Server consolidation

  • Storage consolidation

Shared disk fault tolerance can be obtained by implementing RAID on the shared disk subsystem.

The following scenario illustrates some of the benefits the High Availability Extension can provide.

Example Cluster Scenario

Suppose you have configured a three-server cluster, with a Web server installed on each of the three servers in the cluster. Each of the servers in the cluster hosts two Web sites. All the data, graphics, and Web page content for each Web site are stored on a shared disk subsystem connected to each of the servers in the cluster. The following figure depicts how this setup might look.

Figure 1.1. Three-Server Cluster

Three-Server Cluster

During normal cluster operation, each server is in constant communication with the other servers in the cluster and performs periodic polling of all registered resources to detect failure.

Suppose Web Server 1 experiences hardware or software problems and the users depending on Web Server 1 for Internet access, e-mail, and information lose their connections. The following figure shows how resources are moved when Web Server 1 fails.

Figure 1.2. Three-Server Cluster after One Server Fails

Three-Server Cluster after One Server Fails

Web Site A moves to Web Server 2 and Web Site B moves to Web Server 3. IP addresses and certificates also move to Web Server 2 and Web Server 3.

When you configured the cluster, you decided where the Web sites hosted on each Web server would go should a failure occur. In the previous example, you configured Web Site A to move to Web Server 2 and Web Site B to move to Web Server 3. This way, the workload once handled by Web Server 1 continues to be available and is evenly distributed between any surviving cluster members.

When Web Server 1 failed, the High Availability Extension software did the following:

  • Detected a failure and verified with STONITH that Web Server 1 was really dead. STONITH is an acronym for Shoot The Other Node In The Head and is a means of bringing down misbehaving nodes to prevent them from causing trouble in the cluster.

  • Remounted the shared data directories that were formerly mounted on Web server 1 on Web Server 2 and Web Server 3.

  • Restarted applications that were running on Web Server 1 on Web Server 2 and Web Server 3.

  • Transferred IP addresses to Web Server 2 and Web Server 3.

In this example, the failover process happened quickly and users regained access to Web site information within seconds, and in most cases, without needing to log in again.

Now suppose the problems with Web Server 1 are resolved, and Web Server 1 is returned to a normal operating state. Web Site A and Web Site B can either automatically fail back (move back) to Web Server 1, or they can stay where they are. This is dependent on how you configured the resources for them. Migrating the services back to Web Server 1 will incur some down-time, so the High Availability Extension also allows you to defer the migration until a period when it will cause little or no service interruption. There are advantages and disadvantages to both alternatives.

The High Availability Extension also provides resource migration capabilities. You can move applications, Web sites, etc. to other servers in your cluster as required for system management.

For example, you could have manually moved Web Site A or Web Site B from Web Server 1 to either of the other servers in the cluster. You might want to do this to upgrade or perform scheduled maintenance on Web Server 1, or just to increase performance or accessibility of the Web sites.

1.3. Cluster Configurations: Storage

Cluster configurations with the High Availability Extension might or might not include a shared disk subsystem. The shared disk subsystem can be connected via high-speed Fibre Channel cards, cables, and switches, or it can be configured to use iSCSI. If a server fails, another designated server in the cluster automatically mounts the shared disk directories that were previously mounted on the failed server. This gives network users continuous access to the directories on the shared disk subsystem.

[Important]Shared Disk Subsystem with cLVM

When using a shared disk subsystem with cLVM, that subsystem must be connected to all servers in the cluster from which it needs to be accessed.

Typical resources might include data, applications, and services. The following figure shows how a typical Fibre Channel cluster configuration might look.

Figure 1.3. Typical Fibre Channel Cluster Configuration

Typical Fibre Channel Cluster Configuration

Although Fibre Channel provides the best performance, you can also configure your cluster to use iSCSI. iSCSI is an alternative to Fibre Channel that can be used to create a low-cost Storage Area Network (SAN). The following figure shows how a typical iSCSI cluster configuration might look.

Figure 1.4. Typical iSCSI Cluster Configuration

Typical iSCSI Cluster Configuration

Although most clusters include a shared disk subsystem, it is also possible to create a cluster without a shared disk subsystem. The following figure shows how a cluster without a shared disk subsystem might look.

Figure 1.5. Typical Cluster Configuration Without Shared Storage

Typical Cluster Configuration Without Shared Storage

1.4. Architecture

This section provides a brief overview of the High Availability Extension architecture. It identifies and provides information on the architectural components, and describes how those components interoperate.

1.4.1. Architecture Layers

The High Availability Extension has a layered architecture. Figure 1.6, “Architecture” illustrates the different layers and their associated components.

Figure 1.6. Architecture

Architecture

1.4.1.1. Messaging and Infrastructure Layer

The primary or first layer is the messaging/infrastructure layer, also known as the Corosync/OpenAIS layer. This layer contains components that send out the messages containing I'm alive signals, as well as other information. The program of the High Availability Extension resides in the messaging/infrastructure layer.

1.4.1.2. Resource Allocation Layer

The next layer is the resource allocation layer. This layer is the most complex, and consists of the following components:

Cluster Resource Manager (CRM)

Every action taken in the resource allocation layer passes through the Cluster Resource Manager. If other components of the resource allocation layer (or components which are in a higher layer) need to communicate, they do so through the local CRM. On every node, the CRM maintains the Cluster Information Base (CIB).

Cluster Information Base (CIB)

The Cluster Information Base is an in-memory XML representation of the entire cluster configuration and current status. It contains definitions of all cluster options, nodes, resources, constraints and the relationship to each other. The CIB also synchronizes updates to all cluster nodes. There is one master CIB in the cluster, maintained by the Designated Coordinator (DC). All other nodes contain a CIB replica.

Designated Coordinator (DC)

One CRM in the cluster is elected as DC. The DC is the only entity in the cluster that can decide that a cluster-wide change needs to be performed, such as fencing a node or moving resources around. The DC is also the node where the master copy of the CIB is kept. All other nodes get their configuration and resource allocation information from the current DC. The DC is elected from all nodes in the cluster after a membership change.

Policy Engine (PE)

Whenever the Designated Coordinator needs to make a cluster-wide change (react to a new CIB), the Policy Engine calculates the next state of the cluster based on the current state and configuration. The PE also produces a transition graph containing a list of (resource) actions and dependencies to achieve the next cluster state. The PE always runs on the DC.

Local Resource Manager (LRM)

The LRM calls the local Resource Agents (see Section 1.4.1.3, “Resource Layer”) on behalf of the CRM. It can thus perform start / stop / monitor operations and report the result to the CRM. It also hides the difference between the supported script standards for Resource Agents (OCF, LSB). The LRM is the authoritative source for all resource-related information on its local node.

1.4.1.3. Resource Layer

The highest layer is the Resource Layer. The Resource Layer includes one or more Resource Agents (RA). Resource Agents are programs (usually shell scripts) that have been written to start, stop, and monitor a certain kind of service (a resource). Resource Agents are called only by the LRM. Third parties can include their own agents in a defined location in the file system and thus provide out-of-the-box cluster integration for their own software.

1.4.2. Process Flow

SUSE Linux Enterprise High Availability Extension uses Pacemaker as CRM. The CRM is implemented as daemon (crmd) that has an instance on each cluster node. Pacemaker centralizes all cluster decision-making by electing one of the crmd instances to act as a master. Should the elected crmd process (or the node it is on) fail, a new one is established.

A CIB, reflecting the cluster’s configuration and current state of all resources in the cluster is kept on each node. The contents of the CIB are automatically kept in sync across the entire cluster.

Many actions performed in the cluster will cause a cluster-wide change. These actions can include things like adding or removing a cluster resource or changing resource constraints. It is important to understand what happens in the cluster when you perform such an action.

For example, suppose you want to add a cluster IP address resource. To do this, you can use one of the command line tools or the GUI to modify the CIB. It is not required to perform the actions on the DC, you can use either tool on any node in the cluster and they will be relayed to the DC. The DC will then replicate the CIB change to all cluster nodes.

Based on the information in the CIB, the PE then computes the ideal state of the cluster and how it should be achieved and feeds a list of instructions to the DC. The DC sends commands via the messaging/infrastructure layer which are received by the crmd peers on other nodes. Each crmd uses its LRM (implemented as lrmd) to perform resource modifications. The lrmd is not cluster-aware and interacts directly with resource agents (scripts).

All peer nodes report the results of their operations back to the DC. Once the DC concludes that all necessary operations are successfully performed in the cluster, the cluster will go back to the idle state and wait for further events. If any operation was not carried out as planned, the PE is invoked again with the new information recorded in the CIB.

In some cases, it may be necessary to power off nodes in order to protect shared data or complete resource recovery. For this Pacemaker comes with a fencing subsystem, stonithd. STONITH is an acronym for Shoot The Other Node In The Head and is usually implemented with a remote power switch. In Pacemaker, STONITH devices are modeled as resources (and configured in the CIB) to enable them to be easily monitored for failure. However, stonithd takes care of understanding the STONITH topology such that its clients simply request a node be fenced and it does the rest.

Chapter 2. System Requirements

Abstract

The following section informs you about system requirements and some prerequisites for SUSE® Linux Enterprise High Availability Extension, including hardware, software, shared disk system, and other essentials.

2.1. Hardware Requirements

The following list specifies hardware requirements for a cluster based on SUSE® Linux Enterprise High Availability Extension. These requirements represent the minimum hardware configuration. Additional hardware might be necessary, depending on how you intend to use your cluster.

  • 1 to 32 Linux servers with software as specified in Section 2.2, “Software Requirements”. The servers do not require identical hardware (memory, disk space, etc.), but they must have the same architecture. Cross-platform clusters are not supported.

  • At least two TCP/IP communication media. Cluster nodes use multicast or unicast for communication so the network equipment must support the communication means you want to use. The communication media should support a data rate of 100 Mbit/s or higher. Preferably, the Ethernet channels should be bonded.

  • Optional: A shared disk subsystem connected to all servers in the cluster from where it needs to be accessed.

  • A STONITH mechanism. STONITH is an acronym for Shoot the other node in the head. A STONITH device is a power switch which the cluster uses to reset nodes that are thought to be dead or behaving in a strange manner. Resetting non-heartbeating nodes is the only reliable way to ensure that no data corruption is performed by nodes that hang and only appear to be dead.

    [Important]No Support Without STONITH

    A cluster without STONITH is not supported.

    For more information, refer to Chapter 9, Fencing and STONITH.

2.2. Software Requirements

Ensure that the following software requirements are met:

  • SUSE® Linux Enterprise Server 11 SP3 with all available online updates installed on all nodes that will be part of the cluster.

  • SUSE Linux Enterprise High Availability Extension 11 SP3 including all available online updates installed on all nodes that will be part of the cluster.

2.3. Shared Disk System Requirements

A shared disk system (Storage Area Network, or SAN) is recommended for your cluster if you want data to be highly available. If a shared disk subsystem is used, ensure the following:

  • The shared disk system is properly set up and functional according to the manufacturer’s instructions.

  • The disks contained in the shared disk system should be configured to use mirroring or RAID to add fault tolerance to the shared disk system. Hardware-based RAID is recommended. Host-based software RAID is not supported for all configurations.

  • If you are using iSCSI for shared disk system access, ensure that you have properly configured iSCSI initiators and targets.

  • When using DRBD* to implement a mirroring RAID system that distributes data across two machines, make sure to only access the device provided by DRBD, and never the backing device. Use the same (bonded) NICs that the rest of the cluster uses to leverage the redundancy provided there.

2.4. Other Requirements

Time Synchronization

Cluster nodes should synchronize to an NTP server outside the cluster. For more information, see the SUSE Linux Enterprise Server Administration Guide, available at http://www.suse.com/doc/sles11. Refer to the chapter Time Synchronization with NTP.

If nodes are not synchronized, log files or cluster reports are very hard to analyze.

NIC Names

Must be identical on all nodes.

Hostname and IP Address

Configure hostname resolution by editing the /etc/hosts file on each server in the cluster. To ensure that cluster communication is not slowed down or tampered with by any DNS:

  • Use static IP addresses.

  • List all cluster nodes in this file with their fully qualified hostname and short hostname. It is essential that members of the cluster are able to find each other by name. If the names are not available, internal cluster communication will fail.

For more information, see the SUSE Linux Enterprise Server Administration Guide, available at http://www.suse.com/doc. Refer to chapter Basic Networking > Configuring Hostname and DNS.

SSH

All cluster nodes must be able to access each other via SSH. Tools like hb_report (for troubleshooting) and the history explorer require passwordless SSH access between the nodes, otherwise they can only collect data from the current node.

[Note]Regulatory Requirements

If passwordless SSH access does not comply with regulatory requirements, you can use the following work-around for hb_report:

Create a user that can log in without a password (for example, using public key authentication). Configure sudo for this user so it does not require a root password. Start hb_report from command line with the -u option to specify the user's name. For more information, see the hb_report man page.

For the history explorer there is currently no alternative for passwordless login.

Chapter 3. Installation and Basic Setup

Abstract

This chapter describes how to install and set up SUSE® Linux Enterprise High Availability Extension 11 SP3 from scratch. Choose between an automatic setup which allows you to have a cluster up and running within a few minutes (with the choice to adjust any options later on) or decide for a manual setup, allowing you to set your individual options right at the beginning.

Refer to chapter Appendix D, Upgrading Your Cluster to the Latest Product Version if you want to migrate an existing cluster that runs an older version of SUSE Linux Enterprise High Availability Extension or if you want to update any software packages on nodes that are part of a running cluster.

3.1. Definition of Terms

Existing Cluster

The term existing cluster is used to refer to any cluster that consists of at least one node. Existing clusters have a basic Corosync configuration that defines the communication channels, but they do not necessarily have resource configuration yet.

Multicast

A technology used for a one-to-many communication within a network that can be used for cluster communication. Corosync supports both multicast and unicast. If multicast does not comply with your corporate IT policy, use unicast instead.

[Note]Switches and Multicast

If you want to use multicast for cluster communication, make sure your switches support multicast.

Multicast Address (mcastaddr)

IP address to be used for multicasting by the Corosync executive. The IP address can either be IPv4 or IPv6. If IPv6 networking is used, node IDs must be specified. You can use any multicast address in your private network.

Multicast Port (mcastport)

The port to use for cluster communication. Corosync uses two ports: the specified mcastport for receiving multicast, and mcastport -1 for sending multicast.

Unicast

A technology for sending messages to a single network destination. Corosync supports both multicast and unicast. In Corosync, unicast is implemented as UDP-unicast (UDPU).

Bind Network Address (bindnetaddr)

The network address the Corosync executive should bind to. To ease sharing configuration files across the cluster, OpenAIS uses network interface netmask to mask only the address bits that are used for routing the network. For example, if the local interface is 192.168.5.92 with netmask 255.255.255.0, set bindnetaddr to 192.168.5.0. If the local interface is 192.168.5.92 with netmask 255.255.255.192, set bindnetaddr to 192.168.5.64.

[Note]Network Address for All Nodes

As the same Corosync configuration will be used on all nodes, make sure to use a network address as bindnetaddr, not the address of a specific network interface.

Redundant Ring Protocol (RRP)

Allows the use of multiple redundant local area networks for resilience against partial or total network faults. This way, cluster communication can still be kept up as long as a single network is operational. Corosync supports the Totem Redundant Ring Protocol. A logical token-passing ring is imposed on all participating nodes to deliver messages in a reliable and sorted manner. A node is allowed to broadcast a message only if it holds the token. For more information, refer to http://www.rcsc.de/pdf/icdcs02.pdf.

When having defined redundant communication channels in Corosync, use RRP to tell the cluster how to use these interfaces. RRP can have three modes (rrp_mode):

  • If set to active, Corosync uses both interfaces actively.

  • If set to passive, Corosync sends messages alternatively over the available networks.

  • If set to none, RRP is disabled.

Csync2

A synchronization tool that can be used to replicate configuration files across all nodes in the cluster. Csync2 can handle any number of hosts, sorted into synchronization groups. Each synchronization group has its own list of member hosts and its include/exclude patterns that define which files should be synchronized in the synchronization group. The groups, the hostnames belonging to each group, and the include/exclude rules for each group are specified in the Csync2 configuration file, /etc/csync2/csync2.cfg.

For authentication, Csync2 uses the IP addresses and pre-shared keys within a synchronization group. You need to generate one key file for each synchronization group and copy it to all group members.

For more information about Csync2, refer to http://oss.linbit.com/csync2/paper.pdf

conntrack Tools

Allow interaction with the in-kernel connection tracking system for enabling stateful packet inspection for iptables. Used by the High Availability Extension to synchronize the connection status between cluster nodes. For detailed information, refer to http://conntrack-tools.netfilter.org/.

AutoYaST

AutoYaST is a system for installing one or more SUSE Linux Enterprise systems automatically and without user intervention. On SUSE Linux Enterprise you can create an AutoYaST profile that contains installation and configuration data. The profile tells AutoYaST what to install and how to configure the installed system to get a ready-to-use system in the end. This profile can then be used for mass deployment in different ways (for example, to clone existing cluster nodes).

For detailed instructions on how to use AutoYaST in various scenarios, see the SUSE Linux Enterprise 11 SP3 Deployment Guide, available at http://www.suse.com/doc. Refer to chapter Automated Installation.

3.2. Overview

The following basic steps are needed for installation and initial cluster setup.

  1. Installation as Add-on:

    Install the software packages with YaST. Alternatively, you can install them from the command line with zypper:

    zypper in -t pattern ha_sles
  2. Initial Cluster Setup:

    After installing the software on all nodes that will be part of your cluster, the following steps are needed to initially configure the cluster.

    1. Defining the Communication Channels

    2. Optional: Defining Authentication Settings

    3. Transferring the Configuration to All Nodes. Whereas the configuration of Csync2 is done on one node only, the services Csync2 and xinetd need to be started on all nodes.

    4. Optional: Synchronizing Connection Status Between Cluster Nodes

    5. Configuring Services

    6. Bringing the Cluster Online. The OpenAIS/Corosync service needs to be started on all nodes.

The cluster setup steps can either be executed automatically (with bootstrap scripts) or manually (with the YaST cluster module or from command line).

You can also use a combination of both setup methods, for example: set up one node with YaST cluster and then use sleha-join to integrate more nodes.

Existing nodes can also be cloned for mass deployment with AutoYaST. The cloned nodes will have the same packages installed and the same system configuration. For details, refer to Section 3.6, “Mass Deployment with AutoYaST”.

3.3. Installation as Add-on

The packages needed for configuring and managing a cluster with the High Availability Extension are included in the High Availability installation pattern. This pattern is only available after SUSE Linux Enterprise High Availability Extension has been installed as add-on to SUSE Linux Enterprise Server. For information on how to install add-on products, see the SUSE Linux Enterprise 11 SP3 Deployment Guide, available at http://www.suse.com/doc/sles11. Refer to chapter Installing Add-On Products.

Procedure 3.1. Installing the High Availability Pattern

  1. Start YaST as root user and select Software+Software Management.

    Alternatively, start the YaST package manager as root on a command line with yast2 sw_single.

  2. From the Filter list, select Patterns and activate the High Availability pattern in the pattern list.

  3. Click Accept to start installing the packages.

    [Note]

    The software packages needed for High Availability clusters are not automatically copied to the cluster nodes.

  4. Install the High Availability pattern on all machines that will be part of your cluster.

    If you do not want to install SUSE® Linux Enterprise Server 11 SP3 and SUSE Linux Enterprise High Availability Extension 11 SP3 manually on all nodes that will be part of your cluster, use AutoYaST to clone existing nodes. For more information, refer to Section 3.6, “Mass Deployment with AutoYaST”.

3.4. Automatic Cluster Setup (sleha-bootstrap)

The sleha-bootstrap package provides everything you need to get a one-node cluster up and running, to make other nodes join, and to remove nodes from an existing cluster:

Automatically Setting Up the First Node

With sleha-init, define the basic parameters needed for cluster communication and (optionally) set up a STONITH mechanism to protect your shared storage. This leaves you with a running one-node cluster.

Adding Nodes to an Existing Cluster

With sleha-join, add more nodes to your cluster.

Removing Nodes From An Existing Cluster

With sleha-remove, remove nodes from your cluster.

All commands execute bootstrap scripts that require only a minimum of time and manual intervention. Any options set during the bootstrap process can be modified later with the YaST cluster module.

Before starting the automatic setup, make sure that the following prerequisites are fulfilled on all nodes that will participate in the cluster:

Prerequisites

Procedure 3.2. Automatically Setting Up the First Node

The sleha-init command checks for configuration of NTP and guides you through configuration of the cluster communication layer (Corosync), and (optionally) through the configuration of SBD to protect your shared storage. Follow the steps below. For details, refer to the sleha-init man page.

  1. Log in as root to the physical or virtual machine you want to use as cluster node.

  2. Start the bootstrap script by executing

    sleha-init

    If NTP has not been configured to start at boot time, a message appears.

    If you decide to continue anyway, the script will automatically generate keys for SSH access and for the Csync2 synchronization tool and start the services needed for both.

  3. To configure the cluster communication layer (Corosync):

    1. Enter a network address to bind to. By default, the script will propose the network address of eth0. Alternatively, enter a different network address, for example the address of bond0.

    2. Enter a multicast address. The script proposes a random address that you can use as default.

    3. Enter a multicast port. The script proposes 5405 as default.

  4. To configure SBD (optional), enter a persistent path to the partition of your block device that you want to use for SBD. The path must be consistent across all nodes in the cluster.

    Finally, the script will start the OpenAIS service to bring the one-node cluster online and enable the Web management interface Hawk. The URL to use for Hawk is displayed on the screen.

  5. For any details of the setup process, check /var/log/sleha-bootstrap.log.

You now have a running one-node cluster. If you want to check the cluster status or start managing resources, proceed by logging in to one of the user interfaces, Hawk or the Pacemaker GUI. For more information, refer to Chapter 5, Configuring and Managing Cluster Resources (Web Interface) and Chapter 6, Configuring and Managing Cluster Resources (GUI).

[Important]Secure Password

The bootstrap procedure creates a linux user named hacluster with the password linux. You need it for logging in to the Pacemaker GUI or Hawk. Replace the default password with a secure one as soon as possible:

passwd hacluster

Procedure 3.3. Adding Nodes to an Existing Cluster

If you have a cluster up and running (with one or more nodes), add more cluster nodes with the sleha-join bootstrap script. The script only needs access to an existing cluster node and will complete the basic setup on the current machine automatically. Follow the steps below. For details, refer to the sleha-join man page.

If you have configured the existing cluster nodes with the YaST cluster module, make sure the following prerequisites are fulfilled before you run sleha-join:

If you are logged in to the first node via Hawk, you can follow the changes in cluster status and view the resources being activated in the Web interface.

  1. Log in as root to the physical or virtual machine supposed to join the cluster.

  2. Start the bootstrap script by executing:

    sleha-join

    If NTP has not been configured to start at boot time, a message appears.

  3. If you decide to continue anyway, you will be prompted for the IP address of an existing node. Enter the IP address.

  4. If you have not already configured a passwordless SSH access between both machines, you will also be prompted for the root password of the existing node.

    After logging in to the specified node, the script will copy the Corosync configuration, configure SSH and Csync2, and will bring the current machine online as new cluster node. Apart from that, it will start the service needed for Hawk. If you have configured shared storage with OCFS2, it will also automatically create the mountpoint directory for the OCFS2 file system.

  5. Repeat the steps above for all machines you want to add to the cluster.

  6. For details of the process, check /var/log/sleha-bootstrap.log.

[Important]Check no-quorum-policy

After adding all nodes, check if you need to adjust the no-quorum-policy in the global cluster options. This is especially important for two-node clusters. For more information, refer to Section 4.1.1, “Option no-quorum-policy.

Procedure 3.4. Removing Nodes From An Existing Cluster

If you have a cluster up and running (with at least two nodes), you can remove single nodes from the cluster with the sleha-remove bootstrap script. You need to know the IP address or hostname of the node you want to remove from the cluster. Follow the steps below. For details, refer to the sleha-remove man page.

  1. Log in as root to one of the cluster nodes.

  2. Start the bootstrap script by executing:

    sleha-remove -c IP_ADDR_OR_HOSTNAME

    The script enables the sshd, stops the OpenAIS service on the specified node, and propagates the files to synchronize with Csync2 across the remaining nodes.

    If you specified a hostname and the node to remove cannot be contacted (or the hostname cannot be resolved), the script will inform you and ask if the node should be removed anyway. If you specified an IP address and the node cannot be contacted, you will be asked to enter the hostname and to confirm whether to remove the node anyway.

  3. To remove more nodes, repeat the step above.

  4. For details of the process, check /var/log/sleha-bootstrap.log.

If you need to re-add the removed node at a later point in time, add it with sleha-join. For details, refer to Procedure 3.3, “Adding Nodes to an Existing Cluster”.

3.5. Manual Cluster Setup (YaST)

See Section 3.2, “Overview” for an overview of all steps for initial setup.

3.5.1. YaST Cluster Module

The following sections guide you through each of the setup steps, using the YaST cluster module. To access it, start YaST as root and select High Availability+Cluster. Alternatively, start the module from command line with yast2 cluster.

If you start the cluster module for the first time, it appears as wizard, guiding you through all the steps necessary for basic setup. Otherwise, click the categories on the left panel to access the configuration options for each step.

Figure 3.1. YaST Cluster Module—Overview

YaST Cluster Module—Overview

The YaST cluster module automatically opens the ports in the firewall that are needed for cluster communication on the current machine. The configuration is written to /etc/sysconfig/SuSEfirewall2.d/services/cluster.

Note that some options in the YaST cluster module apply only to the current node, whereas others may automatically be transferred to all nodes. Find detailed information about this in the following sections.

3.5.2. Defining the Communication Channels

For successful communication between the cluster nodes, define at least one communication channel.

[Important]Redundant Communication Paths

However, it is highly recommended to set up cluster communication via two or more redundant paths. This can be done via:

If possible, choose network device bonding.

Procedure 3.5. Defining the First Communication Channel

For communication between the cluster nodes, use either multicast (UDP) or unicast (UDPU).

  1. In the YaST cluster module, switch to the Communication Channels category.

  2. To use multicast:

    1. Set the Transport protocol to UDP.

    2. Define the Bind Network Address. Set the value to the subnet you will use for cluster multicast.

    3. Define the Multicast Address.

    4. Define the Multicast Port.

      Wit the values entered above, you have now defined one communication channel for the cluster. In multicast mode, the same bindnetaddr, mcastaddr, and mcastport will be used for all cluster nodes. All nodes in the cluster will know each other by using the same multicast address. For different clusters, use different multicast addresses.

      Figure 3.2. YaST Cluster—Multicast Configuration

      YaST Cluster—Multicast Configuration

  3. To use unicast:

    1. Set the Transport protocol to UDPU.

    2. Define the Bind Network Address. Set the value to the subnet you will use for cluster unicast.

    3. Define the Multicast Port.

    4. For unicast communication, Corosync needs to know the IP addresses of all nodes in the cluster. For each node that will be part of the cluster, click Add and enter its IP address. To modify or remove any addresses of cluster members, use the Edit or Del buttons.

      Figure 3.3. YaST Cluster—Unicast Configuration

      YaST Cluster—Unicast Configuration

  4. Activate Auto Generate Node ID to automatically generate a unique ID for every cluster node.

  5. If you modified any options for an existing cluster, confirm your changes and close the cluster module. YaST writes the configuration to /etc/corosync/corosync.conf.

  6. If needed, define a second communication channel as described below. Or click Next and proceed with Procedure 3.7, “Enabling Secure Authentication”.

Procedure 3.6. Defining a Redundant Communication Channel

If network device bonding cannot be used for any reason, the second best choice is to define a redundant communication channel (a second ring) in Corosync. That way, two physically separate networks can be used for communication. In case one network fails, the cluster nodes can still communicate via the other network.

[Important]Redundant Rings and /etc/hosts

If multiple rings are configured, each node can have multiple IP addresses. This needs to be reflected in the /etc/hosts file of all nodes.

  1. In the YaST cluster module, switch to the Communication Channels category.

  2. Activate Redundant Channel. The redundant channel must use the same protocol as the first communication channel you defined.

  3. If you use multicast, define the Bind Network Address, the Multicast Address and the Multicast Port for the redundant channel.

    If you use unicast, define the Bind Network Address, the Multicast Port and enter the IP addresses of all nodes that will be part of the cluster.

    Now you have defined an additional communication channel in Corosync that will form a second token-passing ring. In /etc/corosync/corosync.conf, the primary ring (the first channel you have configured) gets the ringnumber 0, the second ring (redundant channel) the ringnumber 1.

  4. To tell Corosync how and when to use the different channels, select the rrp_mode you want to use (active or passive). For more information about the modes, refer to Redundant Ring Protocol (RRP) or click Help. As soon as RRP is used, the Stream Control Transmission Protocol (SCTP) is used for communication between the nodes (instead of TCP). The High Availability Extension monitors the status of the current rings and automatically re-enables redundant rings after faults. Alternatively, you can also check the ring status manually with corosync-cfgtool. View the available options with -h.

    If only one communication channel is defined, rrp_mode is automatically disabled (value none).

  5. If you modified any options for an existing cluster, confirm your changes and close the cluster module. YaST writes the configuration to /etc/corosync/corosync.conf.

  6. For further cluster configuration, click Next and proceed with Section 3.5.3, “Defining Authentication Settings”.

Find an example file for a UDP setup in /etc/corosync/corosync.conf.example. An example for UDPU setup is available in /etc/corosync/corosync.conf.example.udpu.

3.5.3. Defining Authentication Settings

The next step is to define the authentication settings for the cluster. You can use HMAC/SHA1 authentication that requires a shared secret used to protect and authenticate messages. The authentication key (password) you specify will be used on all nodes in the cluster.

Procedure 3.7. Enabling Secure Authentication

  1. In the YaST cluster module, switch to the Security category.

  2. Activate Enable Security Auth.

  3. For a newly created cluster, click Generate Auth Key File. An authentication key is created and written to /etc/corosync/authkey.

    Figure 3.4. YaST Cluster—Security

    YaST Cluster—Security

    If you want the current machine to join an existing cluster, do not generate a new key file. Instead, copy the /etc/corosync/authkey from one of the nodes to the current machine (either manually or with Csync2).

  4. If you modified any options for an existing cluster, confirm your changes and close the cluster module. YaST writes the configuration to /etc/corosync/corosync.conf.

  5. For further cluster configuration, click Next and proceed with Section 3.5.4, “Transferring the Configuration to All Nodes”.

3.5.4. Transferring the Configuration to All Nodes

Instead of copying the resulting configuration files to all nodes manually, use the csync2 tool for replication across all nodes in the cluster.

This requires the following basic steps:

Procedure 3.8. Configuring Csync2 with YaST

  1. In the YaST cluster module, switch to the Csync2 category.

  2. To specify the synchronization group, click Add in the Sync Host group and enter the local hostnames of all nodes in your cluster. For each node, you must use exactly the strings that are returned by the hostname command.

  3. Click Generate Pre-Shared-Keys to create a key file for the synchronization group. The key file is written to /etc/csync2/key_hagroup. After it has been created, it must be copied manually to all members of the cluster.

  4. To populate the Sync File list with the files that usually need to be synchronized among all nodes, click Add Suggested Files.

    Figure 3.5. YaST Cluster—Csync2

    YaST Cluster—Csync2

  5. If you want to Edit, Add or Remove files from the list of files to be synchronized use the respective buttons. You must enter the absolute pathname for each file.

  6. Activate Csync2 by clicking Turn Csync2 ON. This will execute chkconfig csync2 to start Csync2 automatically at boot time.

  7. If you modified any options for an existing cluster, confirm your changes and close the cluster module. YaST then writes the Csync2 configuration to /etc/csync2/csync2.cfg. To start the synchronization process now, proceed with Procedure 3.9, “Synchronizing the Configuration Files with Csync2”.

  8. For further cluster configuration, click Next and proceed with Section 3.5.5, “Synchronizing Connection Status Between Cluster Nodes”.

Procedure 3.9. Synchronizing the Configuration Files with Csync2

To successfully synchronize the files with Csync2, make sure that the following prerequisites are met:

  • The same Csync2 configuration is available on all nodes. Copy the file /etc/csync2/csync2.cfg manually to all nodes after you have configured it as described in Procedure 3.8, “Configuring Csync2 with YaST”. It is recommended to include this file in the list of files to be synchronized with Csync2.

  • Copy the /etc/csync2/key_hagroup file you have generated on one node in Step 3 to all nodes in the cluster as it is needed for authentication by Csync2. However, do not regenerate the file on the other nodes as it needs to be the same file on all nodes.

  • Both Csync2 and xinetd must be running on all nodes.

    [Note]Starting Services at Boot Time

    Execute the following commands on all nodes to make both services start automatically at boot time and to start xinetd now:

    chkconfig csync2 on
    chkconfig xinetd on
    rcxinetd start
  1. On the node that you want to copy the configuration from, execute the following command:

    csync2 -xv

    This will synchronize all the files once by pushing them to the other nodes. If all files are synchronized successfully, Csync2 will finish with no errors.

    If one or several files that are to be synchronized have been modified on other nodes (not only on the current one), Csync2 will report a conflict. You will get an output similar to the one below:

    While syncing file /etc/corosync/corosync.conf:
    ERROR from peer hex-14: File is also marked dirty here!
    Finished with 1 errors.
  2. If you are sure that the file version on the current node is the best one, you can resolve the conflict by forcing this file and resynchronizing:

    csync2 -f /etc/corosync/corosync.conf
    csync2 -x

For more information on the Csync2 options, run csync2 -help.

[Note]Pushing Synchronization After Any Changes

Csync2 only pushes changes. It does not continuously synchronize files between the nodes.

Each time you update files that need to be synchronized, you have to push the changes to the other nodes: Run csync2 -xv on the node where you did the changes. If you run the command on any of the other nodes with unchanged files, nothing will happen.

3.5.5. Synchronizing Connection Status Between Cluster Nodes

To enable stateful packet inspection for iptables, configure and use the conntrack tools with the following basic steps:

  1. Configuring the conntrackd with YaST.

  2. Configuring a resource for conntrackd (class: ocf, provider: heartbeat). If you use Hawk to add the resource, use the default values proposed by Hawk.

After configuring the conntrack tools, you can use them for Load Balancing with Linux Virtual Server.

Procedure 3.10. Configuring the conntrackd with YaST

Use the YaST cluster module to configure the user-space conntrackd. It needs a dedicated network interface that is not used for other communication channels. The daemon can be started via a resource agent afterward.

  1. In the YaST cluster module, switch to the Configure conntrackd category.

  2. Select a Dedicated Interface for synchronizing the connection status. The IPv4 address of the selected interface is automatically detected and shown in YaST. It must already be configured and it must support multicast.

  3. Define the Multicast Address to be used for synchronizing the connection status.

  4. In Group Number, define a numeric ID for the group to synchronize the connection status to.

  5. Click Generate /etc/conntrackd/conntrackd.conf to create the configuration file for conntrackd.

  6. If you modified any options for an existing cluster, confirm your changes and close the cluster module.

  7. For further cluster configuration, click Next and proceed with Section 3.5.6, “Configuring Services”.

Figure 3.6. YaST Cluster—conntrackd

YaST Cluster—conntrackd

3.5.6. Configuring Services

In the YaST cluster module define whether to start certain services on a node at boot time. You can also use the module to start and stop the services manually. To bring the cluster nodes online and start the cluster resource manager, OpenAIS must be running as a service.

Procedure 3.11. Enabling OpenAIS and mgmtd

  1. In the YaST cluster module, switch to the Service category.

  2. To start OpenAIS each time this cluster node is booted, select the respective option in the Booting group. If you select Off in the Booting group, you must start OpenAIS manually each time this node is booted. To start OpenAIS manually, use the rcopenais start command.

  3. If you want to use the Pacemaker GUI for configuring, managing and monitoring cluster resources, activate Enable mgmtd. This daemon is needed for the GUI.

  4. To start or stop OpenAIS immediately, click the respective button.

  5. If you modified any options for an existing cluster node, confirm your changes and close the cluster module. Note that the configuration only applies to the current machine, not to all cluster nodes.

    If you have done the initial cluster setup exclusively with the YaST cluster module, you have now completed the basic configuration steps. Proceed with Section 3.5.7, “Bringing the Cluster Online”.

    Figure 3.7. YaST Cluster—Services

    YaST Cluster—Services

3.5.7. Bringing the Cluster Online

After the initial cluster configuration is done, start the OpenAIS/Corosync service on each cluster node to bring the stack online:

Procedure 3.12. Starting OpenAIS/Corosync and Checking the Status

  1. Log in to an existing node.

  2. Check if the service is already running:

    rcopenais status

    If not, start OpenAIS/Corosync now:

    rcopenais start
  3. Repeat the steps above for each of the cluster nodes.

  4. On one of the nodes, check the cluster status with the following command:

    crm_mon

    If all nodes are online, the output should be similar to the following:

    Last updated: Tue Mar 12 10:40:39 2013
    Last change: Mon Mar 11 17:57:24 2013 by hacluster via cibadmin on barett-vm1
    Stack: classic openais (with plugin)
    Current DC: barett-vm1 - partition with quorum
    Version: 1.1.8-5b6364d
    2 Nodes configured, 2 expected votes
    0 Resources configured.
    
    Online: [ barett-vm1 barett-vm2 ]

    This output indicates that the cluster resource manager is started and is ready to manage resources.

After the basic configuration is done and the nodes are online, you can start to configure cluster resources, using one of the cluster management tools like the crm shell, the Pacemaker GUI, or the HA Web Konsole. For more information, refer to the following chapters.

3.6. Mass Deployment with AutoYaST

The following procedure is suitable for deploying cluster nodes which are clones of an already existing node. The cloned nodes will have the same packages installed and the same system configuration.

Procedure 3.13. Cloning a Cluster Node with AutoYaST

[Important]Identical Hardware

This scenario assumes you are rolling out SUSE Linux Enterprise High Availability Extension 11 SP3 to a set of machines with exactly the same hardware configuration.

If you need to deploy cluster nodes on non-identical hardware, refer to the Rule-Based Autoinstallation section in the SUSE Linux Enterprise 11 SP3 Deployment Guide, available at http://www.suse.com/doc.

  1. Make sure the node you want to clone is correctly installed and configured. For details, refer to Section 3.3, “Installation as Add-on”, and Section 3.4, “Automatic Cluster Setup (sleha-bootstrap)” or Section 3.5, “Manual Cluster Setup (YaST)”, respectively.

  2. Follow the description outlined in the SUSE Linux Enterprise 11 SP3 Deployment Guide for simple mass installation. This includes the following basic steps:

    1. Creating an AutoYaST profile. Use the AutoYaST GUI to create and modify a profile based on the existing system configuration. In AutoYaST, choose the High Availability module and click the Clone button. If needed, adjust the configuration in the other modules and save the resulting control file as XML.

    2. Determining the source of the AutoYaST profile and the parameter to pass to the installation routines for the other nodes.

    3. Determining the source of the SUSE Linux Enterprise Server and SUSE Linux Enterprise High Availability Extension installation data.

    4. Determining and setting up the boot scenario for autoinstallation.

    5. Passing the command line to the installation routines, either by adding the parameters manually or by creating an info file.

    6. Starting and monitoring the autoinstallation process.

After the clone has been successfully installed, execute the following steps to make the cloned node join the cluster:

Procedure 3.14. Bringing the Cloned Node Online

  1. Transfer the key configuration files from the already configured nodes to the cloned node with Csync2 as described in Section 3.5.4, “Transferring the Configuration to All Nodes”.

  2. To bring the node online, start the OpenAIS service on the cloned node as described in Section 3.5.7, “Bringing the Cluster Online”.

The cloned node will now join the cluster because the /etc/corosync/corosync.conf file has been applied to the cloned node via Csync2. The CIB is automatically synchronized among the cluster nodes.

Part II. Configuration and Administration

Contents

4. Configuration and Administration Basics
4.1. Global Cluster Options
4.2. Cluster Resources
4.3. Resource Monitoring
4.4. Monitoring System Health
4.5. Resource Constraints
4.6. For More Information
5. Configuring and Managing Cluster Resources (Web Interface)
5.1. Hawk—Overview
5.2. Configuring Global Cluster Options
5.3. Configuring Cluster Resources
5.4. Managing Cluster Resources
5.5. Multi-Site Clusters (Geo Clusters)
5.6. Monitoring Multiple Clusters
5.7. Troubleshooting
6. Configuring and Managing Cluster Resources (GUI)
6.1. Pacemaker GUI—Overview
6.2. Configuring Global Cluster Options
6.3. Configuring Cluster Resources
6.4. Managing Cluster Resources
7. Configuring and Managing Cluster Resources (Command Line)
7.1. crm Shell—Overview
7.2. Configuring Global Cluster Options
7.3. Configuring Cluster Resources
7.4. Managing Cluster Resources
7.5. Setting Passwords Independent of cib.xml
7.6. Retrieving History Information
7.7. For More Information
8. Adding or Modifying Resource Agents
8.1. STONITH Agents
8.2. Writing OCF Resource Agents
8.3. OCF Return Codes and Failure Recovery
9. Fencing and STONITH
9.1. Classes of Fencing
9.2. Node Level Fencing
9.3. STONITH Configuration
9.4. Monitoring Fencing Devices
9.5. Special Fencing Devices
9.6. Basic Recommendations
9.7. For More Information
10. Access Control Lists
10.1. Requirements and Prerequisites
10.2. The Basics of ACLs
10.3. Configuring ACLs with the Pacemaker GUI
10.4. Configuring ACLs with the crm Shell
10.5. For More Information
11. Network Device Bonding
11.1. Configuring Bonding Devices with YaST
11.2. Hotplugging of Bonding Slaves
11.3. For More Information
12. Load Balancing with Linux Virtual Server
12.1. Conceptual Overview
12.2. Configuring IP Load Balancing with YaST
12.3. Further Setup
12.4. For More Information
13. Multi-Site Clusters (Geo Clusters)
13.1. Challenges for Multi-Site Clusters
13.2. Conceptual Overview
13.3. Requirements
13.4. Basic Setup
13.5. Managing Multi-Site Clusters
13.6. Troubleshooting

Chapter 4. Configuration and Administration Basics

Abstract

The main purpose of an HA cluster is to manage user services. Typical examples of user services are an Apache web server or a database. From the user's point of view, the services do something specific when ordered to do so. To the cluster, however, they are just resources which may be started or stopped—the nature of the service is irrelevant to the cluster.

In this chapter, we will introduce some basic concepts you need to know when configuring resources and administering your cluster. The following chapters show you how to execute the main configuration and administration tasks with each of the management tools the High Availability Extension provides.

4.1. Global Cluster Options

Global cluster options control how the cluster behaves when confronted with certain situations. They are grouped into sets and can be viewed and modified with the cluster management tools like Pacemaker GUI and the crm shell. The predefined values can be kept in most cases. However, to make key functions of your cluster work correctly, you need to adjust the following parameters after basic cluster setup:

Learn how to adjust those parameters with the cluster management tools of your choice:

4.1.1. Option no-quorum-policy

This global option defines what to do when the cluster does not have quorum (no majority of nodes is part of the partition).

Allowed values are:

ignore

The quorum state does not influence the cluster behavior at all, resource management is continued.

This setting is useful for the following scenarios:

  • Two-node clusters: Since a single node failure would always result in a loss of majority, usually you want the cluster to carry on regardless. Resource integrity is ensured using fencing, which also prevents split brain scenarios.

  • Resource-driven clusters: For local clusters with redundant communication channels, a split brain scenario only has a certain probability. Thus, a loss of communication with a node most likely indicates that the node has crashed, and that the surviving nodes should recover and start serving the resources again.

    If no-quorum-policy is set to ignore, a 4-node cluster can sustain concurrent failure of three nodes before service is lost, whereas with the other settings, it would lose quorum after concurrent failure of two nodes.

freeze

If quorum is lost, the cluster freezes. Resource management is continued: running resources are not stopped (but possibly restarted in response to monitor events), but no further resources are started within the affected partition.

This setting is recommended for clusters where certain resources depend on communication with other nodes (for example, OCFS2 mounts). In this case, the default setting no-quorum-policy=stop is not useful, as it would lead to the following scenario: Stopping those resources would not be possible while the peer nodes are unreachable. Instead, an attempt to stop them would eventually time out and cause a stop failure, triggering escalated recovery and fencing.

stop (default value)

If quorum is lost, all resources in the affected cluster partition are stopped in an orderly fashion.

suicide

Fence all nodes in the affected cluster partition.

4.1.2. Option stonith-enabled

This global option defines if to apply fencing, allowing STONITH devices to shoot failed nodes and nodes with resources that cannot be stopped. By default, this global option is set to true, because for normal cluster operation it is necessary to use STONITH devices. According to the default value, the cluster will refuse to start any resources if no STONITH resources have been defined.

If you need to disable fencing for any reasons, set stonith-enabled to false.

[Important]No Support Without STONITH

A cluster without STONITH is not supported.

For an overview of all global cluster options and their default values, see Pacemaker Explained, available from http://www.clusterlabs.org/doc/ . Refer to section Available Cluster Options.

4.2. Cluster Resources

As a cluster administrator, you need to create cluster resources for every resource or application you run on servers in your cluster. Cluster resources can include Web sites, e-mail servers, databases, file systems, virtual machines, and any other server-based applications or services you want to make available to users at all times.

4.2.1. Resource Management

Before you can use a resource in the cluster, it must be set up. For example, if you want to use an Apache server as a cluster resource, set up the Apache server first and complete the Apache configuration before starting the respective resource in your cluster.

If a resource has specific environment requirements, make sure they are present and identical on all cluster nodes. This kind of configuration is not managed by the High Availability Extension. You must do this yourself.

[Note]Do Not Touch Services Managed by the Cluster

When managing a resource with the High Availability Extension, the same resource must not be started or stopped otherwise (outside of the cluster, for example manually or on boot or reboot). The High Availability Extension software is responsible for all service start or stop actions.

However, if you want to check if the service is configured properly, start it manually, but make sure that it is stopped again before High Availability takes over.

After having configured the resources in the cluster, use the cluster management tools to start, stop, clean up, remove or migrate any resources manually. For details how to do so with your preferred cluster management tool:

4.2.2. Supported Resource Agent Classes

For each cluster resource you add, you need to define the standard that the resource agent conforms to. Resource agents abstract the services they provide and present an accurate status to the cluster, which allows the cluster to be non-committal about the resources it manages. The cluster relies on the resource agent to react appropriately when given a start, stop or monitor command.

Typically, resource agents come in the form of shell scripts. The High Availability Extension supports the following classes of resource agents:

Linux Standards Base (LSB) Scripts

LSB resource agents are generally provided by the operating system/distribution and are found in /etc/init.d. To be used with the cluster, they must conform to the LSB init script specification. For example, they must have several actions implemented, which are, at minimum, start, stop, restart, reload, force-reload, and status. For more information, see http://refspecs.linuxbase.org/LSB_4.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html.

The configuration of those services is not standardized. If you intend to use an LSB script with High Availability, make sure that you understand how the relevant script is configured. Often you can find information about this in the documentation of the relevant package in /usr/share/doc/packages/PACKAGENAME.

Open Cluster Framework (OCF) Resource Agents

OCF RA agents are best suited for use with High Availability, especially when you need master resources or special monitoring abilities. The agents are generally located in /usr/lib/ocf/resource.d/provider/. Their functionality is similar to that of LSB scripts. However, the configuration is always done with environmental variables which allow them to accept and process parameters easily. The OCF specification (as it relates to resource agents) can be found at http://www.opencf.org/cgi-bin/viewcvs.cgi/specs/ra/resource-agent-api.txt?rev=HEAD&content-type=text/vnd.viewcvs-markup. OCF specifications have strict definitions of which exit codes must be returned by actions, see Section 8.3, “OCF Return Codes and Failure Recovery”. The cluster follows these specifications exactly. For a detailed list of all available OCF RAs, refer to Chapter 21, HA OCF Agents.

All OCF Resource Agents are required to have at least the actions start, stop, status, monitor, and meta-data. The meta-data action retrieves information about how to configure the agent. For example, if you want to know more about the IPaddr agent by the provider heartbeat, use the following command:

OCF_ROOT=/usr/lib/ocf /usr/lib/ocf/resource.d/heartbeat/IPaddr meta-data

The output is information in XML format, including several sections (general description, available parameters, available actions for the agent).

STONITH Resource Agents

This class is used exclusively for fencing related resources. For more information, see Chapter 9, Fencing and STONITH.

The agents supplied with the High Availability Extension are written to OCF specifications.

4.2.3. Types of Resources

The following types of resources can be created:

Primitives

A primitive resource, the most basic type of a resource.

Learn how to create primitive resources with your preferred cluster management tool:

Groups

Groups contain a set of resources that need to be located together, started sequentially and stopped in the reverse order. For more information, refer to Section 4.2.5.1, “Groups”.

Clones

Clones are resources that can be active on multiple hosts. Any resource can be cloned, provided the respective resource agent supports it. For more information, refer to Section 4.2.5.2, “Clones”.

Masters

Masters are a special type of clone resources, they can have multiple modes. For more information, refer to Section 4.2.5.3, “Masters”.

4.2.4. Resource Templates

If you want to create lots of resources with similar configurations, defining a resource template is the easiest way. Once defined, it can be referenced in primitives—or in certain types of constraints, as described in Section 4.5.3, “Resource Templates and Constraints”.

If a template is referenced in a primitive, the primitive will inherit all operations, instance attributes (parameters), meta attributes, and utilization attributes defined in the template. Additionally, you can define specific operations or attributes for your primitive. If any of these are defined in both the template and the primitive, the values defined in the primitive will take precedence over the ones defined in the template.

Learn how to define resource templates with your preferred cluster configuration tool:

4.2.5. Advanced Resource Types

Whereas primitives are the simplest kind of resources and therefore easy to configure, you will probably also need more advanced resource types for cluster configuration, such as groups, clones or masters.

4.2.5.1. Groups

Some cluster resources are dependent on other components or resources and require that each component or resource starts in a specific order and runs together on the same server with resources it depends on. To simplify this configuration, you can use groups.

Example 4.1. Resource Group for a Web Server

An example of a resource group would be a Web server that requires an IP address and a file system. In this case, each component is a separate cluster resource that is combined into a cluster resource group. The resource group would then run on a server or servers, and in case of a software or hardware malfunction, fail over to another server in the cluster the same as an individual cluster resource.


Figure 4.1. Group Resource

Group Resource

Groups have the following properties:

Starting and Stopping

Resources are started in the order they appear in and stopped in the reverse order.

Dependency

If a resource in the group cannot run anywhere, then none of the resources located after that resource in the group is allowed to run.

Contents

Groups may only contain a collection of primitive cluster resources. Groups must contain at least one resource, otherwise the configuration is not valid. To refer to the child of a group resource, use the child’s ID instead of the group’s ID.

Constraints

Although it is possible to reference the group’s children in constraints, it is usually preferable to use the group’s name instead.

Stickiness

Stickiness is additive in groups. Every active member of the group will contribute its stickiness value to the group’s total. So if the default resource-stickiness is 100 and a group has seven members (five of which are active), then the group as a whole will prefer its current location with a score of 500.

Resource Monitoring

To enable resource monitoring for a group, you must configure monitoring separately for each resource in the group that you want monitored.

Learn how to create groups with your preferred cluster management tool:

4.2.5.2. Clones

You may want certain resources to run simultaneously on multiple nodes in your cluster. To do this you must configure a resource as a clone. Examples of resources that might be configured as clones include STONITH and cluster file systems like OCFS2. You can clone any resource provided. This is supported by the resource’s Resource Agent. Clone resources may even be configured differently depending on which nodes they are hosted.

There are three types of resource clones:

Anonymous Clones

These are the simplest type of clones. They behave identically anywhere they are running. Because of this, there can only be one instance of an anonymous clone active per machine.

Globally Unique Clones

These resources are distinct entities. An instance of the clone running on one node is not equivalent to another instance on another node; nor would any two instances on the same node be equivalent.

Stateful Clones

Active instances of these resources are divided into two states, active and passive. These are also sometimes referred to as primary and secondary, or master and slave. Stateful clones can be either anonymous or globally unique. See also Section 4.2.5.3, “Masters”.

Clones must contain exactly one group or one regular resource.

When configuring resource monitoring or constraints, masters have different requirements than simple resources. For details, see Pacemaker Explained, available from http://www.clusterlabs.org/doc/ . Refer to section Clones - Resources That Get Active on Multiple Hosts.

Learn how to create clones with your preferred cluster management tool:

4.2.5.3. Masters

Masters are a specialization of clones that allow the instances to be in one of two operating modes (master or slave). Masters must contain exactly one group or one regular resource.

When configuring resource monitoring or constraints, masters have different requirements than simple resources. For details, see Pacemaker Explained, available from http://www.clusterlabs.org/doc/ . Refer to section Multi-state - Resources That Have Multiple Modes.

4.2.6. Resource Options (Meta Attributes)

For each resource you add, you can define options. Options are used by the cluster to decide how your resource should behave—they tell the CRM how to treat a specific resource. Resource options can be set with the crm_resource --meta command or with the Pacemaker GUI as described in Procedure 6.3, “Adding or Modifying Meta and Instance Attributes”. Alternatively, use Hawk: Procedure 5.4, “Adding Primitive Resources”.

Table 4.1. Options for a Primitive Resource

Option

Description

Default

priority

If not all resources can be active, the cluster will stop lower priority resources in order to keep higher priority ones active.

0

target-role

In what state should the cluster attempt to keep this resource? Allowed values: stopped, started, master.

started

is-managed

Is the cluster allowed to start and stop the resource? Allowed values: true, false.

true

resource-stickiness

How much does the resource prefer to stay where it is? Defaults to the value of default-resource-stickiness in the rsc_defaults section.

calculated

migration-threshold

How many failures should occur for this resource on a node before making the node ineligible to host this resource?

INFINITY (disabled)

multiple-active

What should the cluster do if it ever finds the resource active on more than one node? Allowed values: block (mark the resource as unmanaged), stop_only, stop_start.

stop_start

failure-timeout

How many seconds to wait before acting as if the failure had not occurred (and potentially allowing the resource back to the node on which it failed)?

0 (disabled)

allow-migrate

Allow resource migration for resources which support migrate_to/migrate_from actions.

false


4.2.7. Instance Attributes (Parameters)

The scripts of all resource classes can be given parameters which determine how they behave and which instance of a service they control. If your resource agent supports parameters, you can add them with the crm_resource command or with the GUI as described in Procedure 6.3, “Adding or Modifying Meta and Instance Attributes”. Alternatively, use Hawk: Procedure 5.4, “Adding Primitive Resources”. In the crm command line utility and in Hawk, instance attributes are called params or Parameter, respectively. The list of instance attributes supported by an OCF script can be found by executing the following command as root:

crm ra info [class:[provider:]]resource_agent

or (without the optional parts):

crm ra info resource_agent

The output lists all the supported attributes, their purpose and default values.

For example, the command

crm ra info IPaddr

returns the following output:

Manages virtual IPv4 addresses (portable version) (ocf:heartbeat:IPaddr)
    
This script manages IP alias IP addresses
It can add an IP alias, or remove one.   
    
Parameters (* denotes required, [] the default):
    
ip* (string): IPv4 address
The IPv4 address to be configured in dotted quad notation, for example
"192.168.1.1".                                                        
    
nic (string, [eth0]): Network interface
The base network interface on which the IP address will be brought
online.                                                           
    
If left empty, the script will try and determine this from the    
routing table.                                                    
    
Do NOT specify an alias interface in the form eth0:1 or anything here;
rather, specify the base interface only.                              
    
cidr_netmask (string): Netmask
The netmask for the interface in CIDR format. (ie, 24), or in
dotted quad notation  255.255.255.0).                        
    
If unspecified, the script will also try to determine this from the
routing table.                                                     
    
broadcast (string): Broadcast address
Broadcast address associated with the IP. If left empty, the script will
determine this from the netmask.                                        
    
iflabel (string): Interface label
You can specify an additional label for your IP address here.
    
lvs_support (boolean, [false]): Enable support for LVS DR
Enable support for LVS Direct Routing configurations. In case a IP
address is stopped, only move it to the loopback device to allow the
local node to continue to service requests, but no longer advertise it
on the network.                                                       
    
local_stop_script (string): 
Script called when the IP is released
    
local_start_script (string): 
Script called when the IP is added
    
ARP_INTERVAL_MS (integer, [500]): milliseconds between gratuitous ARPs
milliseconds between ARPs                                         
    
ARP_REPEAT (integer, [10]): repeat count
How many gratuitous ARPs to send out when bringing up a new address
    
ARP_BACKGROUND (boolean, [yes]): run in background
run in background (no longer any reason to do this)
    
ARP_NETMASK (string, [ffffffffffff]): netmask for ARP
netmask for ARP - in nonstandard hexadecimal format.
    
Operations' defaults (advisory minimum):
    
start         timeout=90
stop          timeout=100
monitor_0     interval=5s timeout=20s
[Note]Instance Attributes for Groups, Clones or Masters

Note that groups, clones and masters do not have instance attributes. However, any instance attributes set will be inherited by the group's, clone's or master's children.

4.2.8. Resource Operations

By default, the cluster will not ensure that your resources are still healthy. To instruct the cluster to do this, you need to add a monitor operation to the resource’s definition. Monitor operations can be added for all classes or resource agents. For more information, refer to Section 4.3, “Resource Monitoring”.

Table 4.2. Resource Operation Properties

Operation

Description

id

Your name for the action. Must be unique. (The ID is not shown).

name

The action to perform. Common values: monitor, start, stop.

interval

How frequently to perform the operation. Unit: seconds

timeout

How long to wait before declaring the action has failed.

requires

What conditions need to be satisfied before this action occurs. Allowed values: nothing, quorum, fencing. The default depends on whether fencing is enabled and if the resource’s class is stonith. For STONITH resources, the default is nothing.

on-fail

The action to take if this action ever fails. Allowed values:

  • ignore: Pretend the resource did not fail.

  • block: Do not perform any further operations on the resource.

  • stop: Stop the resource and do not start it elsewhere.

  • restart: Stop the resource and start it again (possibly on a different node).

  • fence: Bring down the node on which the resource failed (STONITH).

  • standby: Move all resources away from the node on which the resource failed.

enabled

If false, the operation is treated as if it does not exist. Allowed values: true, false.

role

Run the operation only if the resource has this role.

record-pending

Can be set either globally or for individual resources. Makes the CIB reflect the state of in-flight operations on resources.

description

Description of the operation.


4.2.9. Timeout Values

Timeouts values for resources can be influenced by the following parameters:

  • default-action-timeout (global cluster option),

  • op_defaults (global defaults for operations),

  • a specific timeout value defined in a resource template,

  • a specific timeout value defined for a resource.

Of the default values, op_defaults takes precedence over default-action-timeout. If a specific value is defined for a resource, it always takes precedence over any of the defaults (and over a value defined in a resource template).

For information on how to set the default parameters, refer to the technical information document default action timeout and default op timeout. It is available at http://www.suse.com/support/kb/doc.php?id=7009584. You can also adjust the default parameters with Hawk as described in Procedure 5.2, “Modifying Global Cluster Options”.

Getting timeout values right is very important. Setting them too low will result in a lot of (unnecessary) fencing operations for the following reasons:

  1. If a resource runs into a timeout, it fails and the cluster will try to stop it.

  2. If stopping the resource also fails (for example because the timeout for stopping is set too low), the cluster will fence the node (it considers the node where this happens to be out of control).

The CRM executes an initial monitoring for each resource on every node, the so-called probe, which is also executed after the cleanup of a resource. If no specific timeout is configured for the resource's monitoring operation, the CRM will automatically check for any other monitoring operations. If multiple monitoring operations are defined for a resource, the CRM will select the one with the smallest interval and will use its timeout value as default timeout for probing. If no monitor operation is configured at all, the cluster-wide default, defined in op_defaults, applies. If you do not want to rely on the automatic calculation or the op_defaults values, define a specific timeout for this monitoring by adding a monitoring operation to the respective resource, with the timeout set to 0, for example:

crm configure primitive rsc1 ocf:pacemaker:Dummy \
    op monitor interval="10" timeout="60"

The probe of rsc1 will time out in 60s, independent of the global timeout defined in op_defaults, or any other operation timeouts configured.

The best practice for setting timeout values is as follows:

  1. Check how long it takes your resources to start and stop (under load).

  2. Adjust the (default) timeout values accordingly:

    1. For example, set the default-action-timeout to 120 seconds.

    2. For resources that need longer periods of time, define individual timeout values.

  3. When configuring operations for a resource, add separate start and stop operations. When configuring operations with Hawk or the Pacemaker GUI, both will provide useful timeout proposals for those operations.

4.3. Resource Monitoring

If you want to ensure that a resource is running, you must configure resource monitoring for it.

If the resource monitor detects a failure, the following takes place:

  • Log file messages are generated, according to the configuration specified in the logging section of /etc/corosync/corosync.conf. By default, the logs are written to syslog, usually /var/log/messages.

  • The failure is reflected in the cluster management tools (Pacemaker GUI, Hawk, crm_mon), and in the CIB status section.

  • The cluster initiates noticeable recovery actions which may include stopping the resource to repair the failed state and restarting the resource locally or on another node. The resource also may not be restarted at all, depending on the configuration and state of the cluster.

If you do not configure resource monitoring, resource failures after a successful start will not be communicated, and the cluster will always show the resource as healthy.

Usually, resources are only monitored by the cluster as long as they are running. However, to detect concurrency violations, also configure monitoring for resources which are stopped. For example:

primitive dummy1 ocf:heartbeat:Dummy \
   op monitor interval="300s" role="Stopped" timeout="10s" \
   op monitor interval="30s" timeout="10s"

This configuration triggers a monitoring operation every 300 seconds for the resource dummy1 as soon as it is in role="Stopped". When running, it will be monitored every 30 seconds.

Learn how to add monitor operations to resources with your preferred cluster management tool:

4.4. Monitoring System Health

To avoid a node running out of disk space and thus being no longer able to adequately manage any resources that have been assigned to it, the High Availability Extension provides a resource agent, ocf:pacemaker:SysInfo. Use it to monitor a node's health with respect to disk partitions. The SysInfo RA creates a node attribute named #health_disk which will be set to red if any of the monitored disks' free space is below a specified limit.

To define how the CRM should react in case a node's health reaches a critical state, use the global cluster option node-health-strategy.

Procedure 4.1. Configuring System Health Monitoring

To automatically move resources away from a node in case the node runs out of disk space, proceed as follows:

  1. Configure an ocf:pacemaker:SysInfo resource:

    primitive sysinfo ocf:pacemaker:SysInfo \ 
      params disks="/tmp /var"1 min_disk_free="100M"2 disk_unit="M"3 \ 
      op monitor interval="15s"

    1

    Which disk partitions to monitor. For example, /tmp, /usr, /var, and /dev. To specify multiple partitions as attribute values, separate them with a blank.

    [Note]/ File System Always Monitored

    You do not need to specify the root partition (/) in disks. It is always monitored by default.

    2

    The minimum free disk space required for those partitions. Optionally, you can specify the unit to use for measurement (in the example above, M for megabytes is used). If not specified, min_disk_free defaults to the unit defined in the disk_unit parameter.

    3

    The unit in which to report the disk space.

  2. To complete the resource configuration, create a clone of ocf:pacemaker:SysInfo and start it on each cluster node.

  3. Set the node-health-strategy to migrate-on-red:

    property node-health-strategy="migrate-on-red"

    In case of a #health_disk attribute set to red, the policy engine adds -INF to the resources' score for that node. This will cause any resources to move away from this node. The STONITH resource will be the last one to be stopped but even if the STONITH resource is not running any more, the node can still be fenced. Fencing has direct access to the CIB and will continue to work.

After a node's health status has turned to red, solve the issue that led to the problem. Then clear the red status to make the node eligible again for running resources. Log in to the cluster node and use one of the following methods:

  • Execute the following command:

    crm node status-attr NODE delete #health_disk
  • Restart OpenAIS on that node.

  • Reboot the node.

The node will be returned to service and can run resources again.

4.5. Resource Constraints

Having all the resources configured is only part of the job. Even if the cluster knows all needed resources, it might still not be able to handle them correctly. Resource constraints let you specify which cluster nodes resources can run on, what order resources will load, and what other resources a specific resource is dependent on.

4.5.1. Types of Constraints

There are three different kinds of constraints available:

Resource Location

Locational constraints that define on which nodes a resource may be run, may not be run or is preferred to be run.

Resource Colocation

Colocational constraints that tell the cluster which resources may or may not run together on a node.

Resource Order

Ordering constraints to define the sequence of actions.

For more information on configuring constraints and detailed background information about the basic concepts of ordering and colocation, refer to the following documents. They are available at http://www.clusterlabs.org/doc/ and http://www.clusterlabs.org/wiki/Documentation , respectively:

  • Pacemaker Explained , chapter Resource Constraints

  • Colocation Explained

  • Ordering Explained

Learn how to add the various kinds of constraints with your preferred cluster management tool:

4.5.2. Scores and Infinity

When defining constraints, you also need to deal with scores. Scores of all kinds are integral to how the cluster works. Practically everything from migrating a resource to deciding which resource to stop in a degraded cluster is achieved by manipulating scores in some way. Scores are calculated on a per-resource basis and any node with a negative score for a resource cannot run that resource. After calculating the scores for a resource, the cluster then chooses the node with the highest score.

INFINITY is currently defined as 1,000,000. Additions or subtractions with it stick to the following three basic rules:

  • Any value + INFINITY = INFINITY

  • Any value - INFINITY = -INFINITY

  • INFINITY - INFINITY = -INFINITY

When defining resource constraints, you specify a score for each constraint. The score indicates the value you are assigning to this resource constraint. Constraints with higher scores are applied before those with lower scores. By creating additional location constraints with different scores for a given resource, you can specify an order for the nodes that a resource will fail over to.

4.5.3. Resource Templates and Constraints

If you have defined a resource template, it can be referenced in the following types of constraints:

  • order constraints,

  • colocation constraints,

  • rsc_ticket constraints (for multi-site clusters).

However, colocation constraints must not contain more than one reference to a template. Resource sets must not contain a reference to a template.

Resource templates referenced in constraints stand for all primitives which are derived from that template. This means, the constraint applies to all primitive resources referencing the resource template. Referencing resource templates in constraints is an alternative to resource sets and can simplify the cluster configuration considerably. For details about resource sets, refer to Procedure 5.10, “Using Resource Sets for Colocation or Order Constraints”.

4.5.4. Failover Nodes

A resource will be automatically restarted if it fails. If that cannot be achieved on the current node, or it fails N times on the current node, it will try to fail over to another node. Each time the resource fails, its failcount is raised. You can define a number of failures for resources (a migration-threshold), after which they will migrate to a new node. If you have more than two nodes in your cluster, the node a particular resource fails over to is chosen by the High Availability software.

However, you can specify the node a resource will fail over to by configuring one or several location constraints and a migration-threshold for that resource.

Learn how to specify failover nodes with your preferred cluster management tool:

Example 4.2. Migration Threshold—Process Flow

For example, let us assume you have configured a location constraint for resource r1 to preferably run on node1. If it fails there, migration-threshold is checked and compared to the failcount. If failcount >= migration-threshold then the resource is migrated to the node with the next best preference.

By default, once the threshold has been reached, the node will no longer be allowed to run the failed resource until the resource's failcount is reset. This can be done manually by the cluster administrator or by setting a failure-timeout option for the resource.

For example, a setting of migration-threshold=2 and failure-timeout=60s would cause the resource to migrate to a new node after two failures and potentially allow it to move back (depending on the stickiness and constraint scores) after one minute.


There are two exceptions to the migration threshold concept, occurring when a resource either fails to start or fails to stop:

  • Start failures set the failcount to INFINITY and thus always cause an immediate migration.

  • Stop failures cause fencing (when stonith-enabled is set to true which is the default).

    In case there is no STONITH resource defined (or stonith-enabled is set to false), the resource will not migrate at all.

For details on using migration thresholds and resetting failcounts with your preferred cluster management tool:

4.5.5. Failback Nodes

A resource might fail back to its original node when that node is back online and in the cluster. If you want to prevent a resource from failing back to the node it was running on prior to failover, or if you want to specify a different node for the resource to fail back to, you must change its resource stickiness value. You can either specify resource stickiness when you are creating a resource, or afterwards.

Consider the following implications when specifying resource stickiness values:

Value is 0:

This is the default. The resource will be placed optimally in the system. This may mean that it is moved when a better or less loaded node becomes available. This option is almost equivalent to automatic failback, except that the resource may be moved to a node that is not the one it was previously active on.

Value is greater than 0:

The resource will prefer to remain in its current location, but may be moved if a more suitable node is available. Higher values indicate a stronger preference for a resource to stay where it is.

Value is less than 0:

The resource prefers to move away from its current location. Higher absolute values indicate a stronger preference for a resource to be moved.

Value is INFINITY:

The resource will always remain in its current location unless forced off because the node is no longer eligible to run the resource (node shutdown, node standby, reaching the migration-threshold, or configuration change). This option is almost equivalent to completely disabling automatic failback.

Value is -INFINITY:

The resource will always move away from its current location.

4.5.6. Placing Resources Based on Their Load Impact

Not all resources are equal. Some, such as Xen guests, require that the node hosting them meets their capacity requirements. If resources are placed such that their combined need exceed the provided capacity, the resources diminish in performance (or even fail).

To take this into account, the High Availability Extension allows you to specify the following parameters:

  1. The capacity a certain node provides.

  2. The capacity a certain resource requires.

  3. An overall strategy for placement of resources.

Learn how to configure these settings with your preferred cluster management tool:

A node is considered eligible for a resource if it has sufficient free capacity to satisfy the resource's requirements. The nature of the required or provided capacities is completely irrelevant for the High Availability Extension, it just makes sure that all capacity requirements of a resource are satisfied before moving a resource to a node.

To manually configure the resource's requirements and the capacity a node provides, use utilization attributes. You can name the utilization attributes according to your preferences and define as many name/value pairs as your configuration needs. However, the attribute's values must be integers.

If multiple resources with utilization attributes are grouped or have colocation constraints, the High Availability Extension takes that into account. If possible, the resources will be placed on a node that can fulfill all capacity requirements.

[Note]Utilization Attributes for Groups

It is impossible to set utilization attributes directly for a resource group. However, to simplify the configuration for a group, you can add a utilization attribute with the total capacity needed to any of the resources in the group.

The High Availability Extension also provides means to detect and configure both node capacity and resource requirements automatically:

The NodeUtilization resource agent checks the capacity of a node (regarding CPU and RAM). To configure automatic detection, create a clone resource of the following class, provider, and type: ofc:pacemaker:NodeUtilization. One instance of the clone should be running on each node. After the instance has started, a utilization section will be added to the node's configuration in CIB.

For automatic detection of a resource's minimal requirements (regarding RAM and CPU) the Xen resource agent has been improved. Upon start of a Xen resource, it will reflect the consumption of RAM and CPU. Utilization attributes will automatically be added to the resource configuration.

Apart from detecting the minimal requirements, the High Availability Extension also allows to monitor the current utilization via the VirtualDomain resource agent. It detects CPU and RAM use of the virtual machine. To use this feature, configure a resource of the following class, provider and type: ofc:heartbeat:VirtualDomain. Add the dynamic_utilization instance attribute (parameter) and set its value to 1. This updates the utilization values in the CIB during each monitoring cycle.

Independent of manually or automatically configuring capacity and requirements, the placement strategy must be specified with the placement-strategy property (in the global cluster options). The following values are available:

default (default value)

Utilization values are not considered at all. Resources are allocated according to location scoring. If scores are equal, resources are evenly distributed across nodes.

utilization

Utilization values are considered when deciding if a node has enough free capacity to satisfy a resource's requirements. However, load-balancing is still done based on the number of resources allocated to a node.

minimal

Utilization values are considered when deciding if a node has enough free capacity to satisfy a resource's requirements. An attempt is made to concentrate the resources on as few nodes as possible (in order to achieve power savings on the remaining nodes).

balanced

Utilization values are considered when deciding if a node has enough free capacity to satisfy a resource's requirements. An attempt is made to distribute the resources evenly, thus optimizing resource performance.

[Note]Configuring Resource Priorities

The available placement strategies are best-effort—they do not yet use complex heuristic solvers to always reach optimum allocation results. Thus, set your resource priorities in a way that makes sure that your most important resources are scheduled first.

Example 4.3. Example Configuration for Load-Balanced Placing

The following example demonstrates a three-node cluster of equal nodes, with four virtual machines.

node node1 utilization memory="4000"
node node2 utilization memory="4000"
node node3 utilization memory="4000"
primitive xenA ocf:heartbeat:Xen utilization memory="3500" \
     meta priority="10"
primitive xenB ocf:heartbeat:Xen utilization memory="2000" \
     meta priority="1"
primitive xenC ocf:heartbeat:Xen utilization memory="2000" \
     meta priority="1"
primitive xenD ocf:heartbeat:Xen utilization memory="1000" \
     meta priority="5"
property placement-strategy="minimal"

With all three nodes up, resource xenA will be placed onto a node first, followed by xenD. xenB and xenC would either be allocated together or one of them with xenD.

If one node failed, too little total memory would be available to host them all. xenA would be ensured to be allocated, as would xenD. However, only one of the remaining resources xenB or xenC could still be placed. Since their priority is equal, the result would still be open. To resolve this ambiguity as well, you would need to set a higher priority for either one.


4.5.7. Monitoring Services on Remote Hosts

Monitoring of virtual machines can be done with the VM agent (which only checks if the guest shows up in the hypervisor), or by external scripts called from the VirtualDomain or Xen agent. Up to now, more fine-grained monitoring was only possible with a full setup of the High Availability stack within the virtual machines.

By providing support for Nagios plug-ins, the High Availability Extension now also allows you to monitor services on remote hosts. You can collect external statuses on the guests without modifying the guest image. For example, VM guests might run Web services or simple network resources that need to be accessible. With the Nagios resource agents, you can now monitor the Web service or the network resource on the guest. In case these services are not reachable anymore, the High Availability Extension will trigger a restart or migration of the respective guest.

If your guests depend on a service (for example, an NFS server to be used by the guest), the service can either be an ordinary resource managed by the cluster or an external service that is not managed by the cluster but monitored with Nagios resources instead.

To configure the Nagios resources, the following packages must be installed on the host:

  • nagios-plugins

  • nagios-plugins-metadata

YaST or zypper will resolve any dependencies on further packages, if required.

A typical use case is to configure the Nagios plug-ins as resources belonging to a resource container, which usually is a VM. The container will be restarted if any of its resources has failed. Refer to Example 4.4, “Configuring Resources for Nagios Plug-ins” for a configuration example. Alternatively, Nagios resource agents can also be configured as ordinary resources if you want to use them for monitoring hosts or services via the network.

Example 4.4. Configuring Resources for Nagios Plug-ins

primitive vm1 ocf:heartbeat:VirtualDomain \
  params hypervisor="qemu:///system" config="/etc/libvirt/qemu/vm1.xml" \
  op start interval="0" timeout="90" \
  op stop interval="0" timeout="90" \
  op monitor interval="10" timeout="30"
primitive vm1-sshd nagios:check_tcp \
  params hostname="vm1" port="22" \1
  op start interval="0" timeout="120" \2
  op monitor interval="10"
group vm1-and-services vm1 vm1-sshd \
  meta container="vm1"3

1

The supported parameters are same as the long options of a Nagios plug-in. Nagios plug-ins connect to services with the parameter hostname. Therefore the attribute's value must be a resolvable hostname or an IP address.

2

As it takes some time to get the guest operating system up and its services running, the start timeout of the Nagios resource must be long enough.

3

A cluster resource container of type ocf:heartbeat:Xen, ocf:heartbeat:VirtualDomain or ocf:heartbeat:lxc. It can either be a VM or a Linux Container.

The example above contains only one Nagios resource for the check_tcpplug-in, but multiple Nagios resources for different plug-in types can be configured (for example, check_http or check_udp).

If the hostnames of the services are the same, the hostname parameter can also be specified for the group, instead of adding it to the individual primitives. For example:

group  vm1-and-services vm1 vm1-sshd vm1-httpd \ 
     meta container="vm1" \ 
     params hostname="vm1" 

If any of the services monitored by the Nagios plug-ins fail within the VM, the cluster will detect that and restart the container resource (the VM). Which action to take in this case can be configured by specifying the on-fail attribute for the service's monitoring operation. It defaults to restart-container.

Failure counts of services will be taken into account when considering the VM's migration-threshold.


4.6. For More Information

http://clusterlabs.org/

Home page of Pacemaker, the cluster resource manager shipped with the High Availability Extension.

http://linux-ha.org

Home page of the The High Availability Linux Project.

http://www.clusterlabs.org/doc/

Holds a number of comprehensive manuals, for example:

  • Pacemaker Explained: Explains the concepts used to configure Pacemaker. Contains comprehensive and very detailed information for reference.

  • Fencing and Stonith: How to configure and use STONITH devices.

  • CRM Command Line Interface: Introduction to the crm command line tool.

http://www.clusterlabs.org/wiki/Documentation

Features some more useful documentation, such as:

  • Colocation Explained

  • Ordering Explained

Chapter 5. Configuring and Managing Cluster Resources (Web Interface)

Abstract

In addition to the crm command line tool and the Pacemaker GUI, the High Availability Extension also comes with the HA Web Konsole (Hawk), a Web-based user interface for management tasks. It allows you to monitor and administer your Linux cluster from non-Linux machines as well. Furthermore, it is the ideal solution in case your system only provides a minimal graphical user interface.

This chapter introduces Hawk and covers basic tasks for configuring and managing cluster resources: modifying global cluster options, creating basic and advanced types of resources (groups and clones), configuring constraints, specifying failover nodes and failback nodes, configuring resource monitoring, starting, cleaning up or removing resources, and migrating resources manually. For detailed analysis of the cluster status, Hawk generates a cluster report (hb_report). You can view the cluster history or explore potential failure scenarios with the simulator.

The Web interface is included in the hawk package. It must be installed on all cluster nodes you want to connect to with Hawk. On the machine from which you want to access a cluster node using Hawk, you only need a (graphical) Web browser with JavaScript and cookies enabled to establish the connection.

[Note]User Authentication

To log in to the cluster from Hawk, the respective user must be a member of the haclient group. The installation creates a Linux user named hacluster and adds the user to the haclient group.

Before using Hawk, either set a password for the hacluster user or create a new user which is a member of the haclient group.

Do this on every node you will connect to with Hawk.

5.1. Hawk—Overview

Learn how to start Hawk, how to log in to the cluster and get to know the Hawk basics.

5.1.1. Starting Hawk and Logging In

Procedure 5.1. Starting Hawk

To use Hawk, the respective Web service must be started on the node that you want to connect to via the Web interface. For communication, the standard HTTPS protocol and port 7630 is used.

  1. On the node you want to connect to, open a shell and log in as root.

  2. Check the status of the service by entering

    rchawk status
  3. If the service is not running, start it with

    rchawk start

    If you want Hawk to start automatically at boot time, execute the following command:

    chkconfig hawk on
  1. On any machine, start a Web browser and make sure that JavaScript and cookies are enabled.

  2. Point it at the IP address or hostname of any cluster node running the Hawk Web service, or the address of any IPaddr(2) resource that you may have configured:

    https://IPaddress:7630/
    [Note]Certificate Warning

    Depending on your browser and browser options, you may get a certificate warning when trying to access the URL for the first time. This is because Hawk uses a self-signed certificate that is not considered trustworthy per default.

    In this case, verify the certificate. To proceed anyway, you can add an exception in the browser to bypass the warning.

    To avoid the warning in the first place, the self-signed certificate can also be replaced with a certificate signed by an official Certificate Authority. For information on how to do so, refer to Replacing the Self-Signed Certificate.

  3. On the Hawk login screen, enter the Username and Password of the hacluster user (or of any other user that is a member of the haclient group) and click Log In.

    The Cluster Status screen appears, displaying the status of your cluster nodes and resources, similar to the output of the crm_mon command.

5.1.2. Main Screen: Cluster Status

After logging in, Hawk displays the Cluster Status screen. It shows a summary with the most important global cluster parameters and the status of your cluster nodes and resources. The following color code is used for status display of nodes and resources:

Hawk Color Code

  • Green: OK. For example, the resource is running or the node is online.

  • Red: Bad, unclean. For example, the resource has failed or the node was not shut down cleanly.

  • Yellow: In transition. For example, the node is currently being shut down. If you click a pending resource to view its details, Hawk also displays the state to which the resource is currently changing (Starting, Stopping, Moving, Promoting, or Demoting).

  • Gray: Not running, but the cluster expects it to be running. For example, nodes that the administrator has stopped or put into standby mode. Also nodes that are offline are displayed in gray (if they have been shut down cleanly).

In addition to the color code, Hawk also displays self-explanatory icons for the state of nodes, resources, tickets and for error messages in all views of the Cluster Status screen.

If a resource has failed, an error message with the details is shown in red at the top of the screen. To analyze the causes for the failure, click the error message. This automatically takes you to Hawk's History Explorer and triggers the collection of data for a time span of 20 minutes (10 minutes before and 10 minutes after the failure occurred). For more details, refer to Procedure 5.25, “Viewing Transitions with the History Explorer”.

Figure 5.1. Hawk—Cluster Status (Summary View)

Hawk—Cluster Status (Summary View)

The Cluster Status screen refreshes itself in near real-time. Choose between the following views, which you can access with the three icons in the upper right corner:

Hawk Cluster Status Views

Summary View

Shows the most important global cluster parameters and the status of your cluster nodes and resources at the same time. If your setup includes Multi-Site Clusters (Geo Clusters), the summary view also shows tickets. To view details about all elements belonging to a certain category (tickets, nodes, or resources), click the category title, which is marked as a link. Otherwise click the individual elements for details.

Tree View

Presents an expandable view of the most important global cluster parameters and the status of your cluster nodes and resources. Click the arrows to expand or collapse the elements belonging to the respective category. In contrast to the Summary View this view not only shows the IDs and status of resources but also the type (for example, primitive, clone, or group).

Table View

This view is especially useful for larger clusters, because it shows in a concise way which resources are currently running on which node. Inactive nodes or resources are also displayed.

The top-level row of the main screen shows the username with which you are logged in. It also allows you to Log Out of the Web interface, and to access the following Tools from the wrench icon next to the username:

To perform basic operator tasks on nodes and resources (like starting or stopping resources, bringing nodes online, or viewing details), click the wrench icon next to the respective node or resource to access a context menu. For any clone, group or master/slave child resource on any of the status screens, select the Parent menu item from the context menu. Clicking this will let you start, stop, etc. the top-level clone or group to which that primitive belongs.

For more complex tasks like configuring resources, constraints, or global cluster options, use the navigation bar on the left hand side. From there, you can also view the cluster history.

[Note]Available Functions in Hawk

By default, users logged in as root or hacluster have full read-write access to all cluster configuration tasks. However, Access Control Lists can be used to define fine-grained access permissions.

If ACLs are enabled in the CRM, the available functions in Hawk depend on the user role and access permissions assigned to you. In addition, the following functions in Hawk can only be executed by the user hacluster:

  • Generating a hb_report.

  • Using the history explorer.

  • Viewing recent events for nodes or resources.

5.2. Configuring Global Cluster Options

Global cluster options control how the cluster behaves when confronted with certain situations. They are grouped into sets and can be viewed and modified with cluster management tools like Pacemaker GUI, Hawk, and crm shell. The predefined values can be kept in most cases. However, to make key functions of your cluster work correctly, you need to adjust the following parameters after basic cluster setup:

Procedure 5.2. Modifying Global Cluster Options

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Cluster Properties to view the global cluster options and their current values. Hawk displays the most important parameters with regards to CRM Configuration, Resource Defaults, and Operation Defaults.

    Figure 5.3. Hawk—Cluster Configuration

    Hawk—Cluster Configuration

  3. Depending on your cluster requirements, adjust the CRM Configuration:

    1. Set no-quorum-policy to the appropriate value.

    2. If you need to disable fencing for any reasons, deselect stonith-enabled.

      [Important]No Support Without STONITH

      A cluster without STONITH is not supported.

    3. To remove a property from the CRM configuration, click the minus icon next to the property. If a property is deleted, the cluster will behave as if that property had the default value. For details of the default values, refer to http://clusterlabs.org/doc/en-US/Pacemaker/1.1/html/Pacemaker_Explained/s-resource-options.html.

    4. To add a new property for the CRM configuration, choose one from the drop-down list and click the plus icon.

  4. If you need to change Resource Defaults or Operation Defaults, proceed as follows:

    1. To change the value of defaults that are already displayed, just edit the value in the respective input field.

    2. To add a new resource default or operation default, choose one from the empty drop-down list, click the plus icon and enter a value. If there are default values defined, Hawk proposes them automatically.

    3. To remove a resource or operation default, click the minus icon next to the parameter. If no values are specified for Resource Defaults and Operation Defaults, the cluster uses the default values that are documented in Section 4.2.6, “Resource Options (Meta Attributes)” and Section 4.2.8, “Resource Operations”.

  5. Confirm your changes.

5.3. Configuring Cluster Resources

As a cluster administrator, you need to create cluster resources for every resource or application you run on servers in your cluster. Cluster resources can include Web sites, mail servers, databases, file systems, virtual machines, and any other server-based applications or services you want to make available to users at all times.

For an overview of the resource types you can create, refer to Section 4.2.3, “Types of Resources”. Apart from the basic specification of a resource (ID, class, provider, and type), you can add or modify the following parameters during or after creation of a resource:

  • Instance attributes (parameters) determine which instance of a service the resource controls. For more information, refer to Section 4.2.7, “Instance Attributes (Parameters)”.

    When creating a resource, Hawk automatically shows any required parameters. Edit them to get a valid resource configuration.

  • Meta attributes tell the CRM how to treat a specific resource. For more information, refer to Section 4.2.6, “Resource Options (Meta Attributes)”.

    When creating a resource, Hawk automatically lists the important meta attributes for that resource (for example, the target-role attribute that defines the initial state of a resource. By default, it is set to Stopped, so the resource will not start immediately).

  • Operations are needed for resource monitoring. For more information, refer to Section 4.2.8, “Resource Operations”.

    When creating a resource, Hawk displays the most important resource operations (monitor, start, and stop).

5.3.1. Configuring Resources with the Setup Wizard

The High Availability Extension comes with a predefined set of resources for some frequently used cluster scenarios, for example, setting up a highly available Web server. Find the predefined sets in the hawk-templates package. You can also define your own wizard templates. For detailed information, refer to https://github.com/ClusterLabs/hawk/blob/master/doc/wizard.txt. Hawk provides a wizard that guides you through all configuration steps.

Procedure 5.3. Using the Setup Wizard

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Setup Wizard. The Cluster Setup Wizard shows a list of available resource sets. If you click an entry, Hawk displays a short help text about the resource set.

  3. Select the resource set you want to configure and click Next.

  4. Follow the instructions on the screen. If you need information about an option, click it to display a short help text in Hawk.

Figure 5.4. Hawk—Setup Wizard

Hawk—Setup Wizard

5.3.2. Creating Simple Cluster Resources

To create the most basic type of a resource, proceed as follows:

Procedure 5.4. Adding Primitive Resources

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Resources. The Resources screen shows categories for all types of resources. It lists any resources that are already defined.

  3. Select the Primitive category and click the plus icon.

  4. Specify the resource:

    1. Enter a unique Resource ID.

    2. From the Class list, select the resource agent class you want to use for the resource: lsb, ocf, service, or stonith. For more information, see Section 4.2.2, “Supported Resource Agent Classes”.

    3. If you selected ocf as class, specify the Provider of your OCF resource agent. The OCF specification allows multiple vendors to supply the same resource agent.

    4. From the Type list, select the resource agent you want to use (for example, IPaddr or Filesystem). A short description for this resource agent is displayed.

      The selection you get in the Type list depends on the Class (and for OCF resources also on the Provider) you have chosen.

  5. Hawk automatically shows any required parameters for the resource plus an empty drop-down list that you can use to specify an additional parameter.

    To define Parameters (instance attributes) for the resource:

    1. Enter values for each required parameter. A short help text is displayed as soon as you click the input field next to a parameter.

    2. To completely remove a parameter, click the minus icon next to the parameter.

    3. To add another parameter, click the empty drop-down list, select a parameter and enter a value for it.

  6. Hawk automatically shows the most important resource Operations and proposes default values. If you do not modify any settings here, Hawk will add the proposed operations and their default values as soon as you confirm your changes.

    For details on how to modify, add or remove operations, refer to Procedure 5.14, “Adding or Modifying Monitor Operations”.

  7. Hawk automatically lists the most important meta attributes for the resource, for example target-role.

    To modify or add Meta Attributes:

    1. To set a (different) value for an attribute, select one from the drop-down list next to the attribute or edit the value in the input field.

    2. To completely remove a meta attribute, click the minus icon next to it.

    3. To add another meta attribute, click the empty drop-down list and select an attribute. The default value for the attribute is displayed. If needed, change it as described above.

  8. Click Create Resource to finish the configuration. A message at the top of the screen shows if the resource was successfully created or not.

Figure 5.5. Hawk—Primitive Resource

Hawk—Primitive Resource

5.3.3. Creating STONITH Resources

[Important]No Support Without STONITH

A cluster without STONITH is not supported.

By default, the global cluster option stonith-enabled is set to true: If no STONITH resources have been defined, the cluster will refuse to start any resources. Configure one or more STONITH resources to complete the STONITH setup. While they are configured similar to other resources, the behavior of STONITH resources is different in some respects. For details refer to Section 9.3, “STONITH Configuration”.

Procedure 5.5. Adding a STONITH Resource

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Resources. The Resources screen shows categories for all types of resources and lists all defined resources.

  3. Select the Primitive category and click the plus icon.

  4. Specify the resource:

    1. Enter a unique Resource ID.

    2. From the Class list, select the resource agent class stonith.

    3. From the Type list, select the STONITH plug-in for controlling your STONITH device. A short description for this plug-in is displayed.

  5. Hawk automatically shows the required Parameters for the resource. Enter values for each parameter.

  6. Hawk displays the most important resource Operations and proposes default values. If you do not modify any settings here, Hawk will add the proposed operations and their default values as soon as you confirm.

  7. Adopt the default Meta Attributes settings if there is no reason to change them.

  8. Confirm your changes to create the STONITH resource.

To complete your fencing configuration, add constraints, use clones or both. For more details, refer to Chapter 9, Fencing and STONITH.

5.3.4. Using Resource Templates

If you want to create lots of resources with similar configurations, defining a resource template is the easiest way. Once defined, it can be referenced in primitives or in certain types of constraints. For detailed information about function and use of resource templates, refer to Section 4.5.3, “Resource Templates and Constraints”.

Procedure 5.6. Creating Resource Templates

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Resources. The Resources screen shows categories for all types of resources plus a Template category.

  3. Select the Template category and click the plus icon.

  4. Enter a Template ID.

  5. Specify the resource template as you would specify a primitive. Follow Procedure 5.4: Adding Primitive Resources, starting with Step 4.b.

  6. Click Create Resource to finish the configuration. A message at the top of the screen shows if the resource template was successfully created.

Figure 5.6. Hawk—Resource Template

Hawk—Resource Template

Procedure 5.7. Referencing Resource Templates

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. To reference the newly created resource template in a primitive, follow these steps:

    1. In the left navigation bar, select Resources. The Resources screen shows categories for all types of resources. It lists all defined resources.

    2. Select the Primitive category and click the plus icon.

    3. Enter a unique Resource ID.

    4. Activate Use Template and, from the drop-down list, select the template to reference.

    5. If needed, specify further Parameters, Operations, or Meta Attributes as described in Procedure 5.4, “Adding Primitive Resources”.

  3. To reference the newly created resource template in colocational or order constraints, proceed as described in Procedure 5.9, “Adding or Modifying Colocational or Order Constraints”.

5.3.5. Configuring Resource Constraints

After you have configured all resources, specify how the cluster should handle them correctly. Resource constraints let you specify on which cluster nodes resources can run, in which order resources will be loaded, and what other resources a specific resource depends on.

For an overview of available types of constraints, refer to Section 4.5.1, “Types of Constraints”. When defining constraints, you also need to specify scores. For more information on scores and their implications in the cluster, see Section 4.5.2, “Scores and Infinity”.

Learn how to create the different types of constraints in the following procedures.

Procedure 5.8. Adding or Modifying Location Constraints

For location constraints, specify a constraint ID, resource, score and node:

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Constraints. The Constraints screen shows categories for all types of constraints. It lists all defined constraints.

  3. To add a new Location constraint, click the plus icon in the respective category.

    To modify an existing constraint, click the wrench icon next to the constraint and select Edit Constraint.

  4. Enter a unique Constraint ID. When modifying existing constraints, the ID is already defined.

  5. Select the Resource for which to define the constraint. The list shows the IDs of all resources that have been configured for the cluster.

  6. Set the Score for the constraint. Positive values indicate the resource can run on the Node you specify in the next step. Negative values mean it should not run on that node. Setting the score to INFINITY forces the resource to run on the node. Setting it to -INFINITY means the resources must not run on the node.

  7. Select the Node for the constraint.

  8. Click Create Constraint to finish the configuration. A message at the top of the screen shows if the constraint was successfully created.

Figure 5.7. Hawk—Location Constraint

Hawk—Location Constraint

Procedure 5.9. Adding or Modifying Colocational or Order Constraints

For both types of constraints specify a constraint ID and a score, then add resources to a dependency chain:

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Constraints. The Constraints screen shows categories for all types of constraints and lists all defined constraints.

  3. To add a new Colocation or Order constraint, click the plus icon in the respective category.

    To modify an existing constraint, click the wrench icon next to the constraint and select Edit Constraint.

  4. Enter a unique Constraint ID. When modifying existing constraints, the ID is already defined.

  5. Define a Score.

    For colocation constraints, the score determines the location relationship between the resources. Positive values indicate the resources should run on the same node. Negative values indicate the resources should not run on the same node. Setting the score to INFINITY forces the resources to run on the same node. Setting it to -INFINITY means the resources must not run on the same node. The score will be combined with other factors to decide where to put the resource.

    For order constraints, the constraint is mandatory if the score is greater than zero, otherwise it is only a suggestion. The default value is INFINITY.

  6. For order constraints, you can usually keep the option Symmetrical enabled. This specifies that resources are stopped in reverse order.

  7. To define the resources for the constraint, follow these steps:

    1. Select a resource from the list Add resource to constraint. The list shows the IDs of all resources and all resource templates configured for the cluster.

    2. To add the selected resource, click the plus icon next to the list. A new list appears beneath. Select the next resource from the list. As both colocation and order constraints define a dependency between resources, you need at least two resources.

    3. Select one of the remaining resources from the list Add resource to constraint. Click the plus icon to add the resource.

      Now you have two resources in a dependency chain.

      If you have defined an order constraint, the topmost resource will start first, then the second etc. Usually the resources will be stopped in reverse order.

      However, if you have defined a colocation constraint, the arrow icons between the resources reflect their dependency, but not their start order. As the topmost resource depends on the next resource and so on, the cluster will first decide where to put the last resource, then place the depending ones based on that decision. If the constraint cannot be satisfied, the cluster may decide not to allow the resource to run at all.

    4. Add as many resources as needed for your colocation or order constraint.

    5. If you want to swap the order of two resources, click the double arrow at the right hand side of the resources to swap the resources in the dependency chain.

  8. If needed, specify further parameters for each resource, like the role (Master, Slave, Started, or Stopped).

  9. Click Create Constraint to finish the configuration. A message at the top of the screen shows if the constraint was successfully created.

Figure 5.8. Hawk—Colocation Constraint

Hawk—Colocation Constraint

As an alternative format for defining colocation or ordering constraints, you can use resource sets. They have the same ordering semantics as groups.

Procedure 5.10. Using Resource Sets for Colocation or Order Constraints

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. Define colocation or order constraints as described in Procedure 5.9, “Adding or Modifying Colocational or Order Constraints”.

  3. When you have added the resources to the dependency chain, you can put them into a resource set by clicking the chain icon at the right hand side. A resource set is visualized by a frame around the resources belonging to a set.

  4. You can also add multiple resources to a resource set or create multiple resource sets.

  5. To extract a resource from a resource set, click the scissors icon above the respective resource.

    The resource will be removed from the set and put back into the dependency chain at its original place.

  6. Confirm your changes to finish the constraint configuration.

For more information on configuring constraints and detailed background information about the basic concepts of ordering and colocation, refer to the documentation available at http://www.clusterlabs.org/doc/ and http://www.clusterlabs.org/wiki/Documentation , respectively:

  • Pacemaker Explained , chapter Resource Constraints

  • Colocation Explained

  • Ordering Explained

Procedure 5.11. Removing Constraints

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Constraints. The Constraints screen shows categories for all types of constraints and lists all defined constraints.

  3. Click the wrench icon next to a constraint and select Remove Constraint.

5.3.6. Specifying Resource Failover Nodes

A resource will be automatically restarted if it fails. If that cannot be achieved on the current node, or it fails N times on the current node, it will try to fail over to another node. You can define a number of failures for resources (a migration-threshold), after which they will migrate to a new node. If you have more than two nodes in your cluster, the node to which a particular resource fails over is chosen by the High Availability software.

You can specify a specific node to which a resource will fail over by proceeding as follows:

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. Configure a location constraint for the resource as described in Procedure 5.8, “Adding or Modifying Location Constraints”.

  3. Add the migration-threshold meta attribute to the resource as described in Procedure 5.4: Adding Primitive Resources, Step 7 and enter a Value for the migration-threshold. The value should be positive and less than INFINITY.

  4. If you want to automatically expire the failcount for a resource, add the failure-timeout meta attribute to the resource as described in Procedure 5.4: Adding Primitive Resources, Step 7 and enter a Value for the failure-timeout.

  5. If you want to specify additional failover nodes with preferences for a resource, create additional location constraints.

The process flow regarding migration thresholds and failcounts is demonstrated in Example 4.2, “Migration Threshold—Process Flow”.

Instead of letting the failcount for a resource expire automatically, you can also clean up failcounts for a resource manually at any time. Refer to Section 5.4.2, “Cleaning Up Resources” for details.

5.3.7. Specifying Resource Failback Nodes (Resource Stickiness)

A resource may fail back to its original node when that node is back online and in the cluster. To prevent this or to specify a different node for the resource to fail back to, change the stickiness value of the resource. You can either specify the resource stickiness when creating it or afterwards.

For the implications of different resource stickiness values, refer to Section 4.5.5, “Failback Nodes”.

Procedure 5.12. Specifying Resource Stickiness

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. Add the resource-stickiness meta attribute to the resource as described in Procedure 5.4: Adding Primitive Resources, Step 7.

  3. Specify a value between -INFINITY and INFINITY for the resource-stickiness.

5.3.8. Configuring Placement of Resources Based on Load Impact

Not all resources are equal. Some, such as Xen guests, require that the node hosting them meets their capacity requirements. If resources are placed so that their combined needs exceed the provided capacity, the performance of the resources diminishes or they fail.

To take this into account, the High Availability Extension allows you to specify the following parameters:

  1. The capacity a certain node provides.

  2. The capacity a certain resource requires.

  3. An overall strategy for placement of resources.

Utilization attributes are used to configure both the resource's requirements and the capacity a node provides. The High Availability Extension now also provides means to detect and configure both node capacity and resource requirements automatically. For more details and a configuration example, refer to Section 4.5.6, “Placing Resources Based on Their Load Impact”.

To display a node's capacity values (defined via utilization attributes) as well as the capacity currently consumed by resources running on the node, switch to the Cluster Status screen in Hawk and select the node you are interested in. Click the wrench icon next to the node and select Show Details.

Figure 5.9. Hawk—Viewing a Node's Capacity Values

Hawk—Viewing a Node's Capacity Values

After you have configured the capacities your nodes provide and the capacities your resources require, you need to set the placement strategy in the global cluster options, otherwise the capacity configurations have no effect. Several strategies are available to schedule the load: for example, you can concentrate it on as few nodes as possible, or balance it evenly over all available nodes. For more information, refer to Section 4.5.6, “Placing Resources Based on Their Load Impact”.

Procedure 5.13. Setting the Placement Strategy

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Cluster Properties to view the global cluster options and their current values.

  3. From the Add new property drop-down list, choose placement-strategy.

  4. Depending on your requirements, set Placement Strategy to the appropriate value.

  5. Click the plus icon to add the new cluster property including its value.

  6. Confirm your changes.

5.3.9. Configuring Resource Monitoring

The High Availability Extension can not only detect a node failure, but also when an individual resource on a node has failed. If you want to ensure that a resource is running, configure resource monitoring for it. For resource monitoring, specify a timeout and/or start delay value, and an interval. The interval tells the CRM how often it should check the resource status. You can also set particular parameters, such as Timeout for start or stop operations.

Procedure 5.14. Adding or Modifying Monitor Operations

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Resources. The Resources screen shows categories for all types of resources and lists all defined resources.

  3. Select the resource to modify, click the wrench icon next to it and select Edit Resource. The resource definition is displayed. Hawk automatically shows the most important resource operations (monitor, start, stop) and proposes default values.

  4. To change the values for an operation:

    1. Click the pen icon next to the operation.

    2. In the dialog that opens, specify the following values:

      • Enter a timeout value in seconds. After the specified timeout period, the operation will be treated as failed. The PE will decide what to do or execute what you specified in the On Fail field of the monitor operation.

      • For monitoring operations, define the monitoring interval in seconds.

      If needed, use the empty drop-down list at the bottom of the monitor dialog to add more parameters, like On Fail (what to do if this action fails?) or Requires (what conditions need to be fulfilled before this action occurs?).

    3. Confirm your changes to close the dialog and to return to the Edit Resource screen.

  5. To completely remove an operation, click the minus icon next to it.

  6. To add another operation, click the empty drop-down list and select an operation. A default value for the operation is displayed. If needed, change it by clicking the pen icon.

  7. Click Apply Changes to finish the configuration. A message at the top of the screen shows if the resource was successfully updated or not.

For the processes which take place if the resource monitor detects a failure, refer to Section 4.3, “Resource Monitoring”.

To view resource failures, switch to the Cluster Status screen in Hawk and select the resource you are interested in. Click the wrench icon next to the resource and select Show Details.

5.3.10. Configuring a Cluster Resource Group

Some cluster resources depend on other components or resources and require that each component or resource starts in a specific order and runs on the same server. To simplify this configuration we support the concept of groups.

For an example of a resource group and more information about groups and their properties, refer to Section 4.2.5.1, “Groups”.

[Note]Empty Groups

Groups must contain at least one resource, otherwise the configuration is not valid. In Hawk, primitives cannot be created or modified while creating a group. Before adding a group, create primitives and configure them as desired. For details, refer to Procedure 5.4, “Adding Primitive Resources”.

Procedure 5.15. Adding a Resource Group

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Resources. The Resources screen shows categories for all types of resources and lists all defined resources.

  3. Select the Group category and click the plus icon.

  4. Enter a unique Group ID.

  5. To define the group members, select one or multiple entries in the list of Available Primitives and click the < icon to add them to the Group Children list. Any new group members are added to the bottom of the list. To define the order of the group members, you currently need to add and remove them in the order you desire.

  6. If needed, modify or add Meta Attributes as described in Adding Primitive Resources, Step 7.

  7. Click Create Group to finish the configuration. A message at the top of the screen shows if the group was successfully created.

Figure 5.10. Hawk—Resource Group

Hawk—Resource Group

5.3.11. Configuring a Clone Resource

If you want certain resources to run simultaneously on multiple nodes in your cluster, configure these resources as a clones. For example, cloning makes sense for resources like STONITH and cluster file systems like OCFS2. You can clone any resource provided. Cloning is supported by the resource’s Resource Agent. Clone resources may be configured differently depending on which nodes they are running on.

For an overview of the available types of resource clones, refer to Section 4.2.5.2, “Clones”.

[Note]Sub-resources for Clones

Clones can either contain a primitive or a group as sub-resources. In Hawk, sub-resources cannot be created or modified while creating a clone. Before adding a clone, create sub-resources and configure them as desired. For details, refer to Procedure 5.4, “Adding Primitive Resources” or Procedure 5.15, “Adding a Resource Group”.

Procedure 5.16. Adding or Modifying Clones

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Resources. The Resources screen shows categories for all types of resources and lists all defined resources.

  3. Select the Clone category and click the plus icon.

  4. Enter a unique Clone ID.

  5. From the Child Resource list, select the primitive or group to use as a sub-resource for the clone.

  6. If needed, modify or add Meta Attributes as described in Procedure 5.4: Adding Primitive Resources, Step 7.

  7. Click Create Clone to finish the configuration. A message at the top of the screen shows if the clone was successfully created.

Figure 5.11. Hawk—Clone Resource

Hawk—Clone Resource

5.4. Managing Cluster Resources

In addition to configuring your cluster resources, Hawk allows you to manage existing resources from the Cluster Status screen. For a general overview of the screen, its different views and the color code used for status information, refer to Section 5.1.2, “Main Screen: Cluster Status”.

Basic resource operations can be executed from any cluster status view. Both Tree View and Table View let you access the individual resources directly. However, in the Summary View you need to click the links in the resources category first to display the resource details. The detailed view also shows any attributes set for that resource. For primitive resources (regular primitives, children of groups, clones, or master/slave resources), the following information will be shown additionally:

  • the resource's failcount

    the last failure timestamp (if the failcount is > 0)

  • operation history and timings (call id, operation, last run timestamp, execution time, queue time, return code and last rc change timestamp)

Figure 5.12. Viewing a Resource's Details

Viewing a Resource's Details

5.4.1. Starting Resources

Before you start a cluster resource, make sure it is set up correctly. For example, if you want to use an Apache server as a cluster resource, set up the Apache server first and complete the Apache configuration before starting the respective resource in your cluster.

[Note]Do Not Touch Services Managed by the Cluster

When managing a resource via the High Availability Extension, the same resource must not be started or stopped otherwise (outside of the cluster, for example manually or on boot or reboot). The High Availability Extension software is responsible for all service start or stop actions.

However, if you want to check if the service is configured properly, start it manually, but make sure that it is stopped again before High Availability takes over.

For interventions in resources that are currently managed by the cluster, set the resource to unmanaged mode first as described in Procedure 5.22, “Changing Management Mode of Resources”.

When creating a resource with Hawk, you can set its initial state with the target-role meta attribute. If you set its value to stopped, the resource does not start automatically after being created.

Procedure 5.17. Starting A New Resource

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Cluster Status.

  3. In one of the individual resource views, click the wrench icon next to the resource and select Start. To continue, confirm the message that appears. As soon as the resource has started, Hawk changes the resource's color to green and shows on which node it is running.

5.4.2. Cleaning Up Resources

A resource will be automatically restarted if it fails, but each failure increases the resource's failcount.

If a migration-threshold has been set for the resource, the node will no longer run the resource when the number of failures reaches the migration threshold.

A resource's failcount can either be reset automatically (by setting a failure-timeout option for the resource) or you can reset it manually as described below.

Procedure 5.18. Cleaning Up A Resource

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Cluster Status.

  3. In one of the individual resource views, click the wrench icon next to the failed resource and select Clean Up. To continue, confirm the message that appears.

    This executes the commands crm_resource -C and crm_failcount -D for the specified resource on the specified node.

For more information, see the man pages of crm_resource and crm_failcount.

5.4.3. Removing Cluster Resources

If you need to remove a resource from the cluster, follow the procedure below to avoid configuration errors:

[Note]Removing Referenced Resources

A cluster resource cannot be removed if its ID is referenced by any constraint. If you cannot delete a resource, check where the resource ID is referenced and remove the resource from the constraint first.

Procedure 5.19. Removing a Cluster Resource

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Cluster Status.

  3. Clean up the resource on all nodes as described in Procedure 5.18, “Cleaning Up A Resource”.

  4. In one of the individual resource views, click the wrench icon next to the resource and select Stop. To continue, confirm the message that appears.

  5. Remove all constraints that relate to the resource, otherwise removing the resource will not be possible. For details, refer to Procedure 5.11, “Removing Constraints”.

  6. If the resource is stopped, click the wrench icon next to it and select Delete Resource.

5.4.4. Migrating Cluster Resources

As mentioned in Section 5.3.6, “Specifying Resource Failover Nodes”, the cluster will fail over (migrate) resources automatically in case of software or hardware failures—according to certain parameters you can define (for example, migration threshold or resource stickiness). Apart from that, you can also manually migrate a resource to another node in the cluster (or decide to just move it away from the current node and leave the decision where to put it to the cluster).

Procedure 5.20. Manually Migrating a Resource

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Cluster Status.

  3. In one of the individual resource views, click the wrench icon next to the resource and select Move.

  4. In the new window, select the node to which to move the resource.

    This creates a location constraint with an INFINITY score for the destination node.

  5. Alternatively, select to move the resource Away from current node.

    This creates a location constraint with a -INFINITY score for the current node.

  6. Click OK to confirm the migration.

To allow a resource to move back again, proceed as follows:

Procedure 5.21. Clearing a Migration Constraint

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Cluster Status.

  3. In one of the individual resource views, click the wrench icon next to the resource and select Drop Relocation Rule. To continue, confirm the message that appears.

    This uses the crm_resource -U command. The resource can move back to its original location or it may stay where it is (depending on resource stickiness).

For more information, see the crm_resource man page or Pacemaker Explained, available from http://www.clusterlabs.org/doc/ . Refer to section Resource Migration.

5.4.5. Changing Management Mode of Resources

When a resource is being managed by the cluster, it must not be touched otherwise (outside of the cluster). For maintenance of individual resources, you can set the respective resources to an unmanaged mode that allows you to modify the resource outside of the cluster.

Procedure 5.22. Changing Management Mode of Resources

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Resources. Select the resource you want to put in unmanaged mode, click the wrench icon next to the resource and select Edit Resource.

  3. Open the Meta Attributes category.

  4. From the empty drop-down list, select the is-managed attribute and click the plus icon to add it.

  5. Deactivate the checkbox next to is-managed to put the resource in unmanaged mode and confirm your changes.

  6. After you have finished the maintenance task for that resource, reactivate the checkbox next to the is-managed attribute for that resource.

    From this point on, the resource will be managed by the High Availability Extension software again.

5.4.6. Setting Nodes to Maintenance Mode

Sometimes it is necessary to put single nodes into maintenance mode. If your cluster consists of more than 3 nodes, you can easily set one node to maintenance mode, while the other nodes continue their normal operation.

Procedure 5.23. Changing Maintenance Mode of Nodes

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Cluster Status.

  3. In one of the individual nodes' views, click the wrench icon next to the node and select Maintenance.

    This will add the following instance attribute to the node: maintenance="true". The resources previously running on the maintenance-mode node will become unmanaged. No new resources will be allocated to the node until it leaves the maintenance mode.

  4. To deactivate the maintenance mode, click the wrench icon next to the node and select Ready.

5.4.7. Viewing the Cluster History

Hawk provides the following possibilities to view past events on the cluster (on different levels and in varying detail).

Procedure 5.24. Viewing Recent Events of Nodes or Resources

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Cluster Status.

  3. In the Tree View or Table View, click the wrench icon next to the resource or node you are interested in and select View Recent Events.

    The dialog that opens shows the events of the last hour.

Procedure 5.25. Viewing Transitions with the History Explorer

The History Explorer provides transition information for a time frame that you can define. It also lists its previous runs and allows you to Delete reports that you no longer need.

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select History Explorer.

  3. By default, the period to explore is set to the last 24 hours. To modify this, set another Start Time and End Time.

  4. Click Display to start collecting transition data.

Figure 5.13. Hawk—History Report

Hawk—History Report

The following information is displayed:

Time

The time line of all past transitions in the cluster.

PE Input/Node

The pe-input* file for each transition and the node on which it was generated. For each transition, the cluster saves a copy of the state which is provided to the policy engine as input. The path to this archive is logged. The pe-input* files are only generated on the Designated Coordinator (DC), but as the DC can change, there may be pe-input* files from several nodes. The files show what the Policy Engine (PE) planned to do.

Details/Full Log

Opens a pop-up window with snippets of /var/log/messages that belong to that particular transition. Different amounts of details are available: Clicking Details displays the output of crm history transition peinput (including the resource agents' log messages), whereas Full Log also includes details from the pengine, crmd, and lrmd and is equivalent to crm history transition log peinput.

Graph/XML

A graph and an XML representation of each transition. If you choose to show the Graph, the PE is reinvoked (using the pe-input* files), and generates a graphical visualization of the transition. Alternatively, you can view the XML representation of the graph.

Figure 5.14. Hawk History Report—Transition Graph

Hawk History Report—Transition Graph

Diff

If two or more pe-inputs are listed, a Diff link will appear to the right of each pair of pe-inputs. Clicking it displays the difference of configuration and status.

5.4.8. Exploring Potential Failure Scenarios

Hawk provides a Simulator that allows you to explore failure scenarios before they happen. After switching to the simulator mode, you can change the status of nodes, add or edit resources and constraints, change the cluster configuration, or execute multiple resource operations to see how the cluster would behave should these events occur. As long as the simulator mode is activated, a control dialog will be displayed in the bottom right hand corner of the Cluster Status screen. The simulator will collect the changes from all screens and will add them to its internal queue of events. The simulation run with the queued events will not be executed unless it is manually triggered in the control dialog. After the simulation run, you can view and analyze the details of what would have happened (log snippets, transition graph, and CIB states).

Procedure 5.26. Switching to Simulator Mode

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. Activate the simulator mode by clicking the wrench icon in the top-level row (next to the username), and by selecting Simulator.

    Hawk's background changes color to indicate the simulator is active. A simulator control dialog is displayed in the bottom right hand corner of the Cluster Status screen. Its title Simulator (initial state) indicates that no simulator run has occurred yet.

  3. Fill the simulator's event queue:

    1. To simulate status change of a node: Click +Node in the simulator control dialog. Select the Node you want to manipulate and select its target State. Confirm your changes to add them to the queue of events listed in the controller dialog.

    2. To simulate a resource operation: Click +Op in the simulator control dialog. Select the Resource to manipulate and the Operation to simulate. If necessary, define an Interval. Select the Node on which to run the operation and the targeted Result. Confirm your changes to add them to the queue of events listed in the controller dialog.

  4. Repeat the previous steps for any other node status changes or resource operations you wish to simulate.

    Figure 5.15. Hawk—Simulator with Injected Events

    Hawk—Simulator with Injected Events

  5. To inject other changes that you wish to simulate:

    1. Switch to one or more of the following Hawk screens: Cluster Status, Setup Wizard, Cluster Configuration, Resources, or Constraints.

      [Note]History Explorer and Simulator Mode

      Clicking the History Explorer tab will deactivate simulator mode.

    2. Add or modify parameters on the screens as desired.

      The simulator will collect the changes from all screens and will add them to its internal queue of events.

    3. To return to the simulator control dialog, switch to the Cluster Status screen or click the wrench icon in the top-level row and click Simulator again.

  6. If you want to remove an event listed in Injected State, select the respective entry and click the minus icon beneath the list.

  7. Start the simulation run by clicking Run in the simulator control dialog. The Cluster Status screen displays the simulated events. For example, if you marked a node as unclean, it will now be shown offline, and all its resources will be stopped. The simulator control dialog changes to Simulator (final state).

    Figure 5.16. Hawk—Simulator in Final State

    Hawk—Simulator in Final State

  8. To view more detailed information about the simulation run:

    1. Click the Details link in the simulator dialog to see log snippets of what occurred.

    2. Click the Graph link to show the transition graph.

    3. Click CIB (in) to display the initial CIB state. To see what the CIB would look like after the transition, click CIB (out).

  9. To start from scratch with a new simulation, use the Reset button.

  10. To exit the simulation mode, close the simulator control dialog. The Cluster Status screen switches back to its normal color and displays the current cluster state.

5.4.9. Generating a Cluster Report

For analysis and diagnosis of problems occurring on the cluster, Hawk can generate a cluster report that collects information from all nodes in the cluster.

Procedure 5.27. Generating a hb_report

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. Click the wrench icon next to the username in the top-level row, and select Generate hb_report.

  3. By default, the period to examine is the last hour. To modify this, set another Start Time and End Time.

  4. Click Generate.

  5. After the report has been created, download the *.tar.bz2 file by clicking the respective link.

For more information about the log files that the hb_report covers, refer to How can I create a report with an analysis of all my cluster nodes?.

5.5. Multi-Site Clusters (Geo Clusters)

Support for multi-site clusters is available as a separate option to SUSE Linux Enterprise High Availability Extension. For an introduction and detailed information on how to set up multi-site clusters, refer to Chapter 13, Multi-Site Clusters (Geo Clusters).

Some of the required steps need to be executed within the individual clusters (that are then combined to a multi-site cluster), while other steps take place on an inter-cluster layer. Therefore not all setup steps can alternatively be executed with Hawk. But Hawk offers the following features related to multi-site clusters:

5.5.1. Viewing Tickets

Procedure 5.28. Viewing Tickets with Hawk

Tickets are visible in Hawk if they have been granted or revoked at least once or if they are referenced in a ticket dependency—see Procedure 5.29, “Configuring Ticket Dependencies”. In case a ticket is referenced in a ticket dependency, but has not been granted to any site yet, Hawk displays it as revoked.

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Cluster Status.

  3. If the Summary View is not already active, click the respective view icon on the upper right-hand side. Along with information about cluster nodes and resources, Hawk also displays a Ticket category.

  4. For more details, either click the title of the Ticket category or the individual ticket entries that are marked as links. Hawk displays the ticket's name and, in a tooltip, the last time the ticket has been granted to the current site.

    Figure 5.17. Hawk Cluster Status (Summary View)—Ticket Details

    Hawk Cluster Status (Summary View)—Ticket Details

[Note]Managing Tickets

To grant or revoke tickets, use the booth client command as described in Section 13.5, “Managing Multi-Site Clusters”. As managing tickets takes place on an inter-cluster layer, you cannot do so with Hawk.

5.5.2. Configuring Additional Cluster Resources and Constraints

Apart from the resources and constraints that you need to define for your specific cluster setup, multi-site clusters require additional resources and constraints as outlined in Section 13.4.1, “Configuring Cluster Resources and Constraints”. All of those can be configured with the CRM shell, but alternatively also with Hawk.

This section focuses on ticket dependencies only as they are specific to multi-site clusters. For general instructions on how to configure resource groups and order constraints with Hawk, refer to Section 5.3.10, “Configuring a Cluster Resource Group” and Procedure 5.9, “Adding or Modifying Colocational or Order Constraints”, respectively.

Procedure 5.29. Configuring Ticket Dependencies

For multi-site clusters, you can specify which resources depend on a certain ticket. Together with this special type of constraint, you can set a loss-policy that defines what should happen to the respective resources if the ticket is revoked. The attribute loss-policy can have the following values:

  • fence: Fence the nodes that are running the relevant resources.

  • stop: Stop the relevant resources.

  • freeze: Do nothing to the relevant resources.

  • demote: Demote relevant resources that are running in master mode to slave mode.

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. In the left navigation bar, select Constraints. The Constraints screen shows categories for all types of constraints and lists all defined constraints.

  3. To add a new ticket dependency, click the plus icon in the Ticket category.

    To modify an existing constraint, click the wrench icon next to the constraint and select Edit Constraint.

  4. Enter a unique Constraint ID. When modifying existing constraints, the ID is already defined.

  5. Set a Loss Policy.

  6. Enter the ID of the ticket that the resources should depend on.

  7. Select a resource from the list Add resource to constraint. The list shows the IDs of all resources and all resource templates configured for the cluster.

  8. To add the selected resource, click the plus icon next to the list. A new list appears beneath, showing the remaining resources. Add as many resources to the constraint as you would like to depend on the ticket.

    Figure 5.18. Hawk—Example Ticket Dependency

    Hawk—Example Ticket Dependency

    Figure 5.18, “Hawk—Example Ticket Dependency” shows a constraint with the ID rsc1-req-ticketA. It defines that the resource rsc1 depends on ticketA and that the node running the resource should be fenced in case ticketA is revoked.

  9. Click Create Constraint to finish the configuration. A message at the top of the screen shows if the constraint was successfully created.

5.5.3. Testing the Impact of Ticket Failover

Hawk's Simulator allows you to explore failure scenarios before they happen. To explore if your resources that depend on a certain ticket behave as expected, you can also test the impact of granting or revoking tickets.

Procedure 5.30. Simulating Granting and Revoking Tickets

  1. Start a Web browser and log in to the cluster as described in Section 5.1.1, “Starting Hawk and Logging In”.

  2. Click the wrench icon next to the username in the top-level row, and select Simulator.

    Hawk's background changes color to indicate the simulator is active. A simulator dialog opens in the bottom right hand corner of the screen. Its title Simulator (initial state) indicates that Cluster Status screen still reflects the current state of the cluster.

  3. To simulate status change of a ticket:

    1. Click +Ticket in the simulator control dialog.

    2. Select the Action you want to simulate.

    3. Confirm your changes to add them to the queue of events listed in the controller dialog below Injected State.

  4. To start the simulation, click Run in the simulator control dialog. The Cluster Status screen displays the impact of the simulated events. The simulator control dialog changes to Simulator (final state).

  5. To exit the simulation mode, close the simulator control dialog. The Cluster Status screen switches back to its normal color and displays the current cluster state.

Figure 5.19. HawkSimulator—Tickets

HawkSimulator—Tickets

For more information about Hawk's Simulator (and which other scenarios can be explored with it), refer to Section 5.5.3, “Testing the Impact of Ticket Failover”.

5.6. Monitoring Multiple Clusters

Use Hawk as a single point of administration for monitoring multiple clusters. Hawk's Cluster Dashboard allows you to view a summary of multiple clusters, with each summary listing the number of nodes, resources, tickets (if you use multi-site clusters), and their state. The summary also shows if any failures have appeared in the respective cluster.

The cluster information displayed in the Cluster Dashboard is stored in a persistent cookie. This means you need to decide which Hawk instance you want to view the Cluster Dashboard on, and always use that one. The machine you are running Hawk on does not even have to be part of any cluster for that purpose—it can be a separate, unrelated system.

Procedure 5.31. Monitoring Multiple Clusters with Hawk

Prerequisites

  • All clusters to be monitored from Hawk's Cluster Dashboard must be running SUSE Linux Enterprise High Availability Extension SP3. It is not possible to monitor clusters that are running earlier versions of SUSE Linux Enterprise High Availability Extension.

  • If you did not replace the self-signed certificate for Hawk on every cluster node with your own certificate (or a certificate signed by an official Certificate Authority), you must log in to Hawk on every node in every cluster at least once. Verify the certificate (or add an exception in the browser to bypass the warning).

  • If using Mozilla Firefox, you must change its preferences to Accept third-party cookies. Otherwise cookies from monitored clusters will not be set, thus preventing login to the clusters you are trying to monitor.

  1. Start the Hawk Web service on a machine you want to use for monitoring multiple clusters.

  2. Start a Web browser and point it at the IP address or hostname of the machine that runs Hawk:

    https://IPaddress:7630/
  3. On the Hawk login screen, click the Dashboard link in the right upper corner.

    The Add Cluster dialog appears.

  4. Enter a custom Cluster Name with which to identify the cluster the Cluster Dashboard.

  5. Enter the Host Name of one of the cluster nodes and confirm your changes.

    The Cluster Dashboard opens and shows a summary of the cluster you just added.

  6. To add more clusters to the dashboard, click the plus icon and enter the details for the next cluster.

    Figure 5.20. Hawk—Cluster Dashboard

    Hawk—Cluster Dashboard

  7. To remove a cluster from the dashboard, click the x icon next to the cluster's summary.

  8. To view more details about a cluster, click somewhere into the cluster's box on the dashboard.

    This opens a new browser window or new browser tab. If you are not currently logged in to the cluster, this takes you to the Hawk login screen. After having logged in, Hawk shows the Cluster Status of that cluster in the summary view. From here, you can administrate the cluster with Hawk as usual.

  9. As the Cluster Dashboard stays open in a separate browser window or tab, you can easily switch between the dashboard and the administration of individual clusters in with Hawk.

Any status changes for nodes or resources are reflected almost immediately within the Cluster Dashboard.

[Note]Node Not Accessible

The Cluster Dashboard only polls one node in each cluster for status. If the node being polled goes down, the dashboard will cycle to poll another node. In that case, Hawk briefly displays a warning message about that node being inaccessible. The message will disappear after Hawk has found another node to contact.

5.7. Troubleshooting

Hawk Log Files

Find the Hawk log files in /srv/www/hawk/log. Check these files in case you cannot access Hawk.

If you have trouble starting or stopping a resource with Hawk, check the Pacemaker log messages. By default, Pacemaker logs to /var/log/messages.

Authentication Fails

If you cannot log in to Hawk with a new user that is a member of the haclient group (or if you experience delays until Hawk accepts logins from this user), stop the nscd daemon with rcnscd stop and try again.

Replacing the Self-Signed Certificate

To avoid the warning about the self-signed certificate on first Hawk startup, replace the automatically created certificate with your own certificate or a certificate that was signed by an official Certificate Authority (CA).

The certificate is stored in /etc/lighttpd/certs/hawk-combined.pem and contains both key and certificate. After you have created or received your new key and certificate, combine them by executing the following command:

cat keyfile certificatefile > /etc/lighttpd/certs/hawk-combined.pem

Change the permissions to make the file only accessible by root:

chown root.root /etc/lighttpd/certs/hawk-combined.pem
chmod 600 /etc/lighttpd/certs/hawk-combined.pem
Login to Hawk Fails After Using History Explorer/hb_report

Depending on the period of time you defined in the History Explorer or hb_report and the events that took place in the cluster during this time, Hawk might collect an extensive amount of information stored in log files in the /tmp directory. This might consume the remaining free disk space on your node. In case Hawk should not respond after using the History Explorer or hb_report, check the hard disk of your cluster node and remove the respective log files.

Cluster Dashboard: Unable to connect to host

If adding clusters to Hawk's dashboard fails, check the prerequisites listed in Procedure 5.31, “Monitoring Multiple Clusters with Hawk”.

Cluster Dashboard: Node Not Accessible

The Cluster Dashboard only polls one node in each cluster for status. If the node being polled goes down, the dashboard will cycle to poll another node. In that case, Hawk briefly displays a warning message about that node being inaccessible. The message will disappear after Hawk has found another node to contact to.

Chapter 6. Configuring and Managing Cluster Resources (GUI)

Abstract

This chapter introduces the Pacemaker GUI and covers basic tasks needed when configuring and managing cluster resources: modifying global cluster options, creating basic and advanced types of resources (groups and clones), configuring constraints, specifying failover nodes and failback nodes, configuring resource monitoring, starting, cleaning up or removing resources, and migrating resources manually.

Support for the GUI is provided by two packages: The pacemaker-mgmt package contains the back-end for the GUI (the mgmtd daemon). It must be installed on all cluster nodes you want to connect to with the GUI. On any machine where you want to run the GUI, install the pacemaker-mgmt-client package.

[Note]User Authentication

To log in to the cluster from the Pacemaker GUI, the respective user must be a member of the haclient group. The installation creates a linux user named hacluster and adds the user to the haclient group.

Before using the Pacemaker GUI, either set a password for the hacluster user or create a new user which is member of the haclient group.

Do this on every node you will connect to with the Pacemaker GUI.

6.1. Pacemaker GUI—Overview

To start the Pacemaker GUI, enter crm_gui at the command line. To access the configuration and administration options, you need to log in to a cluster.

6.1.1. Logging in to a Cluster

To connect to the cluster, select Connection+Login. By default, the Server field shows the localhost's IP address and hacluster as User Name. Enter the user's password to continue.

Figure 6.1. Connecting to the Cluster

Connecting to the Cluster

If you are running the Pacemaker GUI remotely, enter the IP address of a cluster node as Server. As User Name, you can also use any other user belonging to the haclient group to connect to the cluster.

6.1.2. Main Window

After being connected, the main window opens:

Figure 6.2. Pacemaker GUI - Main Window

Pacemaker GUI - Main Window

[Note]Available Functions in Pacemaker GUI

By default, users logged in as root or hacluster have full read-write access to all cluster configuration tasks. However, Access Control Lists can be used to define fine-grained access permissions.

If ACLs are enabled in the CRM, the available functions in the Pacemaker GUI depend on the user role and access permission assigned to you.

To view or modify cluster components like the CRM, resources, nodes or constraints, select the respective subentry of the Configuration category in the left pane and use the options that become available in the right pane. Additionally, the Pacemaker GUI lets you easily view, edit, import and export XML fragments of the CIB for the following subitems: Resource Defaults, Operation Defaults, Nodes, Resources, and Constraints. Select any of the Configuration subitems and select Show+XML Mode in the upper right corner of the window.

If you have already configured your resources, click the Management category in the left pane to show the status of your cluster and its resources. This view also allows you to set nodes to standby and to modify the management status of nodes (if they are currently managed by the cluster or not). To access the main functions for resources (starting, stopping, cleaning up or migrating resources), select the resource in the right pane and use the icons in the toolbar. Alternatively, right-click the resource and select the respective menu item from the context menu.

The Pacemaker GUI also allows you to switch between different view modes, influencing the behavior of the software and hiding or showing certain aspects:

Simple Mode

Lets you add resources in a wizard-like mode. When creating and modifying resources, shows the frequently-used tabs for sub-objects, allowing you to directly add objects of that type via the tab.

Allows you to view and change all available global cluster options by selecting the CRM Config entry in the left pane. The right pane then shows the values that are currently set. If no specific value is set for an option, it shows the default values instead.

Expert Mode

Lets you add resources in either a wizard-like mode or via dialog windows. When creating and modifying resources, it only shows the corresponding tab if a particular type of sub-object already exists in CIB. When adding a new sub-object, you will be prompted to select the object type, thus allowing you to add all supported types of sub-objects.

When selecting the CRM Config entry in the left pane, it only shows the values of global cluster options that have been actually set. It hides all cluster options that will automatically use the defaults (because no values have been set). In this mode, the global cluster options can only be modified by using the individual configuration dialogs.

Hack Mode

Has the same functions as the expert mode. Allows you to add additional attribute sets that include specific rules to make your configuration more dynamic. For example, you can make a resource have different instance attributes depending on the node it is hosted on. Furthermore, you can add a time-based rule for a meta attribute set to determine when the attributes take effect.

The window's status bar also shows the currently active mode.

The following sections guide you through the main tasks you need to execute when configuring cluster options and resources and show you how to administer the resources with the Pacemaker GUI. Where not stated otherwise, the step-by-step instructions reflect the procedure as executed in the simple mode.

6.2. Configuring Global Cluster Options

Global cluster options control how the cluster behaves when confronted with certain situations. They are grouped into sets and can be viewed and modified with the cluster management tools like Pacemaker GUI and crm shell. The predefined values can be kept in most cases. However, to make key functions of your cluster work correctly, you need to adjust the following parameters after basic cluster setup:

Procedure 6.1. Modifying Global Cluster Options

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. Select View+Simple Mode.

  3. In the left pane, select CRM Config to view the global cluster options and their current values.

  4. Depending on your cluster requirements, set No Quorum Policy to the appropriate value.

  5. If you need to disable fencing for any reasons, deselect stonith-enabled.

    [Important]No Support Without STONITH

    A cluster without STONITH enabled is not supported.

  6. Confirm your changes with Apply.

You can at any time switch back to the default values for all options by selecting CRM Config in the left pane and clicking Default.

6.3. Configuring Cluster Resources

As a cluster administrator, you need to create cluster resources for every resource or application you run on servers in your cluster. Cluster resources can include Web sites, e-mail servers, databases, file systems, virtual machines, and any other server-based applications or services you want to make available to users at all times.

For an overview of resource types you can create, refer to Section 4.2.3, “Types of Resources”.

6.3.1. Creating Simple Cluster Resources

To create the most basic type of a resource, proceed as follows:

Procedure 6.2. Adding Primitive Resources

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. In the left pane, select Resources and click Add+Primitive.

  3. In the next dialog, set the following parameters for the resource:

    1. Enter a unique ID for the resource.

    2. From the Class list, select the resource agent class you want to use for that resource: lsb, ocf, service, or stonith. For more information, see Section 4.2.2, “Supported Resource Agent Classes”.

    3. If you selected ocf as class, also specify the Provider of your OCF resource agent. The OCF specification allows multiple vendors to supply the same resource agent.

    4. From the Type list, select the resource agent you want to use (for example, IPaddr or Filesystem). A short description for this resource agent is displayed below.

      The selection you get in the Type list depends on the Class (and for OCF resources also on the Provider) you have chosen.

    5. Below Options, set the Initial state of resource.

    6. Activate Add monitor operation if you want the cluster to monitor if the resource is still healthy.

  4. Click Forward. The next window shows a summary of the parameters that you have already defined for that resource. All required Instance Attributes for that resource are listed. You need to edit them in order to set them to appropriate values. You may also need to add more attributes, depending on your deployment and settings. For details how to do so, refer to Procedure 6.3, “Adding or Modifying Meta and Instance Attributes”.

  5. If all parameters are set according to your wishes, click Apply to finish the configuration of that resource. The configuration dialog is closed and the main window shows the newly added resource.

During or after creation of a resource, you can add or modify the following parameters for resources:

Procedure 6.3. Adding or Modifying Meta and Instance Attributes

  1. In the Pacemaker GUI main window, click Resources in the left pane to see the resources already configured for the cluster.

  2. In the right pane, select the resource to modify and click Edit (or double-click the resource). The next window shows the basic resource parameters and the Meta Attributes, Instance Attributes or Operations already defined for that resource.

  3. To add a new meta attribute or instance attribute, select the respective tab and click Add.

  4. Select the Name of the attribute you want to add. A short Description is displayed.

  5. If needed, specify an attribute Value. Otherwise the default value of that attribute will be used.

  6. Click OK to confirm your changes. The newly added or modified attribute appears on the tab.

  7. If all parameters are set according to your wishes, click OK to finish the configuration of that resource. The configuration dialog is closed and the main window shows the modified resource.

[Tip]XML Source Code for Resources

The Pacemaker GUI allows you to view the XML fragments that are generated from the parameters that you have defined. For individual resources, select Show+XML Mode in the top right corner of the resource configuration dialog.

To access the XML representation of all resources that you have configured, click Resources in the left pane and then select Show+XML Mode in the upper right corner of the main window.

The editor displaying the XML code allows you to Import or Export the XML elements or to manually edit the XML code.

6.3.2. Creating STONITH Resources

[Important]No Support Without STONITH

A cluster without STONITH running is not supported.

By default, the global cluster option stonith-enabled is set to true: If no STONITH resources have been defined, the cluster will refuse to start any resources. To complete STONITH setup, you need to configure one or more STONITH resources. While they are configured similar to other resources, the behavior of STONITH resources is different in some respects. For details refer to Section 9.3, “STONITH Configuration”.

Procedure 6.4. Adding a STONITH Resource

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. In the left pane, select Resources and click Add+Primitive.

  3. In the next dialog, set the following parameters for the resource:

    1. Enter a unique ID for the resource.

    2. From the Class list, select the resource agent class stonith.

    3. From the Type list, select the STONITH plug-in for controlling your STONITH device. A short description for this plug-in is displayed below.

    4. Below Options, set the Initial state of resource.

    5. Activate Add monitor operation if you want the cluster to monitor the fencing device. For more information, refer to Section 9.4, “Monitoring Fencing Devices”.

  4. Click Forward. The next window shows a summary of the parameters that you have already defined for that resource. All required Instance Attributes for the selected STONITH plug-in are listed. You need to edit them in order to set them to appropriate values. You may also need to add more attributes or monitor operations, depending on your deployment and settings. For details how to do so, refer to Procedure 6.3, “Adding or Modifying Meta and Instance Attributes” and Section 6.3.8, “Configuring Resource Monitoring”.

  5. If all parameters are set according to your wishes, click Apply to finish the configuration of that resource. The configuration dialog closes and the main window shows the newly added resource.

To complete your fencing configuration, add constraints or use clones or both. For more details, refer to Chapter 9, Fencing and STONITH.

6.3.3. Using Resource Templates

If you want to create several resources with similar configurations, defining a resource template is the easiest way. Once defined, it can be referenced in primitives or in certain types of constraints. For detailed information about function and use of resource templates, refer to Section 4.5.3, “Resource Templates and Constraints”.

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. In the left pane, select Resources and click Add+Template.

  3. Enter a unique ID for the template.

  4. Specify the resource template as you would specify a primitive. Follow Procedure 6.2: Adding Primitive Resources, starting with Step 3.b.

  5. If all parameters are set according to your wishes, click Apply to finish the configuration of the resource template. The configuration dialog is closed and the main window shows the newly added resource template.

Procedure 6.5. Referencing Resource Templates

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. To reference the newly created resource template in a primitive, follow these steps:

    1. In the left pane, select Resources and click Add+Primitive.

    2. Enter a unique ID and specify Class, Provider, and Type.

    3. Select the Template to reference.

    4. If you want to set specific instance attributes, operations or meta attributes that deviate from the template, continue to configure the resource as described in Procedure 6.2, “Adding Primitive Resources”.

  3. To reference the newly created resource template in colocational or order constraints:

    1. Configure the constraints as described in Procedure 6.7, “Adding or Modifying Colocational Constraints” or Procedure 6.8, “Adding or Modifying Ordering Constraints”, respectively.

    2. For colocation constraints, the Resources drop-down list will show the IDs of all resources and resource templates that have been configured. From there, select the template to reference.

    3. Likewise, for ordering constraints, the First and Then drop-down lists will show both resources and resource templates. From there, select the template to reference.

6.3.4. Configuring Resource Constraints

Having all the resources configured is only part of the job. Even if the cluster knows all needed resources, it might still not be able to handle them correctly. Resource constraints let you specify which cluster nodes resources can run on, what order resources will load, and what other resources a specific resource is dependent on.

For an overview which types of constraints are available, refer to Section 4.5.1, “Types of Constraints”. When defining constraints, you also need to specify scores. For more information about scores and their implications in the cluster, see Section 4.5.2, “Scores and Infinity”.

Learn how to create the different types of the constraints in the following procedures.

Procedure 6.6. Adding or Modifying Locational Constraints

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. In the Pacemaker GUI main window, click Constraints in the left pane to see the constraints already configured for the cluster.

  3. In the left pane, select Constraints and click Add.

  4. Select Resource Location and click OK.

  5. Enter a unique ID for the constraint. When modifying existing constraints, the ID is already defined and is displayed in the configuration dialog.

  6. Select the Resource for which to define the constraint. The list shows the IDs of all resources that have been configured for the cluster.

  7. Set the Score for the constraint. Positive values indicate the resource can run on the Node you specify below. Negative values mean it should not run on this node. Setting the score to INFINITY forces the resource to run on the node. Setting it to -INFINITY means the resources must not run on the node.

  8. Select the Node for the constraint.

  9. If you leave the Node and the Score field empty, you can also add rules by clicking Add+Rule. To add a lifetime, just click Add+Lifetime.

  10. If all parameters are set according to your wishes, click OK to finish the configuration of the constraint. The configuration dialog is closed and the main window shows the newly added or modified constraint.

Procedure 6.7. Adding or Modifying Colocational Constraints

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. In the Pacemaker GUI main window, click Constraints in the left pane to see the constraints already configured for the cluster.

  3. In the left pane, select Constraints and click Add.

  4. Select Resource Colocation and click OK.

  5. Enter a unique ID for the constraint. When modifying existing constraints, the ID is already defined and is displayed in the configuration dialog.

  6. Select the Resource which is the colocation source. The list shows the IDs of all resources and resource templates that have been configured for the cluster.

    If the constraint cannot be satisfied, the cluster may decide not to allow the resource to run at all.

  7. If you leave both the Resource and the With Resource field empty, you can also add a resource set by clicking Add+Resource Set. To add a lifetime, just click Add+Lifetime.

  8. In With Resource, define the colocation target. The cluster will decide where to put this resource first and then decide where to put the resource in the Resource field.

  9. Define a Score to determine the location relationship between both resources. Positive values indicate the resources should run on the same node. Negative values indicate the resources should not run on the same node. Setting the score to INFINITY forces the resources to run on the same node. Setting it to -INFINITY means the resources must not run on the same node. The score will be combined with other factors to decide where to put the resource.

  10. If needed, specify further parameters, like Resource Role.

    Depending on the parameters and options you choose, a short Description explains the effect of the colocational constraint you are configuring.

  11. If all parameters are set according to your wishes, click OK to finish the configuration of the constraint. The configuration dialog is closed and the main window shows the newly added or modified constraint.

Procedure 6.8. Adding or Modifying Ordering Constraints

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. In the Pacemaker GUI main window, click Constraints in the left pane to see the constraints already configured for the cluster.

  3. In the left pane, select Constraints and click Add.

  4. Select Resource Order and click OK.

  5. Enter a unique ID for the constraint. When modifying existing constraints, the ID is already defined and is displayed in the configuration dialog.

  6. With First, define the resource that must be started before the resource specified with Then is allowed to.

  7. With Then define the resource that will start after the First resource.

    Depending on the parameters and options you choose, a short Description explains the effect of the ordering constraint you are configuring.

  8. If needed, define further parameters, for example:

    1. Specify a Score. If greater than zero, the constraint is mandatory, otherwise it is only a suggestion. The default value is INFINITY.

    2. Specify a value for Symmetrical. If true, the resources are stopped in the reverse order. The default value is true.

  9. If all parameters are set according to your wishes, click OK to finish the configuration of the constraint. The configuration dialog is closed and the main window shows the newly added or modified constraint.

You can access and modify all constraints that you have configured in the Constraints view of the Pacemaker GUI.

Figure 6.3. Pacemaker GUI - Constraints

Pacemaker GUI - Constraints

6.3.5. Specifying Resource Failover Nodes

A resource will be automatically restarted if it fails. If that cannot be achieved on the current node, or it fails N times on the current node, it will try to fail over to another node. You can define a number of failures for resources (a migration-threshold), after which they will migrate to a new node. If you have more than two nodes in your cluster, the node a particular resource fails over to is chosen by the High Availability software.

However, you can specify the node a resource will fail over to by proceeding as follows:

  1. Configure a location constraint for that resource as described in Procedure 6.6, “Adding or Modifying Locational Constraints”.

  2. Add the migration-threshold meta attribute to that resource as described in Procedure 6.3, “Adding or Modifying Meta and Instance Attributes” and enter a Value for the migration-threshold. The value should be positive and less that INFINITY.

  3. If you want to automatically expire the failcount for a resource, add the failure-timeout meta attribute to that resource as described in Procedure 6.3, “Adding or Modifying Meta and Instance Attributes” and enter a Value for the failure-timeout.

  4. If you want to specify additional failover nodes with preferences for a resource, create additional location constraints.

For an example of the process flow in the cluster regarding migration thresholds and failcounts, see Example 4.2, “Migration Threshold—Process Flow”.

Instead of letting the failcount for a resource expire automatically, you can also clean up failcounts for a resource manually at any time. Refer to Section 6.4.2, “Cleaning Up Resources” for the details.

6.3.6. Specifying Resource Failback Nodes (Resource Stickiness)

A resource might fail back to its original node when that node is back online and in the cluster. If you want to prevent a resource from failing back to the node it was running on prior to failover, or if you want to specify a different node for the resource to fail back to, you must change its resource stickiness value. You can either specify resource stickiness when you are creating a resource, or afterwards.

For the implications of different resource stickiness values, refer to Section 4.5.5, “Failback Nodes”.

Procedure 6.9. Specifying Resource Stickiness

  1. Add the resource-stickiness meta attribute to the resource as described in Procedure 6.3, “Adding or Modifying Meta and Instance Attributes”.

  2. As Value for the resource-stickiness, specify a value between -INFINITY and INFINITY.

6.3.7. Configuring Placement of Resources Based on Load Impact

Not all resources are equal. Some, such as Xen guests, require that the node hosting them meets their capacity requirements. If resources are placed such that their combined need exceed the provided capacity, the resources diminish in performance (or even fail).

To take this into account, the High Availability Extension allows you to specify the following parameters:

  1. The capacity a certain node provides.

  2. The capacity a certain resource requires.

  3. An overall strategy for placement of resources.

Utilization attributes are used to configure both the resource's requirements and the capacity a node provides. The High Availability Extension now also provides means to detect and configure both node capacity and resource requirements automatically. For more details and a configuration example, refer to Section 4.5.6, “Placing Resources Based on Their Load Impact”.

To manually configure the resource's requirements and the capacity a node provides, proceed as described in Procedure 6.10, “Adding Or Modifying Utilization Attributes”. You can name the utilization attributes according to your preferences and define as many name/value pairs as your configuration needs.

Procedure 6.10. Adding Or Modifying Utilization Attributes

In the following example, we assume that you already have a basic configuration of cluster nodes and resources and now additionally want to configure the capacities a certain node provides and the capacity a certain resource requires. The procedure of adding utilization attributes is basically the same and only differs in Step 2 and Step 3.

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. To specify the capacity a node provides:

    1. In the left pane, click Node.

    2. In the right pane, select the node whose capacity you want to configure and click Edit.

  3. To specify the capacity a resource requires:

    1. In the left pane, click Resources.

    2. In the right pane, select the resource whose capacity you want to configure and click Edit.

  4. Select the Utilization tab and click Add to add an utilization attribute.

  5. Enter a Name for the new attribute. You can name the utilization attributes according to your preferences.

  6. Enter a Value for the attribute and click OK. The attribute value must be an integer.

  7. If you need more utilization attributes, repeat Step 5 to Step 6.

    The Utilization tab shows a summary of the utilization attributes that you have already defined for that node or resource.

  8. If all parameters are set according to your wishes, click OK to close the configuration dialog.

Figure 6.4, “Example Configuration for Node Capacity” shows the configuration of a node which would provide 8 CPU units and 16 GB of memory to resources running on that node:

Figure 6.4. Example Configuration for Node Capacity

Example Configuration for Node Capacity

An example configuration for a resource requiring 4096 memory units and 4 of the CPU units of a node would look as follows:

Figure 6.5. Example Configuration for Resource Capacity

Example Configuration for Resource Capacity

After (manual or automatic) configuration of the capacities your nodes provide and the capacities your resources require, you need to set the placement strategy in the global cluster options, otherwise the capacity configurations have no effect. Several strategies are available to schedule the load: for example, you can concentrate it on as few nodes as possible, or balance it evenly over all available nodes. For more information, refer to Section 4.5.6, “Placing Resources Based on Their Load Impact”.

Procedure 6.11. Setting the Placement Strategy

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. Select View+Simple Mode.

  3. In the left pane, select CRM Config to view the global cluster options and their current values.

  4. Depending on your requirements, set Placement Strategy to the appropriate value.

  5. If you need to disable fencing for any reasons, deselect Stonith Enabled.

  6. Confirm your changes with Apply.

6.3.8. Configuring Resource Monitoring

Although the High Availability Extension can detect a node failure, it also has the ability to detect when an individual resource on a node has failed. If you want to ensure that a resource is running, you must configure resource monitoring for it. Resource monitoring consists of specifying a timeout and/or start delay value, and an interval. The interval tells the CRM how often it should check the resource status. You can also set particular parameters, such as Timeout for start or stop operations.

Procedure 6.12. Adding or Modifying Monitor Operations

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. In the Pacemaker GUI main window, click Resources in the left pane to see the resources already configured for the cluster.

  3. In the right pane, select the resource to modify and click Edit. The next window shows the basic resource parameters and the meta attributes, instance attributes and operations already defined for that resource.

  4. To add a new monitor operation, select the respective tab and click Add.

    To modify an existing operation, select the respective entry and click Edit.

  5. In Name, select the action to perform, for example monitor, start, or stop.

    The parameters shown below depend on the selection you make here.

  6. In the Timeout field, enter a value in seconds. After the specified timeout period, the operation will be treated as failed. The PE will decide what to do or execute what you specified in the On Fail field of the monitor operation.

  7. If needed, expand the Optional section and add parameters, like On Fail (what to do if this action ever fails?) or Requires (what conditions need to be satisfied before this action occurs?).

  8. If all parameters are set according to your wishes, click OK to finish the configuration of that resource. The configuration dialog is closed and the main window shows the modified resource.

For the processes which take place if the resource monitor detects a failure, refer to Section 4.3, “Resource Monitoring”.

To view resource failures in the Pacemaker GUI, click Management in the left pane, then select the resource whose details you want to see in the right pane. For a resource that has failed, the Fail Count and last failure of the resource is shown in the middle of the right pane (below the Migration threshold entry).

Figure 6.6. Viewing a Resource's Failcount

Viewing a Resource's Failcount

6.3.9. Configuring a Cluster Resource Group

Some cluster resources are dependent on other components or resources, and require that each component or resource starts in a specific order and runs together on the same server. To simplify this configuration we support the concept of groups.

For an example of a resource group and more information about groups and their properties, refer to Section 4.2.5.1, “Groups”.

[Note]Empty Groups

Groups must contain at least one resource, otherwise the configuration is not valid.

Procedure 6.13. Adding a Resource Group

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. In the left pane, select Resources and click Add+Group.

  3. Enter a unique ID for the group.

  4. Below Options, set the Initial state of resource and click Forward.

  5. In the next step, you can add primitives as sub-resources for the group. These are created similar as described in Procedure 6.2, “Adding Primitive Resources”.

  6. If all parameters are set according to your wishes, click Apply to finish the configuration of the primitive.

  7. In the next window, you can continue adding sub-resources for the group by choosing Primitive again and clicking OK.

    When you do not want to add more primitives to the group, click Cancel instead. The next window shows a summary of the parameters that you have already defined for that group. The Meta Attributes and Primitives of the group are listed. The position of the resources in the Primitive tab represents the order in which the resources are started in the cluster.

  8. As the order of resources in a group is important, use the Up and Down buttons to sort the Primitives in the group.

  9. If all parameters are set according to your wishes, click OK to finish the configuration of that group. The configuration dialog is closed and the main window shows the newly created or modified group.

Figure 6.7. Pacemaker GUI - Groups

Pacemaker GUI - Groups

Let us assume you already have created a resource group as explained in Procedure 6.13, “Adding a Resource Group”. The following procedure shows you how to modify the group to match Example 4.1, “Resource Group for a Web Server”.

Procedure 6.14. Adding Resources to an Existing Group

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. In the left pane, switch to the Resources view and in the right pane, select the group to modify and click Edit. The next window shows the basic group parameters and the meta attributes and primitives already defined for that resource.

  3. Click the Primitives tab and click Add.

  4. In the next dialog, set the following parameters to add an IP address as sub-resource of the group:

    1. Enter a unique ID (for example, my_ipaddress).

    2. From the Class list, select ocf as resource agent class.

    3. As Provider of your OCF resource agent, select heartbeat.

    4. From the Type list, select IPaddr as resource agent.

    5. Click Forward.

    6. In the Instance Attribute tab, select the IP entry and click Edit (or double-click the IP entry).

    7. As Value, enter the desired IP address, for example, 192.168.1.180.

    8. Click OK and Apply. The group configuration dialog shows the newly added primitive.

  5. Add the next sub-resources (file system and Web server) by clicking Add again.

  6. Set the respective parameters for each of the sub-resources similar to steps Step 4.a to Step 4.h, until you have configured all sub-resources for the group.

    As we configured the sub-resources already in the order in that they need to be started in the cluster, the order on the Primitives tab is already correct.

  7. In case you need to change the resource order for a group, use the Up and Down buttons to sort the resources on the Primitive tab.

  8. To remove a resource from the group, select the resource on the Primitives tab and click Remove.

  9. Click OK to finish the configuration of that group. The configuration dialog is closed and the main window shows the modified group.

6.3.10. Configuring a Clone Resource

You may want certain resources to run simultaneously on multiple nodes in your cluster. To do this you must configure a resource as a clone. Examples of resources that might be configured as clones include STONITH and cluster file systems like OCFS2. You can clone any resource provided. This is supported by the resource’s Resource Agent. Clone resources may even be configured differently depending on which nodes they are hosted.

For an overview which types of resource clones are available, refer to Section 4.2.5.2, “Clones”.

Procedure 6.15. Adding or Modifying Clones

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. In the left pane, select Resources and click Add+Clone.

  3. Enter a unique ID for the clone.

  4. Below Options, set the Initial state of resource.

  5. Activate the respective options you want to set for your clone and click Forward.

  6. In the next step, you can either add a Primitive or a Group as sub-resources for the clone. These are created similar as described in Procedure 6.2, “Adding Primitive Resources” or Procedure 6.13, “Adding a Resource Group”.

  7. If all parameters in the clone configuration dialog are set according to your wishes, click Apply to finish the configuration of the clone.

6.4. Managing Cluster Resources

Apart from the possibility to configure your cluster resources, the Pacemaker GUI also allows you to manage existing resources. To switch to a management view and to access the available options, click Management in the left pane.

Figure 6.8. Pacemaker GUI - Management

Pacemaker GUI - Management

6.4.1. Starting Resources

Before you start a cluster resource, make sure it is set up correctly. For example, if you want to use an Apache server as a cluster resource, set up the Apache server first and complete the Apache configuration before starting the respective resource in your cluster.

[Note]Do Not Touch Services Managed by the Cluster

When managing a resource with the High Availability Extension, the same resource must not be started or stopped otherwise (outside of the cluster, for example manually or on boot or reboot). The High Availability Extension software is responsible for all service start or stop actions.

However, if you want to check if the service is configured properly, start it manually, but make sure that it is stopped again before High Availability takes over.

For interventions in resources that are currently managed by the cluster, set the resource to unmanaged mode first as described in Section 6.4.5, “Changing Management Mode of Resources”.

During creation of a resource with the Pacemaker GUI, you can set the resource's initial state with the target-role meta attribute. If its value has been set to stopped, the resource does not start automatically after being created.

Procedure 6.16. Starting A New Resource

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. Click Management in the left pane.

  3. In the right pane, right-click the resource and select Start from the context menu (or use the Start Resource icon in the toolbar).

6.4.2. Cleaning Up Resources

A resource will be automatically restarted if it fails, but each failure raises the resource's failcount. View a resource's failcount with the Pacemaker GUI by clicking Management in the left pane, then selecting the resource in the right pane. If a resource has failed, its Fail Count is shown in the middle of the right pane (below the Migration Threshold entry).

If a migration-threshold has been set for that resource, the node will no longer be allowed to run the resource as soon as the number of failures has reached the migration threshold.

A resource's failcount can either be reset automatically (by setting a failure-timeout option for the resource) or you can reset it manually as described below.

Procedure 6.17. Cleaning Up A Resource

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. Click Management in the left pane.

  3. In the right pane, right-click the respective resource and select Cleanup Resource from the context menu (or use the Cleanup Resource icon in the toolbar).

    This executes the commands crm_resource -C and crm_failcount -D for the specified resource on the specified node.

For more information, see the man pages of crm_resource and crm_failcount.

6.4.3. Removing Cluster Resources

If you need to remove a resource from the cluster, follow the procedure below to avoid configuration errors:

[Note]Removing Referenced Resources

Cluster resources cannot be removed if their ID is referenced by any constraint. If you cannot delete a resource, check where the resource ID is referenced and remove the resource from the constraint first.

Procedure 6.18. Removing a Cluster Resource

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. Click Management in the left pane.

  3. Select the respective resource in the right pane.

  4. Clean up the resource on all nodes as described in Procedure 6.17, “Cleaning Up A Resource”.

  5. Stop the resource.

  6. Remove all constraints that relate to the resource, otherwise removing the resource will not be possible.

6.4.4. Migrating Cluster Resources

As mentioned in Section 6.3.5, “Specifying Resource Failover Nodes”, the cluster will fail over (migrate) resources automatically in case of software or hardware failures—according to certain parameters you can define (for example, migration threshold or resource stickiness). Apart from that, you can also manually migrate a resource to another node in the cluster.

Procedure 6.19. Manually Migrating a Resource

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. Click Management in the left pane.

  3. Right-click the respective resource in the right pane and select Migrate Resource.

  4. In the new window, select the node to which to move the resource to in To Node. This creates a location constraint with an INFINITY score for the destination node.

  5. If you want to migrate the resource only temporarily, activate Duration and enter the time frame for which the resource should migrate to the new node. After the expiration of the duration, the resource can move back to its original location or it may stay where it is (depending on resource stickiness).

  6. In cases where the resource cannot be migrated (if the resource's stickiness and constraint scores total more than INFINITY on the current node), activate the Force option. This forces the resource to move by creating a rule for the current location and a score of -INFINITY.

    [Note]

    This prevents the resource from running on this node until the constraint is removed with Clear Migrate Constraints or the duration expires.

  7. Click OK to confirm the migration.

To allow a resource to move back again, proceed as follows:

Procedure 6.20. Clearing a Migration Constraint

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. Click Management in the left pane.

  3. Right-click the respective resource in the right pane and select Clear Migrate Constraints.

    This uses the crm_resource -U command. The resource can move back to its original location or it may stay where it is (depending on resource stickiness).

For more information, see the crm_resource man page or Pacemaker Explained, available from http://www.clusterlabs.org/doc/ . Refer to section Resource Migration.

6.4.5. Changing Management Mode of Resources

When a resource is being managed by the cluster, it must not be touched otherwise (outside of the cluster). For maintenance of individual resources, you can set the respective resources to an unmanaged mode that allows you to modify the resource outside of the cluster.

Procedure 6.21. Changing Management Mode of Resources

  1. Start the Pacemaker GUI and log in to the cluster as described in Section 6.1.1, “Logging in to a Cluster”.

  2. Click Management in the left pane.

  3. Right-click the respective resource in the right pane and from the context menu, select Unmanage Resource.

  4. After you have finished the maintenance task for that resource, right-click the respective resource again in the right pane and select Manage Resource.

    From this point on, the resource will be managed by the High Availability Extension software again.

Chapter 7. Configuring and Managing Cluster Resources (Command Line)

Abstract

To configure and manage cluster resources, either use the graphical user interface (the Pacemaker GUI) or the crm command line utility. For the GUI approach, refer to Chapter 6, Configuring and Managing Cluster Resources (GUI).

This chapter introduces crm, the command line tool and covers an overview of this tool, how to use templates, and mainly configuring and managing cluster resources: creating basic and advanced types of resources (groups and clones), configuring constraints, specifying failover nodes and failback nodes, configuring resource monitoring, starting, cleaning up or removing resources, and migrating resources manually.

[Note]User Privileges

Sufficient privileges are necessary to manage a cluster. The crm command and its subcommands have to be run either as root user or as the CRM owner user (typically the user hacluster).

However, the user option allows you to run crm and its subcommands as a regular (unprivileged) user and to change its ID using sudo whenever necessary. For example, with the following command crm will use hacluster as the privileged user ID:

crm options user hacluster

Note that you need to set up /etc/sudoers so that sudo does not ask for a password.

7.1. crm Shell—Overview

After installation you usually need the crm command only. This command has several subcommands which manage resources, CIBs, nodes, resource agents, and others. It offers a thorough help system with embedded examples.

Help can be accessed in several ways:

  • To output the usage of crm and its command line options:

    # crm --help
  • To give a list of all available commands:

    # crm help
  • To access other help sections, not just the command reference:

    # crm help topics
  • To view the extensive help text of the configure subcommand:

    # crm configure help
  • To print the syntax, its usage, and examples of a subcommand of configure:

    # crm configure help group

Almost all output of the help subcommand (do not mix it up with the --help option) opens a text viewer. This text viewer allows you to scroll up or down and read the help text more comfortably. To leave the text viewer, press the Q key.

The crm command itself can be used in the following ways:

  • Directly.  Concatenate all subcommands to crm, press Enter and you see the output immediately. For example, enter crm help ra to get information about the ra subcommand (resource agents).

  • As crm Shell Script.  Use crm and its commands in a script. This can be done in two ways:

    crm -f script.cli
    crm < script.cli

    The script can contain any command from crm. For example:

    # A small example
    statusnode list

    Any line starting with the hash symbol (#) is a comment and is ignored. If a line is too long, insert a backslash (\) at the end and continue in the next line.

  • Interactive as Internal Shell.  Type crm to enter the internal shell. The prompt changes to crm(live)#. With help you can get an overview of the available subcommands. As the internal shell has different levels of subcommands, you can enter one by just typing this subcommand and press Enter.

    For example, if you type resource you enter the resource management level. Your prompt changes to crm(live)resource#. If you want to leave the internal shell, use the commands quit, bye, or exit. If you need to go one level back, use up, end, or cd.

    You can enter the level directly by typing crm and the respective subcommand(s) without any options and hit Enter.

    The internal shell supports also tab completion for subcommands and resources. Type the beginning of a command, press →| and crm completes the respective object.

In addition to previously explained methods, the crm shell also supports synchronous command execution. Use the -w option to activate it. If you have started crm without -w, you can enable it later with the user preference's wait set to yes (options wait yes). If this option is enabled, crm waits until the transition is finished. Whenever a transaction is started, dots are printed to indicate progress. Synchronous command execution is only applicable for commands like resource start.

[Note]Differentiate Between Management and Configuration Subcommands

The crm tool has management capability (the subcommands resource and node) and can be used for configuration (cib, configure).

The following subsections give you an overview about some important aspects of the crm tool.

7.1.1. Displaying Information about OCF Resource Agents

As you have to deal with resource agents in your cluster configuration all the time, the crm tool contains the ra command to get information about resource agents and to manage them (for additional information, see also Section 4.2.2, “Supported Resource Agent Classes”):

# crm ra
crm(live)ra#

The command classes gives you a list of all classes and providers:

crm(live)ra# classes
heartbeat
lsb
ocf / heartbeat linbit lvm2 ocfs2 pacemaker
stonith

To get an overview about all available resource agents for a class (and provider) use the list command:

crm(live)ra# list ocf
AoEtarget           AudibleAlarm        CTDB                ClusterMon
Delay               Dummy               EvmsSCC             Evmsd
Filesystem          HealthCPU           HealthSMART         ICP
IPaddr              IPaddr2             IPsrcaddr           IPv6addr
LVM                 LinuxSCSI           MailTo              ManageRAID
ManageVE            Pure-FTPd           Raid1               Route
SAPDatabase         SAPInstance         SendArp             ServeRAID
...

An overview about a resource agent can be viewed with info:

crm(live)ra# info ocf:drbd:linbit
This resource agent manages a DRBD* resource
as a master/slave resource. DRBD is a shared-nothing replicated storage
device. (ocf:linbit:drbd)

Master/Slave OCF Resource Agent for DRBD

Parameters (* denotes required, [] the default):

drbd_resource* (string): drbd resource name
    The name of the drbd resource from the drbd.conf file.

drbdconf (string, [/etc/drbd.conf]): Path to drbd.conf
    Full path to the drbd.conf file.

Operations' defaults (advisory minimum):

    start         timeout=240
    promote       timeout=90 
    demote        timeout=90 
    notify        timeout=90 
    stop          timeout=100
    monitor_Slave_0 interval=20 timeout=20 start-delay=1m
    monitor_Master_0 interval=10 timeout=20 start-delay=1m

Leave the viewer by pressing Q. Find a configuration example at Appendix A, Example of Setting Up a Simple Testing Resource.

[Tip]Use crm Directly

In the former example we used the internal shell of the crm command. However, you do not necessarily have to use it. You get the same results, if you add the respective subcommands to crm. For example, you can list all the OCF resource agents by entering crm ra list ocf in your shell.

7.1.2. Using Configuration Templates

Configuration templates are ready-made cluster configurations for the crm shell. Do not confuse them with the resource templates (as described in Section 7.3.2, “Creating Resource Templates”). Those are templates for the cluster and not for the crm shell.

Configuration templates require minimum effort to be tailored to the particular user's needs. Whenever a template creates a configuration, warning messages give hints which can be edited later for further customization.

The following procedure shows how to create a simple yet functional Apache configuration:

  1. Log in as root and start the crm tool:

    # crm configure
  2. Create a new configuration from a configuration template:

    1. Switch to the template subcommand:

      crm(live)configure# template
    2. List the available configuration templates:

      crm(live)configure template#  list templates
      gfs2-base   filesystem  virtual-ip  apache   clvm     ocfs2    gfs2
    3. Decide which configuration template you need. As we need an Apache configuration, we choose the apache template:

      crm(live)configure template#  new intranet apache
      INFO: pulling in template apache
      INFO: pulling in template virtual-ip
  3. Define your parameters:

    1. List the just created configuration:

      crm(live)configure template#  list
      intranet
    2. Display the minimum of required changes which have to be filled out by you:

      crm(live)configure template#  show
      ERROR: 23: required parameter ip not set
      ERROR: 61: required parameter id not set
      ERROR: 65: required parameter configfile not set
    3. Invoke your preferred text editor and fill out all lines that have been displayed as errors in Step 3.b:

      crm(live)configure template#  edit
  4. Show the configuration and check whether it is valid (bold text depends on the configuration you have entered in Step 3.c):

    crm(live)configure template#  show
    primitive virtual-ip ocf:heartbeat:IPaddr \
        params ip="192.168.1.101"
    primitive apache ocf:heartbeat:apache \
        params configfile="/etc/apache2/httpd.conf"
    monitor apache 120s:60s
    group intranet \
        apache virtual-ip
  5. Apply the configuration:

    crm(live)configure template#  apply
    crm(live)configure#  cd ..
    crm(live)configure#  show
  6. Submit your changes to the CIB:

    crm(live)configure#  commit

It is possible to simplify the commands even more, if you know the details. The above procedure can be summarized with the following command on the shell:

crm configure template \
   new intranet apache params \
   configfile="/etc/apache2/httpd.conf" ip="192.168.1.101"

If you are inside your internal crm shell, use the following command:

crm(live)configure template# new intranet apache params \
   configfile="/etc/apache2/httpd.conf" ip="192.168.1.101"

However, the previous command only creates its configuration from the configuration template. It does not apply nor commit it to the CIB.

7.1.3. Testing with Shadow Configuration

A shadow configuration is used to test different configuration scenarios. If you have created several shadow configurations, you can test them one by one to see the effects of your changes.

The usual process looks like this:

  1. Log in as root and start the crm tool:

    # crm configure
  2. Create a new shadow configuration:

    crm(live)configure# cib new myNewConfig
    INFO: myNewConfig shadow CIB created
  3. If you want to copy the current live configuration into your shadow configuration, use the following command, otherwise skip this step:

    crm(myNewConfig)# cib reset myNewConfig

    The previous command makes it easier to modify any existing resources later.

  4. Make your changes as usual. After you have created the shadow configuration, all changes go there. To save all your changes, use the following command:

    crm(myNewConfig)# commit
  5. If you need the live cluster configuration again, switch back with the following command:

    crm(myNewConfig)configure# cib use live
    crm(live)#

7.1.4. Debugging Your Configuration Changes

Before loading your configuration changes back into the cluster, it is recommended to review your changes with ptest. The ptest can show a diagram of actions that will be induced by committing the changes. You need the graphviz package to display the diagrams. The following example is a transcript, adding a monitor operation:

# crm configure
crm(live)configure# show fence-node2 
primitive fence-node2 stonith:apcsmart \
        params hostlist="node2"
crm(live)configure# monitor fence-node2 120m:60s
crm(live)configure# show changed
primitive fence-node2 stonith:apcsmart \
        params hostlist="node2" \
        op monitor interval="120m" timeout="60s"
crm(live)configure# ptest
crm(live)configure# commit

7.1.5. Cluster Diagram

To output a cluster diagram as shown in Figure 5.2, “Hawk—Cluster Diagram”, use the command crm configure graph. It displays the current configuration on its current window, therefore requiring X11.

If you prefer Scalable Vector Graphics (SVG), use the following command:

# crm configure graph dot config.svg svg

7.2. Configuring Global Cluster Options

Global cluster options control how the cluster behaves when confronted with certain situations. The predefined values can be kept in most cases. However, to make key functions of your cluster work correctly, you need to adjust the following parameters after basic cluster setup:

Procedure 7.1. Modifying Global Cluster Options With crm

  1. Log in as root and start the crm tool:

    # crm configure
  2. Use the following commands to set the options for a two-node clusters only:

    crm(live)configure# property no-quorum-policy=ignore
    crm(live)configure# property stonith-enabled=false
  3. Show your changes:

    crm(live)configure# show
    property $id="cib-bootstrap-options" \
       dc-version="1.1.1-530add2a3721a0ecccb24660a97dbfdaa3e68f51" \
       cluster-infrastructure="openais" \
       expected-quorum-votes="2" \
       no-quorum-policy="ignore" \
       stonith-enabled="false"
  4. Commit your changes and exit:

    crm(live)configure# commit
    crm(live)configure# exit

7.3. Configuring Cluster Resources

As a cluster administrator, you need to create cluster resources for every resource or application you run on servers in your cluster. Cluster resources can include Web sites, e-mail servers, databases, file systems, virtual machines, and any other server-based applications or services you want to make available to users at all times.

For an overview of resource types you can create, refer to Section 4.2.3, “Types of Resources”.

7.3.1. Creating Cluster Resources

There are three types of RAs (Resource Agents) available with the cluster (for background information, see Section 4.2.2, “Supported Resource Agent Classes”). To create a cluster resource use the crm tool. To add a new resource to the cluster, proceed as follows:

  1. Log in as root and start the crm tool:

    # crm configure
  2. Configure a primitive IP address:

    crm(live)configure# primitive myIP ocf:heartbeat:IPaddr \
         params ip=127.0.0.99 op monitor interval=60s

    The previous command configures a primitive with the name myIP. You need to choose a class (here ocf), provider (heartbeat), and type (IPaddr). Furthermore, this primitive expects other parameters like the IP address. Change the address to your setup.

  3. Display and review the changes you have made:

    crm(live)configure# show
  4. Commit your changes to take effect:

    crm(live)configure# commit

7.3.2. Creating Resource Templates

If you want to create several resources with similar configurations, a resource template simplifies the task. See also Section 4.5.3, “Resource Templates and Constraints” for some basic background information. Do not confuse them with the normal templates from Section 7.1.2, “Using Configuration Templates”. Use the rsc_template command to get familiar with the syntax:

# crm configure rsc_template
usage: rsc_template <name> [<class>:[<provider>:]]<type>
        [params <param>=<value> [<param>=<value>...]]
        [meta <attribute>=<value> [<attribute>=<value>...]]
        [utilization <attribute>=<value> [<attribute>=<value>...]]
        [operations id_spec
            [op op_type [<attribute>=<value>...] ...]]

For example, the following command creates a new resource template with the name BigVM derived from the ocf:heartbeat:Xen resource and some default values and operations:

crm(live)configure# rsc_template BigVM ocf:heartbeat:Xen \
   params allow_mem_management="true" \
   op monitor timeout=60s interval=15s \
   op stop timeout=10m \
   op start timeout=10m

Once you defined the new resource template, you can use it in primitives or reference it in order, colocation, or rsc_ticket constraints. To reference the resource template, use the @ sign:

crm(live)configure# primitive MyVM1 @BigVM \
   params xmfile="/etc/xen/shared-vm/MyVM1" name="MyVM1"

The new primitive MyVM1 is going to inherit everything from the BigVM resource templates. For example, the equivalent of the above two would be:

crm(live)configure# primitive MyVM1 ocf:heartbeat:Xen \
   params xmfile="/etc/xen/shared-vm/MyVM1" name="MyVM1"
   params allow_mem_management="true" \
   op monitor timeout=60s interval=15s \
   op stop timeout=10m \
   op start timeout=10m

If you want to overwrite some options or operations, add them to your (primitive) definition. For instance, the following new primitive MyVM2 doubles the timout for monitor operations but leaves others untouched:

crm(live)configure# primitive MyVM2 @BigVM \
   params xmfile="/etc/xen/shared-vm/MyVM2" name="MyVM2" \
   op monitor timeout=120s interval=30s    

A resource template may be referenced in constraints to stand for all primitives which are derived from that template. This helps to produce a more concise and clear cluster configuration. Resource template references are allowed in all constraints except location constraints. Colocation constraints may not contain more than one template reference.

7.3.3. Creating a STONITH Resource

From the crm perspective, a STONITH device is just another resource. To create a STONITH resource, proceed as follows:

  1. Log in as root and start the crm tool:

    # crm configure
  2. Get a list of all STONITH types with the following command:

    crm(live)# ra list stonith
    apcmaster                  apcmastersnmp              apcsmart
    baytech                    bladehpi                   cyclades
    drac3                      external/drac5             external/dracmc-telnet
    external/hetzner           external/hmchttp           external/ibmrsa
    external/ibmrsa-telnet     external/ipmi              external/ippower9258
    external/kdumpcheck        external/libvirt           external/nut
    external/rackpdu           external/riloe             external/sbd
    external/vcenter           external/vmware            external/xen0
    external/xen0-ha           fence_legacy               ibmhmc
    ipmilan                    meatware                   nw_rpc100s
    rcd_serial                 rps10                      suicide
    wti_mpc                    wti_nps
  3. Choose a STONITH type from the above list and view the list of possible options. Use the following command:

    crm(live)# ra info stonith:external/ipmi
    IPMI STONITH external device (stonith:external/ipmi)
    
    ipmitool based power management. Apparently, the power off
    method of ipmitool is intercepted by ACPI which then makes
    a regular shutdown. If case of a split brain on a two-node
    it may happen that no node survives. For two-node clusters
    use only the reset method.
    
    Parameters (* denotes required, [] the default):
    
    hostname (string): Hostname
        The name of the host to be managed by this STONITH device.
    ...
  4. Create the STONITH resource with the stonith class, the type you have chosen in Step 3, and the respective parameters if needed, for example:

    crm(live)# configure
    crm(live)configure# primitive my-stonith stonith:external/ipmi \
        params hostname="node1"
        ipaddr="192.168.1.221" \
        userid="admin" passwd="secret" \
        op monitor interval=60m timeout=120s  

7.3.4. Configuring Resource Constraints

Having all the resources configured is only one part of the job. Even if the cluster knows all needed resources, it might still not be able to handle them correctly. For example, try not to mount the file system on the slave node of drbd (in fact, this would fail with drbd). Define constraints to make these kind of information available to the cluster.

For more information about constraints, see Section 4.5, “Resource Constraints”.

7.3.4.1. Locational Constraints

This type of constraint may be added multiple times for each resource. All location constraints are evaluated for a given resource. A simple example that expresses a preference to run the resource fs1 on the node with the name earth to 100 would be the following:

crm(live)configure# location fs1-loc fs1 100: earth

Another example is a location with pingd:

crm(live)configure# primitive pingd pingd \
    params name=pingd dampen=5s multiplier=100 host_list="r1 r2"
crm(live)configure#  location node_pref internal_www \
    rule 50: #uname eq node1 \
    rule pingd: defined pingd

7.3.4.2. Colocational Constraints

The colocation command is used to define what resources should run on the same or on different hosts.

It is only possible to set a score of either +inf or -inf, defining resources that must always or must never run on the same node. It is also possible to use non-infinite scores. In that case the colocation is called advisory and the cluster may decide not to follow them in favor of not stopping other resources if there is a conflict.

For example, to run the resources with the IDs filesystem_resource and nfs_group always on the same host, use the following constraint:

crm(live)configure# colocation nfs_on_filesystem inf: nfs_group filesystem_resource

For a master slave configuration, it is necessary to know if the current node is a master in addition to running the resource locally.

7.3.4.3. Ordering Constraints

Sometimes it is necessary to provide an order of resource actions or operations. For example, you cannot mount a file system before the device is available to a system. Ordering constraints can be used to start or stop a service right before or after a different resource meets a special condition, such as being started, stopped, or promoted to master. Use the following commands in the crm shell to configure an ordering constraint:

crm(live)configure# order nfs_after_filesystem mandatory: filesystem_resource nfs_group

7.3.4.4. Constraints for the Example Configuration

The example used for this chapter would not work without additional constraints. It is essential that all resources run on the same machine as the master of the drbd resource. The drbd resource must be master before any other resource starts. Trying to mount the DRBD device when it is not the master simply fails. The following constraints must be fulfilled:

  • The file system must always be on the same node as the master of the DRBD resource.

    crm(live)configure# colocation filesystem_on_master inf: \
        filesystem_resource drbd_resource:Master
  • The NFS server as well as the IP address must be on the same node as the file system.

    crm(live)configure# colocation nfs_with_fs inf: \
       nfs_group filesystem_resource
  • The NFS server as well as the IP address start after the file system is mounted:

    crm(live)configure# order nfs_second mandatory: \
       filesystem_resource:start nfs_group
  • The file system must be mounted on a node after the DRBD resource is promoted to master on this node.

    crm(live)configure# order drbd_first inf: \
        drbd_resource:promote filesystem_resource:start

7.3.5. Specifying Resource Failover Nodes

To determine a resource failover, use the meta attribute migration-threshold. In case failcount exceeds migration-threshold on all nodes, the resource will remain stopped. For example:

crm(live)configure# location r1-node1 r1 100: node1

Normally, r1 prefers to run on node1. If it fails there, migration-threshold is checked and compared to the failcount. If failcount >= migration-threshold then it is migrated to the node with the next best preference.

Start failures set the failcount to inf depend on the start-failure-is-fatal option. Stop failures cause fencing. If there is no STONITH defined, the resource will not migrate at all.

For an overview, refer to Section 4.5.4, “Failover Nodes”.

7.3.6. Specifying Resource Failback Nodes (Resource Stickiness)

A resource might fail back to its original node when that node is back online and in the cluster. If you want to prevent a resource from failing back to the node it was running on prior to failover, or if you want to specify a different node for the resource to fail back to, you must change its resource stickiness value. You can either specify resource stickiness when you are creating a resource, or afterwards.

For an overview, refer to Section 4.5.5, “Failback Nodes”.

7.3.7. Configuring Placement of Resources Based on Load Impact

Some resources may have specific capacity requirements such as minimum amount of memory. Otherwise, they may fail to start completely or run with degraded performance.

To take this into account, the High Availability Extension allows you to specify the following parameters:

  1. The capacity a certain node provides.

  2. The capacity a certain resource requires.

  3. An overall strategy for placement of resources.

For detailed background information about the parameters and a configuration example, refer to Section 4.5.6, “Placing Resources Based on Their Load Impact”.

To configure the resource's requirements and the capacity a node provides, use utilization attributes as described in Procedure 6.10, “Adding Or Modifying Utilization Attributes”. You can name the utilization attributes according to your preferences and define as many name/value pairs as your configuration needs.

In the following example, we assume that you already have a basic configuration of cluster nodes and resources and now additionally want to configure the capacities a certain node provides and the capacity a certain resource requires.

Procedure 7.2. Adding Or Modifying Utilization Attributes With crm

  1. Log in as root and start the crm tool:

    # crm configure
  2. To specify the capacity a node provides, use the following command and replace the placeholder NODE_1 with the name of your node:

    crm(live)configure# node
    NODE_1 utilization memory=16384 cpu=8

    With these values, NODE_1 would be assumed to provide 16GB of memory and 8 CPU cores to resources.

  3. To specify the capacity a resource requires, use:

    crm(live)configure# primitive
     xen1 ocf:heartbeat:Xen ... \
         utilization memory=4096 cpu=4

    This would make the resource consume 4096 of those memory units from nodeA, and 4 of the cpu units.

  4. Configure the placement strategy with the property command:

    crm(live)configure# property ...

    Four values are available for the placement strategy:

    propertyplacement-strategy=default

    Utilization values are not taken into account at all, per default. Resources are allocated according to location scoring. If scores are equal, resources are evenly distributed across nodes.

    propertyplacement-strategy=utilization

    Utilization values are taken into account when deciding whether a node is considered eligible if it has sufficient free capacity to satisfy the resource's requirements. However, load-balancing is still done based on the number of resources allocated to a node.

    propertyplacement-strategy=minimal

    Utilization values are taken into account when deciding whether a node is eligible to serve a resource; an attempt is made to concentrate the resources on as few nodes as possible, thereby enabling possible power savings on the remaining nodes.

    propertyplacement-strategy=balanced

    Utilization values are taken into account when deciding whether a node is eligible to serve a resource; an attempt is made to spread the resources evenly, optimizing resource performance.

    The placing strategies are best-effort, and do not yet utilize complex heuristic solvers to always reach an optimum allocation result. Ensure that resource priorities are properly set so that your most important resources are scheduled first.

  5. Commit your changes before leaving the crm shell:

    crm(live)configure# commit

The following example demonstrates a three node cluster of equal nodes, with 4 virtual machines:

crm(live)configure# node node1 utilization memory="4000"
crm(live)configure# node node2 utilization memory="4000"
crm(live)configure# node node3 utilization memory="4000"
crm(live)configure# primitive xenA ocf:heartbeat:Xen \
    utilization memory="3500" meta priority="10"
crm(live)configure# primitive xenB ocf:heartbeat:Xen \
    utilization memory="2000" meta priority="1"
crm(live)configure# primitive xenC ocf:heartbeat:Xen \
    utilization memory="2000" meta priority="1"
crm(live)configure# primitive xenD ocf:heartbeat:Xen \
    utilization memory="1000" meta priority="5"
crm(live)configure# property placement-strategy="minimal"

With all three nodes up, xenA will be placed onto a node first, followed by xenD. xenB and xenC would either be allocated together or one of them with xenD.

If one node failed, too little total memory would be available to host them all. xenA would be ensured to be allocated, as would xenD; however, only one of xenB or xenC could still be placed, and since their priority is equal, the result is not defined yet. To resolve this ambiguity as well, you would need to set a higher priority for either one.

7.3.8. Configuring Resource Monitoring

To monitor a resource, there are two possibilities: either define a monitor operation with the op keyword or use the monitor command. The following example configures an Apache resource and monitors it every 60 seconds with the op keyword:

crm(live)configure# primitive apache apache \
  params ... \
  op monitor interval=60s timeout=30s

The same can be done with:

crm(live)configure# primitive apache apache \
   params ...
crm(live)configure# monitor apache 60s:30s

For an overview, refer to Section 4.3, “Resource Monitoring”.

7.3.9. Configuring a Cluster Resource Group

One of the most common elements of a cluster is a set of resources that needs to be located together. Start sequentially and stop in the reverse order. To simplify this configuration we support the concept of groups. The following example creates two primitives (an IP address and an e-mail resource):

  1. Run the crm command as system administrator. The prompt changes to crm(live).

  2. Configure the primitives:

    crm(live)# configure
    crm(live)configure# primitive Public-IP ocf:IPaddr:heartbeat \
       params ip=1.2.3.4 id=p.public-ip
    crm(live)configure# primitive Email lsb:exim \
       params id=p.lsb-exim
  3. Group the primitives with their relevant identifiers in the correct order:

    crm(live)configure# group shortcut Public-IP Email

To change the order of a group member, use the modgroup command from the configure subcommand. Use the following commands to move the primitive Email before Public-IP. (This is just to demonstrate the feature):

crm(live)configure# modgroup shortcut add p.lsb-exim before p.public-ip

In case you want to remove a resource from a group (for example, Email), use this command:

crm(live)configure# modgroup shortcut remove p.lsb-exim

For an overview, refer to Section 4.2.5.1, “Groups”.

7.3.10. Configuring a Clone Resource

Clones were initially conceived as a convenient way to start N instances of an IP resource and have them distributed throughout the cluster for load balancing. They have turned out to quite useful for a number of other purposes, including integrating with DLM, the fencing subsystem and OCFS2. You can clone any resource, provided the resource agent supports it.

Learn more about cloned resources in Section 4.2.5.2, “Clones”.

7.3.10.1. Creating Anonymous Clone Resources

To create an anonymous clone resource, first create a primitive resource and then refer to it with the clone command. Do the following:

  1. Log in as root and start the crm tool:

    # crm configure
  2. Configure the primitive, for example:

    crm(live)configure# primitive Apache lsb:apache
  3. Clone the primitive:

    crm(live)configure# clone apache-clone Apache 

7.3.10.2. Creating Stateful/Multi-State Clone Resources

To create an stateful clone resource, first create a primitive resource and then the master/slave resource. The master/slave resource must support at least promote and demote operations.

  1. Log in as root and start the crm tool:

    # crm configure
  2. Configure the primitive. Change the intervals if needed:

    crm(live)configure# primitive myRSC ocf:myCorp:myAppl \
        op monitor interval=60 \
        op monitor interval=61 role=Master
  3. Create the master slave resource:

    crm(live)configure# ms myRSC-clone myRSC

7.4. Managing Cluster Resources

Apart from the possibility to configure your cluster resources, the crm tool also allows you to manage existing resources. The following subsections gives you an overview.

7.4.1. Starting a New Cluster Resource

To start a new cluster resource you need the respective identifier. Proceed as follows:

  1. Log in as root and start the crm tool:

    # crm configure
  2. Switch to the resource level:

    crm(live)# resource
  3. Start the resource with start and press the →| key to show all known resources:

    crm(live)resource# start start ID

7.4.2. Cleaning Up Resources

A resource will be automatically restarted if it fails, but each failure raises the resource's failcount. If a migration-threshold has been set for that resource, the node will no longer be allowed to run the resource as soon as the number of failures has reached the migration threshold.

  1. Open a shell and log in as user root.

  2. Get a list of all your resources:

    crm resource list
      ...
    Resource Group: dlm-clvm:1
             dlm:1  (ocf::pacemaker:controld) Started 
             clvm:1 (ocf::lvm2:clvmd) Started
             cmirrord:1     (ocf::lvm2:cmirrord) Started
  3. Remove the resource:

    crm resource cleanup dlm-clvm

    For example, if you want to stop the DLM resource, from the dlm-clvm resource group, replace RSC with dlm.

7.4.3. Removing a Cluster Resource

Proceed as follows to remove a cluster resource:

  1. Log in as root and start the crm tool:

    # crm configure
  2. Run the following command to get a list of your resources:

    crm(live)# resource status

    For example, the output can look like this (whereas myIP is the relevant identifier of your resource):

    myIP    (ocf::IPaddr:heartbeat) ...
  3. Delete the resource with the relevant identifier (which implies a commit too):

    crm(live)# configure delete YOUR_ID
  4. Commit the changes:

    crm(live)# configure commit

7.4.4. Migrating a Cluster Resource

Although resources are configured to automatically fail over (or migrate) to other nodes of the cluster in the event of a hardware or software failure, you can also manually move a resource to another node in the cluster using either the Pacemaker GUI or the command line.

Use the migrate command for this task. For example, to migrate the resource ipaddress1 to a cluster node named node2, use these commands:

# crm resource
crm(live)resource# migrate ipaddress1 node2

7.4.5. Setting Nodes to Management Mode

Sometimes it is necessary to put single nodes into maintenance mode. If your cluster consists of more than 3 nodes, you can easily set one node to maintenance mode, while the other nodes continue their normal operation.

Use the configure command for this task. For example, to put the node node1 into maintenance mode, use these commands:

# crm configure edit node node1 attributes maintenance="true"

The node node1 becomes unmanaged and other resources will not be allocated to any maintenance mode nodes.

7.5. Setting Passwords Independent of cib.xml

In case your cluster configuration contains sensitive information, such as passwords, it should be stored in local files. That way, these parameters will never be logged or leaked in support reports.

Before using secret, better run the show command first to get an overview of all your resources:

# crm configure show
primitive mydb ocf:heartbeat:mysql \
   params replication_user=admin ...

If you want to set a password for the above mydb resource, use the following commands:

# crm resource secret mydb set passwd linux
INFO: syncing /var/lib/heartbeat/lrm/secrets/mydb/passwd to [your node list]

You can get the saved password back with:

# crm resource secret mydb show passwd
linux

Note that the parameters need to be synchronized between nodes; the crm resource secret command will take care of that. We highly recommend to only use this command to manage secret parameters.

7.6. Retrieving History Information

Investigating the cluster history is a complex task. To simplify this task, the crm shell contains the history command with its subcommands. It is assumed SSH is configured correctly.

Each cluster moves states, migrates resources, or starts important processes. All these actions can be retrieved by subcommands of history. Alternatively, use Hawk as explained in Procedure 5.25, “Viewing Transitions with the History Explorer”.

By default, all history commands look at the events of the last hour. To change this time frame, use the limit subcommand. The syntax is:

# crm history
crm(live)history# limitFROM_TIME [TO_TIME]

Some valid examples include:

limit4:00pm , limit16:00

Both commands mean the same, today at 4pm.

limit2012/01/12 6pm

January 12th 2012 at 6pm

limit"Sun 5 20:46"

In the current year of the current month at Sunday the 5th at 8:46pm

Find more examples and how to create time frames at http://labix.org/python-dateutil.

The info subcommand shows all the parameters which are covered by the the hb_report:

crm(live)history# info
Source: live
Period: 2012-01-12 14:10:56 - end
Nodes: earth
Groups: 
Resources:

To limit hb_report to certain parameters view the available options with the subcommand help.

To narrow down the level of detail, use the subcommand detail with a level:

crm(live)history# detail 2

The higher the number, the more detailed your report will be. Default is 0 (zero).

After you have set above parameters, use log to show the log messages.

To display the last transition, use the following command:

crm(live)history# transition -1
INFO: fetching new logs, please wait ...

This command fetches the logs and runs dotty (from the graphviz package) to show the transition graph. The shell opens the log file which you can browse with the and cursor keys.

If you do not want to open the transition graph, use the nograph option:

crm(live)history# transition -1 nograph

7.7. For More Information

  • The crm man page.

  • See Highly Available NFS Storage with DRBD and Pacemaker (↑Highly Available NFS Storage with DRBD and Pacemaker) for an exhaustive example.

Chapter 8. Adding or Modifying Resource Agents

Abstract

All tasks that need to be managed by a cluster must be available as a resource. There are two major groups here to consider: resource agents and STONITH agents. For both categories, you can add your own agents, extending the abilities of the cluster to your own needs.

8.1. STONITH Agents

A cluster sometimes detects that one of the nodes is behaving strangely and needs to remove it. This is called fencing and is commonly done with a STONITH resource. All STONITH resources reside in /usr/lib/stonith/plugins on each node.

[Warning]SSH and STONITH Are Not Supported

It is impossible to know how SSH might react to other system problems. For this reason, SSH and STONITH agent are not supported for production environments.

To get a list of all currently available STONITH devices (from the software side), use the command crm ra list stonith.

As of yet there is no documentation about writing STONITH agents. If you want to write new STONITH agents, consult the examples available in the source of the cluster-glue package.

8.2. Writing OCF Resource Agents

All OCF resource agents (RAs) are available in /usr/lib/ocf/resource.d/, see Section 4.2.2, “Supported Resource Agent Classes” for more information. Each resource agent must supported the following operations to control it:

start

start or enable the resource

stop

stop or disable the resource

status

returns the status of the resource

monitor

similar to status, but checks also for unexpected states

validate

validate the resource's configuration

meta-data

returns information about the resource agent in XML

The general procedure of how to create a OCF RA is like the following:

  1. Load the file /usr/lib/ocf/resource.d/pacemaker/Dummy as a template.

  2. Create a new subdirectory for each new resource agents to avoid naming contradictions. For example, if you have a resource group kitchen with the resource coffee_machine, add this resource to the directory /usr/lib/ocf/resource.d/kitchen/. To access this RA, execute the command crm:

    configureprimitive coffee_1 ocf:coffee_machine:kitchen ...
  3. Implement the different shell functions and save your file under a different name.

More details about writing OCF resource agents can be found at http://linux-ha.org/wiki/Resource_Agents. Find special information about several concepts at Chapter 1, Product Overview.

8.3. OCF Return Codes and Failure Recovery

According to the OCF specification, there are strict definitions of the exit codes an action must return. The cluster always checks the return code against the expected result. If the result does not match the expected value, then the operation is considered to have failed and a recovery action is initiated. There are three types of failure recovery:

Table 8.1. Failure Recovery Types

Recovery Type

Description

Action Taken by the Cluster

soft

A transient error occurred.

Restart the resource or move it to a new location.

hard

A non-transient error occurred. The error may be specific to the current node.

Move the resource elsewhere and prevent it from being retried on the current node.

fatal

A non-transient error occurred that will be common to all cluster nodes. This means a bad configuration was specified.

Stop the resource and prevent it from being started on any cluster node.


Assuming an action is considered to have failed, the following table outlines the different OCF return codes and the type of recovery the cluster will initiate when the respective error code is received.

Table 8.2. OCF Return Codes

OCF Return Code

OCF Alias

Description

Recovery Type

0

OCF_SUCCESS

Success. The command completed successfully. This is the expected result for all start, stop, promote and demote commands.

soft

1

OCF_ERR_­GENERIC

Generic there was a problem error code.

soft

2

OCF_ERR_ARGS

The resource’s configuration is not valid on this machine (for example, it refers to a location/tool not found on the node).

hard

3

OCF_­ERR_­UN­IMPLEMENTED

The requested action is not implemented.

hard

4

OCF_ERR_PERM

The resource agent does not have sufficient privileges to complete the task.

hard

5

OCF_ERR_­INSTALLED

The tools required by the resource are not installed on this machine.

hard

6

OCF_ERR_­CONFIGURED

The resource’s configuration is invalid (for example, required parameters are missing).

fatal

7

OCF_NOT_­RUNNING

The resource is not running. The cluster will not attempt to stop a resource that returns this for any action.

This OCF return code may or may not require resource recovery—it depends on what is the expected resource status. If unexpected, then soft recovery.

N/A

8

OCF_RUNNING_­MASTER

The resource is running in Master mode.

soft

9

OCF_FAILED_­MASTER

The resource is in Master mode but has failed. The resource will be demoted, stopped and then started (and possibly promoted) again.

soft

other

N/A

Custom error code.

soft


Chapter 9. Fencing and STONITH

Abstract

Fencing is a very important concept in computer clusters for HA (High Availability). A cluster sometimes detects that one of the nodes is behaving strangely and needs to remove it. This is called fencing and is commonly done with a STONITH resource. Fencing may be defined as a method to bring an HA cluster to a known state.

Every resource in a cluster has a state attached. For example: resource r1 is started on node1. In an HA cluster, such a state implies that resource r1 is stopped on all nodes except node1, because an HA cluster must make sure that every resource may be started on only one node. Every node must report every change that happens to a resource. The cluster state is thus a collection of resource states and node states.

When the state of a node or resource cannot be established with certainty, fencing comes in. Even when the cluster is not aware of what is happening on a given node, fencing can ensure that the node does not run any important resources.

9.1. Classes of Fencing

There are two classes of fencing: resource level and node level fencing. The latter is the primary subject of this chapter.

Resource Level Fencing

Using resource level fencing the cluster can ensure that a node cannot access one or more resources. One typical example is a SAN, where a fencing operation changes rules on a SAN switch to deny access from the node.

Resource level fencing can be achieved by using normal resources on which the resource you want to protect depends. Such a resource would simply refuse to start on this node and therefore resources which depend on it will not run on the same node.

Node Level Fencing

Node level fencing ensures that a node does not run any resources at all. This is usually done in a simple if brutal way: reset or power off the node.

9.2. Node Level Fencing

In SUSE® Linux Enterprise High Availability Extension, the fencing implementation is STONITH (Shoot The Other Node in the Head). It provides node level fencing. The High Availability Extension includes the stonith command line tool, an extensible interface for remotely powering down a node in the cluster. For an overview of the available options, run stonith --help or refer to the man page of stonith for more information.

9.2.1. STONITH Devices

To use node level fencing, you first need to have a fencing device. To get a list of STONITH devices which are supported by the High Availability Extension, run the following command as root on any of the nodes:

stonith -L

STONITH devices may be classified into the following categories:

Power Distribution Units (PDU)

Power Distribution Units are an essential element in managing power capacity and functionality for critical network, server and data center equipment. They can provide remote load monitoring of connected equipment and individual outlet power control for remote power recycling.

Uninterruptible Power Supplies (UPS)

A stable power supply provides emergency power to connected equipment by supplying power from a separate source in the event of utility power failure.

Blade Power Control Devices

If you are running a cluster on a set of blades, then the power control device in the blade enclosure is the only candidate for fencing. Of course, this device must be capable of managing single blade computers.

Lights-out Devices

Lights-out devices (IBM RSA, HP iLO, Dell DRAC) are becoming increasingly popular and may even become standard in off-the-shelf computers. However, they are inferior to UPS devices, because they share a power supply with their host (a cluster node). If a node stays without power, the device supposed to control it would be just as useless. In that case, the CRM would continue its attempts to fence the node indefinitely while all other resource operations would wait for the fencing/STONITH operation to complete.

Testing Devices

Testing devices are used exclusively for testing purposes. They are usually more gentle on the hardware. Once the cluster goes into production, they must be replaced with real fencing devices.

The choice of the STONITH device depends mainly on your budget and the kind of hardware you use.

9.2.2. STONITH Implementation

The STONITH implementation of SUSE® Linux Enterprise High Availability Extension consists of two components:

stonithd

stonithd is a daemon which can be accessed by local processes or over the network. It accepts the commands which correspond to fencing operations: reset, power-off, and power-on. It can also check the status of the fencing device.

The stonithd daemon runs on every node in the CRM HA cluster. The stonithd instance running on the DC node receives a fencing request from the CRM. It is up to this and other stonithd programs to carry out the desired fencing operation.

STONITH Plug-ins

For every supported fencing device there is a STONITH plug-in which is capable of controlling said device. A STONITH plug-in is the interface to the fencing device. On each node, all STONITH plug-ins reside in /usr/lib/stonith/plugins (or in /usr/lib64/stonith/plugins for 64-bit architectures). All STONITH plug-ins look the same to stonithd, but are quite different on the other side reflecting the nature of the fencing device.

Some plug-ins support more than one device. A typical example is ipmilan (or external/ipmi) which implements the IPMI protocol and can control any device which supports this protocol.

9.3. STONITH Configuration

To set up fencing, you need to configure one or more STONITH resources—the stonithd daemon requires no configuration. All configuration is stored in the CIB. A STONITH resource is a resource of class stonith (see Section 4.2.2, “Supported Resource Agent Classes”). STONITH resources are a representation of STONITH plug-ins in the CIB. Apart from the fencing operations, the STONITH resources can be started, stopped and monitored, just like any other resource. Starting or stopping STONITH resources means loading and unloading the STONITH device driver on a node. Starting and stopping are thus only administrative operations and do not translate to any operation on the fencing device itself. However, monitoring does translate to logging it to the device (to verify that the device will work in case it is needed). When a STONITH resource fails over to another node it enables the current node to talk to the STONITH device by loading the respective driver.

STONITH resources can be configured just like any other resource. For more information about configuring resources, see Section 6.3.2, “Creating STONITH Resources”, Section 5.3.3, “Creating STONITH Resources”, or Section 7.3.3, “Creating a STONITH Resource”.

The list of parameters (attributes) depends on the respective STONITH type. To view a list of parameters for a specific device, use the stonith command:

stonith -t stonith-device-type -n

For example, to view the parameters for the ibmhmc device type, enter the following:

stonith -t ibmhmc -n

To get a short help text for the device, use the -h option:

stonith -t stonith-device-type -h

9.3.1. Example STONITH Resource Configurations

In the following, find some example configurations written in the syntax of the crm command line tool. To apply them, put the sample in a text file (for example, sample.txt) and run:

crm < sample.txt

For more information about configuring resources with the crm command line tool, refer to Chapter 7, Configuring and Managing Cluster Resources (Command Line).

[Warning]Testing Configurations

Some of the examples below are for demonstration and testing purposes only. Do not use any of the Testing Configuration examples in real-life cluster scenarios.

Example 9.1. Testing Configuration

configure
primitive st-null stonith:null \
params hostlist="node1 node2"
clone fencing st-null
commit
   

Example 9.2. Testing Configuration

An alternative configuration:

configure
 primitive st-node1 stonith:null \
 params hostlist="node1"
 primitive st-node2 stonith:null \
 params hostlist="node2"
 location l-st-node1 st-node1 -inf: node1
 location l-st-node2 st-node2 -inf: node2
 commit

This configuration example is perfectly alright as far as the cluster software is concerned. The only difference to a real world configuration is that no fencing operation takes place.


Example 9.3. Testing Configuration

A more realistic example (but still only for testing) is the following external/ssh configuration:

configure
 primitive st-ssh stonith:external/ssh \
 params hostlist="node1 node2"
 clone fencing st-ssh
 commit

This one can also reset nodes. The configuration is similar to the first one which features the null STONITH device. In this example, clones are used. They are a CRM/Pacemaker feature. A clone is basically a shortcut: instead of defining n identical, yet differently named resources, a single cloned resource suffices. By far the most common use of clones is with STONITH resources, as long as the STONITH device is accessible from all nodes.


Example 9.4. Configuration of an IBM RSA Lights-out Device

The real device configuration is not much different, though some devices may require more attributes. An IBM RSA lights-out device might be configured like this:

configure
primitive st-ibmrsa-1 stonith:external/ibmrsa-telnet \
params nodename=node1 ipaddr=192.168.0.101 \
userid=USERID passwd=PASSW0RD
primitive st-ibmrsa-2 stonith:external/ibmrsa-telnet \
params nodename=node2 ipaddr=192.168.0.102 \
userid=USERID passwd=PASSW0RD
location l-st-node1 st-ibmrsa-1 -inf: node1
location l-st-node2 st-ibmrsa-2 -inf: node2
commit

In this example, location constraints are used for the following reason: There is always a certain probability that the STONITH operation is going to fail. Therefore, a STONITH operation on the node which is the executioner as well is not reliable. If the node is reset, it cannot send the notification about the fencing operation outcome. The only way to do that is to assume that the operation is going to succeed and send the notification beforehand. But if the operation fails, problems could arise. Therefore, by convention, stonithd refuses to kill its host.


Example 9.5. Configuration of an UPS Fencing Device

The configuration of a UPS type fencing device is similar to the examples above. The details are not covered here. All UPS devices employ the same mechanics for fencing. How the device is accessed varies. Old UPS devices only had a serial port, in most cases connected at 1200baud using a special serial cable. Many new ones still have a serial port, but often they also use a USB or Ethernet interface. The kind of connection you can use depends on what the plug-in supports.

For example, compare the apcmaster with the apcsmart device by using the stonith -t stonith-device-type -n command:

stonith -t apcmaster -h

returns the following information:

STONITH Device: apcmaster - APC MasterSwitch (via telnet)
NOTE: The APC MasterSwitch accepts only one (telnet)
connection/session a time. When one session is active,
subsequent attempts to connect to the MasterSwitch will fail.
For more information see http://www.apc.com/
List of valid parameter names for apcmaster STONITH device:
ipaddr
login
 password

With

stonith -t apcsmart -h

you get the following output:

STONITH Device: apcsmart - APC Smart UPS
(via serial port - NOT USB!). 
Works with higher-end APC UPSes, like
Back-UPS Pro, Smart-UPS, Matrix-UPS, etc.
(Smart-UPS may have to be >= Smart-UPS 700?).
See http://www.networkupstools.org/protocols/apcsmart.html
for protocol compatibility details.
For more information see http://www.apc.com/
List of valid parameter names for apcsmart STONITH device:
ttydev
hostlist

The first plug-in supports APC UPS with a network port and telnet protocol. The second plug-in uses the APC SMART protocol over the serial line, which is supported by many different APC UPS product lines.


9.3.2. Constraints Versus Clones

As explained in Section 9.3.1, “Example STONITH Resource Configurations”, there are several ways to configure a STONITH resource: using constraints, clones, or both. The choice of which construct to use for configuration depends on several factors: nature of the fencing device, number of hosts managed by the device, number of cluster nodes, or personal preference.

If clones are safe to use with your configuration and they reduce the configuration, then use cloned STONITH resources.

9.4. Monitoring Fencing Devices

Just like any other resource, the STONITH class agents also support the monitoring operation for checking status.

[Note]Monitoring STONITH Resources

Monitor STONITH resources regularly, yet sparingly. For most devices a monitoring interval of at least 1800 seconds (30 minutes) should suffice.

Fencing devices are an indispensable part of an HA cluster, but the less you need to use them, the better. Power management equipment is often affected by too much broadcast traffic. Some devices cannot handle more than ten or so connections per minute. Some get confused if two clients try to connect at the same time. Most cannot handle more than one session at a time.

Checking the status of fencing devices once every few hours should be enough in most cases. The probability that a fencing operation needs to be performed and the power switch fails is low.

For detailed information on how to configure monitor operations, refer to Procedure 6.3, “Adding or Modifying Meta and Instance Attributes” for the GUI approach or to Section 7.3.8, “Configuring Resource Monitoring” for the command line approach.

9.5. Special Fencing Devices

In addition to plug-ins which handle real STONITH devices, there are special purpose STONITH plug-ins.

[Warning]For Testing Only

Some of the STONITH plug-ins mentioned below are for demonstration and testing purposes only. Do not use any of the following devices in real-life scenarios because this may lead to data corruption and unpredictable results:

  • external/ssh

  • ssh

  • null

external/kdumpcheck

This plug-in checks if a Kernel dump is in progress on a node. If so, it returns true, and acts as if the node has been fenced. The node cannot run any resources during the dump anyway. This avoids fencing a node that is already down but doing a dump, which takes some time. The plug-in must be used in concert with another, real STONITH device. For more details, see /usr/share/doc/packages/cluster-glue/README_kdumpcheck.txt.

external/sbd

This is a self-fencing device. It reacts to a so-called poison pill which can be inserted into a shared disk. On shared-storage connection loss, it stops the node from operating. Learn how to use this STONITH agent to implement storage-based fencing in Chapter 17, Storage Protection. See also http://www.linux-ha.org/wiki/SBD_Fencing for more details.

[Important]external/sbd and DRBD

The external/sbd fencing mechanism requires that the SBD partition is readable directly from each node. Thus, a DRBD* device must not be used for an SBD partition.

However, you can use the fencing mechanism for a DRBD cluster, provided the SBD partition is located on a shared disk that is not mirrored or replicated.

external/ssh

Another software-based fencing mechanism. The nodes must be able to log in to each other as root without passwords. It takes a single parameter, hostlist, specifying the nodes that it will target. As it is not able to reset a truly failed node, it must not be used for real-life clusters—for testing and demonstration purposes only. Using it for shared storage would result in data corruption.

meatware

meatware requires help from the user to operate. Whenever invoked, meatware logs a CRIT severity message which shows up on the node's console. The operator then confirms that the node is down and issues a meatclient(8) command. This tells meatware to inform the cluster that the node should be considered dead. See /usr/share/doc/packages/cluster-glue/README.meatware for more information.

null

This is a fake device used in various testing scenarios. It always claims that it has shot a node, but never does anything. Do not use it unless you know what you are doing.

suicide

This is a software-only device, which can reboot a node it is running on, using the reboot command. This requires action by the node's operating system and can fail under certain circumstances. Therefore avoid using this device whenever possible. However, it is safe to use on one-node clusters.

suicide and null are the only exceptions to the I do not shoot my host rule.

9.6. Basic Recommendations

Check the following list of recommendations to avoid common mistakes:

  • Do not configure several power switches in parallel.

  • To test your STONITH devices and their configuration, pull the plug once from each node and verify that fencing the node does takes place.

  • Test your resources under load and verify the timeout values are appropriate. Setting timeout values too low can trigger (unnecessary) fencing operations. For details, refer to Section 4.2.9, “Timeout Values”.

  • Use appropriate fencing devices for your setup. For details, also refer to Section 9.5, “Special Fencing Devices”.

  • Configure one ore more STONITH resources. By default, the global cluster option stonith-enabled is set to true. If no STONITH resources have been defined, the cluster will refuse to start any resources.

  • Do not set the global cluster option stonith-enabled to false for the following reasons:

    • Clusters without STONITH enabled are not supported.

    • DLM/OCFS2 will block forever waiting for a fencing operation that will never happen.

  • Do not set the global cluster option startup-fencing to false. By default, it is set to true for the following reason: If a node is in an unknown state during cluster startup, the node will be fenced once to clarify its status.

9.7. For More Information

/usr/share/doc/packages/cluster-glue

In your installed system, this directory contains README files for many STONITH plug-ins and devices.

http://www.linux-ha.org/wiki/STONITH

Information about STONITH on the home page of the The High Availability Linux Project.

http://www.clusterlabs.org/doc/
  • Fencing and Stonith: Information about fencing on the home page of the Pacemaker Project.

  • Pacemaker Explained: Explains the concepts used to configure Pacemaker. Contains comprehensive and very detailed information for reference.

http://techthoughts.typepad.com/managing_computers/2007/10/split-brain-quo.html

Article explaining the concepts of split brain, quorum and fencing in HA clusters.

Chapter 10. Access Control Lists

Abstract

The various tools for administrating clusters, like the crm shell, Hawk, or the Pacemaker GUI, can be used by root or any user in the group haclient. By default, these users have full read-write access. In some cases, you may want to limit access or assign more fine-grained access rights.

Optional Access control lists (ACLs) allow you to define rules for users in the haclient group to allow or deny access to any part of the cluster configuration. Typically, sets or rules are combined into roles. Then you can assign users to a role that fits their tasks.

10.1. Requirements and Prerequisites

Before you start using ACLs on your cluster, make sure the following conditions are fulfilled:

  • The same users must be available on all nodes in your cluster. Use NIS to ensure this.

  • All users must belong to the haclient group.

  • All users have to run the crm shell by its absolute path /usr/sbin/crm.

Note the following points:

  • ACLs are an optional feature. If the ACL feature is disabled, root and users belonging to the haclient group have full read/write access to the cluster configuration.

  • If you want to enable the ACL feature, use this command:

    crm configure property enable-acl=true
  • If non-privileged users want to run the crm shell, they have to change the PATH variable and extend it with /usr/sbin.

  • To use ACLs you need some knowledge about XPath. XPath is a language for selecting nodes in an XML document. Refer to http://en.wikipedia.org/wiki/XPath or look into the specification at http://www.w3.org/TR/xpath/.

10.2. The Basics of ACLs

An ACL role is a set of rules which describe access rights to CIB. Rules consist of:

  • access rights to read, write, or deny, and

  • a specification where to apply the rule. This specification can be a tag, an id reference, a combination of both, or an XPath expression.

In most cases, it is more convenient to bundle ACLs into roles and assign a role to a user. However, it is possible to give a user certain access rules without defining any roles.

There are two methods to manage ACL rules:

  • Via an XPath Expression.  You need to know the structure of the underlying XML to create ACL rules.

  • Via a Tag and/or Ref Abbreviation.  Create a shorthand syntax and ACL rules apply to the matched objects.

10.2.1. Setting ACL Rules via XPath

To manage ACL rules via XPath, you need to know the structure of the underlying XML. Retrieve the structure with the following command:

crm configure show xml

The XML structure can also be displayed in the Pacemaker GUI by selecting Configuration+View XML. Regardless of the tool, the output is your cluster configuration in XML (see Example 10.1, “Excerpt of a Cluster Configuration in XML”).

Example 10.1. Excerpt of a Cluster Configuration in XML

<cib admin_epoch="0" 
      cib-last-written="Wed Nov  2 16:42:51 2011" 
      crm_feature_set="3.0.5" 
      dc-uuid="stuttgart" 
      epoch="13" have-quorum="1" num_updates="42" 
      update-client="cibadmin" 
      update-origin="nuernberg" 
      update-user="root"validate-with="pacemaker-1.2">
  <configuration>
    <crm_config>
      <cluster_property_set id="cib-bootstrap-options">
        <nvpair id="cib-bootstrap-options-stonith-enabled" 
                name="stonith-enabled" value="true"/>
      </cluster_property_set>
    </crm_config>
    <nodes>
      <node id="stuttgart" type="normal" uname="stuttgart"/>
      <node id="nuernberg" type="normal" uname="nuernberg"/>
    </nodes>
    <resources> ...  </resources>
    <constraints/>
    <rsc_defaults> ... </rsc_defaults>
    <op_defaults> ... </op_defaults>
  <configuration>
</cib>

With the XPath language you can locate nodes in this XML document. For example, to select the root node (cib) use the XPath expression /cib. To locate the global cluster configurations, use the XPath /cib/configuration/crm_config.

The following table collects the access type and the XPath expression to create an operator role:

Table 10.1. Types and XPath Expression for an Operator Role

Type

XPath/Explanation

Write

//crm_config//nvpair[@name='maintenance-mode']

Turn maintenance mode on or off.

Write

//op_defaults//nvpair[@name='record-pending']

Choose whether pending operations are recorded.

Write

//nodes/node//nvpair[@name='standby']

Set node in online or standby mode.

Write

//resources//nvpair[@name='target-role']

Start, stop, promote or demote any resource.

Write

//resources//nvpair[@name='is-managed']

Select if a resource should be managed or not.

Write

//constraints/rsc_location

Migrate/move resources from one node to another.

Read

/cib

View the status of the cluster.


10.2.2. Setting ACL Rules via Tag Abbreviations

For users who do not want to deal with the XML structure there is an easier method. It is a combination of a tag specifier and/or a reference.

For example, consider the following XPath:

/cib/resources/primitive[@id='rsc1']

primitive is a resource with the reference rsc1. The abbreviated syntax is:

tag: "primitive"  ref:"rsc1"

This also works for constraints. Here is the verbose XPath:

/cib/constraint/rsc_location

The abbreviated syntax is written like this:

tag: "rsc_location"

The CIB daemon knows how to apply the ACL rules to the matched objects. The abbreviated syntax can be used in the crm Shell or the Pacemaker GUI.

10.3. Configuring ACLs with the Pacemaker GUI

Use the Pacemaker GUI to define your roles and users. The following procedure adds a monitor role which has only read access to the CIB. Proceed as follows:

Procedure 10.1. Adding a Monitor Role and Assigning a User with the Pacemaker GUI

  1. Start the Pacemaker GUI and log in as described in Section 6.1.1, “Logging in to a Cluster”.

  2. Click the ACLs entry in the Configuration tree.

  3. Click Add. A dialog box appears. Choose between ACL User and ACL Role.

  4. To define your ACL role(s):

    1. Choose ACL Role. A window opens in which you add your configuration options.

    2. Add a unique identifier in the ID textfield, for example monitor.

    3. Click Add and choose the rights (Read, Write, or Deny). In our example, select Read and proceed with Ok.

    4. Enter the XPath expression /cib in the Xpath textfield. Proceed with Ok.

      Sidenote: If you have resources or constraints, you can also use the abbreviated syntax as explained in Section 10.2.2, “Setting ACL Rules via Tag Abbreviations”. In this case, enter your tag in the Tag textfield and the optional reference in the Ref textfield. In our example, there is no abbreviated form possible, so you can only use the XPath notation here.

    5. If you have other conditions, repeat the steps (Step 4.c and Step 4.d). In our example, this is not the case so your role is finished and you can close the window with Ok.

  5. Assign your role to a user:

    1. Click the Add button. A dialog box appears to choose between ACL User and ACL Role.

    2. Choose ACL User. A window opens in which you add your configuration options.

    3. Enter the username in the ID textfield. Make sure this user belongs to the haclient group.

    4. Click Add and choose Role Ref.

    5. Use the role name specified in Step 4.b.

10.4. Configuring ACLs with the crm Shell

The following procedure adds a monitor role as shown in Section 10.3, “Configuring ACLs with the Pacemaker GUI” and assigns it to a user. Proceed as follows:

Procedure 10.2. Adding a Monitor Role and Assigning a User with the crm Shell

  1. Log in as root.

  2. Start the interactive mode of the crm shell:

    # crm configure
    crm(live)configure#
  3. Define your ACL role(s):

    1. Use the role command to define your new role. To define a monitor role, use the following command:

      role monitor read xpath:"/cib"

      The previous command creates a new role with name monitor, sets the read rights and applies it to all elements in the CIB by using the XPath /cib. If necessary, you can add more access rights and XPath arguments.

      Sidenote: If you have resources or constraints, you can also use the abbreviated syntax as explained in Section 10.2.2, “Setting ACL Rules via Tag Abbreviations”. If you have a primitive resource with the ID rsc1, use the following notation to set the access rights: write tag:"primitive" ref:"rsc1". You can also refer to the ID with write ref:"rsc1". This has the advantage that it can match a primitive resource and a local resource manager resource (LRM), which enables you to configure rsc1 and also cleanup its status at the same time.

    2. Add additional roles as needed.

  4. Assign your roles to users. Make sure this user belongs to the haclient group.

    crm(live)configure# user tux role:monitor
  5. Check your changes:

    crm(live)configure# show
  6. Commit your changes:

    crm(live)configure# commit

10.5. For More Information

See http://www.clusterlabs.org/doc/acls.html.

Chapter 11. Network Device Bonding

For many systems, it is desirable to implement network connections that comply to more than the standard data security or availability requirements of a typical Ethernet device. In these cases, several Ethernet devices can be aggregated to a single bonding device.

The configuration of the bonding device is done by means of bonding module options. The behavior is determined through the mode of the bonding device. By default, this is mode=active-backup, which means that a different slave device will become active if the active slave fails.

When using OpenAIS, the bonding device is not managed by the cluster software. Therefore, the bonding device must be configured on each cluster node that might possibly need to access the bonding device.

11.1. Configuring Bonding Devices with YaST

To configure a bonding device, you need to have multiple Ethernet devices that can be aggregated to a single bonding device. Proceed as follows:

  1. Start YaST as root and select Network Devices+Network Settings.

  2. In the Network Settings, switch to the Overview tab, which shows the available devices.

  3. Check if the Ethernet devices to be aggregate to a bonding device have an IP address assigned. If yes, change it:

    1. Select the device to change and click Edit.

    2. In the Address tab of the Network Card Setup dialog that opens, select the option No Link and IP Setup (Bonding Slaves).

    3. Click Next to return to the Overview tab in the Network Settings dialog.

  4. To add a new bonding device:

    1. Click Add and set the Device Type to Bond. Proceed with Next.

    2. Select how to assign the IP address to the bonding device. Three methods are at your disposal:

      • No Link and IP Setup (Bonding Slaves)

      • Dynamic Address (with DHCP or Zeroconf)

      • Statically assigned IP Address

      Use the method that is appropriate for your environment. If OpenAIS manages virtual IP addresses, select Statically assigned IP Address and assign a basic IP address to the interface.

    3. Switch to the Bond Slaves tab.

    4. It shows any Ethernet devices that have been configured as bonding slaves in Step 3.b. To select the Ethernet devices that you want to include into the bond, activate the check box in front of the relevant Bond Slave.

    5. Edit the Bond Driver Options. The following modes are available:

      balance-rr

      Provides load balancing and fault tolerance.

      active-backup

      Provides fault tolerance.

      balance-xor

      Provides load balancing and fault tolerance.

      broadcast

      Provides fault tolerance

      802.3ad

      Provides dynamic link aggregation if supported by the connected switch.

      balance-tlb

      Provides load balancing for outgoing traffic.

      balance-alb

      Provides load balancing for incoming and outgoing traffic, if the network devices used allow the modifying of the network device's hardware address while in use.

    6. Make sure to add the parameter miimon=100 to Bond Driver Options. Without this parameter, the data integrity is not checked regularly.

  5. Click Next and leave YaST with OK to finish the configuration of the bonding device. YaST writes the configuration to /etc/sysconfig/network/ifcfg-bondDEVICENUMBER.

11.2. Hotplugging of Bonding Slaves

Sometimes it is necessary to replace a bonding slave interface with another one, for example, if the respective network device constantly fails. The solution is to set up hotplugging bonding slaves. It is also necessary to change the udev rules in order to match the device by bus ID instead of by MAC address. This allows you to replace defective hardware (a network card in the same slot but with a different MAC address).

Procedure 11.1. Configuring Hotplugging of Bonding Slaves with YaST

If you prefer manual configuration instead, refer to the SUSE Linux Enterprise Server 11 Administration Guide, chapter Basic Networking, section Hotplugging of Bonding Slaves.

  1. Start YaST as root and select Network Devices+Network Settings.

  2. In the Network Settings, switch to the Overview tab, which shows the already configured devices. If bonding slaves are already configured, the Note column shows it.

  3. For each of the Ethernet devices that have been aggregated to a bonding device, execute the following steps:

    1. Select the device to change and click Edit. The Network Card Setup dialog opens.

    2. Switch to the General tab and make sure that Activate device is set to On Hotplug.

    3. Switch to the Hardware tab.

    4. For the Udev rules, click Change and select the BusID option.

    5. Click OK and Next to return to the Overview tab in the Network Settings dialog. If you click the Ethernet device entry now, the bottom pane shows the device's details, including the bus ID.

  4. Click OK to confirm your changes and leave the network settings.

At boot time, /etc/init.d/network does not wait for the hotplug slaves, but for the bond to become ready, which needs at least one available slave. When one of the slave interfaces is removed from the system (unbind from NIC driver, rmmod of the NIC driver or true PCI hotplug removal), the Kernel removes it from the bond automatically. When a new card is added to the system (replacement of the hardware in the slot), udev renames it by applying the bus-based persistent name rule and calls ifup for it. The ifup call automatically joins it into the bond.

11.3. For More Information

All modes, as well as many other options, are explained in detail in the Linux Ethernet Bonding Driver HOWTO, which can be found at /usr/src/linux/Documentation/networking/bonding.txt once you have installed the package kernel-source.

Chapter 12. Load Balancing with Linux Virtual Server

The goal of Linux Virtual Server (LVS) is to provide a basic framework that directs network connections to multiple servers that share their workload. Linux Virtual Server is a cluster of servers (one or more load balancers and several real servers for running services) which appears to be one large, fast server to an outside client. This apparent single server is called a virtual server. The Linux Virtual Server can be used to build highly scalable and highly available network services, such as Web, cache, mail, FTP, media and VoIP services.

The real servers and the load balancers may be interconnected by either high-speed LAN or by geographically dispersed WAN. The load balancers can dispatch requests to the different servers. They make parallel services of the cluster appear as a virtual service on a single IP address (the virtual IP address or VIP). Request dispatching can use IP load balancing technologies or application-level load balancing technologies. Scalability of the system is achieved by transparently adding or removing nodes in the cluster. High availability is provided by detecting node or daemon failures and reconfiguring the system appropriately.

12.1. Conceptual Overview

The following sections give an overview of the main LVS components and concepts.

12.1.1. Director

The main component of LVS is the ip_vs (or IPVS) Kernel code. It implements transport-layer load balancing inside the Linux Kernel (layer-4 switching). The node that runs a Linux Kernel including the IPVS code is called director. The IPVS code running on the director is the essential feature of LVS.

When clients connect to the director, the incoming requests are load-balanced across all cluster nodes: The director forwards packets to the real servers, using a modified set of routing rules that make the LVS work. For example, connections do not originate or terminate on the director, it does not send acknowledgments. The director acts as a specialized router that forwards packets from end-users to real servers (the hosts that run the applications that process the requests).

By default, the Kernel does not have the IPVS module installed. The IPVS Kernel module is included in the cluster-network-kmp-default package.

12.1.2. User Space Controller and Daemons

The ldirectord daemon is a user-space daemon for managing Linux Virtual Server and monitoring the real servers in an LVS cluster of load balanced virtual servers. A configuration file, /etc/ha.d/ldirectord.cf, specifies the virtual services and their associated real servers and tells ldirectord how to configure the server as a LVS redirector. When the daemon is initialized, it creates the virtual services for the cluster.

By periodically requesting a known URL and checking the responses, the ldirectord daemon monitors the health of the real servers. If a real server fails, it will be removed from the list of available servers at the load balancer. When the service monitor detects that the dead server has recovered and is working again, it will add the server back to the list of available servers. In case that all real servers should be down, a fall-back server can be specified to which to redirect a Web service. Typically the fall-back server is localhost, presenting an emergency page about the Web service being temporarily unavailable.

The ldirectord uses the ipvsadm tool (package ipvsadm) to manipulate the virtual server table in the Linux Kernel.

12.1.3. Packet Forwarding

There are three different methods of how the director can send packets from the client to the real servers:

Network Address Translation (NAT)

Incoming requests arrive at the virtual IP and are forwarded to the real servers by changing the destination IP address and port to that of the chosen real server. The real server sends the response to the load balancer which in turn changes the destination IP address and forwards the response back to the client, so that the end user receives the replies from the expected source. As all traffic goes through the load balancer, it usually becomes a bottleneck for the cluster.

IP Tunneling (IP-IP Encapsulation)

IP tunneling enables packets addressed to an IP address to be redirected to another address, possibly on a different network. The LVS sends requests to real servers through an IP tunnel (redirecting to a different IP address) and the real servers reply directly to the client using their own routing tables. Cluster members can be in different subnets.

Direct Routing

Packets from end users are forwarded directly to the real server. The IP packet is not modified, so the real servers must be configured to accept traffic for the virtual server's IP address. The response from the real server is sent directly to the client. The real servers and load balancers have to be in the same physical network segment.

12.1.4. Scheduling Algorithms

Deciding which real server to use for a new connection requested by a client is implemented using different algorithms. They are available as modules and can be adapted to specific needs. For an overview of available modules, refer to the ipvsadm(8) man page. Upon receiving a connect request from a client, the director assigns a real server to the client based on a schedule. The scheduler is the part of the IPVS Kernel code which decides which real server will get the next new connection.

12.2. Configuring IP Load Balancing with YaST

You can configure Kernel-based IP load balancing with the YaST IP Load Balancing module. It is a front-end for ldirectord.

To access the IP Load Balancing dialog, start YaST as root and select High Availability+IP Load Balancing. Alternatively, start the YaST cluster module as root on a command line with yast2 iplb.

The YaST module writes its configuration to /etc/ha.d/ldirectord.cf. The tabs available in the YaST module correspond to the structure of the /etc/ha.d/ldirectord.cf configuration file, defining global options and defining the options for the virtual services.

For an example configuration and the resulting processes between load balancers and real servers, refer to Example 12.1, “Simple ldirectord Configuration”.

[Note]Global Parameters and Virtual Server Parameters

If a certain parameter is specified in both the virtual server section and in the global section, the value defined in the virtual server section overrides the value defined in the global section.

Procedure 12.1. Configuring Global Parameters

The following procedure describes how to configure the most important global parameters. For more details about the individual parameters (and the parameters not covered here), click Help or refer to the ldirectord man page.

  1. With Check Interval, define the interval in which ldirectord will connect to each of the real servers to check if they are still online.

  2. With Check Timeout, set the time in which the real server should have responded after the last check.

  3. With Failure Count you can define how many times ldirectord will attempt to request the real servers until the check is considered failed.

  4. With Negotiate Timeout define a timeout in seconds for negotiate checks.

  5. In Fallback, enter the hostname or IP address of the Web server onto which to redirect a Web service in case all real servers are down.

  6. If you want the system to send alerts in case the connection status to any real server changes, enter a valid e-mail address in Email Alert.

  7. With Email Alert Frequency, define after how many seconds the e-mail alert should be repeated if any of the real servers remains inaccessible.

  8. In Email Alert Status specify the server states for which email alerts should be sent. If you want to define more than one state, use a comma-separated list.

  9. With Auto Reload define, if ldirectord should continuously monitor the configuration file for modification. If set to yes, the configuration is automatically reloaded upon changes.

  10. With the Quiescent switch, define if to remove failed real servers from the Kernel's LVS table or not. If set to Yes, failed servers are not removed. Instead their weight is set to 0 which means that no new connections will be accepted. Already established connections will persist until they time out.

  11. If you want to use an alternative path for logging, specify a path for the logs in Log File. By default, ldirectord writes its logs to /var/log/ldirectord.log.

Figure 12.1. YaST IP Load Balancing—Global Parameters

YaST IP Load Balancing—Global Parameters

Procedure 12.2. Configuring Virtual Services

You can configure one or more virtual services by defining a couple of parameters for each. The following procedure describes how to configure the most important parameters for a virtual service. For more details about the individual parameters (and the parameters not covered here), click Help or refer to the ldirectord man page.

  1. In the YaST IP Load Balancing module, switch to the Virtual Server Configuration tab.

  2. Add a new virtual server or Edit an existing virtual server. A new dialog shows the available options.

  3. In Virtual Server enter the shared virtual IP address (IPv4 or IPv6) and port under which the load balancers and the real servers are accessible as LVS. Instead of IP address and port number you can also specify a hostname and a service. Alternatively, you can also use a firewall mark. A firewall mark is a way of aggregating an arbitrary collection of VIP:port services into one virtual service.

  4. To specify the Real Servers, you need to enter the IP addresses (IPv4, IPv6, or hostnames) of the servers, the ports (or service names) and the forwarding method. The forwarding method must either be gate, ipip or masq, see Section 12.1.3, “Packet Forwarding”.

    Click the Add button and enter the required arguments for each real server.

  5. As Check Type, select the type of check that should be performed to test if the real servers are still alive. For example, to send a request and check if the response contains an expected string, select Negotiate.

  6. If you have set the Check Type to Negotiate, you also need to define the type of service to monitor. Select it from the Service drop-down list.

  7. In Request, enter the URI to the object that is requested on each real server during the check intervals.

  8. If you want to check if the response from the real servers contains a certain string (I'm alive message), define a regular expression that needs to be matched. Enter the regular expression into Receive. If the response from a real server contains this expression, the real server is considered to be alive.

  9. Depending on the type of Service you have selected in Step 6, you also need to specify further parameters for authentication. Switch to the Auth type tab and enter the details like Login, Password, Database, or Secret. For more information, refer to the YaST help text or to the ldirectord man page.

  10. Switch to the Others tab.

  11. Select the Scheduler to be used for load balancing. For information on the available schedulers, refer to the ipvsadm(8) man page.

  12. Select the Protocol to be used. If the virtual service is specified as an IP address and port, it must be either tcp or udp. If the virtual service is specified as a firewall mark, the protocol must be fwm.

  13. Define further parameters, if needed. Confirm your configuration with OK. YaST writes the configuration to /etc/ha.d/ldirectord.cf.

Figure 12.2. YaST IP Load Balancing—Virtual Services

YaST IP Load Balancing—Virtual Services

Example 12.1. Simple ldirectord Configuration

The values shown in Figure 12.1, “YaST IP Load Balancing—Global Parameters” and Figure 12.2, “YaST IP Load Balancing—Virtual Services”, would lead to the following configuration, defined in /etc/ha.d/ldirectord.cf:

autoreload = yes 1
checkinterval = 5 2
checktimeout = 3 3
quiescent = yes 4
    virtual = 192.168.0.200:80 5
    checktype = negotiate 6
    fallback = 127.0.0.1:80 7
    protocol = tcp 8
    real = 192.168.0.110:80 gate 9
    real = 192.168.0.120:80 gate 9
    receive = "still alive" 10
    request = "test.html" 11
    scheduler = wlc 12
    service = http 13

1

Defines that ldirectord should continuously check the configuration file for modification.

2

Interval in which ldirectord will connect to each of the real servers to check if they are still online.

3

Time in which the real server should have responded after the last check.

4

Defines not to remove failed real servers from the Kernel's LVS table, but to set their weight to 0 instead.

5

Virtual IP address (VIP) of the LVS. The LVS is available at port 80.

6

Type of check that should be performed to test if the real servers are still alive.

7

Server onto which to redirect a Web service all real servers for this service are down.

8

Protocol to be used.

9

Two real servers defined, both available at port 80. The packet forwarding method is gate, meaning that direct routing is used.

10

Regular expression that needs to be matched in the response string from the real server.

11

URI to the object that is requested on each real server during the check intervals.

12

Selected scheduler to be used for load balancing.

13

Type of service to monitor.

This configuration would lead to the following process flow: The ldirectord will connect to each real server once every 5 seconds (2) and request 192.168.0.110:80/test.html or 192.168.0.120:80/test.html as specified in 9 and 11. If it does not receive the expected still alive string (10) from a real server within 3 seconds (3) of the last check, it will remove the real server from the available pool. However, because of the quiescent=yes setting (4), the real server will not be removed from the LVS table, but its weight will be set to 0 so that no new connections to this real server will be accepted. Already established connections will be persistent until they time out.


12.3. Further Setup

Apart from the configuration of ldirectord with YaST, you need to make sure the following conditions are fulfilled to complete the LVS setup:

  • The real servers are set up correctly to provide the needed services.

  • The load balancing server (or servers) must be able to route traffic to the real servers using IP forwarding. The network configuration of the real servers depends on which packet forwarding method you have chosen.

  • To prevent the load balancing server (or servers) from becoming a single point of failure for the whole system, you need to set up one or several backups of the load balancer. In the cluster configuration, configure a primitive resource for ldirectord, so that ldirectord can fail over to other servers in case of hardware failure.

  • As the backup of the load balancer also needs the ldirectord configuration file to fulfill its task, make sure the /etc/ha.d/ldirectord.cf is available on all servers that you want to use as backup for the load balancer. You can synchronize the configuration file with Csync2 as described in Section 3.5.4, “Transferring the Configuration to All Nodes”.

12.4. For More Information

To learn more about Linux Virtual Server, refer to the project home page available at http://www.linuxvirtualserver.org/.

For more information about ldirectord, refer to its comprehensive man page.

Chapter 13. Multi-Site Clusters (Geo Clusters)

Abstract

Apart from local clusters and metro area clusters, SUSE® Linux Enterprise High Availability Extension 11 SP3 also supports multi-site clusters (geo clusters). That means you can have multiple, geographically dispersed sites with a local cluster each. Failover between these clusters is coordinated by a higher level entity, the so-called booth. Support for multi-site clusters is available as a separate option to SUSE Linux Enterprise High Availability Extension.

13.1. Challenges for Multi-Site Clusters

Typically, multi-site environments are too far apart to support synchronous communication between the sites and synchronous data replication. That leads to the following challenges:

  • How to make sure that a cluster site is up and running?

  • How to make sure that resources are only started once?

  • How to make sure that quorum can be reached between the different sites and a split brain scenario can be avoided?

  • How to manage failover between the sites?

  • How to deal with high latency in case of resources that need to be stopped?

In the following sections, learn how to meet these challenges with SUSE Linux Enterprise High Availability Extension.

13.2. Conceptual Overview

Multi-site clusters based on SUSE Linux Enterprise High Availability Extension can be considered as overlay clusters where each cluster site corresponds to a cluster node in a traditional cluster. The overlay cluster is managed by the booth mechanism. It guarantees that the cluster resources will be highly available across different cluster sites. This is achieved by using so-called tickets that are treated as failover domain between cluster sites, in case a site should be down.

The following list explains the individual components and mechanisms that were introduced for multi-site clusters in more detail.

Components and Concepts

Ticket

A ticket grants the right to run certain resources on a specific cluster site. A ticket can only be owned by one site at a time. Initially, none of the sites has a ticket—each ticket must be granted once by the cluster administrator. After that, tickets are managed by the booth for automatic failover of resources. But administrators may also intervene and grant or revoke tickets manually.

Resources can be bound to a certain ticket by dependencies. Only if the defined ticket is available at a site, the respective resources are started. Vice versa, if the ticket is removed, the resources depending on that ticket are automatically stopped.

The presence or absence of tickets for a site is stored in the CIB as a cluster status. With regards to a certain ticket, there are only two states for a site: true (the site has the ticket) or false (the site does not have the ticket). The absence of a certain ticket (during the initial state of the multi-site cluster) is not treated differently from the situation after the ticket has been revoked: both are reflected by the value false.

A ticket within an overlay cluster is similar to a resource in a traditional cluster. But in contrast to traditional clusters, tickets are the only type of resource in an overlay cluster. They are primitive resources that do not need to be configured nor cloned.

Booth

The booth is the instance managing the ticket distribution and thus, the failover process between the sites of a multi-site cluster. Each of the participating clusters and arbitrators runs a service, the boothd. It connects to the booth daemons running at the other sites and exchanges connectivity details. Once a ticket is granted to a site, the booth mechanism will manage the ticket automatically: If the site which holds the ticket is out of service, the booth daemons will vote which of the other sites will get the ticket. To protect against brief connection failures, sites that lose the vote (either explicitly or implicitly by being disconnected from the voting body) need to relinquish the ticket after a time-out. Thus, it is made sure that a ticket will only be re-distributed after it has been relinquished by the previous site. See also Dead Man Dependency (loss-policy="fence").

Arbitrator

Each site runs one booth instance that is responsible for communicating with the other sites. If you have a setup with an even number of sites, you need an additional instance to reach consensus about decisions such as failover of resources across sites. In this case, add one or more arbitrators running at additional sites. Arbitrators are single machines that run a booth instance in a special mode. As all booth instances communicate with each other, arbitrators help to make more reliable decisions about granting or revoking tickets.

An arbitrator is especially important for a two-site scenario: For example, if site A can no longer communicate with site B, there are two possible causes for that:

  • A network failure between A and B.

  • Site B is down.

However, if site C (the arbitrator) can still communicate with site B, site B must still be up and running.

Dead Man Dependency (loss-policy="fence")

After a ticket is revoked, it can take a long time until all resources depending on that ticket are stopped, especially in case of cascaded resources. To cut that process short, the cluster administrator can configure a loss-policy (together with the ticket dependencies) for the case that a ticket gets revoked from a site. If the loss-policy is set to fence, the nodes that are hosting dependent resources are fenced. This considerably speeds up the recovery process of the cluster and makes sure that resources can be migrated more quickly.

Figure 13.1. Example Scenario: A Two-Site Cluster (4 Nodes + Arbitrator)

Example Scenario: A Two-Site Cluster (4 Nodes + Arbitrator)

As usual, the CIB is synchronized within each cluster, but it is not synchronized across cluster sites of a multi-site cluster. You have to configure the resources that will be highly available across the multi-site cluster for every site accordingly.

13.3. Requirements

Software Requirements

  • All clusters that will be part of the multi-site cluster must be based on SUSE Linux Enterprise High Availability Extension 11 SP3.

  • SUSE® Linux Enterprise Server 11 SP3 must be installed on all arbitrators.

  • The booth package must be installed on all cluster nodes and on all arbitrators that will be part of the multi-site cluster.

The most common scenario is probably a multi-site cluster with two sites and a single arbitrator on a third site. However, technically, there are no limitations with regards to the number of sites and the number of arbitrators involved.

Nodes belonging to the same cluster site should be synchronized via NTP. However, time synchronization is not required between the individual cluster sites.

13.4. Basic Setup

Configuring a multi-site cluster takes the following basic steps:

13.4.1. Configuring Cluster Resources and Constraints

Apart from the resources and constraints that you need to define for your specific cluster setup, multi-site clusters require additional resources and constraints as described below. Instead of configuring them with the CRM shell, you can also do so with the HA Web Konsole. For details, refer to Section 5.5.2, “Configuring Additional Cluster Resources and Constraints”.

Procedure 13.1. Configuring Ticket Dependencies

The crm configure rsc_ticket command lets you specify the resources depending on a certain ticket. Together with the constraint, you can set a loss-policy that defines what should happen to the respective resources if the ticket is revoked. The attribute loss-policy can have the following values:

  • fence: Fence the nodes that are running the relevant resources.

  • stop: Stop the relevant resources.

  • freeze: Do nothing to the relevant resources.

  • demote: Demote relevant resources that are running in master mode to slave mode.

  1. On one of the cluster nodes, start a shell and log in as root or equivalent.

  2. Enter crm configure to switch to the interactive shell.

  3. Configure a constraint that defines which resources depend on a certain ticket. For example:

    crm(live)configure#
    rsc_ticket rsc1-req-ticketA ticketA: rsc1 loss-policy="fence"

    This creates a constraint with the ID rsc1-req-ticketA. It defines that the resource rsc1 depends on ticketA and that the node running the resource should be fenced in case ticketA is revoked.

    If resource rsc1 was not a primitive, but a special clone resource that can run in master or slave mode, you may want to configure that only rsc1's master mode depends on ticketA. With the following configuration, rsc1 is automatically demoted to slave mode if ticketA is revoked:

    crm(live)configure#
    rsc_ticket rsc1-req-ticketA ticketA: rsc1:Master loss-policy="demote"
  4. If you want other resources to depend on further tickets, create as many constraints as necessary with rsc_ticket.

  5. Review your changes with show.

  6. If everything is correct, submit your changes with commit and leave the crm live configuration with exit.

    The constraints are saved to the CIB.

Procedure 13.2. Configuring a Resource Group for boothd

Each site needs to run one instance of boothd that communicates with the other booth daemons. The daemon can be started on any node, therefore it should be configured as primitive resource. To make the boothd resource stay on the same node, if possible, add resource stickiness to the configuration. As each daemon needs a persistent IP address, configure another primitive with a virtual IP address. Group booth primitives:

  1. On one of the cluster nodes, start a shell and log in as root or equivalent.

  2. Enter crm configure to switch to the interactive shell.

  3. To create both primitive resources and to add them to one group, g-booth:

    crm(live)configure#
    primitive booth-ip ocf:heartbeat:IPaddr2 params ip="IP_ADDRESS"
    primitive booth ocf:pacemaker:booth-site \
          meta resource-stickiness="INFINITY" \
          op monitor interval="10s" timeout="20s"
    group g-booth booth-ip booth
  4. Review your changes with show.

  5. If everything is correct, submit your changes with commit and leave the crm live configuration with exit.

  6. Repeat the resource group configuration on the other cluster sites, using a different IP address for each boothd resource group.

    With this configuration, each booth daemon will be available at its individual IP address, independent of the node the daemon is running on.

Procedure 13.3. Adding an Ordering Constraint

If a ticket has been granted to a site but all nodes of that site should fail to host the boothd resource group for any reason, a split-brain situation among the geographically dispersed sites could occur. In that case, no boothd instance would be available to safely manage fail-over of the ticket to another site. To avoid a potential concurrency violation of the ticket (the ticket is granted to multiple sites simultaneously), add an ordering constraint:

  1. On one of the cluster nodes, start a shell and log in as root or equivalent.

  2. Enter crm configure to switch to the interactive shell.

  3. Create an ordering constraint:

    crm(live)configure#
    order order-booth-rsc1 inf: g-booth rsc1

    This defines that rsc1 (that depends on ticketA) can only be started after the g-booth resource group.

    In case rsc1 is not a primitive, but a special clone resource and configured as described in Step 3, the ordering constraint should be configured as follows:

    crm(live)configure#
    order order-booth-rsc1 inf: g-booth rsc1:promote

    This defines that rsc1 can only be promoted to master mode after the g-booth resource group has started.

  4. Review your changes with show.

  5. For any other resources that depend on a certain ticket, define further ordering constraints.

  6. If everything is correct, submit your changes with commit and leave the crm live configuration with exit.

13.4.2. Setting Up the Booth Services

After having configured the resource group for the boothd and the ticket dependencies, complete the booth setup:

Procedure 13.4. Editing The Booth Configuration File

  1. Log in to a cluster node as root or equivalent.

  2. Create /etc/booth/booth.conf and edit it according to the example below:

    Example 13.1. Example Booth Configuration File

    transport="UDP" 1
    port="6666" 2
    arbitrator="147.2.207.14" 3
    site="147.4.215.19" 4
    site="147.18.2.1"  4
    ticket="ticketA;510006"
    ticket="ticketB;510006"     

    1

    Defines the transport protocol used for communication between the sites. For SP2, only UDP is supported, other transport layers will follow.

    2

    Defines the port used for communication between the sites. Choose any port that is not already used for different services. Make sure to open the port in the nodes' and arbitrators' firewalls.

    3

    Defines the IP address of the arbitrator. Insert an entry for each arbitrator you use in your setup.

    4

    Defines the IP address used for the boothd on each site. Make sure to insert the correct virtual IP addresses (IPaddr2) for each site, otherwise the booth mechanism will not work correctly.

    5

    Defines the ticket to be managed by the booth. For each ticket, add a ticket entry.

    6

    Optional parameter. Defines the ticket's expiry time in seconds. A site that has been granted a ticket will renew the ticket regularly. If the booth does not receive any information about renewal of the ticket within the defined expiry time, the ticket will be revoked and granted to another site. If no expiry time is specified, the ticket will expire after 600 seconds by default.


    An example booth configuration file is available at /etc/booth/booth.conf.example.

  3. Verify your changes and save the file.

  4. Copy /etc/booth/booth.conf to all sites and arbitrators. In case of any changes, make sure to update the file accordingly on all parties.

    [Note]Synchronize Booth Configuration to All Sites and Arbitrators

    All cluster nodes and arbitrators within the multi-site cluster must use the same booth configuration. While you may need to copy the files manually to the arbitrators and to one cluster node per site, you can use Csync2 within each cluster site to synchronize the file to all nodes.

Procedure 13.5. Starting the Booth Services

  1. Start the booth resource group on each other cluster site. It will start one instance of the booth service per site.

  2. Log in to each arbitrator and start the booth service:

    /etc/init.d/booth-arbitrator start

    This starts the booth service in arbitrator mode. It can communicate with all other booth daemons but in contrast to the booth daemons running on the cluster sites, it cannot be granted a ticket.

After finishing the booth configuration and starting the booth services, you are now ready to start the ticket process.

13.5. Managing Multi-Site Clusters

Before the booth can manage a certain ticket within the multi-site cluster, you initially need to grant it to a site manually. Use the booth client command line tool to grant, list, or revoke tickets as described in Overview of booth client Commands. The booth client commands work on any machine where the booth daemon is running.

Overview of booth client Commands

Listing All Tickets on All Sites
#booth client list
      
ticket: ticketA, owner: 147.4.215.19, expires: 2013/04/24 12:00:01
ticket: ticketB, owner: None, expires: INF
Granting a Ticket to a Site
#booth client grant -t ticketA -s 147.2.207.14

cluster[3100]: 2013/04/24_11:44:14 info: grant command sent, result will be
returned asynchronously, you can get the result from the log files.

In this case, ticketA will be granted to the site 147.2.207.14. The grant operation will be executed immediately. However, it might not be finished yet when the message above appears on the screen. Find the exact status in the log files.

Before granting a ticket, the command will execute a sanity check. If the same ticket is already granted to another site, you will be warned about that and be prompted to revoke the ticket from the current site first.

Revoking a Ticket From a Site
#booth client revoke -t ticketA -s 147.2.207.14

cluster[3100]: 2013/04/24_11:44:14 info: revoke command sent, result will be
returned asynchronously, you can get the result from the log files.

In this case, ticketA will be revoked from the site 147.2.207.14. The revoke operation will be executed immediately. However, it might not be finished yet when the message above appears on the screen. Find the exact status in the log files.

[Warning]crm_ticket and crm site ticket

In case the booth service is not running for any reasons, you may also manage tickets manually with crm_ticket or crm site ticket. Both commands are only available on cluster nodes. In case of manual intervention, use them with great care as they cannot verify if the same ticket is already granted elsewhere. For basic information about the commands, refer to their man pages.

As long as booth is up and running, only use booth client for manual intervention.

After you have initially granted a ticket to a site, the booth mechanism will take over and manage the ticket automatically. If the site holding a ticket should be out of service, the ticket will automatically be revoked after the expiry time and granted to another site. The resources that depend on that ticket will fail over to the new site holding the ticket. The nodes that have run the resources before will be treated according to the loss-policy you set within the constraint.

Procedure 13.6. Managing Tickets Manually

Assuming that you want to manually move ticketA from site 147.2.207.14 to 147.2.207.15, proceed as follows:

  1. Set ticketA to standby with the following command:

    crm_ticket -t ticketA -s
  2. Wait for any resources that depend on ticketA to be stopped or demoted cleanly.

  3. Revoke ticketA from its current site with:

    booth client revoke -t ticketA -s 147.2.207.14
  4. Wait for the revocation process to be finished successfully (check /var/log/messages for details). Do not execute any grant commands during this time.

  5. After the ticket has been revoked from its original site, grant it to the new site with:

    booth client grant -t ticketA -s 147.2.207.15

13.6. Troubleshooting

Booth logs to /var/log/messages and uses the same logging mechanism as the CRM. Thus, changing the log level will also take effect on booth logging. The booth log messages also contain information about any tickets.

Both the booth log messages and the booth configuration file are included in the hb_report.

In case of unexpected booth behavior or any problems, check /var/log/messages or create an hb_report.

Part III. Storage and Data Replication

Chapter 14. OCFS2

Abstract

Oracle Cluster File System 2 (OCFS2) is a general-purpose journaling file system that has been fully integrated since the Linux 2.6 Kernel. OCFS2 allows you to store application binary files, data files, and databases on devices on shared storage. All nodes in a cluster have concurrent read and write access to the file system. A user-space control daemon, managed via a clone resource, provides the integration with the HA stack, in particular with OpenAIS/Corosync and the Distributed Lock Manager (DLM).

14.1. Features and Benefits

OCFS2 can be used for the following storage solutions for example:

  • General applications and workloads.

  • Xen image store in a cluster. Xen virtual machines and virtual servers can be stored on OCFS2 volumes that are mounted by cluster servers. This provides quick and easy portability of Xen virtual machines between servers.

  • LAMP (Linux, Apache, MySQL, and PHP | Perl | Python) stacks.

As a high-performance, symmetric and parallel cluster file system, OCFS2 supports the following functions:

  • An application's files are available to all nodes in the cluster. Users simply install it once on an OCFS2 volume in the cluster.

  • All nodes can concurrently read and write directly to storage via the standard file system interface, enabling easy management of applications that run across the cluster.

  • File access is coordinated through DLM. DLM control is good for most cases, but an application's design might limit scalability if it contends with the DLM to coordinate file access.

  • Storage backup functionality is available on all back-end storage. An image of the shared application files can be easily created, which can help provide effective disaster recovery.

OCFS2 also provides the following capabilities:

  • Metadata caching.

  • Metadata journaling.

  • Cross-node file data consistency.

  • Support for multiple-block sizes up to 4 KB, cluster sizes up to 1 MB, for a maximum volume size of 4 PB (Petabyte).

  • Support for up to 32 cluster nodes.

  • Asynchronous and direct I/O support for database files for improved database performance.

14.2. OCFS2 Packages and Management Utilities

The OCFS2 Kernel module (ocfs2) is installed automatically in the High Availability Extension on SUSE® Linux Enterprise Server 11 SP3. To use OCFS2, make sure the following packages are installed on each node in the cluster: ocfs2-tools and the matching ocfs2-kmp-* packages for your Kernel.

The ocfs2-tools package provides the following utilities for management of OFS2 volumes. For syntax information, see their man pages.

Table 14.1. OCFS2 Utilities

OCFS2 Utility

Description

debugfs.ocfs2

Examines the state of the OCFS file system for the purpose of debugging.

fsck.ocfs2

Checks the file system for errors and optionally repairs errors.

mkfs.ocfs2

Creates an OCFS2 file system on a device, usually a partition on a shared physical or logical disk.

mounted.ocfs2

Detects and lists all OCFS2 volumes on a clustered system. Detects and lists all nodes on the system that have mounted an OCFS2 device or lists all OCFS2 devices.

tunefs.ocfs2

Changes OCFS2 file system parameters, including the volume label, number of node slots, journal size for all node slots, and volume size.


14.3. Configuring OCFS2 Services and a STONITH Resource

Before you can create OCFS2 volumes, you must configure the following resources as services in the cluster: DLM, O2CB and a STONITH resource. OCFS2 uses the cluster membership services from Pacemaker which run in user space. Therefore, DLM and O2CB need to be configured as clone resources that are present on each node in the cluster.

The following procedure uses the crm shell to configure the cluster resources. Alternatively, you can also use the Pacemaker GUI to configure the resources.

[Note]DLM Resource for Both cLVM and OCFS2

Both cLVM and OCFS2 need a DLM resource that runs on all nodes in the cluster and therefore usually is configured as a clone. If you have a setup that includes both OCFS2 and cLVM, configuring one DLM resource for both OCFS2 and cLVM is enough.

Procedure 14.1. Configuring DLM and O2CB Resources

The configuration consists of a base group that includes several primitives and a base clone. Both base group and base clone can be used in various scenarios afterwards (for both OCFS2 and cLVM, for example). You only need to extended the base group with the respective primitives as needed. As the base group has internal colocation and ordering, this facilitates the overall setup as you do not have to specify several individual groups, clones and their dependencies.

Follow the steps below for one node in the cluster:

  1. Start a shell and log in as root or equivalent.

  2. Run crm configure.

  3. Enter the following to create the primitive resources for DLM and O2CB:

    primitive dlm ocf:pacemaker:controld \
          op monitor interval="60" timeout="60"
    primitive o2cb ocf:ocfs2:o2cb \
          op monitor interval="60" timeout="60"
    

    The dlm clone resource controls the distributed lock manager service and makes sure this service is started on all nodes in the cluster. Due to the base group's internal colocation and ordering, the o2cb service is only started on nodes where a copy of the dlm service is already running.

  4. Enter the following to create a base group and a base clone:

    group base-group dlm o2cb 
    clone base-clone base-group \
          meta interleave="true"
  5. Review your changes with show.

  6. If everything is correct, submit your changes with commit and leave the crm live configuration with exit.

Procedure 14.2. Configuring a STONITH Resource

[Note]STONITH Device Needed

You need to configure a fencing device. Without a STONITH mechanism (like external/sbd) in place the configuration will fail.

  1. Start a shell and log in as root or equivalent.

  2. Create an SBD partition as described in Section 17.1.3.1, “Creating the SBD Partition”.

  3. Run crm configure.

  4. Configure external/sdb as fencing device with /dev/sdb2 being a dedicated partition on the shared storage for heartbeating and fencing:

    primitive sbd_stonith stonith:external/sbd \
          meta target-role="Started" \
          op monitor interval="15" timeout="15" start-delay="15"
  5. Review your changes with show.

  6. If everything is correct, submit your changes with commit and leave the crm live configuration with exit.

14.4. Creating OCFS2 Volumes

After you have configured DLM and O2CB as cluster resources as described in Section 14.3, “Configuring OCFS2 Services and a STONITH Resource”, configure your system to use OCFS2 and create OCFs2 volumes.

[Note]OCFS2 Volumes for Application and Data Files

We recommend that you generally store application files and data files on different OCFS2 volumes. If your application volumes and data volumes have different requirements for mounting, it is mandatory to store them on different volumes.

Before you begin, prepare the block devices you plan to use for your OCFS2 volumes. Leave the devices as free space.

Then create and format the OCFS2 volume with the mkfs.ocfs2 as described in Procedure 14.3, “Creating and Formatting an OCFS2 Volume”. The most important parameters for the command are listed in Table 14.2, “Important OCFS2 Parameters”. For more information and the command syntax, refer to the mkfs.ocfs2 man page.

Table 14.2. Important OCFS2 Parameters

OCFS2 Parameter

Description and Recommendation

Volume Label (-L)

A descriptive name for the volume to make it uniquely identifiable when it is mounted on different nodes. Use the tunefs.ocfs2 utility to modify the label as needed.

Cluster Size (-C)

Cluster size is the smallest unit of space allocated to a file to hold the data. For the available options and recommendations, refer to the mkfs.ocfs2 man page.

Number of Node Slots (-N)

The maximum number of nodes that can concurrently mount a volume. For each of the nodes, OCFS2 creates separate system files, such as the journals, for each of the nodes. Nodes that access the volume can be a combination of little-endian architectures (such as x86, x86-64, and ia64) and big-endian architectures (such as ppc64 and s390x).

Node-specific files are referred to as local files. A node slot number is appended to the local file. For example: journal:0000 belongs to whatever node is assigned to slot number 0.

Set each volume's maximum number of node slots when you create it, according to how many nodes that you expect to concurrently mount the volume. Use the tunefs.ocfs2 utility to increase the number of node slots as needed. Note that the value cannot be decreased.

Block Size (-b)

The smallest unit of space addressable by the file system. Specify the block size when you create the volume. For the available options and recommendations, refer to the mkfs.ocfs2 man page.

Specific Features On/Off (--fs-features)

A comma separated list of feature flags can be provided, and mkfs.ocfs2 will try to create the file system with those features set according to the list. To turn a feature on, include it in the list. To turn a feature off, prepend no to the name.

For on overview of all available flags, refer to the mkfs.ocfs2 man page.

Pre-Defined Features (--fs-feature-level)

Allows you to choose from a set of pre-determined file system features. For the available options, refer to the mkfs.ocfs2 man page.


If you do not specify any specific features when creating and formatting the volume with mkfs.ocfs2, the following features are enabled by default: backup-super, sparse, inline-data, unwritten, metaecc, indexed-dirs, and xattr.

Procedure 14.3. Creating and Formatting an OCFS2 Volume

Execute the following steps only on one of the cluster nodes.

  1. Open a terminal window and log in as root.

  2. Check if the cluster is online with the command crm_mon.

  3. Create and format the volume using the mkfs.ocfs2 utility. For information about the syntax for this command, refer to the mkfs.ocfs2 man page.

    For example, to create a new OCFS2 file system on /dev/sdb1 that supports up to 32 cluster nodes, use the following command:

    mkfs.ocfs2 -N 32 /dev/sdb1

14.5. Mounting OCFS2 Volumes

You can either mount an OCFS2 volume manually or with the cluster manager, as described in Procedure 14.5, “Mounting an OCFS2 Volume with the Cluster Manager”.

Procedure 14.4. Manually Mounting an OCFS2 Volume

  1. Open a terminal window and log in as root.

  2. Check if the cluster is online with the command crm_mon.

  3. Mount the volume from the command line, using the mount command.

[Warning]Manually Mounted OCFS2 Devices

If you mount the OCFS2 file system manually for testing purposes, make sure to unmount it again before starting to use it by means of OpenAIS.

Procedure 14.5. Mounting an OCFS2 Volume with the Cluster Manager

To mount an OCFS2 volume with the High Availability software, configure an ocf file system resource in the cluster. The following procedure uses the crm shell to configure the cluster resources. Alternatively, you can also use the Pacemaker GUI to configure the resources.

  1. Start a shell and log in as root or equivalent.

  2. Run crm configure.

  3. Configure Pacemaker to mount the OCFS2 file system on every node in the cluster:

    primitive ocfs2-1 ocf:heartbeat:Filesystem \
          params device="/dev/sdb1" directory="/mnt/shared" fstype="ocfs2" options="acl" \
          op monitor interval="20" timeout="40"
  4. Add the file system primitive to the base group you have configured in Procedure 14.1, “Configuring DLM and O2CB Resources”:

    1. Enter

      edit base-group
    2. In the vi editor that opens, modify the group as follows and save your changes:

      group base-group dlm o2cb ocfs2-1

      Due to the base group's internal colocation and ordering, Pacemaker will only start the ocfs2-1 resource on nodes that also have an o2cb resource already running.

  5. Review your changes with show. To check if you have configured all needed resources, also refer to Appendix B, Example Configuration for OCFS2 and cLVM.

  6. If everything is correct, submit your changes with commit and leave the crm live configuration with exit.

14.6. Using Quotas on OCFS2 File Systems

To use quotas on an OCFS2 file system, create and mount the files system with the appropriate quota features or mount options, respectively: ursquota (quota for individual users) or grpquota (quota for groups). These features can also be enabled later on an unmounted file system using tunefs.ocfs2.

When a file system has the appropriate quota feature enabled, it tracks in its metadata how much space and files each user (or group) uses. Since OCFS2 treats quota information as file system-internal metadata, you do not need to run the quotacheck(8) program. All functionality is built into fsck.ocfs2 and the file system driver itself.

To enable enforcement of limits imposed on each user or group, run quotaon(8) like you would do for any other file system.

For performance reasons each cluster node performs quota accounting locally and synchronizes this information with a common central storage once per 10 seconds. This interval is tunable with tunefs.ocfs2, options usrquota-sync-interval and grpquota-sync-interval. Therefore quota information may not be exact at all times and as a consequence users or groups can slightly exceed their quota limit when operating on several cluster nodes in parallel.

14.7. For More Information

For more information about OCFS2, see the following links:

http://oss.oracle.com/projects/ocfs2/

OCFS2 project home page at Oracle.

http://oss.oracle.com/projects/ocfs2/documentation

OCFS2 User's Guide, available from the project documentation home page.

Chapter 15. Distributed Replicated Block Device (DRBD)

Abstract

The distributed replicated block device (DRBD*) allows you to create a mirror of two block devices that are located at two different sites across an IP network. When used with OpenAIS, DRBD supports distributed high-availability Linux clusters. This chapter shows you how to install and set up DRBD.

15.1. Conceptual Overview

DRBD replicates data on the primary device to the secondary device in a way that ensures that both copies of the data remain identical. Think of it as a networked RAID 1. It mirrors data in real-time, so its replication occurs continuously. Applications do not need to know that in fact their data is stored on different disks.

[Important]Unencrypted Data

The data traffic between mirrors is not encrypted. For secure data exchange, you should deploy a Virtual Private Network (VPN) solution for the connection.

DRBD is a Linux Kernel module and sits between the I/O scheduler at the lower end and the file system at the upper end, see Figure 15.1, “Position of DRBD within Linux”. To communicate with DRBD, users use the high-level command drbdadm. For maximum flexibility DRBD comes with the low-level tool drbdsetup.

Figure 15.1. Position of DRBD within Linux

Position of DRBD within Linux

DRBD allows you to use any block device supported by Linux, usually:

  • partition or complete hard disk

  • software RAID

  • Logical Volume Manager (LVM)

  • Enterprise Volume Management System (EVMS)

By default, DRBD uses the TCP ports 7788 and higher for communication between DRBD nodes. Make sure that your firewall does not prevent communication on this port.

You must set up the DRBD devices before creating file systems on them. Everything pertaining to user data should be done solely via the /dev/drbd_R device and not on the raw device, as DRBD uses the last 128 MB of the raw device for metadata. Make sure to create file systems only on the /dev/drbd<n> device and not on the raw device.

For example, if the raw device is 1024 MB in size, the DRBD device has only 896 MB available for data, with 128 MB hidden and reserved for the metadata. Any attempt to access the space between 896 MB and 1024 MB fails because it is not available for user data.

15.2. Installing DRBD Services

To install the needed packages for DRBD, install the High Availability Extension Add-On product on both SUSE Linux Enterprise Server machines in your networked cluster as described in Part I, “Installation and Setup”. Installing High Availability Extension also installs the DRBD program files.

If you do not need the complete cluster stack but just want to use DRBD, refer to Table 15.1, “DRBD RPM Packages”. It contains a list of all RPM packages for DRBD. Recently, the drbd package has been split into separate packages.

Table 15.1. DRBD RPM Packages

Filename

Explanation

drbd

Convenience package, split into other

drbd-bash-completion

Programmable bash completion support for drbdadm

drbd-heartbeat

Heartbeat resource agent for DRBD (only needed for Heartbeat)

drbd-kmp-default

Kernel module for DRBD (needed)

drbd-kmp-xen

Xen Kernel module for DRBD

drbd-udev

udev integration scripts for DRBD, managing symlinks to DRBD devices in /dev/drbd/by-res and /dev/drbd/by-disk

drbd-utils

Management utilities for DRBD (needed)

drbd-pacemaker

Pacemaker resource agent for DRBD

drbd-xen

Xen block device management script for DRBD

yast2-drbd

YaST DRBD Configuration (recommended)


To simplify the work with drbdadm, use the Bash completion support in the RPM package drbd-bash-completion. If you want to enable it in your current shell session, insert the following command:

source /etc/bash_completion.d/drbdadm.sh

To use it permanently for root, create a file /root/.bashrc and insert the previous line.

15.3. Configuring the DRBD Service

[Note]

The following procedure uses the server names jupiter and venus, and the cluster resource name r0. It sets up jupiter as the primary node. Make sure to modify the instructions to use your own nodes and filenames.

Before you start configuring DRBD, make sure the block devices in your Linux nodes are ready and partitioned (if needed). The following procedure assumes you have two nodes, jupiter and venus, and they use the TCP port 7788. Make sure this port is open in your firewall.

To set up DRBD manually, proceed as follows:

Procedure 15.1. Manually Configuring DRBD

  1. Log in as user root.

  2. Change DRBD's configuration files:

    1. Open the file /etc/drbd.conf and insert the following lines, if not available:

      include "drbd.d/global_common.conf";
      include "drbd.d/*.res";

      Beginning with DRBD 8.3 the configuration file is split into separate files, located under the directory /etc/drbd.d/.

    2. Open the file /etc/drbd.d/global_common.conf. It contains already some pre-defined values. Go to the startup section and insert these lines:

      startup {
          # wfc-timeout degr-wfc-timeout outdated-wfc-timeout
          # wait-after-sb;
          wfc-timeout 1;
          degr-wfc-timeout 1;
      }

      These options are used to reduce the timeouts when booting, see http://www.drbd.org/users-guide-emb/re-drbdconf.html for more details.

    3. Create the file /etc/drbd.d/r0.res, change the lines according to your situation, and save it:

      resource r0 { 1
        device /dev/drbd_r0 minor 0; 2
        disk /dev/sda1; 3
        meta-disk internal; 4
        on jupiter { 5
          address  192.168.1.10:7788; 6
        }
        on venus { 5
          address 192.168.1.11:7788; 6
        }
        syncer {
          rate  7M; 7
        }
      }

      1

      Name of the resource. It is recommended to use resource names like r0, r1, etc.

      2

      The device name for DRBD and its minor number.

      In the example above, the device node name, as created with udev, is referenced (/dev/drbd_r0, with r0 representing the resource name). For this usage, you need to have the drbd-udev package installed. Alternatively, omit the device node name in the configuration and use the following line instead:

      device minor 0

      3

      The device that is replicated between nodes. Note, in this example the devices are the same on both nodes. If you need different devices, move the disk parameter into the on section.

      4

      The meta-disk parameter usually contains the value internal, but it is possible to specify an explicit device to hold the meta data. See http://www.drbd.org/users-guide-emb/ch-internals.html#s-metadata for more information.

      5

      The on section contains the hostname of the node

      6

      The IP address and port number of the respective node. Each resource needs an individual port, usually starting with 7788.

      7

      The synchronization rate. Set it to one third of your bandwidth. It only limits the resynchronization, not the mirroring.

  3. Check the syntax of your configuration file(s). If the following command returns an error, verify your files:

    drbdadm dump all
  4. If you have configured Csync2 (which should be the default), the DRBD configuration files are already included in the list of files which need to be synchronized. To syncronize them, use:

    csync2 -xv

    If you do not have Csync2 (or do not want to use it), copy the DRBD configuration files manually to the other node:

    scp /etc/drbd.conf venus:/etc/
    scp /etc/drbd.d/*  venus:/etc/drbd.d/
  5. Initialize the meta data on both systems by entering the following on each node:

    drbdadm -- --ignore-sanity-checks create-md r0
    rcdrbd start

    If your disk already contains a file system that you do not need anymore, destroy the file system structure with the following command and repeat this step:

    dd if=/dev/zero of=/dev/sdb1 count=10000
  6. Watch the DRBD status by entering the following on each node:

    rcdrbd status

    You should get something like this:

    drbd driver loaded OK; device status:
    version: 8.3.7 (api:88/proto:86-91)
    GIT-hash: ea9e28dbff98e331a62bcbcc63a6135808fe2917 build by phil@fat-tyre, 2010-01-13 17:17:27
    m:res  cs         ro                   ds                         p  mounted  fstype
    0:r0   Connected  Secondary/Secondary  Inconsistent/Inconsistent  C
  7. Start the resync process on your intended primary node (jupiter in this case):

    drbdadm -- --overwrite-data-of-peer primary r0
  8. Check the status again with rcdrbd status and you get:

    ...
    m:res  cs         ro                 ds                 p  mounted  fstype
    0:r0   Connected  Primary/Secondary  UpToDate/UpToDate  C

    The status in the ds row (disk status) must be UpToDate on both nodes.

  9. Set jupiter as primary node:

    drbdadm primary r0
  10. Create your file system on top of your DRBD device, for example:

    mkfs.ext3 /dev/drbd_r0
  11. Mount the file system and use it:

    mount /dev/drbd_r0 /mnt/

To use YaST to configure DRBD, proceed as follows:

Procedure 15.2. Using YaST to Configure DRBD

  1. Start YaST and select the configuration module High Availability+DRBD. If you have already a DRBD configuration, YaST warns you. YaST will change your configuration and will save your old DRBD configuration files as *.YaSTsave.

  2. In Start-up Configuration+Booting select On to start DRBD always at boot time (see Figure 15.2, “Start-up Configuration”).

    Figure 15.2. Start-up Configuration

    Start-up Configuration

  3. If you need to configure more than one replicated resource, select Global Configuration. The input field Minor Count selects how many different DRBD resources may be configured without restarting the computer.

  4. The actual configuration of the resource is done in Resource Configuration (see Figure 15.3, “Resource Configuration”).

    Figure 15.3. Resource Configuration

    Resource Configuration

    Press Add to create a new resource. The following parameters have to be set twice:

    Resource Name

    The name of the resource, often called r0. This parameter is mandatory.

    Name

    The hostname of the relevant node

    Address:Port

    The IP address and port number (default 7788) of the respective node

    Device

    The device that holds the replicated data on the respective node. Use this device to create file systems and mount operations. Make sure you add minor 0 after the device name.

    Disk

    The device that is replicated between both nodes

    Meta-disk

    The Meta-disk is either set to the value internal or specifies an explicit device extended by an index to hold the meta data needed by DRBD.

    When using internal, the last 128 MB of the replicated device are used to store the meta data.

    A real device may also be used for multiple drbd resources. For example, if your Meta-Disk is /dev/sda6[0] for the first resource, you may use /dev/sda6[1] for the second resource. However, there must be at least 128 MB space for each resource available on this disk.

    All of these options are explained in the examples in the /usr/share/doc/packages/drbd-utils/drbd.conf file and in the man page of drbd.conf(5).

  5. If you have configured Csync2 (which should be the default), the DRBD configuration files are already included in the list of files which need to be synchronized. To syncronize them, use:

    csync2 -xv

    If you do not have Csync2 (or do not want to use it), copy the DRBD configuration files manually to the other node (pretending to be another node with the name venus):

    scp /etc/drbd.conf venus:/etc/
    scp /etc/drbd.d/*  venus:/etc/drbd.d/
  6. Initialize and start the DRBD service on both systems by entering the following on each node:

    drbdadm create-md r0
    rcdrbd start
  7. Configure node1 as the primary node by entering the following on node1:

    drbdsetup /dev/drbd0 primary --overwrite-data-of-peer
  8. Check the DRBD service status by entering the following on each node:

    rcdrbd status

    Before proceeding, wait until the block devices on both nodes are fully synchronized. Repeat the rcdrbd status command to follow the synchronization progress.

  9. After the block devices on both nodes are fully synchronized, format the DRBD device on the primary with your preferred file system. Any Linux file system can be used.

    [Important]

    Always use the /dev/drbd<n> name in the command, not the actual /dev/disk device name.

15.4. Testing the DRBD Service

If the install and configuration procedures worked as expected, you are ready to run a basic test of the DRBD functionality. This test also helps with understanding how the software works.

  1. Test the DRBD service on jupiter.

    1. Open a terminal console, then log in as root.

    2. Create a mount point on jupiter, such as /srv/r0mount:

      mkdir -p /srv/r0mount
    3. Mount the drbd device:

      mount -o rw /dev/drbd0 /srv/r0mount
    4. Create a file from the primary node:

      touch /srv/r0mount/from_node1
  2. Test the DRBD service on venus.

    1. Open a terminal console, then log in as root.

    2. Unmount the disk on jupiter:

      umount /srv/r0mount
    3. Downgrade the DRBD service on jupiter by typing the following command on jupiter:

      drbdadm secondary r0
    4. On venus, promote the DRBD service to primary:

      drbdadm primary r0
    5. On venus, check to see if venus is primary:

      rcdrbd status
    6. On venus, create a mount point such as /srv/r0mount:

      mkdir /srv/r0mount
    7. On venus, mount the DRBD device:

      mount -o rw /dev/drbd_r0 /srv/r0mount
    8. Verify that the file you created on jupiter is viewable.

      ls /srv/r0mount

      The /srv/r0mount/from_node1 file should be listed.

  3. If the service is working on both nodes, the DRBD setup is complete.

  4. Set up jupiter as the primary again.

    1. Dismount the disk on venus by typing the following command on venus:

      umount /srv/r0mount
    2. Downgrade the DRBD service on venus by typing the following command on venus:

      drbdadm secondary r0
    3. On jupiter, promote the DRBD service to primary:

      drbdadm primary r0
    4. On jupiter, check to see if jupiter is primary:

      rcdrbd status
  5. To get the service to automatically start and fail over if the server has a problem, you can set up DRBD as a high availability service with OpenAIS. For information about installing and configuring OpenAIS for SUSE Linux Enterprise 11 see Part II, “Configuration and Administration”.

15.5. Tuning DRBD

There are several ways to tune DRBD:

  1. Use an external disk for your metadata. This speeds up your connection.

  2. Create a udev rule to change the read-ahead of the DRBD device. Save the following line in the file /etc/udev/rules.d/82-dm-ra.rules and change the read_ahead_kb value to your workload:

    ACTION=="add", KERNEL=="dm-*", ATTR{bdi/read_ahead_kb}="4100"

    This line only works if you use LVM.

  3. Activate bmbv on Linux software RAID systems. The use-bmbv keyword enables DRBD to process IO requests in units not lager than 4kByte. However, this option should be adapted carefully. Use the following line in the common disk section of your DRBD configuration, usually in /etc/drbd.d/global_common.conf:

    disk {
      use-bmbv;
    }

15.6. Troubleshooting DRBD

The drbd setup involves many different components and problems may arise from different sources. The following sections cover several common scenarios and recommend various solutions.

15.6.1. Configuration

If the initial drbd setup does not work as expected, there is probably something wrong with your configuration.

To get information about the configuration:

  1. Open a terminal console, then log in as root.

  2. Test the configuration file by running drbdadm with the -d option. Enter the following command:

    drbdadm -d adjust r0
    

    In a dry run of the adjust option, drbdadm compares the actual configuration of the DRBD resource with your DRBD configuration file, but it does not execute the calls. Review the output to make sure you know the source and cause of any errors.

  3. If there are errors in the /etc/drbd.d/* and drbd.conf files, correct them before continuing.

  4. If the partitions and settings are correct, run drbdadm again without the -d option.

    drbdadm adjust r0
    

    This applies the configuration file to the DRBD resource.

15.6.2. Hostnames

For DRBD, hostnames are case sensitive (Node0 would be a different host than node0).

If you have several network devices and want to use a dedicated network device, the hostname will likely not resolve to the used IP address. In this case, use the parameter disable-ip-verification.

15.6.3. TCP Port 7788

If your system is unable to connect to the peer, this might be a problem with your local firewall. By default, DRBD uses the TCP port 7788 to access the other node. Make sure that this port is accessible on both nodes.

15.6.4. DRBD Devices Broken after Reboot

In cases when DRBD does not know which of the real devices holds the latest data, it changes to a split brain condition. In this case, the respective DRBD subsystems come up as secondary and do not connect to each other. In this case, the following message is written to /var/log/messages:

Split-Brain detected, dropping connection!

To resolve this situation, enter the following on the node which has data to be discarded:

drbdadm secondary r0 
drbdadm -- --discard-my-data connect r0

On the node which has the latest data enter the following:

drbdadm connect r0

15.7. For More Information

The following open source resources are available for DRBD:

  • The project home page http://www.drbd.org.

  • See Highly Available NFS Storage with DRBD and Pacemaker (↑Highly Available NFS Storage with DRBD and Pacemaker).

  • http://clusterlabs.org/wiki/DRBD_HowTo_1.0 by the Linux Pacemaker Cluster Stack Project.

  • The following man pages for DRBD are available in the distribution: drbd(8), drbddisk(8), drbdsetup(8), drbdsetup(8), drbdadm(8), drbd.conf(5).

  • Find a commented example configuration for DRBD at /usr/share/doc/packages/drbd/drbd.conf

Chapter 16. Cluster Logical Volume Manager (cLVM)

Abstract

When managing shared storage on a cluster, every node must be informed about changes that are done to the storage subsystem. The Linux Volume Manager 2 (LVM2), which is widely used to manage local storage, has been extended to support transparent management of volume groups across the whole cluster. Clustered volume groups can be managed using the same commands as local storage.

16.1. Conceptual Overview

Clustered LVM is coordinated with different tools:

Distributed Lock Manager (DLM)

Coordinates disk access for cLVM.

Logical Volume Manager2 (LVM2)

Enables flexible distribution of one file system over several disks. LVM provides a virtual pool of disk space.

Clustered Logical Volume Manager (cLVM)

Coordinates access to the LVM2 metadata so every node knows about changes. cLVM does not coordinate access to the shared data itself; to enable cLVM to do so, you must configure OCFS2 or other cluster-aware applications on top of the cLVM-managed storage.

16.2. Configuration of cLVM

Depending on your scenario it is possible to create a RAID 1 device with cLVM with the following layers:

  • LVM.  This is a very flexible solution if you want to increase or decrease your file system size, add more physical storage, or create snapshots of your file systems. This method is described in Section 16.2.3, “Scenario: cLVM With iSCSI on SANs”.

  • DRBD.  This solution only provides RAID 0 (striping) and RAID 1 (mirroring). The last method is described in Section 16.2.4, “Scenario: cLVM With DRBD”.

  • MD Devices (Linux Software RAID or mdadm).  Although this solution provides all RAID levels, it does not support clusters yet.

Make sure you have fulfilled the following prerequisites:

  • A shared storage device is available, such as provided by a Fibre Channel, FCoE, SCSI, iSCSI SAN, or DRBD*.

  • In case of DRBD, both nodes must be primary (as described in the following procedure).

  • Check if the locking type of LVM2 is cluster-aware. The keyword locking_type in /etc/lvm/lvm.conf must contain the value 3 (should be the default). Copy the configuration to all nodes, if necessary.

[Note]Create Cluster Resources First

First create your cluster resources as described in Section 16.2.2, “Creating the Cluster Resources” and then your LVM volumes. Otherwise it is impossible to remove the volumes later.

16.2.1. Configuring Cmirrord

To track mirror log information in a cluster, the cmirrord daemon is used. Cluster mirrors are not possible without this daemon running.

We assume that /dev/sda and /dev/sdb are the shared storage devices. Replace these with your own device name(s), if necessary. Proceed as follows:

  1. Create a cluster with at least two nodes.

  2. Configure your cluster to run dlm, clvmd, and STONITH:

    # crm configure
    crm(live)configure# primitive clvmd ocf:lvm2:clvmd \
            op stop interval="0" timeout="100" \
            op start interval="0" timeout="90" \
            op monitor interval="20" timeout="20"
    crm(live)configure# primitive dlm ocf:pacemaker:controld \
            op start interval="0" timeout="90" \
            op stop interval="0" timeout="100" \
            op monitor interval="60" timeout="60"
    crm(live)configure# primitive sbd_stonith stonith:external/sbd
    crm(live)configure# group base-group dlm clvmd
    crm(live)configure# clone base-clone base-group \
            meta interleave="true"
  3. Leave the crm shell with exit and commit your changes.

  4. Create a clustered volume group (VG):

    pvcreate /dev/sda /dev/sdb
    vgcreate -cy vg /dev/sda /dev/sdb
  5. Create a mirrored-log logical volume (LV) in your cluster:

    lvcreate -nlv -m1 -l10%VG vg --mirrorlog mirrored
  6. Use lvs to show the progress. If the percentage number has reached 100%, the mirrored disk is successfully synced.

  7. To test the clustered volume /dev/vg/lv, use the following steps:

    1. Read or write to /dev/vg/lv.

    2. Deactivate your LV with lvchange -an.

    3. Activate your LV with lvchange -ay.

    4. Use lvconvert to convert a mirrored log to a disk log.

  8. Create a mirrored-log LV in another cluster VG. This is a different volume group from the previous one.

The current cLVM can only handle one physical volume (PV) per mirror side. If one mirror is actually made up of several PVs that need to be concatenated or striped, lvcreate does not understand this. For this reason, lvcreate and cmirrord metadata needs to understand grouping of PVs into one side, effectively supporting RAID10.

In order to support RAID10 for cmirrord, use the following procedure (assuming that /dev/sda and /dev/sdb are the shared storage devices):

  1. Create a volume group (VG):

    pvcreate /dev/sda /dev/sdb
    vgcreate vg /dev/sda /dev/sdb
  2. Open the file /etc/lvm/lvm.conf and go to the section allocation. Set the following line and save the file:

    mirror_legs_require_separate_pvs = 1
  3. Add your tags to your PVs:

    pvchange --addtag @a /dev/sda
    pvchange --addtag @b /dev/sdb

    A tag is an unordered keyword or term assigned to the metadata of a storage object. Tagging allows you to classify collections of LVM storage objects in ways that you find useful by attaching an unordered list of tags to their metadata.

  4. List your tags:

    pvs -o pv_name,vg_name,pv_tags /dev/sd{a,b}

    You should receive this output:

      PV         VG     PV Tags
      /dev/sda vgtest a
      /dev/sdb vgtest b

If you need further information regarding LVM, refer to our Storage Administration Guide at https://www.suse.com/documentation/sles11/stor_admin/data/lvm.html.

16.2.2. Creating the Cluster Resources

Preparing the cluster for use of cLVM includes the following basic steps:

Procedure 16.1. Creating a DLM Resource

[Note]DLM Resource for Both cLVM and OCFS2

Both cLVM and OCFS2 need a DLM resource that runs on all nodes in the cluster and therefore is usually configured as a clone. If you have a setup that includes both OCFS2 and cLVM, configuring one DLM resource for both OCFS2 and cLVM is enough.

  1. Start a shell and log in as root.

  2. Run crm configure.

  3. Check the current configuration of the cluster resources with show.

  4. If you have already configured a DLM resource (and a corresponding base group and base clone), continue with Procedure 16.2, “Creating LVM and cLVM Resources”.

    Otherwise, configure a DLM resource and a corresponding base group and base clone as described in Procedure 14.1, “Configuring DLM and O2CB Resources”.

  5. Leave the crm live configuration with exit.

Procedure 16.2. Creating LVM and cLVM Resources

  1. Start a shell and log in as root.

  2. Run crm configure.

  3. Configure a cLVM resource as follows:

    primitive clvm ocf:lvm2:clvmd \
          params daemon_timeout="30"
  4. Configure an LVM resource for the volume group as follows:

    primitive vg1 ocf:heartbeat:LVM \
          params volgrpname="cluster-vg" \
          op monitor interval="60" timeout="60"
  5. If you want the volume group to be activated exclusively on one node, configure the LVM resource as described below and omit Step 6:

    primitive vg1 ocf:heartbeat:LVM \
          params volgrpname="cluster-vg" exclusive="yes" \
          op monitor interval="60" timeout="60"

    In this case, cLVM will protect all logical volumes within the VG from being activated on multiple nodes, as an additional measure of protection for non-clustered applications.

  6. To ensure that the cLVM and LVM resources are activated cluster-wide, add both primitives to the base group you have created in Procedure 14.1, “Configuring DLM and O2CB Resources”:

    1. Enter

      edit base-group
    2. In the vi editor that opens, modify the group as follows and save your changes:

      group base-group dlm o2cb clvm vg1 ocfs2-1
      [Important]Setup Without OCFS2

      If your setup does not include OCFS2, omit the ocfs2-1 primitive from the base group. The oc2cb primitive can be configured and included in the group anyway, regardless of whether you use OCFS2 or not.

  7. Review your changes with show. To check if you have configured all needed resources, also refer to Appendix B, Example Configuration for OCFS2 and cLVM.

  8. If everything is correct, submit your changes with commit and leave the crm live configuration with exit.

16.2.3. Scenario: cLVM With iSCSI on SANs

The following scenario uses two SAN boxes which export their iSCSI targets to several clients. The general idea is displayed in Figure 16.1, “Setup of iSCSI with cLVM”.

Figure 16.1. Setup of iSCSI with cLVM

Setup of iSCSI with cLVM

[Warning]Data Loss

The following procedures will destroy any data on your disks!

Configure only one SAN box first. Each SAN box has to export its own iSCSI target. Proceed as follows:

Procedure 16.3. Configuring iSCSI Targets (SAN)

  1. Run YaST and click Network Services+iSCSI Target to start the iSCSI Server module.

  2. If you want to start the iSCSI target whenever your computer is booted, choose When Booting, otherwise choose Manually.

  3. If you have a firewall running, enable Open Port in Firewall.

  4. Switch to the Global tab. If you need authentication enable incoming or outgoing authentication or both. In this example, we select No Authentication.

  5. Add a new iSCSI target:

    1. Switch to the Targets tab.

    2. Click Add.

    3. Enter a target name. The name has to be formatted like this:

      iqn.DATE.DOMAIN

      For more information about the format, refer to , Section 3.2.6.3.1. Type "iqn." (iSCSI Qualified Name) .

    4. If you want a more descriptive name, you can change it as long as your identifier is unique for your different targets.

    5. Click Add.

    6. Enter the device name in Path and use a Scsiid.

    7. Click Next twice.

  6. Confirm the warning box with Yes.

  7. Open the configuration file /etc/iscsi/iscsi.conf and change the parameter node.startup to automatic.

Now set up your iSCSI initiators as follows:

Procedure 16.4. Configuring iSCSI Initiators

  1. Run YaST and click Network Services+iSCSI Initiator.

  2. If you want to start the iSCSI initiator whenever your computer is booted, choose When Booting, otherwise set Manually.

  3. Change to the Discovery tab and click the Discovery button.

  4. Add your IP address and your port of your iSCSI target (see Procedure 16.3, “Configuring iSCSI Targets (SAN)”). Normally, you can leave the port as it is and use the default value.

  5. If you use authentication, insert the incoming and outgoing username and password, otherwise activate No Authentication.

  6. Select Next. The found connections are displayed in the list.

  7. Proceed with Finish.

  8. Open a shell, log in as root.

  9. Test if the iSCSI initiator has been started successfully:

    iscsiadm -m discovery -t st -p 192.168.3.100
    192.168.3.100:3260,1 iqn.2010-03.de.jupiter:san1
  10. Establish a session:

    iscsiadm -m node -l
    Logging in to [iface: default, target: iqn.2010-03.de.jupiter:san2, portal: 192.168.3.100,3260]
    Logging in to [iface: default, target: iqn.2010-03.de.venus:san1, portal: 192.168.3.101,3260]
    Login to [iface: default, target: iqn.2010-03.de.jupiter:san2, portal: 192.168.3.100,3260]: successful
    Login to [iface: default, target: iqn.2010-03.de.venus:san1, portal: 192.168.3.101,3260]: successful

    See the device names with lsscsi:

    ...
    [4:0:0:2]    disk    IET      ...     0     /dev/sdd
    [5:0:0:1]    disk    IET      ...     0     /dev/sde

    Look for entries with IET in their third column. In this case, the devices are /dev/sdd and /dev/sde.

Procedure 16.5. Creating the LVM Volume Groups

  1. Open a root shell on one of the nodes you have run the iSCSI initiator from Procedure 16.4, “Configuring iSCSI Initiators”.

  2. Prepare the physical volume for LVM with the command pvcreate on the disks /dev/sdd and /dev/sde:

    pvcreate /dev/sdd
    pvcreate /dev/sde
  3. Create the cluster-aware volume group on both disks:

    vgcreate --clustered y clustervg /dev/sdd /dev/sde
  4. Create logical volumes as needed:

    lvcreate --name clusterlv --size 500M clustervg
  5. Check the physical volume with pvdisplay:

      --- Physical volume ---
          PV Name               /dev/sdd
          VG Name               clustervg
          PV Size               509,88 MB / not usable 1,88 MB
          Allocatable           yes
          PE Size (KByte)       4096
          Total PE              127
          Free PE               127
          Allocated PE          0
          PV UUID               52okH4-nv3z-2AUL-GhAN-8DAZ-GMtU-Xrn9Kh
          
          --- Physical volume ---
          PV Name               /dev/sde
          VG Name               clustervg
          PV Size               509,84 MB / not usable 1,84 MB
          Allocatable           yes
          PE Size (KByte)       4096
          Total PE              127
          Free PE               127
          Allocated PE          0
          PV UUID               Ouj3Xm-AI58-lxB1-mWm2-xn51-agM2-0UuHFC
  6. Check the volume group with vgdisplay:

      --- Volume group ---
          VG Name               clustervg
          System ID
          Format                lvm2
          Metadata Areas        2
          Metadata Sequence No  1
          VG Access             read/write
          VG Status             resizable
          Clustered             yes
          Shared                no
          MAX LV                0
          Cur LV                0
          Open LV               0
          Max PV                0
          Cur PV                2
          Act PV                2
          VG Size               1016,00 MB
          PE Size               4,00 MB
          Total PE              254
          Alloc PE / Size       0 / 0
          Free  PE / Size       254 / 1016,00 MB
          VG UUID               UCyWw8-2jqV-enuT-KH4d-NXQI-JhH3-J24anD

After you have created the volumes and started your resources you should have a new device named /dev/dm-0. It is recommended to use a clustered file system on top of your LVM resource, for example OCFS. For more information, see Chapter 14, OCFS2

16.2.4. Scenario: cLVM With DRBD

The following scenarios can be used if you have data centers located in different parts of your city, country, or continent.

Procedure 16.6. Creating a Cluster-Aware Volume Group With DRBD

  1. Create a primary/primary DRBD resource:

    1. First, set up a DRBD device as primary/secondary as described in Procedure 15.1, “Manually Configuring DRBD”. Make sure the disk state is up-to-date on both nodes. Check this with cat /proc/drbd or with rcdrbd status.

    2. Add the following options to your configuration file (usually something like /etc/drbd.d/r0.res):

      resource r0 {
        startup {
          become-primary-on both;
        }
      
        net {
           allow-two-primaries;
        }
        ...
      }
    3. Copy the changed configuration file to the other node, for example:

      scp /etc/drbd.d/r0.res venus:/etc/drbd.d/
    4. Run the following commands on both nodes:

      drbdadm disconnect r0
      drbdadm connect r0
      drbdadm primary r0
    5. Check the status of your nodes:

      cat /proc/drbd
      ...
       0: cs:Connected ro:Primary/Primary ds:UpToDate/UpToDate C r----
  2. Include the clvmd resource as a clone in the pacemaker configuration, and make it depend on the DLM clone resource. See Procedure 16.1, “Creating a DLM Resource” for detailed instructions. Before proceeding, confirm that these resources have started successfully on your cluster. You may use crm_mon or the GUI to check the running services.

  3. Prepare the physical volume for LVM with the command pvcreate. For example, on the device /dev/drbd_r0 the command would look like this:

    pvcreate /dev/drbd_r0
  4. Create a cluster-aware volume group:

    vgcreate --clustered y myclusterfs /dev/drbd_r0
  5. Create logical volumes as needed. You may probably want to change the size of the logical volume. For example, create a 4 GB logical volume with the following command:

    lvcreate --name testlv -L 4G myclusterfs
  6. The logical volumes within the VG are now available as file system mounts or raw usage. Ensure that services using them have proper dependencies to collocate them with and order them after the VG has been activated.

After finishing these configuration steps, the LVM2 configuration can be done just like on any standalone workstation.

16.3. Configuring Eligible LVM2 Devices Explicitly

When several devices seemingly share the same physical volume signature (as can be the case for multipath devices or DRBD), it is recommended to explicitly configure the devices which LVM2 scans for PVs.

For example, if the command vgcreate uses the physical device instead of using the mirrored block device, DRBD will be confused which may result in a split brain condition for DRBD.

To deactivate a single device for LVM2, do the following:

  1. Edit the file /etc/lvm/lvm.conf and search for the line starting with filter.

  2. The patterns there are handled as regular expressions. A leading a means to accept a device pattern to the scan, a leading r rejects the devices that follow the device pattern.

  3. To remove a device named /dev/sdb1, add the following expression to the filter rule:

    "r|^/dev/sdb1$|"

    The complete filter line will look like the following:

    filter = [ "r|^/dev/sdb1$|", "r|/dev/.*/by-path/.*|", "r|/dev/.*/by-id/.*|", "a/.*/" ]

    A filter line, that accepts DRBD and MPIO devices but rejects all other devices would look like this:

    filter = [ "a|/dev/drbd.*|", "a|/dev/.*/by-id/dm-uuid-mpath-.*|", "r/.*/" ]
  4. Write the configuration file and copy it to all cluster nodes.

16.4. For More Information

Thorough information is available from the pacemaker mailing list, available at http://www.clusterlabs.org/wiki/Help:Contents.

The official cLVM FAQ can be found at http://sources.redhat.com/cluster/wiki/FAQ/CLVM.

Chapter 17. Storage Protection

Abstract

The High Availability cluster stack's highest priority is protecting the integrity of data. This is achieved by preventing uncoordinated concurrent access to data storage: For example, ext3 file systems are only mounted once in the cluster, OCFS2 volumes will not be mounted unless coordination with other cluster nodes is available. In a well-functioning cluster Pacemaker will detect if resources are active beyond their concurrency limits and initiate recovery. Furthermore, its policy engine will never exceed these limitations.

However, network partitioning or software malfunction could potentially cause scenarios where several coordinators are elected. If this so-called split brain scenarios were allowed to unfold, data corruption might occur. Hence, several layers of protection have been added to the cluster stack to mitigate this.

The primary component contributing to this goal is IO fencing/STONITH since it ensures that all other access prior to storage activation is terminated. Other mechanisms are cLVM2 exclusive activation or OCFS2 file locking support to protect your system against administrative or application faults. Combined appropriately for your setup, these can reliably prevent split brain scenarios from causing harm.

This chapter describes an IO fencing mechanism that leverages the storage itself, followed by the description of an additional layer of protection to ensure exclusive storage access. These two mechanisms can be combined for higher levels of protection.

17.1. Storage-based Fencing

You can reliably avoid split brain scenarios by using one or more STONITH Block Devices (SBD), watchdog support and the external/sbd STONITH agent.

17.1.1. Overview

In an environment where all nodes have access to shared storage, a small partition (1MB) of the device is formatted for use with SBD. After the respective daemon is configured, it is brought online on each node before the rest of the cluster stack is started. It is terminated after all other cluster components have been shut down, thus ensuring that cluster resources are never activated without SBD supervision.

The daemon automatically allocates one of the message slots on the partition to itself, and constantly monitors it for messages addressed to itself. Upon receipt of a message, the daemon immediately complies with the request, such as initiating a power-off or reboot cycle for fencing.

The daemon constantly monitors connectivity to the storage device, and terminates itself in case the partition becomes unreachable. This guarantees that it is not disconnected from fencing messages. If the cluster data resides on the same logical unit in a different partition, this is not an additional point of failure: The work-load will terminate anyway if the storage connectivity has been lost.

Increased protection is offered through watchdog support. Modern systems support a hardware watchdog that has to be tickled or fed by a software component. The software component (usually a daemon) regularly writes a service pulse to the watchdog—if the daemon stops feeding the watchdog, the hardware will enforce a system restart. This protects against failures of the SBD process itself, such as dying, or becoming stuck on an IO error.

If Pacemaker integration is activated, SBD will not self-fence if device majority is lost. For example, your cluster contains 3 nodes: A, B, and C. Due to a network split, A can only see itself while B and C can still communicate. In this case, there are two cluster partitions, one with quorum due to being the majority (B, C), and one without (A). If this happens while the majority of fencing devices are unreachable, node A would immediately commit suicide, but the nodes B and C would continue to run.

17.1.2. Number of SBD Devices

SBD supports the use of 1-3 devices:

One Device

The most simple implementation. It is appropriate for clusters where all of your data is one the same shared storage.

Two Devices

This configuration is primarily useful for environments that use host-based mirroring but where no third storage device is available. SBD will not terminate itself if it loses access to one mirror leg, allowing the cluster to continue. However, since SBD does not have enough knowledge to detect an asymmetric split of the storage, it will not fence the other side while only one mirror leg is available. Thus, it cannot automatically tolerate a second failure while one of the storage arrays is down.

Three Devices

The most reliable configuration. It is resilient against outages of one device—be it due to failures or maintenance. SBD will only terminate itself if more than one device is lost. Fencing messages can be successfully be transmitted if at least two devices are still accessible.

This configuration is suitable for more complex scenarios where storage is not restricted to a single array. Host-based mirroring solutions can have one SBD per mirror leg (not mirrored itself), and an additional tie-breaker on iSCSI.

17.1.3. Setting Up Storage-based Protection

The following steps are necessary to set up storage-based protection:

All of the following procedures must be executed as root. Before you start, make sure the following requirements are met:

[Important]Requirements
  • The environment must have shared storage reachable by all nodes.

  • The shared storage segment must not make use of host-based RAID, cLVM2, nor DRBD*.

  • However, using storage-based RAID and multipathing is recommended for increased reliability.

17.1.3.1. Creating the SBD Partition

It is recommended to create a 1MB partition at the start of the device. If your SBD device resides on a multipath group, you need to adjust the timeouts SBD uses, as MPIO's path down detection can cause some latency. After the msgwait timeout, the message is assumed to have been delivered to the node. For multipath, this should be the time required for MPIO to detect a path failure and switch to the next path. You may have to test this in your environment. The node will terminate itself if the SBD daemon running on it has not updated the watchdog timer fast enough. The watchdog timeout must be shorter than the msgwait timeout—half the value is a good estimate.

[Note]Device Name for SBD Partition

In the following, this SBD partition is referred to by /dev/SBD . Replace it with your actual pathname, for example: /dev/sdc1.

[Important]Overwriting Existing Data

Make sure the device you want to use for SBD does not hold any data. The sbd command will overwrite the device without further requests for confirmation.

  1. Initialize the SBD device with the following command:

    sbd -d /dev/SBD create

    This will write a header to the device, and create slots for up to 255 nodes sharing this device with default timings.

    If you want to use more than one device for SBD, provide the devices by specifying the -d option multiple times, for example:

    sbd -d /dev/SBD1 -d /dev/SBD2 -d /dev/SBD3 create
  2. If your SBD device resides on a multipath group, adjust the timeouts SBD uses. This can be specified when the SBD device is initialized (all timeouts are given in seconds):

    /usr/sbin/sbd -d /dev/SBD -4 1801 -1 902 create

    1

    The -4 option is used to specify the msgwait timeout. In the example above, it is set to 180 seconds.

    2

    The -1 option is used to specify the watchdog timeout. In the example above, it is set to 90 seconds.

  3. With the following command, check what has been written to the device:

    sbd -d /dev/SBD dump 
    Header version     : 2
    Number of slots    : 255
    Sector size        : 512
    Timeout (watchdog) : 5
    Timeout (allocate) : 2
    Timeout (loop)     : 1
    Timeout (msgwait)  : 10

As you can see, the timeouts are also stored in the header, to ensure that all participating nodes agree on them.

17.1.3.2. Setting Up the Software Watchdog

In SUSE Linux Enterprise High Availability Extension, watchdog support in the Kernel is enabled by default: It ships with a number of different Kernel modules that provide hardware-specific watchdog drivers. The High Availability Extension uses the SBD daemon as software component that feeds the watchdog. If configured as described in Section 17.1.3.3, “Starting the SBD Daemon”, the SBD daemon will start automatically when the respective node is brought online with rcopenais start .

Usually, the appropriate watchdog driver for your hardware is automatically loaded during system boot. softdog is the most generic driver, but it is recommended to use a driver with actual hardware integration. For example:

  • On HP hardware, this is the hpwdt driver.

  • For systems with an Intel TCO, the iTCO_wdt driver can be used.

For a list of choices, refer to /usr/src/your_kernel_version/drivers/watchdog. Alternatively, list the drivers that have been installed with your Kernel version with the following command:

rpm -ql your_kernel_version | grep watchdog

As most watchdog driver names contain strings like wd, wdt, or dog, use one of the following commands to check which driver is currently loaded:

lsmod | grep wd 

or

lsmod | grep dog 

17.1.3.3. Starting the SBD Daemon

The SBD daemon is a critical piece of the cluster stack. It has to be running when the cluster stack is running, or even when part of it has crashed, so that it can be fenced.

  1. Stop OpenAIS:

    rcopenais stop
  2. To make the OpenAIS init script start and stop SBD, create the file /etc/sysconfig/sbd and add the following lines:

    SBD_DEVICE="/dev/SBD"
    # The next line enables the watchdog support:
    SBD_OPTS="-W"

    If you need to specify multiple devices in the first line, separate them by a semicolon (the order of the devices does not matter):

    SBD_DEVICE="/dev/SBD1; /dev/SBD2; /dev/SBD3"
    # The next line enables the watchdog support:
    SBD_OPTS="-W"

    If the SBD device is not accessible, the daemon will fail to start and inhibit OpenAIS startup.

    [Note]

    If the SBD device becomes inaccessible from a node, this could cause the node to enter an infinite reboot cycle. This is technically correct behavior, but depending on your administrative policies, most likely a nuisance. In such cases, better do not automatically start up OpenAIS on boot.

  3. Copy /etc/sysconfig/sbd to all nodes (either manually or with Csync2, see also Section 3.5.4, “Transferring the Configuration to All Nodes”).

  4. Before proceeding, ensure that SBD has started on all nodes by executing rcopenais restart .

17.1.3.4. Testing SBD

  1. The following command will dump the node slots and their current messages from the SBD device:

    sbd -d /dev/SBD list

    Now you should see all cluster nodes that have ever been started with SBD listed here, the message slot should show clear.

  2. Try sending a test message to one of the nodes:

    sbd -d /dev/SBD message nodea test
  3. The node will acknowledge the receipt of the message in the system logs:

    Aug 29 14:10:00 nodea sbd: [13412]: info: Received command test from nodeb

    This confirms that SBD is indeed up and running on the node and that it is ready to receive messages.

17.1.3.5. Configuring the Fencing Resource

  1. To complete the SBD setup, activate SBD as a STONITH/fencing mechanism in the CIB as follows:

    crm configure
    crm(live)configure# property stonith-enabled="true"
    crm(live)configure# property stonith-timeout="30s"
    crm(live)configure# primitive stonith_sbd stonith:external/sbd 
    crm(live)configure# commit
    crm(live)configure# quit

    The resource does not need to be cloned, as it would shut down the respective node anyway if there was a problem.

    Which value to set for stonith-timeout depends on the msgwait timeout. Provided you kept the default msgwait timeout value (10 seconds), setting stonith-timeout to 30 seconds is appropriate.

    Since node slots are allocated automatically, no manual host list needs to be defined.

  2. Disable any other fencing devices you might have configured before, since the SBD mechanism is used for this function now.

Once the resource has started, your cluster is successfully configured for shared-storage fencing and will utilize this method in case a node needs to be fenced.

17.1.3.6. For More Information

http://www.linux-ha.org/wiki/SBD_Fencing

17.2. Ensuring Exclusive Storage Activation

This section introduces sfex, an additional low-level mechanism to lock access to shared storage exclusively to one node. Note that sfex does not replace STONITH. Since sfex requires shared storage, it is recommended that the external/sbd fencing mechanism described above is used on another partition of the storage.

By design, sfex cannot be used in conjunction with workloads that require concurrency (such as OCFS2), but serves as a layer of protection for classic fail-over style workloads. This is similar to a SCSI-2 reservation in effect, but more general.

17.2.1. Overview

In a shared storage environment, a small partition of the storage is set aside for storing one or more locks.

Before acquiring protected resources, the node must first acquire the protecting lock. The ordering is enforced by Pacemaker, and the sfex component ensures that even if Pacemaker were subject to a split brain situation, the lock will never be granted more than once.

These locks must also be refreshed periodically, so that a node's death does not permanently block the lock and other nodes can proceed.

17.2.2. Setup

In the following, learn how to create a shared partition for use with sfex and how to configure a resource for the sfex lock in the CIB. A single sfex partition can hold any number of locks, it defaults to one, and needs 1 KB of storage space allocated per lock.

[Important]Requirements
  • The shared partition for sfex should be on the same logical unit as the data you wish to protect.

  • The shared sfex partition must not make use of host-based RAID, nor DRBD.

  • Using a cLVM2 logical volume is possible.

Procedure 17.1. Creating an sfex Partition

  1. Create a shared partition for use with sfex. Note the name of this partition and use it as a substitute for /dev/sfex below.

  2. Create the sfex meta data with the following command:

    sfex_init -n 1 /dev/sfex
  3. Verify that the meta data has been created correctly:

    sfex_stats -i 1 /dev/sfex ; echo $?

    This should return 2, since the lock is not currently held.

Procedure 17.2. Configuring a Resource for the sfex Lock

  1. The sfex lock is represented via a resource in the CIB, configured as follows:

    primitive sfex_1 ocf:heartbeat:sfex \
    #	params device="/dev/sfex" index="1" collision_timeout="1" \
          lock_timeout="70" monitor_interval="10" \
    #	op monitor interval="10s" timeout="30s" on_fail="fence"
  2. To protect resources via a sfex lock, create mandatory ordering and placement constraints between the protectees and the sfex resource. If the resource to be protected has the id filesystem1:

    # order order-sfex-1 inf: sfex_1 filesystem1
    # colocation colo-sfex-1 inf: filesystem1 sfex_1
  3. If using group syntax, add the sfex resource as the first resource to the group:

    # group LAMP sfex_1 filesystem1 apache ipaddr

17.3. For More Information

See http://www.linux-ha.org/wiki/SBD_Fencing and man sbd.

Chapter 18. Samba Clustering

Abstract

A clustered Samba server provides a High Availability solution in your heterogeneous networks. This chapter explains some background information and how to set up a clustered Samba server.

18.1. Conceptual Overview

Trivial Database (TDB) has been used by Samba for many years. It allows multiple applications to write simultaneously. To make sure all write operations are successfully performed and do not collide with each other, TDB uses an internal locking mechanism.

Cluster Trivial Database (CTDB) is a small extension of the existing TDB. CTDB is described by the project as a cluster implementation of the TDB database used by Samba and other projects to store temporary data.

Each cluster node runs a local CTDB daemon. Samba communicates with its local CTDB daemon instead of writing directly to its TDB. The daemons exchange metadata over the network, but actual write and read operations are done on a local copy with fast storage. The concept of CTDB is displayed in Figure 18.1, “Structure of a CTDB Cluster”.

[Note]CTDB For Samba Only

The current implementation of the CTDB Resource Agent configures CTDB to only manage Samba. Everything else, including IP failover, should be configured with Pacemaker.

CTDB is only supported for completely homogeneous clusters. For example, all nodes in the cluster need to have the same architecture. You cannot mix i586 with x86_64.

Figure 18.1. Structure of a CTDB Cluster

Structure of a CTDB Cluster

A clustered Samba server must share certain data:

  • Mapping table that associates Unix user and group IDs to Windows users and groups.

  • The user database must be synchronized between all nodes.

  • Join information for a member server in a Windows domain must be available on all nodes.

  • Metadata has to be available on all nodes, like active SMB sessions, share connections, and various locks.

The goal is that a clustered Samba server with N+1 nodes is faster than with only N nodes. One node is not slower than an unclustered Samba server.

18.2. Basic Configuration

[Note]Changed Configuration Files

The CTDB Resource Agent automatically changes /etc/sysconfig/ctdb and /etc/samba/smb.conf. Use crm ra info CTDB to list all parameters that can be specified for the CTDB resource.

To set up a clustered Samba server, proceed as follows:

Procedure 18.1. Setting Up a Basic Clustered Samba Server

  1. Prepare your cluster:

    1. Configure your cluster (OpenAIS, Pacemaker, OCFS2) as described in this guide in Part II, “Configuration and Administration”.

    2. Configure a shared file system, like OCFS2, and mount it, for example, on /shared.

    3. If you want to turn on POSIX ACLs, enable it:

      • For a new OCFS2 file system use:

        mkfs.ocfs2 --fs-features=xattr ...
      • For an existing OCFS2 file system use:

        tunefs.ocfs2 --fs-feature=xattrDEVICE

        Make sure the acl option is specified in the file system resource. Use the crm shell as follows:

        crm(live)configure# primary ocfs2-3 ocf:heartbeat:Filesystem options="acl" ...
    4. Make sure the services ctdb, smb, nmb, and winbind are disabled:

      chkconfig ctdb off
      chkconfig smb off
      chkconfig nmb off
      chkconfig winbind off
  2. Create a directory for the CTDB lock on the shared file system:

    mkdir -p /shared/samba/
  3. In /etc/ctdb/nodes insert all nodes which contain all private IP addresses of each node in the cluster:

    192.168.1.10
    192.168.1.11
  4. Copy the configuration file to all of your nodes by using csync2:

    csync2 -xv

    For more information, see Procedure 3.9, “Synchronizing the Configuration Files with Csync2”.

  5. Add a CTDB resource to the cluster:

    crm configure
    crm(live)configure# primitive ctdb ocf:heartbeat:CTDB params \
        ctdb_manages_winbind="false" \ 
        ctdb_manages_samba="true" \
        ctdb_recovery_lock="/shared/samba/ctdb.lock" \
          op monitor interval="10" timeout="20" \
          op start interval="0" timeout="90" \
          op stop interval="0" timeout="100"
    crm(live)configure# clone ctdb-clone ctdb \
        meta globally-unique="false" interleave="true"
    crm(live)configure# colocation ctdb-with-fs inf: ctdb-clone fs-clone
    crm(live)configure# order start-ctdb-after-fs inf: fs-clone ctdb-clone
    crm(live)configure# commit
  6. Add a clustered IP address:

    crm(live)configure# primitive ip ocf:heartbeat:IPaddr2 params ip=192.168.2.222 \
      clusterip_hash="sourceip-sourceport" op monitor interval=60s
    crm(live)configure# clone ip-clone ip meta globally-unique="true"
    crm(live)configure# colocation ip-with-ctdb inf: ip-clone ctdb-clone
    crm(live)configure# order start-ip-after-ctdb inf: ctdb-clone ip-clone
    crm(live)configure# commit
  7. Check the result:

    crm status
    Clone Set: dlm-clone
         Started: [ hex-14 hex-13 ]
     Clone Set: o2cb-clone
         Started: [ hex-14 hex-13 ]
     Clone Set: c-ocfs2-3
         Started: [ hex-14 hex-13 ]
     Clone Set: ctdb-clone
         Started: [ hex-14 hex-13 ]
     Clone Set: ip-clone (unique)
         ip:0       (ocf::heartbeat:IPaddr2):       Started hex-13
         ip:1       (ocf::heartbeat:IPaddr2):       Started hex-14
  8. Test from a client machine. On a Linux client, run the following command to see if you can copy files from and to the system:

    smbclient //192.168.2.222/myshare

18.3. Joining an Active Directory Domain

Active Directory (AD) is a directory service for Windows server systems.

The following instructions outline how to join a CTDB cluster to an Active Directory domain:

  1. Consult your Windows Server documentation for instructions on how to set up an Active Directory domain. In this example, we use the following parameters:

    AD and DNS server

    win2k3.2k3test.example.com

    AD domain

    2k3test.example.com

    Cluster AD member NetBIOS name

    CTDB-SERVER
  2. Procedure 18.2, “Configuring CTDB”

  3. Procedure 18.3, “Joining Active Directory”

The next step is to configure the CTDB:

Procedure 18.2. Configuring CTDB

  1. Make sure you have configured your cluster as shown in Section 18.2, “Basic Configuration”.

  2. Stop the CTDB resource on one node:

    # crm resource stop ctdb-clone
  3. Open the /etc/samba/smb.conf configuration file, add your NetBIOS name, and close the file:

    [global
        netbios name = CTDB-SERVER

    Other settings such as security, workgroup etc. are added by the YaST wizard.

  4. Update on all nodes the file /etc/samba.conf:

    csync2 -xv
  5. Restart the CTDB resource:

    # crm resource start ctdb-clone

Finally, join your cluster to the Active Directory server:

Procedure 18.3. Joining Active Directory

  1. Make sure the following files are included in Csync2's configuration to become installed on all cluster hosts:

    /etc/samba/smb.conf
    /etc/security/pam_winbind.conf
    /etc/krb5.conf
    /etc/nsswitch.conf
    /etc/security/pam_mount.conf.xml
    /etc/pam.d/common-session

    You can also use YaST's Configure Csync2 module for this task, see Section 3.5.4, “Transferring the Configuration to All Nodes”.

  2. Create a CTDB resource as described in Procedure 18.1, “Setting Up a Basic Clustered Samba Server”.

  3. Run YaST and open the Windows Domain Membership module from the Network Services entry.

  4. Enter your domain or workgroup settings and finish with Ok.

18.4. Debugging and Testing Clustered Samba

To debug your clustered Samba server, the following tools which operate on different levels are available:

ctdb_diagnostics

Run this tool to diagnose your clustered Samba server. Detailed debug messages should help you track down any problems you might have.

The ctdb_diagnostics command searches for the following files which must be available on all nodes:

/etc/krb5.conf
/etc/hosts
/etc/ctdb/nodes
/etc/sysconfig/ctdb
/etc/resolv.conf
/etc/nsswitch.conf
/etc/sysctl.conf
/etc/samba/smb.conf
/etc/fstab
/etc/multipath.conf
/etc/pam.d/system-auth
/etc/sysconfig/nfs
/etc/exports
/etc/vsftpd/vsftpd.conf

If the files /etc/ctdb/public_addresses and /etc/ctdb/static-routes exist, they will be checked as well.

ping_pong

Check whether your file system is suitable for CTDB with ping_pong. It performs certain tests of your cluster file system like coherence and performance (see http://wiki.samba.org/index.php/Ping_pong) and gives some indication how your cluster may behave under high load.

send_arp Tool and SendArp Resource Agent

The SendArp resource agent is located in /usr/lib/heartbeat/send_arp (or /usr/lib64/heartbeat/send_arp). The send_arp tool sends out a gratuitous ARP (Address Resolution Protocol) packet and can be used for updating other machines' ARP tables. It can help to identify communication problems after a failover process. If you cannot connect to a node or ping it although it shows the clustered IP address for samba, use the send_arp command to test if the nodes only need an ARP table update.

For more information, refer to http://wiki.wireshark.org/Gratuitous_ARP.

To test certain aspects of your cluster file system proceed as follows:

Procedure 18.4. Test Coherence and Performance of Your Cluster File System

  1. Start the command ping_pong on one node and replace the placeholder N with the amount of nodes plus one. The file ABSPATH/data.txt is available in your shared storage and is therefore accessible on all nodes (ABSPATH indicates an absolute path):

    ping_pong ABSPATH/data.txt N

    Expect a very high locking rate as you are running only one node. If the program does not print a locking rate, replace your cluster file system.

  2. Start a second copy of ping_pong on another node with the same parameters.

    Expect to see a dramatic drop in the locking rate. If any of the following applies to your cluster file system, replace it:

    • ping_pong does not print a locking rate per second,

    • the locking rates in the two instances are not almost equal,

    • the locking rate did not drop after you started the second instance.

  3. Start a third copy of ping_pong. Add another node and note how the locking rates change.

  4. Kill the ping_pong commands one after the other. You should observe an increase of the locking rate until you get back to the single node case. If you did not get the expected behavior, find more information in Chapter 14, OCFS2.

Chapter 19. Disaster Recovery with ReaR

Abstract

ReaR (Relax and Recover) is an administrator tool-set for creating disaster recovery images. The disaster recovery information can either be stored via the network or locally on hard disks, USB devices, DVD/CD-R, tape or similar. The backup data is stored on a network file system (NFS).

Keep in mind, ReaR needs to be configured and tested before any disaster happens. ReaR will not save you, if a disaster has already taken place.

[Warning]Extensive Testing Required

It is essential, whenever you create a rescue CD, to always test the disaster recovery with an identical test machine. Only if this procedure works satisfactorily, your disaster recovery system is correctly and reliably set up.

[Warning]No Version Upgrade for the ReaR Package

SUSE does not deliver any updates for the ReaR package. It cannot be guaranteed that an existing ReaR disaster recovery setup will still work after the upgrade.

If you do a ReaR version upgrade on your own, carefully revalidate that your particular ReaR disaster recovery procedure still works.

19.1. Conceptual Overview

SUSE Linux Enterprise Server ships a disaster recovery system in two packages:

  • rear

  • rear-SUSE

The package rear-SUSE is another method of a disaster recovery which incorporates AutoYaST to recreate your basic system. You should try and test both methods for your systems. Every IT infrastructure is different, in one case rear is enough, in other situations rear-SUSE is a better fit. Regardless of the method, both are used in the following way:

  1. Preparation.  Make a bootable CD and backup system and user data.

  2. Testing.  Test the recovery process thoroughly and the backup on the same hardware as your main system before any disaster happens.

  3. Recovery.  Boot from the rescue CD and restore your system from your backup.

To prepare the rescue media, the following steps are performed by ReaR:

Preparation of Rescue Media by ReaR

  1. Gather system information.

  2. Store disk layout (partitioning, filesystems, LVM, RAID, and boot loader).

  3. Clone the system (Kernel drivers and modules, device driver configuration, network configuration, system software and tools).

  4. Backup system and user data.

  5. Create bootable rescue CD with system configuration.

When a disaster occurrs, the recovery process consists of these actions:

Recovery Process

  1. Boot from the rescue media.

  2. Restore the disk layout (partitions, RAID configurations, LVM, file systems).

  3. Restore system and user data.

  4. Restore boot loader.

  5. Reboot system.

19.2. Preparing for the Worst Scenarios: Disaster Recovery Plans

Before the worst scenario happens, take actions to prepare with a disaster recovery plan. A disaster recovery plan is a document where all risks, infrastructure, and the budget is being collected. Maybe you have already some plan in place, but here is the general overview:

  • Risk Analysis.  Conduct a solid risk analysis of your infrastructure. List all the possible threats and evaluate how serious they are. Determine how likely these threats are and prioritize them. It is recommended to use a simple categorization: probability and impact.

  • Budget Planing.  The outcome of the analysis is an overview, which risks can be tolerated and which are critical for your business. Ask yourself, how can you minimize risks and how much will it cost. Depending on how big your company is, spend two to fifteen percent of the overall IT budget on disaster recovery.

  • Disaster Recovery Plan Development.  Make checklists, test procedures, establish and assign priorities, and inventory your IT infrastructure. Define how to deal with a problem when some services in your infrastructure fail.

  • Test.  After defining an elaborate plan, test it. Test it at least once a year. Use the same testing hardware as your main IT infrastructure.

19.3. Setting Up ReaR

ReaR supports some backup tools (Tivoli Storage Manager, QNetix Galaxy, Symantec NetBackup, HP DataProtector) and can output its rescue medium to a CD or PXE environment. The restore step is possible through NFS or CIFS and other network file systems. Find more information in the man page of ReaR (man rear).

To use ReaR you need at least two identical systems: the main machine where your productive environment is stored and the test machine. Identical in this context means, for example, you can replace a network card with another one using the same Kernel driver. If a hardware component does not use the same driver, it is not considered identical by ReaR.

ReaR can be used in different scenarios. The following example uses a NFS server as backup storage:

Procedure 19.1. Storing Your Backup on a NFS Server

  1. Set up a NFS server with YaST as described in Sharing File Systems with NFS from http://www.suse.com/doc/sles11/book_sle_admin/data/cha_nfs.html.

  2. Adapt the configuration file(s). Depending on how many servers you want to recover, use /etc/rear/site.conf for site-wide settings and /etc/rear/local.conf for machine-local settings. The following example uses a /etc/rear/local.conf configuration file. Replace the NETFS_URL with your own values. Further options are listed in the Various Settings section of the documentation at http://rear.github.com/documentation/.

    # Create ReaR rescue media as ISO image:
    OUTPUT=ISO
    # Store the backup file via NFS:
    BACKUP=NETFS
    # Only a NETFS_URL of the form 'nfs://host/path' is supported
    # so that 'mount -o nolock -t nfs host:/path' works.
    NETFS_URL=nfs://192.168.1.1/nfs/rear/
    # Keep an older copy of the backup in a HOSTNAME.old directory
    # provided there is no '.lockfile' in the HOSTNAME directory:
    NETFS_KEEP_OLD_BACKUP_COPY=yes

    If your NFS host is not an IP address but a hostname, DNS must work when the backup is restored.

  3. Prepare the backup by running:

    rear mkbackup

To perform a disaster recovery on your test machine, proceed as follows:

Procedure 19.2. Perform Disaster Recovery on Test Machine

  1. Locate the recovery ISO image stored as /tmp/rear-HOSTNAME.iso and burn it on CD.

  2. Boot your test machine with the recovery CD.

  3. Enter rear at the boot prompt.

  4. Log in as root (no password needed).

  5. Enter rear recover to start the recovery process. The recovery process installs and configures the machine and retrieves the backup data from your NFS server.

After this procedure, make sure the test machine is correctly set up and can serve as a replacement for your main machine. Test this procedure on a regular basis to ensure everything works as expected. Keep copies of the rescue CD iso, in case the media is damaged.

19.4. Using the YaST ReaR Module

The YaST ReaR module can be used to start with a basic setup. ReaR saves the recovery image and data on an NFS backend or a USB stick. However, the YaST ReaR module does not support recovery from a disaster. This requires some expertise and has to be done manually by the administrator.

To start with a basic setup, proceed as follows:

  1. Decide how to start your recovery system. Choose USB if you want to boot from a USB stick or ISO for CD-ROM respectively.

  2. Decide where the backup should be stored. Either select NFS or USB:

    • Select NFS if you have to use a server that offers Network File System. Specify the location as nfs://hostname/directory.

    • Select USB if you want to store your data on a USB stick. If no USB devices are shown, attach a USB stick or a USB disk and click Rescan USB Devices.

  3. If you want a previous backup copy to be saved, check Keep old backup.

  4. If you want to add additional directories that should also be included in your backup, use the Advanced menu and select Additional Directories in Backup.

  5. In case your rescue system does not boot due to missing Kernel modules, use the Advanced menu, select Additional Kernel Modules in Rescue System, and add the respective Kernel modules into the list of added modules for your rescue system.

  6. Click the Save and run rear now button to start the backup process.

After the YaST ReaR module is finished with the backup, test your backup to make sure it works as expected.

19.5. Setting Up rear-SUSE with AutoYaST

With the package rear-SUSE, the recovery process uses AutoYaST together with a ReaR backup, which is stored on a NFS server. Before you use it, check your disk space, you need at least 5 GB and up to 15 GB. The size is the sum of the following:

  • The SUSE installation medium (size of 5 GB DVD)

  • A working directory copied from the SUSE installation medium. The working copy is used by rear-SUSE for preparing the recovery ISO image.

  • Recovery ISO image. From 500 MB up to 5 GB.

Depending on your situation, you can limit the overall size. Refer to the rear-SUSE documentation for details in /usr/share/doc/packages/rear-SUSE/README.

[Note]Support of File Systems

AutoYaST can only recover file systems which are supported by YaST. Some file systems, like OCFS2, are currently not supported.

The following procedure creates a full recovery ISO image. This means, it downloads the SUSE installation medium, creates a full backup, and generates the recovery ISO image. Proceed as follows:

Procedure 19.3. Creating a Full Recovery Image

  1. Get the IP or hostname of your NFS server where your ReaR backup will be stored. If you do not have one, set up as described in Sharing File Systems with NFS .

  2. Proceed with the backup as described in Procedure 19.1, “Storing Your Backup on a NFS Server”, but use the command rear mkbackuponly to prepare the backup. You do not need to burn the CD.

  3. Start the backup, and replace BASE_DIR with your working directory (for example, /var/tmp/rear-SUSE/), and MEDIUM_URI (for example, http://server/path/medium.iso):

    RecoveryImage -c configure-all -d BASE_DIR \
      -l log-to-base-dir \
      -b make-rear-backup \
      -a clone-system \
      -i install-RPMs \
      -r restore-all \
      -m MEDIUM_URI

    This will start the backup process and store your data on your NFS server. After the backup process, the recovery ISO image is created.

  4. Burn the recovery ISO image on a DVD. Find the image in your BASE_DIR path with the name RecoverImage.DATE.iso.

After the DVD has been burnt, test your disaster recovery with another server using the same hardware. For example, identical hardware is a hard disk with the same disk geometry, or a network card which uses the same Kernel driver.

Procedure 19.4. Recovering with the Recovery Image

  1. Boot your test machine with the recovery image from Procedure 19.3, “Creating a Full Recovery Image” of Step 4.

  2. Enter autorecover at the boot prompt. The recovery image boots and starts the AutoYaST installation process.

  3. Follow the instructions on the screen. Any error messages regarding the packages rear or rear-SUSE can be ignored.

After the recovery, make sure the test machine functions properly and all data has been restored correctly from your NFS backup.

19.6. For More Information

Part IV. Troubleshooting and Reference

Contents

20. Troubleshooting
20.1. Installation and First Steps
20.2. Logging
20.3. Resources
20.4. STONITH and Fencing
20.5. Miscellaneous
20.6. Fore More Information
21. HA OCF Agents
ocf:anything — Manages an arbitrary service
ocf:AoEtarget — Manages ATA-over-Ethernet (AoE) target exports
ocf:apache — Manages an Apache web server instance
ocf:asterisk — Manages an Asterisk PBX
ocf:AudibleAlarm — Emits audible beeps at a configurable interval
ocf:ClusterMon — Runs crm_mon in the background, recording the cluster status to an HTML file
ocf:conntrackd — This resource agent manages conntrackd
ocf:CTDB — CTDB Resource Agent
ocf:db2 — Resource Agent that manages an IBM DB2 LUW databases in Standard role as primitive or in HADR roles as master/slave configuration. Multiple partitions are supported.
ocf:Delay — Waits for a defined timespan
ocf:dhcpd — Chrooted ISC DHCP Server resource agent.
ocf:drbd — Manages a DRBD resource (deprecated)
ocf:Dummy — Example stateless resource agent
ocf:eDir88 — Manages a Novell eDirectory directory server
ocf:ethmonitor — Monitors network interfaces
ocf:Evmsd — Controls clustered EVMS volume management (deprecated)
ocf:EvmsSCC — Manages EVMS Shared Cluster Containers (SCCs) (deprecated)
ocf:exportfs — Manages NFS exports
ocf:Filesystem — Manages filesystem mounts
ocf:fio — fio IO load generator
ocf:ICP — Manages an ICP Vortex clustered host drive
ocf:ids — Manages an Informix Dynamic Server (IDS) instance
ocf:IPaddr2 — Manages virtual IPv4 addresses (Linux specific version)
ocf:IPaddr — Manages virtual IPv4 addresses (portable version)
ocf:IPsrcaddr — Manages the preferred source address for outgoing IP packets
ocf:IPv6addr — Manages IPv6 aliases
ocf:iSCSILogicalUnit — Manages iSCSI Logical Units (LUs)
ocf:iSCSITarget — iSCSI target export agent
ocf:iscsi — Manages a local iSCSI initiator and its connections to iSCSI targets
ocf:jboss — Manages a JBoss application server instance
ocf:ldirectord — Wrapper OCF Resource Agent for ldirectord
ocf:LinuxSCSI — Enables and disables SCSI devices through the kernel SCSI hot-plug subsystem (deprecated)
ocf:LVM — Controls the availability of an LVM Volume Group
ocf:lxc — Manages LXC containers
ocf:MailTo — Notifies recipients by email in the event of resource takeover
ocf:ManageRAID — Manages RAID devices
ocf:ManageVE — Manages an OpenVZ Virtual Environment (VE)
ocf:mysql-proxy — Manages a MySQL Proxy instance
ocf:mysql — Manages a MySQL database instance
ocf:named — Manages a named server
ocf:nfsserver — Manages an NFS server
ocf:nginx — Manages an Nginx web/proxy server instance
ocf:oracle — Manages an Oracle Database instance
ocf:oralsnr — Manages an Oracle TNS listener
ocf:pgsql — Manages a PostgreSQL database instance
ocf:pingd — Monitors connectivity to specific hosts or IP addresses ("ping nodes") (deprecated)
ocf:portblock — Block and unblocks access to TCP and UDP ports
ocf:postfix — Manages a highly available Postfix mail server instance
ocf:pound — Manage a Pound instance
ocf:proftpd — OCF Resource Agent compliant FTP script.
ocf:Pure-FTPd — Manages a Pure-FTPd FTP server instance
ocf:Raid1 — Manages Linux software RAID (MD) devices on shared storage
ocf:Route — Manages network routes
ocf:rsyncd — Manages an rsync daemon
ocf:rsyslog — rsyslog resource agent
ocf:scsi2reservation — scsi-2 reservation
ocf:SendArp — Broadcasts unsolicited ARP announcements
ocf:ServeRAID — Enables and disables shared ServeRAID merge groups
ocf:sfex — Manages exclusive access to shared storage using Shared Disk File EXclusiveness (SF-EX)
ocf:slapd — Manages a Stand-alone LDAP Daemon (slapd) instance
ocf:SphinxSearchDaemon — Manages the Sphinx search daemon.
ocf:Squid — Manages a Squid proxy server instance
ocf:Stateful — Example stateful resource agent
ocf:symlink — Manages a symbolic link
ocf:SysInfo — Records various node attributes in the CIB
ocf:syslog-ng — Syslog-ng resource agent
ocf:tomcat — Manages a Tomcat servlet environment instance
ocf:varnish — Manage a Varnish instance
ocf:VIPArip — Manages a virtual IP address through RIP2
ocf:VirtualDomain — Manages virtual domains through the libvirt virtualization framework
ocf:vmware — Manages VMWare Server 2.0 virtual machines
ocf:WAS6 — Manages a WebSphere Application Server 6 instance
ocf:WAS — Manages a WebSphere Application Server instance
ocf:WinPopup — Sends an SMB notification message to selected hosts
ocf:Xen — Manages Xen unprivileged domains (DomUs)
ocf:Xinetd — Manages a service of Xinetd
ocf:zabbixserver — Zabbix server resource agent

Chapter 20. Troubleshooting

Abstract

Strange problems may occur that are not easy to understand, especially when starting to experiment with High Availability. However, there are several utilities that allow you to take a closer look at the High Availability internal processes. This chapter recommends various solutions.

20.1. Installation and First Steps

Troubleshooting difficulties when installing the packages or bringing the cluster online.

Are the HA packages installed?

The packages needed for configuring and managing a cluster are included in the High Availability installation pattern, available with the High Availability Extension.

Check if High Availability Extension is installed as an add-on to SUSE Linux Enterprise Server 11 SP3 on each of the cluster nodes and if the High Availability pattern is installed on each of the machines as described in Section 3.3, “Installation as Add-on”.

Is the initial configuration the same for all cluster nodes?

To communicate with each other, all nodes belonging to the same cluster need to use the same bindnetaddr, mcastaddr and mcastport as described in Section 3.5, “Manual Cluster Setup (YaST)”.

Check if the communication channels and options configured in /etc/corosync/corosync.conf are the same for all cluster nodes.

In case you use encrypted communication, check if the /etc/corosync/authkey file is available on all cluster nodes.

All corosync.conf settings with the exception of nodeid must be the same; authkey files on all nodes must be identical.

Does the Firewall allow communication via the mcastport?

If the mcastport used for communication between the cluster nodes is blocked by the firewall, the nodes cannot see each other. When configuring the initial setup with YaST as described in , the firewall settings are usually automatically adjusted.

To make sure the mcastport is not blocked by the firewall, check the settings in /etc/sysconfig/SuSEfirewall2 on each node. Alternatively, start the YaST firewall module on each cluster node. After clicking Allowed Service+Advanced, add the mcastport to the list of allowed UDP Ports and confirm your changes.

Is OpenAIS started on each cluster node?

Check the OpenAIS status on each cluster node with /etc/init.d/openais status. In case OpenAIS is not running, start it by executing /etc/init.d/openais start.

20.2. Logging

I enabled monitoring but there is no trace of monitoring operations in the logs?

The lrmd daemon does not log recurring monitor operations unless an error occurred. Logging all recurring operations would produce too much noise. Therefore recurring monitor operations are logged only once an hour.

I only get a failed message. Is it possible to get more information?

Add the --verbose parameter to your commands. If you do that multiple times, the debug output becomes quite verbose. See /var/log/messages for useful hints.

How can I get an overview of all my nodes and resources?

Use the crm_mon command. The following displays the resource operation history (option -o) and inactive resources (-r):

crm_mon -o -r

The display is refreshed when the status changes (to cancel this press Ctrl+C.) An example may look like:

Example 20.1. Stopped Resources

Refresh in 10s...

============
Last updated: Mon Jan 19 08:56:14 2009
Current DC: d42 (d42)
3 Nodes configured.
3 Resources configured.
============

Online: [ d230 d42 ]
OFFLINE: [ clusternode-1 ]

Full list of resources:

Clone Set: o2cb-clone
         Stopped: [  o2cb:0 o2cb:1o2cb:2 ]
Clone Set: dlm-clone
         Stopped [ dlm:0 dlm:1 dlm:2 ]
mySecondIP      (ocf::heartbeat:IPaddr):        Stopped

Operations:
* Node d230:
   aa: migration-threshold=1000000
    + (5) probe: rc=0 (ok)
    + (37) stop: rc=0 (ok)
    + (38) start: rc=0 (ok)
    + (39) monitor: interval=15000ms rc=0 (ok)
* Node d42:
   aa: migration-threshold=1000000
    + (3) probe: rc=0 (ok)
    + (12) stop: rc=0 (ok)

First get your node online, then check your resources and operations.

The Configuration Explained PDF covers three different recovery types in the How Does the Cluster Interpret the OCF Return Codes? section. It is available at http://www.clusterlabs.org/doc/ .

20.3. Resources

How can I clean up my resources?

Use the following commands :

crm resource list
crm resource cleanup rscid [node]

If you leave out the node, the resource is cleaned on all nodes. More information can be found in Section 7.4.2, “Cleaning Up Resources”.

How can I list my currently known resources?

Use the command crm resource list to display your current resources.

I configured a resource, but it always fails. Why?

To check an OCF script use ocf-tester, for instance:

ocf-tester -n ip1 -o ip=YOUR_IP_ADDRESS \
  /usr/lib/ocf/resource.d/heartbeat/IPaddr

Use -o multiple times for more parameters. The list of required and optional parameters can be obtained by running crm ra info AGENT, for example:

crm ra info ocf:heartbeat:IPaddr

Before running ocf-tester, make sure the resource is not managed by the cluster.

Why do resources not fail over and why are there no errors?

If your cluster is a two node cluster, killing one node will leave the remaining node without quorum. Unless you set the no-quorum-policy property to ignore, nothing happens. For two-node clusters you need:

property no-quorum-policy="ignore"

Another possibility is that the killed node is considered unclean. Then it is necessary to fence it. If the stonith resource is not operational or does not exist, the remaining node will waiting for the fencing to happen. The fencing timeouts are typically high, so it may take quite a while to see any obvious sign of problems (if ever).

Yet another possible explanation is that a resource is simply not allowed to run on this node. That may be due to a failure which happened in the past and which was not cleaned. Or it may be due to an earlier administrative action, i.e. a location constraint with a negative score. Such a location constraint is for instance inserted by the crm resource migrate command.

Why can I never tell where my resource will run?

If there are no location constraints for a resource, its placement is subject to an (almost) random node choice. You are well advised to always express a preferred node for resources. That does not mean that you need to specify location preferences for all resources. One preference suffices for a set of related (colocated) resources. A node preference looks like this:

location rsc-prefers-node1 rsc 100: node1

20.4. STONITH and Fencing

Why does my STONITH resource not start?

Start (or enable) operation includes checking the status of the device. If the device is not ready, the STONITH resource will fail to start.

At the same time the STONITH plugin will be asked to produce a host list. If this list is empty, there is no point in running a STONITH resource which cannot shoot anything. The name of the host on which STONITH is running is filtered from the list, since the node cannot shoot itself.

If you want to use single-host management devices such as lights-out devices, make sure that the stonith resource is not allowed to run on the node which it is supposed to to fence. Use an infinitely negative location node preference (constraint). The cluster will move the stonith resource to another place where it can start, but not before informing you.

Why does fencing not happen, although I have the STONITH resource?

Each STONITH resource must provide a host list. This list may be inserted by hand in the STONITH resource configuration or retrieved from the device itself, for instance from outlet names. That depends on the nature of the STONITH plugin. stonithd uses the list to find out which STONITH resource can fence the target node. Only if the node appears in the list can the STONITH resource shoot (fence) the node.

If stonithd does not find the node in any of the host lists provided by running STONITH resources, it will ask stonithd instances on other nodes. If the target node does not show up in the host lists of other stonithd instances, the fencing request ends in a timeout at the originating node.

Why does my STONITH resource fail occasionally?

Power management devices may give up if there is too much broadcast traffic. Space out the monitor operations. Given that fencing is necessary only once in a while (and hopefully never), checking the device status once a few hours is more than enough.

Also, some of these devices may refuse to talk to more than one party at the same time. This may be a problem if you keep a terminal or browser session open while the cluster tries to test the status.

20.5. Miscellaneous

How can I run commands on all cluster nodes?

Use the command pssh for this task. If necessary, install pssh. Create a file (for example hosts.txt) where you collect all your IP addresses or hostnames you want to visit. Make sure you can log in with ssh to each host listed in your hosts.txt file. If everything is correctly prepared, execute pssh and use the hosts.txt file (option -h) and the interactive mode (option -i) as shown in this example:

pssh -i -h hosts.txt "ls -l /corosync/*.conf"
[1] 08:28:32 [SUCCESS] root@venus.example.com
-rw-r--r-- 1 root root 1480 Nov 14 13:37 /etc/corosync/corosync.conf
[2] 08:28:32 [SUCCESS] root@192.168.2.102
-rw-r--r-- 1 root root 1480 Nov 14 13:37 /etc/corosync/corosync.conf
What is the state of my cluster?

To check the current state of your cluster, use one of the programs crm_mon or crm status. This displays the current DC as well as all the nodes and resources known by the current node.

Why can several nodes of my cluster not see each other?

There could be several reasons:

  • Look first in the configuration file /etc/corosync/corosync.conf and check if the multicast or unicast address is the same for every node in the cluster (look in the interface section with the key mcastaddr.)

  • Check your firewall settings.

  • Check if your switch supports multicast or unicast addresses.

  • Check if the connection between your nodes is broken. Most often, this is the result of a badly configured firewall. This also may be the reason for a split brain condition, where the cluster is partitioned.

Why can an OCFS2 device not be mounted?

Check /var/log/messages for the following line:

Jan 12 09:58:55 clusternode2 lrmd: [3487]: info: RA output: (o2cb:1:start:stderr) 2009/01/12_09:58:55 
  ERROR: Could not load ocfs2_stackglue
Jan 12 16:04:22 clusternode2 modprobe: FATAL: Module ocfs2_stackglue not found.

In this case the Kernel module ocfs2_stackglue.ko is missing. Install the package ocfs2-kmp-default, ocfs2-kmp-pae or ocfs2-kmp-xen, depending on the installed Kernel.

How can I create a report with an analysis of all my cluster nodes?

Use the tool hb_report to create a report. The tool is used to compile:

  • Cluster-wide log files,

  • Package states,

  • DLM/OCFS2 states,

  • System information,

  • CIB history,

  • Parsing of core dump reports, if a debuginfo package is installed.

Usually run hb_report with the following command:

hb_report -f 0:00 -n earth -n venus

The command extracts all information since 0am on the hosts earth and venus and creates a tar.bz2 archive named hb_report-DATE.tar.bz2 in the current directory, for example, hb_report-Wed-03-Mar-2012. If you are only interested in a specific time frame, add the end time with the -t option.

[Warning]Remove Sensitive Information

The hb_report tool tries to remove any sensitive information from the CIB and the peinput files, however, it can not do everything. If you have more sensitive information, supply additional patterns. The logs and the crm_mon, ccm_tool, and crm_verify output are not sanitized.

Before sharing your data in any way, check the archive and remove all information you do not want to expose.

Customize the command execution with further options. For example, if you have an OpenAIS cluster, you certainly want to add the option -A. In case you have another user who has permissions to the cluster, use the -u option and specify this user (in addition to root and hacluster). Further options can be found in the manpage of hb_report.

After hb_report analyzed all the relevant log files and created the directory (or archive), check the logs for an uppercase ERROR string. The most important files in the top level directory of the report are:

analysis.txt

Compares files that should be identical on all nodes.

crm_mon.txt

Contains the output of the crm_mon command.

corosync.txt

Contains a copy of the Corosync configuration file.

description.txt

Contains all cluster package versions on your nodes. There is also the sysinfo.txt file which is node specific. It is linked to the top directory.

Node-specific files are stored in a subdirectory named by the node's name.

20.6. Fore More Information

For additional information about high availability on Linux, including configuring cluster resources and managing and customizing a High Availability cluster, see http://clusterlabs.org/wiki/Documentation.

Chapter 21. HA OCF Agents

Contents

ocf:anything — Manages an arbitrary service
ocf:AoEtarget — Manages ATA-over-Ethernet (AoE) target exports
ocf:apache — Manages an Apache web server instance
ocf:asterisk — Manages an Asterisk PBX
ocf:AudibleAlarm — Emits audible beeps at a configurable interval
ocf:ClusterMon — Runs crm_mon in the background, recording the cluster status to an HTML file
ocf:conntrackd — This resource agent manages conntrackd
ocf:CTDB — CTDB Resource Agent
ocf:db2 — Resource Agent that manages an IBM DB2 LUW databases in Standard role as primitive or in HADR roles as master/slave configuration. Multiple partitions are supported.
ocf:Delay — Waits for a defined timespan
ocf:dhcpd — Chrooted ISC DHCP Server resource agent.
ocf:drbd — Manages a DRBD resource (deprecated)
ocf:Dummy — Example stateless resource agent
ocf:eDir88 — Manages a Novell eDirectory directory server
ocf:ethmonitor — Monitors network interfaces
ocf:Evmsd — Controls clustered EVMS volume management (deprecated)
ocf:EvmsSCC — Manages EVMS Shared Cluster Containers (SCCs) (deprecated)
ocf:exportfs — Manages NFS exports
ocf:Filesystem — Manages filesystem mounts
ocf:fio — fio IO load generator
ocf:ICP — Manages an ICP Vortex clustered host drive
ocf:ids — Manages an Informix Dynamic Server (IDS) instance
ocf:IPaddr2 — Manages virtual IPv4 addresses (Linux specific version)
ocf:IPaddr — Manages virtual IPv4 addresses (portable version)
ocf:IPsrcaddr — Manages the preferred source address for outgoing IP packets
ocf:IPv6addr — Manages IPv6 aliases
ocf:iSCSILogicalUnit — Manages iSCSI Logical Units (LUs)
ocf:iSCSITarget — iSCSI target export agent
ocf:iscsi — Manages a local iSCSI initiator and its connections to iSCSI targets
ocf:jboss — Manages a JBoss application server instance
ocf:ldirectord — Wrapper OCF Resource Agent for ldirectord
ocf:LinuxSCSI — Enables and disables SCSI devices through the kernel SCSI hot-plug subsystem (deprecated)
ocf:LVM — Controls the availability of an LVM Volume Group
ocf:lxc — Manages LXC containers
ocf:MailTo — Notifies recipients by email in the event of resource takeover
ocf:ManageRAID — Manages RAID devices
ocf:ManageVE — Manages an OpenVZ Virtual Environment (VE)
ocf:mysql-proxy — Manages a MySQL Proxy instance
ocf:mysql — Manages a MySQL database instance
ocf:named — Manages a named server
ocf:nfsserver — Manages an NFS server
ocf:nginx — Manages an Nginx web/proxy server instance
ocf:oracle — Manages an Oracle Database instance
ocf:oralsnr — Manages an Oracle TNS listener
ocf:pgsql — Manages a PostgreSQL database instance
ocf:pingd — Monitors connectivity to specific hosts or IP addresses ("ping nodes") (deprecated)
ocf:portblock — Block and unblocks access to TCP and UDP ports
ocf:postfix — Manages a highly available Postfix mail server instance
ocf:pound — Manage a Pound instance
ocf:proftpd — OCF Resource Agent compliant FTP script.
ocf:Pure-FTPd — Manages a Pure-FTPd FTP server instance
ocf:Raid1 — Manages Linux software RAID (MD) devices on shared storage
ocf:Route — Manages network routes
ocf:rsyncd — Manages an rsync daemon
ocf:rsyslog — rsyslog resource agent
ocf:scsi2reservation — scsi-2 reservation
ocf:SendArp — Broadcasts unsolicited ARP announcements
ocf:ServeRAID — Enables and disables shared ServeRAID merge groups
ocf:sfex — Manages exclusive access to shared storage using Shared Disk File EXclusiveness (SF-EX)
ocf:slapd — Manages a Stand-alone LDAP Daemon (slapd) instance
ocf:SphinxSearchDaemon — Manages the Sphinx search daemon.
ocf:Squid — Manages a Squid proxy server instance
ocf:Stateful — Example stateful resource agent
ocf:symlink — Manages a symbolic link
ocf:SysInfo — Records various node attributes in the CIB
ocf:syslog-ng — Syslog-ng resource agent
ocf:tomcat — Manages a Tomcat servlet environment instance
ocf:varnish — Manage a Varnish instance
ocf:VIPArip — Manages a virtual IP address through RIP2
ocf:VirtualDomain — Manages virtual domains through the libvirt virtualization framework
ocf:vmware — Manages VMWare Server 2.0 virtual machines
ocf:WAS6 — Manages a WebSphere Application Server 6 instance
ocf:WAS — Manages a WebSphere Application Server instance
ocf:WinPopup — Sends an SMB notification message to selected hosts
ocf:Xen — Manages Xen unprivileged domains (DomUs)
ocf:Xinetd — Manages a service of Xinetd
ocf:zabbixserver — Zabbix server resource agent

All OCF agents require several parameters to be set when they are started. The following overview shows how to manually operate these agents. The data that is available in this appendix is directly taken from the meta-data invocation of the respective RA. Find all these agents in /usr/lib/ocf/resource.d/heartbeat/.

When configuring an RA, omit the OCF_RESKEY_ prefix to the parameter name. Parameters that are in square brackets may be omitted in the configuration.

Name

ocf:anything — Manages an arbitrary service

Synopsis

OCF_RESKEY_binfile=string [OCF_RESKEY_cmdline_options=string] [OCF_RESKEY_workdir=string] [OCF_RESKEY_pidfile=string] [OCF_RESKEY_logfile=string] [OCF_RESKEY_errlogfile=string] [OCF_RESKEY_user=string] [OCF_RESKEY_monitor_hook=string] [OCF_RESKEY_stop_timeout=string] anything [start | stop | monitor | meta-data | validate-all]

Description

This is a generic OCF RA to manage almost anything.

Supported Parameters

OCF_RESKEY_binfile=Full path name of the binary to be executed

The full name of the binary to be executed. This is expected to keep running with the same pid and not just do something and exit.

OCF_RESKEY_cmdline_options=Command line options

Command line options to pass to the binary

OCF_RESKEY_workdir=Full path name of the work directory

The path from where the binfile will be executed.

OCF_RESKEY_pidfile=File to write STDOUT to

File to read/write the PID from/to.

OCF_RESKEY_logfile=File to write STDOUT to

File to write STDOUT to

OCF_RESKEY_errlogfile=File to write STDERR to

File to write STDERR to

OCF_RESKEY_user=User to run the command as

User to run the command as

OCF_RESKEY_monitor_hook=Command to run in monitor operation

Command to run in monitor operation

OCF_RESKEY_stop_timeout=Seconds to wait after having sent SIGTERM before sending SIGKILL in stop operation

In the stop operation: Seconds to wait for kill -TERM to succeed before sending kill -SIGKILL. Defaults to 2/3 of the stop operation timeout.


Name

ocf:AoEtarget — Manages ATA-over-Ethernet (AoE) target exports

Synopsis

[OCF_RESKEY_device=string] [OCF_RESKEY_nic=string] [OCF_RESKEY_shelf=integer] [OCF_RESKEY_slot=integer] OCF_RESKEY_pid=string [OCF_RESKEY_binary=string] AoEtarget [start | stop | monitor | reload | meta-data | validate-all]

Description

This resource agent manages an ATA-over-Ethernet (AoE) target using vblade. It exports any block device, or file, as an AoE target using the specified Ethernet device, shelf, and slot number.

Supported Parameters

OCF_RESKEY_device=Device to export

The local block device (or file) to export as an AoE target.

OCF_RESKEY_nic=Ethernet interface

The local Ethernet interface to use for exporting this AoE target.

OCF_RESKEY_shelf=AoE shelf number

The AoE shelf number to use when exporting this target.

OCF_RESKEY_slot=AoE slot number

The AoE slot number to use when exporting this target.

OCF_RESKEY_pid=Daemon pid file

The file to record the daemon pid to.

OCF_RESKEY_binary=vblade binary

Location of the vblade binary.


Name

ocf:apache — Manages an Apache web server instance

Synopsis

OCF_RESKEY_configfile=string [OCF_RESKEY_httpd=string] [OCF_RESKEY_port=integer] [OCF_RESKEY_statusurl=string] [OCF_RESKEY_testregex=string] [OCF_RESKEY_client=string] [OCF_RESKEY_testurl=string] [OCF_RESKEY_testregex10=string] [OCF_RESKEY_testconffile=string] [OCF_RESKEY_testname=string] [OCF_RESKEY_options=string] [OCF_RESKEY_envfiles=string] [OCF_RESKEY_use_ipv6=boolean] apache [start | stop | status | monitor | meta-data | validate-all]

Description

This is the resource agent for the Apache web server. This resource agent operates both version 1.x and version 2.x Apache servers. The start operation ends with a loop in which monitor is repeatedly called to make sure that the server started and that it is operational. Hence, if the monitor operation does not succeed within the start operation timeout, the apache resource will end with an error status. The monitor operation by default loads the server status page which depends on the mod_status module and the corresponding configuration file (usually /etc/apache2/mod_status.conf). Make sure that the server status page works and that the access is allowed *only* from localhost (address 127.0.0.1). See the statusurl and testregex attributes for more details. See also http://httpd.apache.org/

Supported Parameters

OCF_RESKEY_configfile=configuration file path

The full pathname of the Apache configuration file. This file is parsed to provide defaults for various other resource agent parameters.

OCF_RESKEY_httpd=httpd binary path

The full pathname of the httpd binary (optional).

OCF_RESKEY_port=httpd port

A port number that we can probe for status information using the statusurl. This will default to the port number found in the configuration file, or 80, if none can be found in the configuration file.

OCF_RESKEY_statusurl=url name

The URL to monitor (the apache server status page by default). If left unspecified, it will be inferred from the apache configuration file. If you set this, make sure that it succeeds *only* from the localhost (127.0.0.1). Otherwise, it may happen that the cluster complains about the resource being active on multiple nodes.

OCF_RESKEY_testregex=monitor regular expression

Regular expression to match in the output of statusurl. Case insensitive.

OCF_RESKEY_client=http client

Client to use to query to Apache. If not specified, the RA will try to find one on the system. Currently, wget and curl are supported. For example, you can set this parameter to "curl" if you prefer that to wget.

OCF_RESKEY_testurl=test url

URL to test. If it does not start with "http", then it's considered to be relative to the Listen address.

OCF_RESKEY_testregex10=extended monitor regular expression

Regular expression to match in the output of testurl. Case insensitive.

OCF_RESKEY_testconffile=test configuration file

A file which contains test configuration. Could be useful if you have to check more than one web application or in case sensitive info should be passed as arguments (passwords). Furthermore, using a config file is the only way to specify certain parameters. Please see README.webapps for examples and file description.

OCF_RESKEY_testname=test name

Name of the test within the test configuration file.

OCF_RESKEY_options=command line options

Extra options to apply when starting apache. See man httpd(8).

OCF_RESKEY_envfiles=environment settings files

Files (one or more) which contain extra environment variables. If you want to prevent script from reading the default file, set this parameter to empty string.

OCF_RESKEY_use_ipv6=use ipv6 with http clients

We will try to detect if the URL (for monitor) is IPv6, but if that doesn't work set this to true to enforce IPv6.


Name

ocf:asterisk — Manages an Asterisk PBX

Synopsis

[OCF_RESKEY_binary=string] [OCF_RESKEY_canary_binary=string] [OCF_RESKEY_config=string] [OCF_RESKEY_user=string] [OCF_RESKEY_group=string] [OCF_RESKEY_additional_parameters=string] [OCF_RESKEY_realtime=boolean] [OCF_RESKEY_maxfiles=integer] [OCF_RESKEY_monitor_sipuri=string] asterisk [start | stop | status | monitor | validate-all | meta-data]

Description

Resource agent for the Asterisk PBX. May manage an Asterisk PBX telephony system or a clone set that forms an Asterisk distributed device setup.

Supported Parameters

OCF_RESKEY_binary=Asterisk PBX server binary

Location of the Asterisk PBX server binary

OCF_RESKEY_canary_binary=Asterisk PBX Canary server binary

Location of the Asterisk PBX Canary server binary

OCF_RESKEY_config=Asterisk PBX config

The Asterisk PBX configuration file

OCF_RESKEY_user=Asterisk PBX user

User running Asterisk PBX daemon

OCF_RESKEY_group=Asterisk PBX group

Group running Asterisk PBX daemon (for logfile and directory permissions)

OCF_RESKEY_additional_parameters=Additional parameters to pass to the Asterisk PBX

Additional parameters which are passed to the Asterisk PBX on startup (e.g. -L <load> or -M <value>).

OCF_RESKEY_realtime=Asterisk PBX realtime priority

Determines whether the Asterisk PBX daemon will be run with realtime priority or not.

OCF_RESKEY_maxfiles=Asterisk PBX allowed MAXFILES

Determines how many files the Asterisk PBX is allowed to open at a time. Helps to fix the 'Too many open files' error message.

OCF_RESKEY_monitor_sipuri=SIP URI to check when monitoring

A SIP URI to check when monitoring. During monitor, the agent will attempt to do a SIP OPTIONS request against this URI. Requires the sipsak utility to be present and executable. If unset, the agent does no SIP URI monitoring.


Name

ocf:AudibleAlarm — Emits audible beeps at a configurable interval

Synopsis

[OCF_RESKEY_nodelist=string] AudibleAlarm [start | stop | restart | status | monitor | meta-data | validate-all]

Description

Resource script for AudibleAlarm. It sets an audible alarm running by beeping at a set interval.

Supported Parameters

OCF_RESKEY_nodelist=Node list

The node list that should never sound the alarm.


Name

ocf:ClusterMon — Runs crm_mon in the background, recording the cluster status to an HTML file

Synopsis

[OCF_RESKEY_user=string] [OCF_RESKEY_update=integer] [OCF_RESKEY_extra_options=string] OCF_RESKEY_pidfile=string OCF_RESKEY_htmlfile=string ClusterMon [start | stop | monitor | meta-data | validate-all]

Description

This is a ClusterMon Resource Agent. It outputs current cluster status to the html.

Supported Parameters

OCF_RESKEY_user=The user we want to run crm_mon as

The user we want to run crm_mon as

OCF_RESKEY_update=Update interval

How frequently should we update the cluster status

OCF_RESKEY_extra_options=Extra options

Additional options to pass to crm_mon. Eg. -n -r

OCF_RESKEY_pidfile=PID file

PID file location to ensure only one instance is running

OCF_RESKEY_htmlfile=HTML output

Location to write HTML output to.


Name

ocf:conntrackd — This resource agent manages conntrackd

Synopsis

[OCF_RESKEY_binary=string] [OCF_RESKEY_config=string] conntrackd [start | promote | demote | notify | stop | monitor | monitor | meta-data | validate-all]

Description

Master/Slave OCF Resource Agent for conntrackd

Supported Parameters

OCF_RESKEY_binary=Name of the conntrackd executable

Name of the conntrackd executable. If conntrackd is installed and available in the default PATH, it is sufficient to configure the name of the binary For example "my-conntrackd-binary-version-0.9.14" If conntrackd is installed somewhere else, you may also give a full path For example "/packages/conntrackd-0.9.14/sbin/conntrackd"

OCF_RESKEY_config=Path to conntrackd.conf

Full path to the conntrackd.conf file. For example "/packages/conntrackd-0.9.14/etc/conntrackd/conntrackd.conf"


Name

ocf:CTDB — CTDB Resource Agent

Synopsis

OCF_RESKEY_ctdb_recovery_lock=string [OCF_RESKEY_ctdb_manages_samba=boolean] [OCF_RESKEY_ctdb_manages_winbind=boolean] [OCF_RESKEY_ctdb_service_smb=string] [OCF_RESKEY_ctdb_service_nmb=string] [OCF_RESKEY_ctdb_service_winbind=string] [OCF_RESKEY_ctdb_samba_skip_share_check=boolean] [OCF_RESKEY_ctdb_monitor_free_memory=integer] [OCF_RESKEY_ctdb_start_as_disabled=boolean] [OCF_RESKEY_ctdb_config_dir=string] [OCF_RESKEY_ctdb_binary=string] [OCF_RESKEY_ctdbd_binary=string] OCF_RESKEY_ctdb_socket=string OCF_RESKEY_ctdb_dbdir=string [OCF_RESKEY_ctdb_logfile=string] [OCF_RESKEY_ctdb_debuglevel=integer] [OCF_RESKEY_smb_conf=string] OCF_RESKEY_smb_private_dir=string [OCF_RESKEY_smb_passdb_backend=string] [OCF_RESKEY_smb_idmap_backend=string] [OCF_RESKEY_smb_fileid_algorithm=string] CTDB [start | stop | monitor | meta-data | validate-all]

Description

This resource agent manages CTDB, allowing one to use Clustered Samba in a Linux-HA/Pacemaker cluster. You need a shared filesystem (e.g. OCFS2) on which the CTDB lock will be stored. Create /etc/ctdb/nodes containing a list of private IP addresses of each node in the cluster, then configure this RA as a clone. To have CTDB manage Samba, set ctdb_manages_samba="yes". Note that this option will be deprecated in future, in favour of configuring a separate Samba resource. For more information see http://linux-ha.org/wiki/CTDB_(resource_agent)

Supported Parameters

OCF_RESKEY_ctdb_recovery_lock=CTDB shared lock file

The location of a shared lock file, common across all nodes. This must be on shared storage, e.g.: /shared-fs/samba/ctdb.lock

OCF_RESKEY_ctdb_manages_samba=Should CTDB manage Samba?

Should CTDB manage starting/stopping the Samba service for you? This will be deprecated in future, in favor of configuring a separate Samba resource.

OCF_RESKEY_ctdb_manages_winbind=Should CTDB manage Winbind?

Should CTDB manage starting/stopping the Winbind service for you? This will be deprecated in future, in favor of configuring a separate Winbind resource.

OCF_RESKEY_ctdb_service_smb=Name of smb init script

Name of smb init script. Only necessary if CTDB is managing Samba directly. Will usually be auto-detected.

OCF_RESKEY_ctdb_service_nmb=Name of nmb init script

Name of nmb init script. Only necessary if CTDB is managing Samba directly. Will usually be auto-detected.

OCF_RESKEY_ctdb_service_winbind=Name of winbind init script

Name of winbind init script. Only necessary if CTDB is managing Winbind directly. Will usually be auto-detected.

OCF_RESKEY_ctdb_samba_skip_share_check=Skip share check during monitor?

If there are very many shares it may not be feasible to check that all of them are available during each monitoring interval. In that case this check can be disabled.

OCF_RESKEY_ctdb_monitor_free_memory=Minimum amount of free memory (MB)

If the amount of free memory drops below this value the node will become unhealthy and ctdb and all managed services will be shutdown. Once this occurs, the administrator needs to find the reason for the OOM situation, rectify it and restart ctdb with "service ctdb start".

OCF_RESKEY_ctdb_start_as_disabled=Start CTDB disabled?

When set to yes, the CTDB node will start in DISABLED mode and not host any public ip addresses.

OCF_RESKEY_ctdb_config_dir=CTDB config file directory

The directory containing various CTDB configuration files. The "nodes" and "notify.sh" scripts are expected to be in this directory, as is the "events.d" subdirectory.

OCF_RESKEY_ctdb_binary=CTDB binary path

Full path to the CTDB binary.

OCF_RESKEY_ctdbd_binary=CTDB Daemon binary path

Full path to the CTDB cluster daemon binary.

OCF_RESKEY_ctdb_socket=CTDB socket location

Full path to the domain socket that ctdbd will create, used for local clients to attach and communicate with the ctdb daemon.

OCF_RESKEY_ctdb_dbdir=CTDB database directory

The directory to put the local CTDB database files in. Persistent database files will be put in ctdb_dbdir/persistent.

OCF_RESKEY_ctdb_logfile=CTDB log file location

Full path to log file. To log to syslog instead, use the value "syslog".

OCF_RESKEY_ctdb_debuglevel=CTDB debug level

What debug level to run at (0-10). Higher means more verbose.

OCF_RESKEY_smb_conf=Path to smb.conf

Path to default samba config file. Only necessary if CTDB is managing Samba.

OCF_RESKEY_smb_private_dir=Samba private dir (deprecated)

The directory for smbd to use for storing such files as smbpasswd and secrets.tdb. Old versions of CTBD (prior to 1.0.50) required this to be on shared storage. This parameter should not be set for current versions of CTDB, and only remains in the RA for backwards compatibility.

OCF_RESKEY_smb_passdb_backend=Samba passdb backend

Which backend to use for storing user and possibly group information. Only necessary if CTDB is managing Samba.

OCF_RESKEY_smb_idmap_backend=Samba idmap backend

Which backend to use for SID/uid/gid mapping. Only necessary if CTDB is managing Samba.

OCF_RESKEY_smb_fileid_algorithm=Samba VFS fileid algorithm

Which fileid:algorithm to use with vfs_fileid. The correct value depends on which clustered filesystem is in use, e.g.: for OCFS2, this should be set to "fsid". Only necessary if CTDB is managing Samba.


Name

ocf:db2 — Resource Agent that manages an IBM DB2 LUW databases in Standard role as primitive or in HADR roles as master/slave configuration. Multiple partitions are supported.

Synopsis

OCF_RESKEY_instance=string [OCF_RESKEY_dblist=string] [OCF_RESKEY_admin=string] [OCF_RESKEY_dbpartitionnum=string] db2 [start | stop | promote | demote | notify | monitor | monitor | validate-all | meta-data]

Description

Resource Agent that manages an IBM DB2 LUW databases in Standard role as primitive or in HADR roles in master/slave configuration. Multiple partitions are supported. Standard mode: An instance including all or selected databases is made highly available. Configure each partition as a separate primitive resource. HADR mode: A single database in HADR configuration is made highly available by automating takeover operations. Configure a master / slave resource with notifications enabled and an additional monitoring operation with role "Master". In case of HADR be very deliberate in specifying intervals/timeouts. The detection of a failure including promote must complete within HADR_PEER_WINDOW. In addition to honoring requirements for crash recovery etc. for your specific database use the following relations as guidance: "monitor interval" < HADR_PEER_WINDOW - (appr 30 sec) "promote timeout" < HADR_PEER_WINDOW + (appr 20 sec) For further information and examples consult http://www.linux-ha.org/wiki/db2_(resource_agent)

Supported Parameters

OCF_RESKEY_instance=instance

The instance of the database(s).

OCF_RESKEY_dblist=List of databases to be managed

List of databases to be managed, e.g "db1 db2". Defaults to all databases in the instance. Specify one db for HADR mode.

OCF_RESKEY_admin=DEPRECATED: admin

DEPRECATED: The admin user of the instance.

OCF_RESKEY_dbpartitionnum=database partition number (DBPARTITIONNUM)

The number of the partion (DBPARTITIONNUM) to be managed.


Name

ocf:Delay — Waits for a defined timespan

Synopsis

[OCF_RESKEY_startdelay=integer] [OCF_RESKEY_stopdelay=integer] [OCF_RESKEY_mondelay=integer] Delay [start | stop | status | monitor | meta-data | validate-all]

Description

This script is a test resource for introducing delay.

Supported Parameters

OCF_RESKEY_startdelay=Start delay

How long in seconds to delay on start operation.

OCF_RESKEY_stopdelay=Stop delay

How long in seconds to delay on stop operation. Defaults to "startdelay" if unspecified.

OCF_RESKEY_mondelay=Monitor delay

How long in seconds to delay on monitor operation. Defaults to "startdelay" if unspecified.


Name

ocf:dhcpd — Chrooted ISC DHCP Server resource agent.

Synopsis

OCF_RESKEY_config=string OCF_RESKEY_chrooted=boolean OCF_RESKEY_chrooted_path=string [OCF_RESKEY_binary=string] [OCF_RESKEY_user=string] [OCF_RESKEY_group=string] [OCF_RESKEY_interface=string] [OCF_RESKEY_includes=string] [OCF_RESKEY_leases=string] [OCF_RESKEY_pid=string] dhcpd [start | stop | monitor | meta-data | validate-all]

Description

Manage an ISC DHCP server service in a chroot environment.

Supported Parameters

OCF_RESKEY_config=Configuration file

The absolute path to the DHCP server configuration file.

OCF_RESKEY_chrooted=Enable chroot mode

Configure the dhcpd service to run in a chrooted or non-chrooted mode.

OCF_RESKEY_chrooted_path=The chrooted path

The absolute path of the chrooted DHCP environment.

OCF_RESKEY_binary=dhcpd binary

The binary for the DHCP server process. An absolute path definition is not required, but can be used to override environment path.

OCF_RESKEY_user=dhcpd owner

The system user the DHCP server process will run as when it is chrooted.

OCF_RESKEY_group=dhcpd group owner

The system group the DHCP server process will run as when it is chrooted.

OCF_RESKEY_interface=Network Interface

The network interface(s) the DHCP server process will bind to. A blank value will bind the process to all interfaces.

OCF_RESKEY_includes=Include Files

This parameter provides a means to copy include files into the chrooted environment. If a dhcpd.conf file contains a line similar to this: include "/etc/named.keys"; Then an admin also has to tell the dhcpd RA that this file should be pulled into the chrooted environment. This is a space delimited list.

OCF_RESKEY_leases=Leases file

The leases database file, relative to chrooted_path.

OCF_RESKEY_pid=PID file

The path and filename of the PID file. It is relative to chrooted_path.


Name

ocf:drbd — Manages a DRBD resource (deprecated)

Synopsis

OCF_RESKEY_drbd_resource=string [OCF_RESKEY_drbdconf=string] [OCF_RESKEY_clone_overrides_hostname=boolean] [OCF_RESKEY_ignore_deprecation=boolean] drbd [start | promote | demote | notify | stop | monitor | monitor | meta-data | validate-all]

Description

Deprecation warning: This agent is deprecated and may be removed from a future release. See the ocf:linbit:drbd resource agent for a supported alternative. -- This resource agent manages a Distributed Replicated Block Device (DRBD) object as a master/slave resource. DRBD is a mechanism for replicating storage; please see the documentation for setup details.

Supported Parameters

OCF_RESKEY_drbd_resource=drbd resource name

The name of the drbd resource from the drbd.conf file.

OCF_RESKEY_drbdconf=Path to drbd.conf

Full path to the drbd.conf file.

OCF_RESKEY_clone_overrides_hostname=Override drbd hostname

Whether or not to override the hostname with the clone number. This can be used to create floating peer configurations; drbd will be told to use node_<cloneno> as the hostname instead of the real uname, which can then be used in drbd.conf.

OCF_RESKEY_ignore_deprecation=Suppress deprecation warning

If set to true, suppresses the deprecation warning for this agent.


Name

ocf:Dummy — Example stateless resource agent

Synopsis

OCF_RESKEY_state=string [OCF_RESKEY_fake=string] Dummy [start | stop | monitor | reload | migrate_to | migrate_from | meta-data | validate-all]

Description

This is a Dummy Resource Agent. It does absolutely nothing except keep track of whether its running or not. Its purpose in life is for testing and to serve as a template for RA writers. NB: Please pay attention to the timeouts specified in the actions section below. They should be meaningful for the kind of resource the agent manages. They should be the minimum advised timeouts, but they shouldn't/cannot cover _all_ possible resource instances. So, try to be neither overly generous nor too stingy, but moderate. The minimum timeouts should never be below 10 seconds.

Supported Parameters

OCF_RESKEY_state=State file

Location to store the resource state in.

OCF_RESKEY_fake=Fake attribute that can be changed to cause a reload

Fake attribute that can be changed to cause a reload


Name

ocf:eDir88 — Manages a Novell eDirectory directory server

Synopsis

OCF_RESKEY_eDir_config_file=string [OCF_RESKEY_eDir_monitor_ldap=boolean] [OCF_RESKEY_eDir_monitor_idm=boolean] [OCF_RESKEY_eDir_jvm_initial_heap=integer] [OCF_RESKEY_eDir_jvm_max_heap=integer] [OCF_RESKEY_eDir_jvm_options=string] eDir88 [start | stop | monitor | meta-data | validate-all]

Description

Resource script for managing an eDirectory instance. Manages a single instance of eDirectory as an HA resource. The "multiple instances" feature or eDirectory has been added in version 8.8. This script will not work for any version of eDirectory prior to 8.8. This RA can be used to load multiple eDirectory instances on the same host. It is very strongly recommended to put eDir configuration files (as per the eDir_config_file parameter) on local storage on each node. This is necessary for this RA to be able to handle situations where the shared storage has become unavailable. If the eDir configuration file is not available, this RA will fail, and heartbeat will be unable to manage the resource. Side effects include STONITH actions, unmanageable resources, etc... Setting a high action timeout value is _very_ _strongly_ recommended. eDir with IDM can take in excess of 10 minutes to start. If heartbeat times out before eDir has had a chance to start properly, mayhem _WILL ENSUE_. The LDAP module seems to be one of the very last to start. So this script will take even longer to start on installations with IDM and LDAP if the monitoring of IDM and/or LDAP is enabled, as the start command will wait for IDM and LDAP to be available.

Supported Parameters

OCF_RESKEY_eDir_config_file=eDir config file

Path to configuration file for eDirectory instance.

OCF_RESKEY_eDir_monitor_ldap=eDir monitor ldap

Should we monitor if LDAP is running for the eDirectory instance?

OCF_RESKEY_eDir_monitor_idm=eDir monitor IDM

Should we monitor if IDM is running for the eDirectory instance?

OCF_RESKEY_eDir_jvm_initial_heap=DHOST_INITIAL_HEAP value

Value for the DHOST_INITIAL_HEAP java environment variable. If unset, java defaults will be used.

OCF_RESKEY_eDir_jvm_max_heap=DHOST_MAX_HEAP value

Value for the DHOST_MAX_HEAP java environment variable. If unset, java defaults will be used.

OCF_RESKEY_eDir_jvm_options=DHOST_OPTIONS value

Value for the DHOST_OPTIONS java environment variable. If unset, original values will be used.


Name

ocf:ethmonitor — Monitors network interfaces

Synopsis

OCF_RESKEY_interface=string OCF_RESKEY_name=string [OCF_RESKEY_multiplier=integer] [OCF_RESKEY_repeat_count=integer] [OCF_RESKEY_repeat_interval=integer] [OCF_RESKEY_pktcnt_timeout=integer] [OCF_RESKEY_arping_count=integer] [OCF_RESKEY_arping_timeout=integer] [OCF_RESKEY_arping_cache_entries=integer] ethmonitor [start | stop | status | monitor | meta-data | validate-all]

Description

Monitor the vitality of a local network interface. You may setup this RA as a clone resource to monitor the network interfaces on different nodes, with the same interface name. This is not related to the IP adress or the network on which a interface is configured. You may use this RA to move resources away from a node, which has a faulty interface or prevent moving resources to such a node. This gives you independend control of the resources, without involving cluster intercommunication. But it requires your nodes to have more than one network interface. The resource configuration requires a monitor operation, because the monitor does the main part of the work. In addition to the resource configuration, you need to configure some location contraints, based on a CIB attribute value. The name of the attribute value is configured in the 'name' option of this RA. Example constraint configuration: location loc_connected_node my_resource_grp rule ="rule_loc_connected_node" -INF: ethmonitor eq 0 The ethmonitor works in 3 different modes to test the interface vitality. 1. call ip to see if the link status is up (if link is down -> error) 2. call ip an watch the RX counter (if packages come around in a certain time -> success) 3. call arping to check wether any of the IPs found in the lokal ARP cache answers an ARP REQUEST (one answer -> success) 4. return error

Supported Parameters

OCF_RESKEY_interface=Network interface name

The name of the network interface which should be monitored (e.g. eth0).

OCF_RESKEY_name=Attribute name

The name of the CIB attribute to set. This is the name to be used in the constraints. Defaults to "ethmonitor-'interface_name'".

OCF_RESKEY_multiplier=Multiplier for result variable

Multiplier for the value of the CIB attriobute specified in parameter name.

OCF_RESKEY_repeat_count=Monitor repeat count

Specify how often the interface will be monitored, before the status is set to failed. You need to set the timeout of the monitoring operation to at least repeat_count * repeat_interval

OCF_RESKEY_repeat_interval=Monitor repeat interval in seconds

Specify how long to wait in seconds between the repeat_counts.

OCF_RESKEY_pktcnt_timeout=packet counter timeout

Timeout for the RX packet counter. Stop listening for packet counter changes after the given number of seconds.

OCF_RESKEY_arping_count=Number of arpings per IP

Number of ARP REQUEST packets to send for every IP. Usually one ARP REQUEST (arping) is send

OCF_RESKEY_arping_timeout=Timeout for arpings per IP

Time in seconds to wait for ARP REQUESTs (all packets of arping_count). This is to limit the time for arp requests, to be able to send requests to more than one node, without running in the monitor operation timeout.

OCF_RESKEY_arping_cache_entries=Number of ARP cache entries to try

Maximum number of IPs from ARP cache list to check for ARP REQUEST (arping) answers. Newest entries are tried first.


Name

ocf:Evmsd — Controls clustered EVMS volume management (deprecated)

Synopsis

[OCF_RESKEY_ignore_deprecation=boolean] Evmsd [start | stop | monitor | meta-data]

Description

Deprecation warning: EVMS is no longer actively maintained and should not be used. This agent is deprecated and may be removed from a future release. -- This is a Evmsd Resource Agent.

Supported Parameters

OCF_RESKEY_ignore_deprecation=Suppress deprecation warning

If set to true, suppresses the deprecation warning for this agent.


Name

ocf:EvmsSCC — Manages EVMS Shared Cluster Containers (SCCs) (deprecated)

Synopsis

[OCF_RESKEY_ignore_deprecation=boolean] EvmsSCC [start | stop | notify | status | monitor | meta-data]

Description

Deprecation warning: EVMS is no longer actively maintained and should not be used. This agent is deprecated and may be removed from a future release. -- Resource script for EVMS shared cluster container. It runs evms_activate on one node in the cluster.

Supported Parameters

OCF_RESKEY_ignore_deprecation=Suppress deprecation warning

If set to true, suppresses the deprecation warning for this agent.


Name

ocf:exportfs — Manages NFS exports

Synopsis

[OCF_RESKEY_clientspec=string] [OCF_RESKEY_options=string] [OCF_RESKEY_directory=string] OCF_RESKEY_fsid=string [OCF_RESKEY_unlock_on_stop=boolean] [OCF_RESKEY_wait_for_leasetime_on_stop=boolean] [OCF_RESKEY_rmtab_backup=string] exportfs [start | stop | monitor | meta-data | validate-all]

Description

Exportfs uses the exportfs command to add/remove nfs exports. It does NOT manage the nfs server daemon. It depends on Linux specific NFS implementation details, so is considered not portable to other platforms yet.

Supported Parameters

OCF_RESKEY_clientspec= Client ACL.

The client specification allowing remote machines to mount the directory over NFS.

OCF_RESKEY_options= Export options.

The options to pass to exportfs for the exported directory.

OCF_RESKEY_directory= The directory to export.

The directory which you wish to export using NFS.

OCF_RESKEY_fsid= Unique fsid within cluster.

The fsid option to pass to exportfs. This can be a unique positive integer, a UUID, or the special string "root" which is functionally identical to numeric fsid of 0. 0 (root) identifies the export as the root of an NFSv4 pseudofilesystem -- avoid this setting unless you understand its special status. This value will override any fsid provided via the options parameter.

OCF_RESKEY_unlock_on_stop= Unlock filesystem on stop?

Relinquish NFS locks associated with this filesystem when the resource stops. Enabling this parameter is highly recommended unless the path exported by this exportfs resource is also exported by a different resource.

OCF_RESKEY_wait_for_leasetime_on_stop= Ride out the NFSv4 lease time on resource stop?

When stopping (unexporting), wait out the NFSv4 lease time. Only after all leases have expired does the NFS kernel server relinquish all server-side handles on the exported filesystem. If this exportfs resource manages an export that resides on a mount point designed to fail over along with the NFS export itself, then enabling this parameter will ensure such failover is working properly. Note that when this parameter is set, your stop timeout MUST accommodate for the wait period. This parameter is safe to disable if none of your NFS clients are using NFS version 4 or later.

OCF_RESKEY_rmtab_backup= Location of the rmtab backup, relative to directory.

Back up those entries from the NFS rmtab that apply to the exported directory, to the specified backup file. The filename is interpreted as relative to the exported directory. This backup is required if clients are connecting to the export via NFSv3 over TCP. Note that a configured monitor operation is required for this functionality. To disable rmtab backups, set this parameter to the special string "none".


Name

ocf:Filesystem — Manages filesystem mounts

Synopsis

[OCF_RESKEY_device=string] [OCF_RESKEY_directory=string] [OCF_RESKEY_fstype=string] [OCF_RESKEY_options=string] [OCF_RESKEY_statusfile_prefix=string] [OCF_RESKEY_run_fsck=string] [OCF_RESKEY_fast_stop=boolean] [OCF_RESKEY_force_clones=boolean] Filesystem [start | stop | notify | monitor | validate-all | meta-data]

Description

Resource script for Filesystem. It manages a Filesystem on a shared storage medium. The standard monitor operation of depth 0 (also known as probe) checks if the filesystem is mounted. If you want deeper tests, set OCF_CHECK_LEVEL to one of the following values: 10: read first 16 blocks of the device (raw read) This doesn't exercise the filesystem at all, but the device on which the filesystem lives. This is noop for non-block devices such as NFS, SMBFS, or bind mounts. 20: test if a status file can be written and read The status file must be writable by root. This is not always the case with an NFS mount, as NFS exports usually have the "root_squash" option set. In such a setup, you must either use read-only monitoring (depth=10), export with "no_root_squash" on your NFS server, or grant world write permissions on the directory where the status file is to be placed.

Supported Parameters

OCF_RESKEY_device=block device

The name of block device for the filesystem, or -U, -L options for mount, or NFS mount specification.

OCF_RESKEY_directory=mount point

The mount point for the filesystem.

OCF_RESKEY_fstype=filesystem type

The type of filesystem to be mounted.

OCF_RESKEY_options=options

Any extra options to be given as -o options to mount. For bind mounts, add "bind" here and set fstype to "none". We will do the right thing for options such as "bind,ro".

OCF_RESKEY_statusfile_prefix=status file prefix

The prefix to be used for a status file for resource monitoring with depth 20. If you don't specify this parameter, all status files will be created in a separate directory.

OCF_RESKEY_run_fsck=run_fsck

Specify how to decide whether to run fsck or not. "auto" : decide to run fsck depending on the fstype(default) "force" : always run fsck regardless of the fstype "no" : do not run fsck ever.

OCF_RESKEY_fast_stop=fast stop

Normally, we expect no users of the filesystem and the stop operation to finish quickly. If you cannot control the filesystem users easily and want to prevent the stop action from failing, then set this parameter to "no" and add an appropriate timeout for the stop operation.

OCF_RESKEY_force_clones=allow running as a clone, regardless of filesystem type

The usage of a clone setup for local filesystems is forbidden by default. For special setups like glusterfs, cloning a mount of a local device with a filesystem like ext4 or xfs, independently on several nodes is a valid use-case. Only set this to "true" if you know what you are doing!


Name

ocf:fio — fio IO load generator

Synopsis

[OCF_RESKEY_args=string] fio [start | stop | monitor | meta-data | validate-all]

Description

fio is a generic I/O load generator. This RA allows start/stop of fio instances to simulate load on a cluster without configuring complex services.

Supported Parameters

OCF_RESKEY_args=fio arguments

Arguments to the fio client. Minimally, this should be a (list of) job descriptions to run.


Name

ocf:ICP — Manages an ICP Vortex clustered host drive

Synopsis

[OCF_RESKEY_driveid=string] [OCF_RESKEY_device=string] ICP [start | stop | status | monitor | validate-all | meta-data]

Description

Resource script for ICP. It Manages an ICP Vortex clustered host drive as an HA resource.

Supported Parameters

OCF_RESKEY_driveid=ICP cluster drive ID

The ICP cluster drive ID.

OCF_RESKEY_device=device

The device name.


Name

ocf:ids — Manages an Informix Dynamic Server (IDS) instance

Synopsis

[OCF_RESKEY_informixdir=string] [OCF_RESKEY_informixserver=string] [OCF_RESKEY_onconfig=string] [OCF_RESKEY_dbname=string] [OCF_RESKEY_sqltestquery=string] ids [start | stop | status | monitor | validate-all | meta-data | methods | usage]

Description

OCF resource agent to manage an IBM Informix Dynamic Server (IDS) instance as an High-Availability resource.

Supported Parameters

OCF_RESKEY_informixdir= INFORMIXDIR environment variable

The value the environment variable INFORMIXDIR has after a typical installation of IDS. Or in other words: the path (without trailing '/') where IDS was installed to. If this parameter is unspecified the script will try to get the value from the shell environment.

OCF_RESKEY_informixserver= INFORMIXSERVER environment variable

The value the environment variable INFORMIXSERVER has after a typical installation of IDS. Or in other words: the name of the IDS server instance to manage. If this parameter is unspecified the script will try to get the value from the shell environment.

OCF_RESKEY_onconfig= ONCONFIG environment variable

The value the environment variable ONCONFIG has after a typical installation of IDS. Or in other words: the name of the configuration file for the IDS instance specified in INFORMIXSERVER. The specified configuration file will be searched at '/etc/'. If this parameter is unspecified the script will try to get the value from the shell environment.

OCF_RESKEY_dbname= database to use for monitoring, defaults to 'sysmaster'

This parameter defines which database to use in order to monitor the IDS instance. If this parameter is unspecified the script will use the 'sysmaster' database as a default.

OCF_RESKEY_sqltestquery= SQL test query to use for monitoring, defaults to 'SELECT COUNT(*) FROM systables;'

SQL test query to run on the database specified by the parameter 'dbname' in order to monitor the IDS instance and determine if it's functional or not. If this parameter is unspecified the script will use 'SELECT COUNT(*) FROM systables;' as a default.


Name

ocf:IPaddr2 — Manages virtual IPv4 addresses (Linux specific version)

Synopsis

OCF_RESKEY_ip=string [OCF_RESKEY_nic=string] [OCF_RESKEY_cidr_netmask=string] [OCF_RESKEY_broadcast=string] [OCF_RESKEY_iflabel=string] [OCF_RESKEY_lvs_support=boolean] [OCF_RESKEY_lvs_ipv6_addrlabel=boolean] [OCF_RESKEY_lvs_ipv6_addrlabel_value=integer] [OCF_RESKEY_mac=string] [OCF_RESKEY_clusterip_hash=string] [OCF_RESKEY_unique_clone_address=boolean] [OCF_RESKEY_arp_interval=integer] [OCF_RESKEY_arp_count=integer] [OCF_RESKEY_arp_bg=string] [OCF_RESKEY_arp_mac=string] [OCF_RESKEY_arp_sender=string] [OCF_RESKEY_flush_routes=boolean] IPaddr2 [start | stop | status | monitor | meta-data | validate-all]

Description

This Linux-specific resource manages IP alias IP addresses. It can add an IP alias, or remove one. In addition, it can implement Cluster Alias IP functionality if invoked as a clone resource. If used as a clone, you should explicitly set clone-node-max >= 2, and/or clone-max < number of nodes. In case of node failure, clone instances need to be re-allocated on surviving nodes. Which would not be possible, if there is already an instance on those nodes, and clone-node-max=1 (which is the default).

Supported Parameters

OCF_RESKEY_ip=IPv4 address

The IPv4 address to be configured in dotted quad notation, for example "192.168.1.1".

OCF_RESKEY_nic=Network interface

The base network interface on which the IP address will be brought online. If left empty, the script will try and determine this from the routing table. Do NOT specify an alias interface in the form eth0:1 or anything here; rather, specify the base interface only. If you want a label, see the iflabel parameter. Prerequisite: There must be at least one static IP address, which is not managed by the cluster, assigned to the network interface. If you can not assign any static IP address on the interface, modify this kernel parameter: sysctl -w net.ipv4.conf.all.promote_secondaries=1 # (or per device)

OCF_RESKEY_cidr_netmask=CIDR netmask

The netmask for the interface in CIDR format (e.g., 24 and not 255.255.255.0) If unspecified, the script will also try to determine this from the routing table.

OCF_RESKEY_broadcast=Broadcast address

Broadcast address associated with the IP. If left empty, the script will determine this from the netmask.

OCF_RESKEY_iflabel=Interface label

You can specify an additional label for your IP address here. This label is appended to your interface name. A label can be specified in nic parameter but it is deprecated. If a label is specified in nic name, this parameter has no effect.

OCF_RESKEY_lvs_support=Enable support for LVS DR

Enable support for LVS Direct Routing configurations. In case a IP address is stopped, only move it to the loopback device to allow the local node to continue to service requests, but no longer advertise it on the network. Notes for IPv6: It is not necessary to enable this option on IPv6. Instead, enable 'lvs_ipv6_addrlabel' option for LVS-DR usage on IPv6.

OCF_RESKEY_lvs_ipv6_addrlabel=Enables adding IPv6 address label.

Enable adding IPv6 address label so IPv6 traffic originating from the address' interface does not use this address as the source. This is necessary for LVS-DR health checks to realservers to work. Without it, the most recently added IPv6 address (probably the address added by IPaddr2) will be used as the source address for IPv6 traffic from that interface and since that address exists on loopback on the realservers, the realserver response to pings/connections will not never leave its loopback. See RFC3484 for the detail of the source address selection. See also 'lvs_ipv6_addrlabel_value' parameter.

OCF_RESKEY_lvs_ipv6_addrlabel_value=IPv6 address label value.

Specify IPv6 address label value used when 'lvs_ipv6_addrlabel' is enabled. The value should be an unused label in the policy table which is shown by 'ip addrlabel list' command. You would rarely need to change this parameter.

OCF_RESKEY_mac=Cluster IP MAC address

Set the interface MAC address explicitly. Currently only used in case of the Cluster IP Alias. Leave empty to chose automatically.

OCF_RESKEY_clusterip_hash=Cluster IP hashing function

Specify the hashing algorithm used for the Cluster IP functionality.

OCF_RESKEY_unique_clone_address=Create a unique address for cloned instances

If true, add the clone ID to the supplied value of ip to create a unique address to manage

OCF_RESKEY_arp_interval=ARP packet interval in ms

Specify the interval between unsolicited ARP packets in milliseconds.

OCF_RESKEY_arp_count=ARP packet count

Number of unsolicited ARP packets to send.

OCF_RESKEY_arp_bg=ARP from background

Whether or not to send the arp packets in the background.

OCF_RESKEY_arp_mac=ARP MAC

MAC address to send the ARP packets to. You really shouldn't be touching this.

OCF_RESKEY_arp_sender=ARP sender

The program to send ARP packets with on start. For infiniband interfaces, default is ipoibarping. If ipoibarping is not available, set this to send_arp.

OCF_RESKEY_flush_routes=Flush kernel routing table on stop

Flush the routing table on stop. This is for applications which use the cluster IP address and which run on the same physical host that the IP address lives on. The Linux kernel may force that application to take a shortcut to the local loopback interface, instead of the interface the address is really bound to. Under those circumstances, an application may, somewhat unexpectedly, continue to use connections for some time even after the IP address is deconfigured. Set this parameter in order to immediately disable said shortcut when the IP address goes away.


Name

ocf:IPaddr — Manages virtual IPv4 addresses (portable version)

Synopsis

OCF_RESKEY_ip=string [OCF_RESKEY_nic=string] [OCF_RESKEY_cidr_netmask=string] [OCF_RESKEY_broadcast=string] [OCF_RESKEY_iflabel=string] [OCF_RESKEY_lvs_support=boolean] [OCF_RESKEY_local_stop_script=string] [OCF_RESKEY_local_start_script=string] [OCF_RESKEY_ARP_INTERVAL_MS=integer] [OCF_RESKEY_ARP_REPEAT=integer] [OCF_RESKEY_ARP_BACKGROUND=boolean] [OCF_RESKEY_ARP_NETMASK=string] IPaddr [start | stop | monitor | validate-all | meta-data]

Description

This script manages IP alias IP addresses It can add an IP alias, or remove one.

Supported Parameters

OCF_RESKEY_ip=IPv4 address

The IPv4 address to be configured in dotted quad notation, for example "192.168.1.1".

OCF_RESKEY_nic=Network interface

The base network interface on which the IP address will be brought online. If left empty, the script will try and determine this from the routing table. Do NOT specify an alias interface in the form eth0:1 or anything here; rather, specify the base interface only. Prerequisite: There must be at least one static IP address, which is not managed by the cluster, assigned to the network interface. If you can not assign any static IP address on the interface, modify this kernel parameter: sysctl -w net.ipv4.conf.all.promote_secondaries=1 (or per device)

OCF_RESKEY_cidr_netmask=Netmask

The netmask for the interface in CIDR format. (ie, 24), or in dotted quad notation 255.255.255.0). If unspecified, the script will also try to determine this from the routing table.

OCF_RESKEY_broadcast=Broadcast address

Broadcast address associated with the IP. If left empty, the script will determine this from the netmask.

OCF_RESKEY_iflabel=Interface label

You can specify an additional label for your IP address here.

OCF_RESKEY_lvs_support=Enable support for LVS DR

Enable support for LVS Direct Routing configurations. In case a IP address is stopped, only move it to the loopback device to allow the local node to continue to service requests, but no longer advertise it on the network.

OCF_RESKEY_local_stop_script=Script called when the IP is released

Script called when the IP is released

OCF_RESKEY_local_start_script=Script called when the IP is added

Script called when the IP is added

OCF_RESKEY_ARP_INTERVAL_MS=milliseconds between gratuitous ARPs

milliseconds between ARPs

OCF_RESKEY_ARP_REPEAT=repeat count

How many gratuitous ARPs to send out when bringing up a new address

OCF_RESKEY_ARP_BACKGROUND=run in background

run in background (no longer any reason to do this)

OCF_RESKEY_ARP_NETMASK=netmask for ARP

netmask for ARP - in nonstandard hexadecimal format.


Name

ocf:IPsrcaddr — Manages the preferred source address for outgoing IP packets

Synopsis

[OCF_RESKEY_ipaddress=string] [OCF_RESKEY_cidr_netmask=string] IPsrcaddr [start | stop | monitor | validate-all | meta-data]

Description

Resource script for IPsrcaddr. It manages the preferred source address modification.

Supported Parameters

OCF_RESKEY_ipaddress=IP address

The IP address.

OCF_RESKEY_cidr_netmask=Netmask

The netmask for the interface in CIDR format. (ie, 24), or in dotted quad notation 255.255.255.0).


Name

ocf:IPv6addr — Manages IPv6 aliases

Synopsis

[OCF_RESKEY_ipv6addr=string] [OCF_RESKEY_cidr_netmask=string] [OCF_RESKEY_nic=string] IPv6addr [start | stop | status | monitor | validate-all | meta-data]

Description

This script manages IPv6 alias IPv6 addresses,It can add an IP6 alias, or remove one.

Supported Parameters

OCF_RESKEY_ipv6addr=IPv6 address

The IPv6 address this RA will manage

OCF_RESKEY_cidr_netmask=Netmask

The netmask for the interface in CIDR format. (ie, 24). The value of this parameter overwrites the value of _prefix_ of ipv6addr parameter.

OCF_RESKEY_nic=Network interface

The base network interface on which the IPv6 address will be brought online.


Name

ocf:iSCSILogicalUnit — Manages iSCSI Logical Units (LUs)

Synopsis

[OCF_RESKEY_implementation=string] [OCF_RESKEY_target_iqn=string] [OCF_RESKEY_lun=integer] [OCF_RESKEY_path=string] OCF_RESKEY_scsi_id=string OCF_RESKEY_scsi_sn=string [OCF_RESKEY_vendor_id=string] [OCF_RESKEY_product_id=string] [OCF_RESKEY_additional_parameters=string] [OCF_RESKEY_allowed_initiators=string] iSCSILogicalUnit [start | stop | status | monitor | meta-data | validate-all]

Description

Manages iSCSI Logical Unit. An iSCSI Logical unit is a subdivision of an SCSI Target, exported via a daemon that speaks the iSCSI protocol.

Supported Parameters

OCF_RESKEY_implementation=iSCSI target daemon implementation

The iSCSI target daemon implementation. Must be one of "iet", "tgt", or "lio". If unspecified, an implementation is selected based on the availability of management utilities, with "iet" being tried first, then "tgt", then "lio".

OCF_RESKEY_target_iqn=iSCSI target IQN

The iSCSI Qualified Name (IQN) that this Logical Unit belongs to.

OCF_RESKEY_lun=Logical Unit number (LUN)

The Logical Unit number (LUN) exposed to initiators.

OCF_RESKEY_path=Block device (or file) path

The path to the block device exposed. Some implementations allow this to be a regular file, too.

OCF_RESKEY_scsi_id=SCSI ID

The SCSI ID to be configured for this Logical Unit. The default is the resource name, truncated to 24 bytes.

OCF_RESKEY_scsi_sn=SCSI serial number

The SCSI serial number to be configured for this Logical Unit. The default is a hash of the resource name, truncated to 8 bytes.

OCF_RESKEY_vendor_id=SCSI vendor ID

The SCSI vendor ID to be configured for this Logical Unit.

OCF_RESKEY_product_id=SCSI product ID

The SCSI product ID to be configured for this Logical Unit.

OCF_RESKEY_additional_parameters=List of iSCSI LU parameters

Additional LU parameters. A space-separated list of "name=value" pairs which will be passed through to the iSCSI daemon's management interface. The supported parameters are implementation dependent. Neither the name nor the value may contain whitespace.

OCF_RESKEY_allowed_initiators=List of iSCSI initiators allowed to connect to this lun.

Allowed initiators. A space-separated list of initiators allowed to connect to this lun. Initiators may be listed in any syntax the target implementation allows. If this parameter is empty or not set, access to this lun will not be allowed from any initiator, if target is not in demo mode. This parameter is only necessary, when using LIO.


Name

ocf:iSCSITarget — iSCSI target export agent

Synopsis

[OCF_RESKEY_implementation=string] OCF_RESKEY_iqn=string OCF_RESKEY_tid=integer [OCF_RESKEY_portals=string] [OCF_RESKEY_allowed_initiators=string] OCF_RESKEY_incoming_username=string [OCF_RESKEY_incoming_password=string] [OCF_RESKEY_additional_parameters=string] iSCSITarget [start | stop | status | monitor | meta-data | validate-all]

Description

Manages iSCSI targets. An iSCSI target is a collection of SCSI Logical Units (LUs) exported via a daemon that speaks the iSCSI protocol.

Supported Parameters

OCF_RESKEY_implementation=Specifies the iSCSI target implementation ("iet", "tgt" or "lio").

The iSCSI target daemon implementation. Must be one of "iet", "tgt", or "lio". If unspecified, an implementation is selected based on the availability of management utilities, with "iet" being tried first, then "tgt", then "lio".

OCF_RESKEY_iqn=iSCSI target IQN

The target iSCSI Qualified Name (IQN). Should follow the conventional "iqn.yyyy-mm.<reversed domain name>[:identifier]" syntax.

OCF_RESKEY_tid=iSCSI target ID

The iSCSI target ID. Required for tgt.

OCF_RESKEY_portals=iSCSI portal addresses

iSCSI network portal addresses. Not supported by all implementations. If unset, the default is to create one portal that listens on .

OCF_RESKEY_allowed_initiators=List of iSCSI initiators allowed to connect to this target

Allowed initiators. A space-separated list of initiators allowed to connect to this target. Initiators may be listed in any syntax the target implementation allows. If this parameter is empty or not set, access to this target will be allowed from any initiator.

OCF_RESKEY_incoming_username=Incoming account username

A username used for incoming initiator authentication. If unspecified, allowed initiators will be able to log in without authentication. This is a unique parameter, as it not allowed to re-use a single username across multiple target instances.

OCF_RESKEY_incoming_password=Incoming account password

A password used for incoming initiator authentication.

OCF_RESKEY_additional_parameters=List of iSCSI target parameters

Additional target parameters. A space-separated list of "name=value" pairs which will be passed through to the iSCSI daemon's management interface. The supported parameters are implementation dependent. Neither the name nor the value may contain whitespace.


Name

ocf:iscsi — Manages a local iSCSI initiator and its connections to iSCSI targets

Synopsis

[OCF_RESKEY_portal=string] OCF_RESKEY_target=string [OCF_RESKEY_discovery_type=string] [OCF_RESKEY_iscsiadm=string] [OCF_RESKEY_udev=string] [OCF_RESKEY_try_recovery=boolean] iscsi [start | stop | status | monitor | validate-all | methods | meta-data]

Description

OCF Resource Agent for iSCSI. Add (start) or remove (stop) iSCSI targets.

Supported Parameters

OCF_RESKEY_portal=Portal address

The iSCSI portal address in the form: {ip_address|hostname}[":"port]

OCF_RESKEY_target=Target IQN

The iSCSI target IQN.

OCF_RESKEY_discovery_type=Target discovery type

Target discovery type. Check the open-iscsi documentation for supported discovery types.

OCF_RESKEY_iscsiadm=iscsiadm binary

open-iscsi administration utility binary.

OCF_RESKEY_udev=udev

If the next resource depends on the udev creating a device then we wait until it is finished. On a normally loaded host this should be done quickly, but you may be unlucky. If you are not using udev set this to "no", otherwise we will spin in a loop until a timeout occurs.

OCF_RESKEY_try_recovery=on error wait for iSCSI recovery in monitor

If the iSCSI session exists but is currently inactive/broken, which is most probably due to network problems, the iSCSI layer will try to recover. If this parameter is set to true, we'll wait for the recovery to succeed. In that case the monitor operation can only time out so you should set the monitor op timeout attribute appropriately.


Name

ocf:jboss — Manages a JBoss application server instance

Synopsis

OCF_RESKEY_resource_name=string OCF_RESKEY_console=string [OCF_RESKEY_shutdown_timeout=integer] [OCF_RESKEY_kill_timeout=integer] [OCF_RESKEY_user=string] [OCF_RESKEY_statusurl=string] [OCF_RESKEY_java_home=string] [OCF_RESKEY_java_opts=string] OCF_RESKEY_jboss_home=string [OCF_RESKEY_pstring=string] [OCF_RESKEY_run_opts=string] [OCF_RESKEY_shutdown_opts=string] [OCF_RESKEY_rotate_consolelog=string] [OCF_RESKEY_rotate_value=integer] [OCF_RESKEY_rotate_logsuffix=integer] jboss [start | stop | status | monitor | meta-data | validate-all]

Description

Resource script for Jboss. It manages a Jboss instance as an HA resource.

Supported Parameters

OCF_RESKEY_resource_name=The name of the resource

The name of the resource. Defaults to the name of the resource instance.

OCF_RESKEY_console=jboss log path

A destination of the log of jboss run and shutdown script.

OCF_RESKEY_shutdown_timeout=shutdown timeout

Timeout for jboss bin/shutdown.sh. We wait for this timeout to expire, then send the TERM and QUIT signals. Finally, the KILL signal is used to terminate the jboss process. You should set the timeout for the stop operation to a value bigger than the sum of the timeout parameters. See also kill_timeout.

OCF_RESKEY_kill_timeout=stop by signal timeout

If bin/shutdown.sh doesn't stop the jboss process, then we send it TERM and QUIT signals, intermittently and once a second. After this timeout expires, if the process is still live, we use the KILL signal. See also shutdown_timeout.

OCF_RESKEY_user=A user name to start a resource.

A user name to start a JBoss.

OCF_RESKEY_statusurl=URL to test in the monitor operation.

URL to test in the monitor operation.

OCF_RESKEY_java_home=Home directory of Java.

Home directory of Java. Defaults to the environment variable JAVA_HOME. If it is not set, then define this parameter.

OCF_RESKEY_java_opts=Java options.

Java options.

OCF_RESKEY_jboss_home=Home directory of Jboss.

Home directory of Jboss.

OCF_RESKEY_pstring=pkill/pgrep search string

With this string heartbeat matches for the right process to kill.

OCF_RESKEY_run_opts=options for jboss run.sh

Start options to start Jboss with, defaults are from the Jboss-Doku.

OCF_RESKEY_shutdown_opts=options for jboss shutdown.sh

Stop options to stop Jboss with.

OCF_RESKEY_rotate_consolelog=Rotate console log flag

Rotate console log flag.

OCF_RESKEY_rotate_value=console log rotation value (default is 86400 seconds)

console log rotation value (default is 86400 seconds).

OCF_RESKEY_rotate_logsuffix=Rotate console log suffix

Rotate console log suffix.


Name

ocf:ldirectord — Wrapper OCF Resource Agent for ldirectord

Synopsis

OCF_RESKEY_configfile=string [