ocf_heartbeat_lxc(7)

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

NAME

6       ocf_heartbeat_lxc - Manages LXC containers
7

SYNOPSIS

9       lxc [start | stop | monitor | meta-data | validate-all]
10

DESCRIPTION

12       Allows LXC containers to be managed by the cluster. Notes for lxc
13       Versions before 1.0.0, where the Container is stopped using kill -PWR
14       instead of lxc-stop: It is 'assumed' that the 'init' system will do an
15       orderly shudown if presented with a 'kill -PWR' signal. On a 'sysvinit'
16       this would require the container to have an inittab file containing
17       "p0::powerfail:/sbin/init 0"
18

SUPPORTED PARAMETERS

20       container
21           The unique name for this 'Container Instance' e.g. 'test1'.
22
23           (unique, required, string, no default)
24
25       config
26           Absolute path to the file holding the specific configuration for
27           this container e.g. '/etc/lxc/test1/config'.
28
29           (required, string, no default)
30
31       log
32           Absolute path to the container log file
33
34           (optional, string, default "/run/resource-agents/RESOURCE_ID.log")
35
36       use_screen
37           Provides the option of capturing the 'root console' from the
38           container and showing it on a separate screen. To see the screen
39           output run 'screen -r {container name}' The default value is set to
40           'false', change to 'true' to activate this option
41
42           (optional, boolean, default false)
43

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

66       The following is an example configuration for a lxc resource using the
67       crm(8) shell:
68
69           primitive p_lxc ocf:heartbeat:lxc \
70             params \
71               container=string \
72               config=string \
73             op monitor timeout="20s" interval="60s" depth="0"
74

EXAMPLE PCS

76       The following is an example configuration for a lxc resource using
77       pcs(8)
78
79           pcs resource create p_lxc ocf:heartbeat:lxc \
80             container=string \
81             config=string \
82             op monitor timeout="20s" interval="60s" OCF_CHECK_LEVEL="0"
83

AUTHOR

88       ClusterLabs contributors (see the resource agent source for information
89       about individual authors)
90
91
92
93resource-agents UNKNOWN           10/11/2023              OCF_HEARTBEAT_LXC(7)