NAME

       ocf_heartbeat_rkt - rkt container resource agent.

SYNOPSIS

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

DESCRIPTION

       The rkt HA resource agent creates and launches a container based off a supplied image.
       Containers managed by this agent are both created and removed upon the agent's start and
       stop actions.

SUPPORTED PARAMETERS

       image
           The image to base this container off of.

           (required, string, no default)

       name
           The name to give the created container. By default this will be that resource's
           instance name.

           (optional, string, no default)

       allow_pull
           Allow the image to be pulled from the configured registry when the image does not
           exist locally. NOTE, this can drastically increase the time required to start the
           container if the image repository is pulled over the network.

           (optional, boolean, no default)

       run_opts
           Add options to be appended to the 'rkt run' command which is used when creating the
           container during the start action. This option allows users to do things such as
           setting a custom entry point and injecting environment variables into the newly
           created container.

           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
           Specify a command to launch within the container once it has initialized.

           (optional, string, no default)

       mount_points
           A comma separated list of directories that the container is expecting to use. The
           agent will ensure they exist by running 'mkdir -p'

           (optional, string, no default)

       monitor_cmd
           Specify the full path of a command to launch within the container to check the health
           of the container. This command must return 0 to indicate that the container is
           healthy. A non-zero return code will indicate that the container has failed and should
           be recovered.

           Note: Using this method for monitoring processes inside a container is not
           recommended, as rkt 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
           Kill a container immediately rather than waiting for it to gracefully shutdown

           (optional, boolean, no default)

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

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

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

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

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

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

EXAMPLE CRM SHELL

       The following is an example configuration for a rkt resource using the crm(8) shell:

           primitive p_rkt ocf:heartbeat:rkt \
             params \
               image=string \
             op monitor timeout="30s" interval="30s" depth="0"

EXAMPLE PCS

       The following is an example configuration for a rkt resource using pcs(8)

           pcs resource create p_rkt ocf:heartbeat:rkt \
             image=string \
             op monitor timeout="30s" interval="30s" OCF_CHECK_LEVEL="0"

SEE ALSO

       http://clusterlabs.org/

AUTHOR

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