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

NAME

6       ocf_heartbeat_podman - Podman container resource agent.
7

SYNOPSIS

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

DESCRIPTION

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

SUPPORTED PARAMETERS

17       image
18           The podman 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 podman registry
30           when the image does not exist locally. NOTE, this can drastically
31           increase the time required to start the container if the image
32           repository is pulled over the network.
33
34           (optional, boolean, no default)
35
36       run_opts
37           Add options to be appended to the 'podman run' command which is
38           used when creating the container during the start action. This
39           option allows users to do things such as setting a custom entry
40           point and injecting environment variables into the newly created
41           container. Note the '-d' option is supplied regardless of this
42           value to force containers to run in the background.
43
44           NOTE: Do not explicitly specify the --name argument in the
45           run_opts. This agent will set --name using either the resource's
46           instance or the name provided in the 'name' argument of this agent.
47
48           (optional, string, no default)
49
50       run_cmd
51           Specify a command to launch within the container once it has
52           initialized.
53
54           (optional, string, no default)
55
56       mount_points
57           A comma separated list of directories that the container is
58           expecting to use. The agent will ensure they exist by running
59           'mkdir -p'
60
61           (optional, string, no default)
62
63       monitor_cmd
64           Specify the full path of a command to launch within the container
65           to check the health of the container. This command must return 0 to
66           indicate that the container is healthy. A non-zero return code will
67           indicate that the container has failed and should be recovered.
68
69           If 'podman exec' is supported, it is used to execute the command.
70           If not, nsenter is used.
71
72           Note: Using this method for monitoring processes inside a container
73           is not recommended, as containerd tries to track processes running
74           inside the container and does not deal well with many short-lived
75           processes being spawned. Ensure that your container monitors its
76           own processes and terminates on fatal error rather than invoking a
77           command from the outside.
78
79           (optional, string, no default)
80
81       force_kill
82           Kill a container immediately rather than waiting for it to
83           gracefully shutdown
84
85           (optional, boolean, no default)
86
87       reuse
88           Allow the container to be reused after stopping the container. By
89           default containers are removed after stop. With the reuse option
90           containers will persist after the container stops.
91
92           (optional, boolean, no default)
93

SUPPORTED ACTIONS

95       This resource agent supports the following actions (operations):
96
97       start
98           Starts the resource. Suggested minimum timeout: 90s.
99
100       stop
101           Stops the resource. Suggested minimum timeout: 90s.
102
103       monitor
104           Performs a detailed status check. Suggested minimum timeout: 30s.
105           Suggested interval: 30s.
106
107       meta-data
108           Retrieves resource agent metadata (internal use only). Suggested
109           minimum timeout: 5s.
110
111       validate-all
112           Performs a validation of the resource configuration. Suggested
113           minimum timeout: 30s.
114

EXAMPLE CRM SHELL

116       The following is an example configuration for a podman resource using
117       the crm(8) shell:
118
119           primitive p_podman ocf:heartbeat:podman \
120             params \
121               image=string \
122             op monitor timeout="30s" interval="30s" depth="0"
123

EXAMPLE PCS

125       The following is an example configuration for a podman resource using
126       pcs(8)
127
128           pcs resource create p_podman ocf:heartbeat:podman \
129             image=string \
130             op monitor timeout="30s" interval="30s" depth="0"
131

SEE ALSO

133       http://clusterlabs.org/
134

AUTHOR

136       ClusterLabs contributors (see the resource agent source for information
137       about individual authors)
138
139
140
141resource-agents UNKNOWN           10/24/2018           OCF_HEARTBEAT_PODMAN(7)
Impressum