ocf_heartbeat_syslog-ng man page

ocf_heartbeat_syslog-ng ā€” Syslog-ng resource agent

Synopsis

syslog-ng [start | stop | status | monitor | meta-data | validate-all]

Description

This script manages a syslog-ng instance as an HA resource.

For Premium Edition you should set the following parameters (based on default path being "/opt/syslog-ng"): syslog_ng_binary="/opt/syslog-ng/sbin/syslog-ng" syslog_ng_ctl="/opt/syslog-ng/sbin/syslog-ng-ctl" control_file="/opt/syslog-ng/var/run/syslog-ng.ctl" persist_file="/opt/syslog-ng/var/syslog-ng.persist" pidfile="/opt/syslog-ng/var/run/syslog-ng.pid"

Additional parameter for Premium Edition 6 only: qdisk_dir="/opt/syslog-ng/var/"

Supported Parameters

configfile

This parameter specifies a configuration file for a syslog-ng instance managed by this RA.

(required, string, no default)

syslog_ng_binary

This parameter specifies syslog-ng's executable file.

(optional, string, default "/sbin/syslog-ng")

syslog_ng_ctl

This parameter specifies the path of the syslog-ng-ctl executable file.

(optional, string, default "/sbin/syslog-ng-ctl")

qdisk_dir

This parameter specifies the directory used for holding disk buffers of syslog-ng (only supported in Premium Edition 6).

(optional, string, no default)

control_file

This parameter specifies the path, where syslog-ng would place its control socket, through which it can be controlled.

(optional, string, no default)

persist_file

This parameter specifies the path for syslog-ng's persist file, which holds persistent information about the mapping of destinations and disk buffers, the internal state of sources, etc.

(optional, string, no default)

pidfile

This parameter specifies the path where the pid file of syslog-ng resides.

(optional, string, no default)

start_opts

This parameter specifies startup options for a syslog-ng instance managed by this RA. When no value is given, no startup options is used. Don't use option '-F'. It causes a stuck of a start action.

(optional, string, no default)

kill_term_timeout

On a stop action, a normal stop method(pkill -TERM) is firstly used. And then the confirmation of its completion is waited for the specified seconds by this parameter. The default value is 10.

(optional, integer, default 10)

Supported Actions

This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 60s.

stop

Stops the resource. Suggested minimum timeout: 120s.

status

Performs a status check. Suggested minimum timeout: 60s.

monitor

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

meta-data

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

validate-all

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

Example CRM Shell

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

primitive p_syslog-ng ocf:heartbeat:syslog-ng \
  params \
    configfile=string \
  op monitor depth="0" timeout="60s" interval="60s" 

Example PCS

The following is an example configuration for a syslog-ng resource using pcs(8)

pcs resource create p_syslog-ng ocf:heartbeat:syslog-ng \
  configfile=string \
  op monitor depth="0" timeout="60s" interval="60s" 

See Also

http://clusterlabs.org/

Author

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

Info

10/24/2018 resource-agents UNKNOWN OCF resource agents