ocf_heartbeat_Stateful - Man Page

Example stateful resource agent

Synopsis

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

Description

This is an example resource agent that implements two states

Supported Parameters

state

Location to store the resource state in

(unique, optional, string, default "/run/resource-agents/Stateful-RESOURCE_ID.state")

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.

promote

Promotes the resource to the Master role. Suggested minimum timeout: 20s.

demote

Demotes the resource to the Slave role. Suggested minimum timeout: 20s.

monitor

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

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: 20s.

Example CRM Shell

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

primitive p_Stateful ocf:heartbeat:Stateful \
  op monitor depth="0" timeout="20s" interval="10s"
ms ms_Stateful p_Stateful \
  meta notify="true" interleave="true"

Example PCS

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

pcs resource create p_Stateful ocf:heartbeat:Stateful \
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s" promotable

See Also

http://clusterlabs.org/

Author

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

Info

07/26/2024 resource-agents UNKNOWN OCF resource agents