ocf_heartbeat_rkt(7)

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

NAME

6       ocf_heartbeat_rkt - rkt container resource agent.
7

SYNOPSIS

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

DESCRIPTION

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

SUPPORTED PARAMETERS

17       image
18           The image to base this container off of.
19
20           (required, string, no default)
21
22       name
23           The name to give the created container. By default this will be
24           that resource's instance name.
25
26           (optional, string, no default)
27
28       allow_pull
29           Allow the image to be pulled from the configured registry when the
30           image does not exist locally. NOTE, this can drastically increase
31           the time required to start the container if the image repository is
32           pulled over the network.
33
34           (optional, boolean, no default)
35
36       run_opts
37           Add options to be appended to the 'rkt run' command which is used
38           when creating the container during the start action. This option
39           allows users to do things such as setting a custom entry point and
40           injecting environment variables into the newly created container.
41
42           NOTE: Do not explicitly specify the --name argument in the
43           run_opts. This agent will set --name using either the resource's
44           instance or the name provided in the 'name' argument of this agent.
45
46           (optional, string, no default)
47
48       run_cmd
49           Specify a command to launch within the container once it has
50           initialized.
51
52           (optional, string, no default)
53
54       mount_points
55           A comma separated list of directories that the container is
56           expecting to use. The agent will ensure they exist by running
57           'mkdir -p'
58
59           (optional, string, no default)
60
61       monitor_cmd
62           Specify the full path of a command to launch within the container
63           to check the health of the container. This command must return 0 to
64           indicate that the container is healthy. A non-zero return code will
65           indicate that the container has failed and should be recovered.
66
67           Note: Using this method for monitoring processes inside a container
68           is not recommended, as rkt tries to track processes running inside
69           the container and does not deal well with many short-lived
70           processes being spawned. Ensure that your container monitors its
71           own processes and terminates on fatal error rather than invoking a
72           command from the outside.
73
74           (optional, string, no default)
75
76       force_kill
77           Kill a container immediately rather than waiting for it to
78           gracefully shutdown
79
80           (optional, boolean, no default)
81

SUPPORTED ACTIONS

83       This resource agent supports the following actions (operations):
84
85       start
86           Starts the resource. Suggested minimum timeout: 90s.
87
88       stop
89           Stops the resource. Suggested minimum timeout: 90s.
90
91       monitor
92           Performs a detailed status check. Suggested minimum timeout: 30s.
93           Suggested interval: 30s.
94
95       meta-data
96           Retrieves resource agent metadata (internal use only). Suggested
97           minimum timeout: 5s.
98
99       validate-all
100           Performs a validation of the resource configuration. Suggested
101           minimum timeout: 30s.
102

EXAMPLE CRM SHELL

104       The following is an example configuration for a rkt resource using the
105       crm(8) shell:
106
107           primitive p_rkt ocf:heartbeat:rkt \
108             params \
109               image=string \
110             op monitor timeout="30s" interval="30s" depth="0"
111

EXAMPLE PCS

113       The following is an example configuration for a rkt resource using
114       pcs(8)
115
116           pcs resource create p_rkt ocf:heartbeat:rkt \
117             image=string \
118             op monitor timeout="30s" interval="30s" OCF_CHECK_LEVEL="0"
119

AUTHOR

124       ClusterLabs contributors (see the resource agent source for information
125       about individual authors)
126
127
128
129resource-agents UNKNOWN           10/11/2023              OCF_HEARTBEAT_RKT(7)