OCF_HEARTBEAT_DOCKER(7)

💖 NAME 💖

okay bestie, welcome to OCF_HEARTBEAT_DOCKER(7) from the OCF resource agents manual — this is literally the ocf_heartbeat_docker-compose page 🫶

• ocf_heartbeat_docker-compose — this script manages docker services using docker-compose.

✨ SYNOPSIS ✨

the group-chat summoning spell is:

docker-compose [start | stop | monitor | meta-data | validate-all]

🌸 DESCRIPTION 🌸

so this agent manages docker services using docker-compose as an OCF resource in a High Availability setup. It relies on a well-tested docker compose YAML file that’s distributed on an identical location on all cluster nodes.

Caveat, bestie, read this twice: 1. A YAML file (docker-compose.yml) and an optional Dockerfile must be provided in a working directory. 2. It is suggested to test run the docker-compose and verify on all cluster nodes before enabling this agent. 💅

🎀 SUPPORTED PARAMETERS 🎀

• binpath — the docker-composer binary path. For example, "/usr/bin/docker-compose". It’s (optional, string, default "/usr/bin/docker-compose").
• dirpath — the directory contains the docker compose yaml file. For example, "/data/docker". It’s (required, string, no default).
• ymlfile — the docker-compose yaml file. For example, "docker-compose.yml". It’s (optional, string, default "docker-compose.yml").

🔥 SUPPORTED ACTIONS 🔥

This resource agent supports the following actions (operations), bestie:

• start — starts the resource. Suggested minimum timeout: 240s.
• stop — stops the resource. Suggested minimum timeout: 20s.
• monitor — performs a detailed status check. Suggested minimum timeout: 10s. Suggested interval: 60s.
• validate-all — performs a validation of the resource configuration. Suggested minimum timeout: 5s.
• meta-data — retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

👑 EXAMPLE CRM SHELL 👑

Here’s an example configuration for a docker-compose resource using the crm(8) shell:

           primitive p_docker-compose ocf:heartbeat:docker-compose \
             params \
               dirpath=string \
             op monitor depth="0" timeout="10s" interval="60s"

🦋 EXAMPLE PCS 🦋

Here’s an example configuration for a docker-compose resource using pcs(8):

           pcs resource create p_docker-compose ocf:heartbeat:docker-compose \
             dirpath=string \
             op monitor OCF_CHECK_LEVEL="0" timeout="10s" interval="60s"

🌈 SEE ALSO 🌈

• http://clusterlabs.org/

⭐ AUTHOR ⭐

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

---

kisses and good vibes 💖 this page is from resource-agents UNKNOWN, dated 10/01/2026, and it’s OCF_HEARTBEAT_DOCKER(7). slay, bestie 🫶