'\" t
.\"     Title: ocf_heartbeat_mysql
.\"    Author: Linux-HA contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 02/03/2011
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 1.0.3
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_MYSQL" "7" "02/03/2011" "resource-agents 1.0.3" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_mysql \- Manages a MySQL database instance
.SH "SYNOPSIS"
.HP \w'\fBmysql\fR\ 'u
\fBmysql\fR [start | stop | status | monitor | validate\-all | meta\-data]
.SH "DESCRIPTION"
.PP
Resource script for MySQL\&. It manages a MySQL Database instance as an HA resource\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBbinary\fR
.RS 4
Location of the MySQL binary (optional, string, default
/usr/bin/mysqld_safe)
.RE
.PP
\fBconfig\fR
.RS 4
Configuration file (optional, string, default
/etc/mysql/my\&.cnf)
.RE
.PP
\fBdatadir\fR
.RS 4
Directory containing databases (optional, string, default
/var/lib/mysql)
.RE
.PP
\fBuser\fR
.RS 4
User running MySQL daemon (optional, string, default
mysql)
.RE
.PP
\fBgroup\fR
.RS 4
Group running MySQL daemon (for logfile and directory permissions) (optional, string, default
mysql)
.RE
.PP
\fBlog\fR
.RS 4
The logfile to be used for mysqld\&. (optional, string, default
/var/log/mysql\&.log)
.RE
.PP
\fBpid\fR
.RS 4
The pidfile to be used for mysqld\&. (optional, string, default
/var/run/mysqld/mysqld\&.pid)
.RE
.PP
\fBsocket\fR
.RS 4
The socket to be used for mysqld\&. (optional, string, default
/var/run/mysqld/mysqld\&.sock)
.RE
.PP
\fBtest_table\fR
.RS 4
Table to be tested in monitor statement (in database\&.table notation) (optional, string, default
mysql\&.user)
.RE
.PP
\fBtest_user\fR
.RS 4
MySQL test user (optional, string, default
root)
.RE
.PP
\fBtest_passwd\fR
.RS 4
MySQL test user password (optional, string, no default)
.RE
.PP
\fBenable_creation\fR
.RS 4
If the MySQL database does not exist, it will be created (optional, integer, default
0)
.RE
.PP
\fBadditional_parameters\fR
.RS 4
Additional parameters which are passed to the mysqld on startup\&. (e\&.g\&. \-\-skip\-external\-locking or \-\-skip\-grant\-tables) (optional, string, no default)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 120\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 120\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 60\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30\&. Suggested interval: 10\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5\&.
.RE
.SH "EXAMPLE"
.PP
The following is an example configuration for a mysql resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive example_mysql ocf:heartbeat:mysql \e

  op monitor depth="0" timeout="30" interval="10" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP

\m[blue]\fB\%http://www.linux-ha.org/wiki/mysql_(resource_agent)\fR\m[]
.SH "AUTHOR"
.PP
\fBLinux\-HA contributors (see the resource agent source for information about individual authors)\fR