table of contents
OCF_HEARTBEAT_DOCKER(7) | OCF resource agents | OCF_HEARTBEAT_DOCKER(7) |
NAME¶
ocf_heartbeat_docker - Docker container resource agent.SYNOPSIS¶
docker [start | stop | monitor | meta-data | validate-all]
DESCRIPTION¶
The docker HA resource agent creates and launches a docker container based off a supplied docker image. Containers managed by this agent are both created and removed upon the agent's start and stop actions.SUPPORTED PARAMETERS¶
image(required, string, no default)
name
(optional, string, no default)
allow_pull
(optional, boolean, no default)
run_opts
NOTE: Do not explicitly specify the --name argument in the run_opts. This agent will set --name using either the resource's instance or the name provided in the 'name' argument of this agent.
(optional, string, no default)
run_cmd
(optional, string, no default)
monitor_cmd
If 'docker exec' is supported, it is used to execute the command. If not, nsenter is used.
Note: Using this method for monitoring processes inside a container is not recommended, as containerd tries to track processes running inside the container and does not deal well with many short-lived processes being spawned. Ensure that your container monitors its own processes and terminates on fatal error rather than invoking a command from the outside.
(optional, string, no default)
force_kill
(optional, boolean, no default)
reuse
(optional, boolean, no default)
SUPPORTED ACTIONS¶
This resource agent supports the following actions (operations):start
stop
monitor
meta-data
validate-all
EXAMPLE CRM SHELL¶
The following is an example configuration for a docker resource using the crm(8) shell:primitive p_docker ocf:heartbeat:docker \ params \ image=string \ op monitor timeout="30" interval="30" depth="0"
EXAMPLE PCS¶
The following is an example configuration for a docker resource using pcs(8)pcs resource create p_docker ocf:heartbeat:docker \ image=string \ op monitor timeout="30" interval="30" depth="0"
SEE ALSO¶
http://clusterlabs.org/AUTHOR¶
ClusterLabs contributors (see the resource agent source for information about individual authors)06/04/2017 | resource-agents 4.0.0~rc1-4 |