carta
ocf_heartbeat_dovecot(7)

ocf_heartbeat_dovecot7

Manages a highly available dovecot imap/pop3 server instance

Usage

dovecot [{start | stop | monitor | meta-data | validate-all}]

Overview

This script manages Dovecot as an OCF resource in a high-availability setup.

Supported parameters

binary

Full path to the Dovecot binary. For example, "/usr/sbin/dovecot".

(optional, string, default "/usr/sbin/dovecot")

config_file

Full path to a Dovecot configuration file. For example, "/etc/dovecot/dovecot.conf".

(unique, optional, string, no default)

pid_file

Full path to a Dovecot PID file. For example, "/var/run/dovecot/master.pid".

(unique, optional, string, default "/var/run/dovecot/master.pid")

parameters

The Dovecot daemon may be called with additional parameters. Specify any of them here.

(optional, string, no default)

Supported actions

This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

reload

Suggested minimum timeout: 20s.

monitor

Performs a detailed status check. Suggested minimum timeout: 20s. Suggested interval: 60s.

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

Example CRM shell

The following is an example configuration for a dovecot resource using the crm(8) shell:

primitive p_dovecot ocf:heartbeat:dovecot \
  op monitor depth="0" timeout="20s" interval="60s" 

Example PCS

The following is an example configuration for a dovecot resource using pcs(8)

pcs resource create p_dovecot ocf:heartbeat:dovecot \
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s" 

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)

Author

ClusterLabs contributors (see the resource agent source for information about individual authors)

From resource-agents 1:4.16.0-3+deb13u2 in Debian 13 (Trixie). Parsed by carta from the page's man source.