Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
OCF_HEARTBEAT_LXC(7)	      OCF resource agents	  OCF_HEARTBEAT_LXC(7)

NAME
       ocf_heartbeat_lxc - Manages LXC containers

SYNOPSIS

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

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

SUPPORTED PARAMETERS
       container
	   The unique name for this 'Container Instance' e.g. 'test1'.

	   (unique, required, string, no default)

       config
	   Absolute path to the	file holding the specific configuration	for
	   this	container e.g. '/etc/lxc/test1/config'.

	   (required, string, no default)

       log
	   Absolute path to the	container log file

	   (optional, string, default
	   "/var/run/resource-agents/RESOURCE_ID.log")

       use_screen
	   Provides the	option of capturing the	'root console' from the
	   container and showing it on a separate screen. To see the screen
	   output run 'screen -r {container name}' The default value is	set to
	   'false', change to 'true' to	activate this option

	   (optional, boolean, default false)

SUPPORTED ACTIONS
       This resource agent supports the	following actions (operations):

       start
	   Starts the resource.	Suggested minimum timeout: 10s.

       stop
	   Stops the resource. Suggested minimum timeout: 30s.

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

       validate-all
	   Performs a validation of the	resource configuration.	Suggested
	   minimum timeout: 20s.

       meta-data
	   Retrieves resource agent metadata (internal use only). Suggested
	   minimum timeout: 5s.

EXAMPLE	CRM SHELL
       The following is	an example configuration for a lxc resource using the
       crm(8) shell:

	   primitive p_lxc ocf:heartbeat:lxc \
	     params \
	       container=string	\
	       config=string \
	     op	monitor	timeout="20s" interval="60s" depth="0"

EXAMPLE	PCS
       The following is	an example configuration for a lxc resource using
       pcs(8)

	   pcs resource	create p_lxc ocf:heartbeat:lxc \
	     container=string \
	     config=string \
	     op	monitor	timeout="20s" interval="60s" OCF_CHECK_LEVEL="0"

SEE ALSO
       http://clusterlabs.org/

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

resource-agents	4.13.0		  04/12/2025		  OCF_HEARTBEAT_LXC(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ocf_heartbeat_lxc&sektion=7&manpath=FreeBSD+Ports+14.3.quarterly>

home | help