ocf_heartbeat_docker-compose(7)

1OCF_HEARTBEAT_DOCKER(7)       OCF resource agents      OCF_HEARTBEAT_DOCKER(7)
2
3
4

NAME

6       ocf_heartbeat_docker-compose - This script manages docker services
7       using docker-compose.
8

SYNOPSIS

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

DESCRIPTION

13       Manages docker services using docker-compose as an OCF resource in an
14       High Availability setup. It relies on a well-tested docker compose YAML
15       file which distributed on an identical location on all cluster nodes.
16
17       Caveat: 1. A YAML file (docker-compose.yml) and an optional Dockerfile
18       must be provided in a working directory. 2. It is suggested to test run
19       the docker-compose and verify on all cluster nodes before enabling this
20       agent.
21

SUPPORTED PARAMETERS

23       binpath
24           The docker-composer binary path. For example,
25           "/usr/bin/docker-compose"
26
27           (optional, string, default "/usr/bin/docker-compose")
28
29       dirpath
30           The directory contains docker compose yaml file. For example,
31           "/data/docker"
32
33           (required, string, no default)
34
35       ymlfile
36           The docker-compose yaml file. For example, "docker-compose.yml"
37
38           (optional, string, default "docker-compose.yml")
39

SUPPORTED ACTIONS

41       This resource agent supports the following actions (operations):
42
43       start
44           Starts the resource. Suggested minimum timeout: 240s.
45
46       stop
47           Stops the resource. Suggested minimum timeout: 20s.
48
49       monitor
50           Performs a detailed status check. Suggested minimum timeout: 10s.
51           Suggested interval: 60s.
52
53       validate-all
54           Performs a validation of the resource configuration. Suggested
55           minimum timeout: 5s.
56
57       meta-data
58           Retrieves resource agent metadata (internal use only). Suggested
59           minimum timeout: 5s.
60

EXAMPLE CRM SHELL

62       The following is an example configuration for a docker-compose resource
63       using the crm(8) shell:
64
65           primitive p_docker-compose ocf:heartbeat:docker-compose \
66             params \
67               dirpath=string \
68             op monitor depth="0" timeout="10s" interval="60s"
69

EXAMPLE PCS

71       The following is an example configuration for a docker-compose resource
72       using pcs(8)
73
74           pcs resource create p_docker-compose ocf:heartbeat:docker-compose \
75             dirpath=string \
76             op monitor OCF_CHECK_LEVEL="0" timeout="10s" interval="60s"
77

AUTHOR

82       ClusterLabs contributors (see the resource agent source for information
83       about individual authors)
84
85
86
87resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_DOCKER(7)