Product SiteDocumentation Site

HA Resource Parameters

This appendix provides descriptions of HA resource parameters. You can configure the parameters with luci, by using the ccs command, or by editing etc/cluster/cluster.conf. Table B.1, “HA Resource Summary” lists the resources, their corresponding resource agents, and references to other tables containing parameter descriptions. To understand resource agents in more detail you can view them in /usr/share/cluster of any cluster node.
For a comprehensive list and description of cluster.conf elements and attributes, refer to the cluster schema at /usr/share/cluster/cluster.rng, and the annotated schema at /usr/share/doc/cman-X.Y.ZZ/cluster_conf.html (for example /usr/share/doc/cman-3.0.12/cluster_conf.html).
Table B.1. HA Resource Summary
Resource Resource Agent Reference to Parameter Description
Apache apache.sh Table B.2, “Apache Server”
File System fs.sh Table B.3, “File System”
GFS2 File System clusterfs.sh Table B.4, “GFS2”
IP Address ip.sh Table B.5, “IP Address”
LVM lvm.sh Table B.6, “LVM”
MySQL mysql.sh Table B.7, “MySQL”
NFS Client nfsclient.sh Table B.8, “NFS Client”
NFS Export nfsexport.sh Table B.9, “NFS Export”
NFS/CIFS Mount netfs.sh Table B.10, “NFS/CIFS Mount”
Open LDAP openldap.sh Table B.11, “Open LDAP”
Oracle 10g oracledb.sh Table B.12, “Oracle 10g”
PostgreSQL 8 postgres-8.sh Table B.13, “PostgreSQL 8”
SAP Database SAPDatabase Table B.14, “SAP Database”
SAP Instance SAPInstance Table B.15, “SAP Instance”
Samba samba.sh Table B.16, “Samba Service”
Script script.sh Table B.17, “Script”
Service service.sh Table B.18, “Service”
Sybase ASE ASEHAagent.sh Table B.19, “Sybase ASE Failover Instance”
Tomcat 6 tomcat-6.sh Table B.20, “Tomcat 6”
Virtual Machine vm.sh Table B.21, “Virtual Machine”
NOTE: luci displays this as a virtual service if the host cluster can support virtual machines.

Table B.2. Apache Server
Field Description
Name The name of the Apache Service.
Server Root The default value is /etc/httpd.
Config File Specifies the Apache configuration file. The default valuer is /etc/httpd/conf.
httpd Options Other command line options for httpd.
Shutdown Wait (seconds) Specifies the number of seconds to wait for correct end of service shutdown.

Table B.3. File System
Field Description
Name Specifies a name for the file system resource.
File System Type If not specified, mount tries to determine the file system type.
Mount Point Path in file system hierarchy to mount this file system.
Device Specifies the device associated with the file system resource. This can be a block device, file system label, or UUID of a file system.
Options Mount options; that is, options used when the file system is mounted. These may be file-system specific. Refer to the mount(8) man page for supported mount options.
File System ID

Note

File System ID is used only by NFS services.
When creating a new file system resource, you can leave this field blank. Leaving the field blank causes a file system ID to be assigned automatically after you commit the parameter during configuration. If you need to assign a file system ID explicitly, specify it in this field.
Force unmount If enabled, forces the file system to unmount. The default setting is disabled. Force Unmount kills all processes using the mount point to free up the mount when it tries to unmount.
Reboot host node if unmount fails If enabled, reboots the node if unmounting this file system fails. The default setting is disabled.
Check file system before mounting If enabled, causes fsck to be run on the file system before mounting it. The default setting is disabled.

Table B.4. GFS2
Field Description
Name The name of the file system resource.
Mount Point The path to which the file system resource is mounted.
Device The device file associated with the file system resource.
Options Mount options.
File System ID

Note

File System ID is used only by NFS services.
When creating a new GFS2 resource, you can leave this field blank. Leaving the field blank causes a file system ID to be assigned automatically after you commit the parameter during configuration. If you need to assign a file system ID explicitly, specify it in this field.
Force Unmount If enabled, forces the file system to unmount. The default setting is disabled. Force Unmount kills all processes using the mount point to free up the mount when it tries to unmount. With GFS2 resources, the mount point is not unmounted at service tear-down unless Force Unmount is enabled.
Reboot Host Node if Unmount Fails (self fence) If enabled and unmounting the file system fails, the node will immediately reboot. Generally, this is used in conjunction with force-unmount support, but it is not required.

Table B.5. IP Address
Field Description
IP Address The IP address for the resource. This is a virtual IP address. IPv4 and IPv6 addresses are supported, as is NIC link monitoring for each IP address.
Monitor Link Enabling this causes the status check to fail if the link on the NIC to which this IP address is bound is not present.

Table B.6. LVM
Field Description
Name A unique name for this LVM resource.
Volume Group Name A descriptive name of the volume group being managed.
Logical Volume Name (optional) Name of the logical volume being managed. This parameter is optional if there is more than one logical volume in the volume group being managed.

Table B.7. MySQL
Field Description
Name Specifies a name of the MySQL server resource.
Config File Specifies the configuration file. The default value is /etc/my.cnf.
Listen Address Specifies an IP address for MySQL server. If an IP address is not provided, the first IP address from the service is taken.
mysqld Options Other command line options for httpd.
Shutdown Wait (seconds) Specifies the number of seconds to wait for correct end of service shutdown.

Table B.8. NFS Client
Field Description
Name This is a symbolic name of a client used to reference it in the resource tree. This is not the same thing as the Target option.
Target This is the server from which you are mounting. It can be specified using a hostname, a wildcard (IP address or hostname based), or a netgroup defining a host or hosts to export to.
Option Defines a list of options for this client — for example, additional client access rights. For more information, refer to the exports (5) man page, General Options.

Table B.9. NFS Export
Field Description
Name
Descriptive name of the resource. The NFS Export resource ensures that NFS daemons are running. It is fully reusable; typically, only one NFS Export resource is needed.

Tip

Name the NFS Export resource so it is clearly distinguished from other NFS resources.

Table B.10. NFS/CIFS Mount
Field Description
Name
Symbolic name for the NFS or CIFS mount.

Note

This resource is required when a cluster service is configured to be an NFS client.
Mount Point Path to which the file system resource is mounted.
Host NFS/CIFS server IP address or hostname.
NFS Export Path or CIFS share NFS Export directory name or CIFS share name.
File System type
File system type:
  • NFS — Specifies using the default NFS version. This is the default setting.
  • NFS v4 — Specifies using NFSv4 protocol.
  • CIFS — Specifies using CIFS protocol.
Options Mount options. Specifies a list of mount options. If none are specified, the file system is mounted -o sync.
Force Unmount If Force Unmount is enabled, the cluster kills all processes using this file system when the service is stopped. Killing all processes using the file system frees up the file system. Otherwise, the unmount will fail, and the service will be restarted.
No Unmount If enabled, specifies that the file system should not be unmounted during a stop or relocation operation.

Table B.11. Open LDAP
Field Description
Name Specifies a service name for logging and other purposes.
Config File Specifies an absolute path to a configuration file. The default value is /etc/openldap/slapd.conf.
URL List The default value is ldap:///.
slapd Options Other command line options for slapd.
Shutdown Wait (seconds) Specifies the number of seconds to wait for correct end of service shutdown.

Table B.12. Oracle 10g
Field Description
Instance name (SID) of Oracle instance Instance name.
Oracle user name This is the user name of the Oracle user that the Oracle AS instance runs as.
Oracle application home directory This is the Oracle (application, not user) home directory. It is configured when you install Oracle.
Virtual hostname (optional) Virtual Hostname matching the installation hostname of Oracle 10g. Note that during the start/stop of an oracledb resource, your hostname is changed temporarily to this hostname. Therefore, you should configure an oracledb resource as part of an exclusive service only.

Table B.13. PostgreSQL 8
Field Description
Name Specifies a service name for logging and other purposes.
Config File Define absolute path to configuration file. The default value is /var/lib/pgsql/data/postgresql.conf.
Postmaster User User who runs the database server because it cannot be run by root. The default value is postgres.
Postmaster Options Other command line options for postmaster.
Shutdown Wait (seconds) Specifies the number of seconds to wait for correct end of service shutdown.

Table B.14. SAP Database
Field Description
SAP Database Name Specifies a unique SAP system identifier. For example, P01.
SAP executable directory Specifies the fully qualified path to sapstartsrv and sapcontrol.
Database type Specifies one of the following database types: Oracle, DB6, or ADA.
Oracle TNS listener name Specifies Oracle TNS listener name.
ABAP stack is not installed, only Java stack is installed If you do not have an ABAP stack installed in the SAP database, enable this parameter.
J2EE instance bootstrap directory The fully qualified path the J2EE instance bootstrap directory. For example, /usr/sap/P01/J00/j2ee/cluster/bootstrap.
J2EE security store path The fully qualified path the J2EE security store directory. For example, /usr/sap/P01/SYS/global/security/lib/tools.

Table B.15. SAP Instance
Field Description
SAP Instance Name The fully qualified SAP instance name. For example, P01_DVEBMGS00_sapp01ci.
SAP executable directory The fully qualified path to sapstartsrv and sapcontrol.
Directory containing the SAP START profile The fully qualified path to the SAP START profile.
Name of the SAP START profile Specifies name of the SAP START profile.

Note

Regarding Table B.16, “Samba Service”, when creating or editing a cluster service, connect a Samba-service resource directly to the service, not to a resource within a service.
Table B.16. Samba Service
Field Description
Name Specifies the name of the Samba server.

Table B.17. Script
Field Description
Name Specifies a name for the custom user script. The script resource allows a standard LSB-compliant init script to be used to start a clustered service.
File (with path) Enter the path where this custom script is located (for example, /etc/init.d/userscript).

Table B.18. Service
Field Description
Service name Name of service. This defines a collection of resources, known as a resource group or cluster service.
Automatically start this service If enabled, this service (or resource group) is started automatically after the cluster forms a quorum. If this parameter is disabled, this service is not started automatically after the cluster forms a quorum; the service is put into the disabled state.
Run exclusive If enabled, this service (resource group) can only be relocated to run on another node exclusively; that is, to run on a node that has no other services running on it. If no nodes are available for a service to run exclusively, the service is not restarted after a failure. Additionally, other services do not automatically relocate to a node running this service as Run exclusive. You can override this option by manual start or relocate operations.
Failover Domain Defines lists of cluster members to try in the event that a service fails.
Recovery policy
Recovery policy provides the following options:
  • Disable — Disables the resource group if any component fails.
  • Relocate — Tries to restart service in another node; that is, it does not try to restart in the current node.
  • Restart — Tries to restart failed parts of this service locally (in the current node) before trying to relocate (default) to service to another node.
  • Restart-Disable — The service will be restarted in place if it fails. However, if restarting the service fails the service will be disabled instead of being moved to another host in the cluster.

Table B.19. Sybase ASE Failover Instance
Field Description
Instance Name Specifies the instance name of the Sybase ASE resource.
ASE server name The ASE server name that is configured for the HA service.
Sybase home directory The home directory of Sybase products.
Login file The full path of login file that contains the login-password pair.
Interfaces file The full path of the interfaces file that is used to start/access the ASE server.
SYBASE_ASE directory name The directory name under sybase_home where ASE products are installed.
SYBASE_OCS directory name The directory name under sybase_home where OCS products are installed. For example, ASE-15_0.
Sybase user The user who can run ASE server.
Deep probe timeout The maximum seconds to wait for the response of ASE server before determining that the server had no response while running deep probe.

Table B.20. Tomcat 6
Field Description
Name Specifies a service name for logging and other purposes.
Config File Specifies the absolute path to the configuration file. The default value is /etc/tomcat6/tomcat6.conf.
Tomcat User User who runs the Tomcat server. The default value is tomcat.
Catalina Options Other command line options for Catalina.
Catalina Base Catalina base directory (differs for each service) The default value is /usr/share/tomcat6.
Shutdown Wait (seconds) Specifies the number of seconds to wait for correct end of service shutdown. The default value is 30.

Table B.21. Virtual Machine
Field Description
Name Specifies the name of the virtual machine. When using the luci interface, you specify this as a service name.
Automatically start this virtual machine If enabled, this virtual machine is started automatically after the cluster forms a quorum. If this parameter is disabled, this virtual machine is not started automatically after the cluster forms a quorum; the virtual machine is put into the disabled state.
Run exclusive If enabled, this virtual machine can only be relocated to run on another node exclusively; that is, to run on a node that has no other virtual machines running on it. If no nodes are available for a virtual machine to run exclusively, the virtual machine is not restarted after a failure. Additionally, other virtual machines do not automatically relocate to a node running this virtual machine as Run exclusive. You can override this option by manual start or relocate operations.
Failover domain Defines lists of cluster members to try in the event that a virtual machine fails.
Recovery policy
Recovery policy provides the following options:
  • Disable — Disables the virtual machine if it fails.
  • Relocate — Tries to restart the virtual machine in another node; that is, it does not try to restart in the current node.
  • Restart — Tries to restart the virtual machine locally (in the current node) before trying to relocate (default) to virtual machine to another node.
  • Restart-Disable — The service will be restarted in place if it fails. However, if restarting the service fails the service will be disabled instead of moved to another host in the cluster.
Restart options With Restart or Restart-Disable selected as the recovery policy for a service, specifies the maximum number of restart failures before relocating or disabling the service and specifies the length of time in seconds after which to forget a restart.
Migration type Specifies a migration type of live or pause. The default setting is live.
Migration mapping
Specifies an alternate interface for migration. You can specify this when, for example, the network address used for virtual machine migration on a node differs from the address of the node used for cluster communication.
Specifying the following indicates that when you migrate a virtual machine from member to member2, you actually migrate to target2. Similarly, when you migrate from member2 to member, you migrate using target.
member:target,member2:target2
Status Program
Status program to run in addition to the standard check for the presence of a virtual machine. If specified, the status program is executed once per minute. This allows you to ascertain the status of critical services within a virtual machine. For example, if a virtual machine runs a web server, your status program could check to see whether a web server is up and running; if the status check fails (signified by returning a non-zero value), the virtual machine is recovered.
After a virtual machine is started, the virtual machine resource agent will periodically call the status program and wait for a successful return code (zero) prior to returning. This times out after five minutes.
Path to XML file used to create the VM Full path to libvirt XML file containing the libvirt domain definition.
VM configuration file path
A colon-delimited path specification that the Virtual Machine Resource Agent (vm.sh) searches for the virtual machine configuration file. For example: /mnt/guests/config:/etc/libvirt/qemu.

Important

The path should never directly point to a virtual machine configuration file.
Path to VM snapshot directory Path to the snapshot directory where the virtual machine image will be stored.
Hypervisor URI Hypervisor URI (normally automatic).
Migration URI Migration URI (normally automatic).