ocf_heartbeat_redis (7) - Linux Manuals

ocf_heartbeat_redis: Redis server

Command to display ocf_heartbeat_redis manual in Linux: $ man 7 ocf_heartbeat_redis

NAME

ocf_heartbeat_redis - Redis server

SYNOPSIS

redis [start | stop | status | monitor | promote | demote | meta-data | validate-all]

DESCRIPTION

Resource agent script for redis server.

This resource fully supports master/slave replication. The master preference of a node is determined by the 'slave_priority' parameter of the redis config. When taking the resource from 'unmanaged' to 'managed', the currently active master will be given a priority of 1000 (plus 1 for each active connection). The default 'slave_priority' is 100, so the master will stay master. For a slave to become master after converting the resource to managed, set a slave_priority greater than 1000.

SUPPORTED PARAMETERS

bin

: Path to `redis-server`
(optional, string, default "/usr/bin/redis-server")

client_bin

: Path to `redis-cli`
(optional, string, default "/usr/bin/redis-cli")

config

: Path to 'redis.conf'
(unique, optional, string, default "/etc/redis/redis.conf")

user

: User to run redis as
(optional, string, default "redis")

rundir

: Directory to store socket and pid file in
(unique, optional, string, default "/var/run/redis")

pidfile_name

: The filename to use for the pidfile. Will be created in the rundir. Should only be a basename, not a full path.
(optional, string, default "redis-server.pid")

socket_name

: The filename to use for the socket. Will be crated in the rundir. Should only be a basename, not a full path.
(optional, string, default "redis.sock")

port

: Port for replication client to connect to on remote server
(optional, string, default "6379")

wait_last_known_master

: During redis cluster bootstrap, wait for the last known master to be promoted before allowing any other instances in the cluster to be promoted. This lessens the risk of data loss when persistent data is in use.
(optional, boolean, default false)

SUPPORTED ACTIONS

This resource agent supports the following actions (operations):

start

: Starts the resource. Suggested minimum timeout: 120.

stop

: Stops the resource. Suggested minimum timeout: 120.

status

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

monitor

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

monitor (Master role)

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

monitor (Slave role)

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

promote

: Promotes the resource to the Master role. Suggested minimum timeout: 120.

demote

: Demotes the resource to the Slave role. Suggested minimum timeout: 120.

notify

: Suggested minimum timeout: 90.

validate-all

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

meta-data

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

EXAMPLE CRM SHELL

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

primitive p_redis ocf:heartbeat:redis \
  op monitor depth="0" timeout="60" interval="45" \
  op monitor role="Master" depth="0" timeout="60" interval="20" \
  op monitor role="Slave" depth="0" timeout="60" interval="60"

ms ms_redis p_redis \
  meta notify="true" interleave="true"

EXAMPLE PCS

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

pcs resource create p_redis ocf:heartbeat:redis \
  op monitor depth="0" timeout="60" interval="45" \
  op monitor role="Master" depth="0" timeout="60" interval="20" \
  op monitor role="Slave" depth="0" timeout="60" interval="60" --master

AUTHOR

Linux-HA contributors (see the resource agent source for information about individual authors)