ocf_heartbeat_podman(7)

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           Note: Using this method for monitoring processes inside a container
70           is not recommended, as containerd tries to track processes running
71           inside the container and does not deal well with many short-lived
72           processes being spawned. Ensure that your container monitors its
73           own processes and terminates on fatal error rather than invoking a
74           command from the outside.
75
76           (optional, string, no default)
77
78       force_kill
79           Kill a container immediately rather than waiting for it to
80           gracefully shutdown
81
82           (optional, boolean, no default)
83
84       reuse
85           Allow the container to be reused once it is stopped. By default,
86           containers get removed once they are stopped. Enable this option to
87           have the particular one persist when this happens.
88
89           (optional, boolean, default 0)
90
91       drop_in_dependency
92           Use transient drop-in files to add extra dependencies to the
93           systemd scopes associated to the container. During reboot, this
94           prevents systemd to stop the container before pacemaker.
95
96           (optional, boolean, no default)
97

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

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

EXAMPLE PCS

129       The following is an example configuration for a podman resource using
130       pcs(8)
131
132           pcs resource create p_podman ocf:heartbeat:podman \
133             image=string \
134             op monitor timeout="30s" interval="30s" OCF_CHECK_LEVEL="0"
135

AUTHOR

140       ClusterLabs contributors (see the resource agent source for information
141       about individual authors)
142
143
144
145resource-agents UNKNOWN           01/25/2023           OCF_HEARTBEAT_PODMAN(7)