ocf_heartbeat_openstack-cinder-volume(7)

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

NAME

6       ocf_heartbeat_openstack-cinder-volume - Attach a cinder volume
7

SYNOPSIS

9       openstack-cinder-volume [start | stop | monitor | meta-data |
10                               validate-all]
11

DESCRIPTION

13       Resource Agent to attach a cinder volume to an instance. It relies on
14       attributes given by openstack-info resource agent (openstack_id
15       attribute).
16

SUPPORTED PARAMETERS

18       openstackcli
19           Path to command line tools for openstack.
20
21           (optional, string, default "/usr/bin/openstack")
22
23       node_id_cache_file
24           Path to Node ID cache file, used to avoid Openstack API calls: 1.
25           Is the local file written? 2. Is openstack_id available as a node
26           attribute? 3. Can we get it from the API?
27
28           (optional, string, default "/run/resource-agents/node_id")
29
30       volume_local_check
31           This option allows the cluster to monitor the cinder volume
32           presence without calling the API.
33
34           (optional, boolean, default true)
35
36       openrc
37           Valid Openstack credentials as openrc file from api_access/openrc.
38
39           (required, string, no default)
40
41       volume_id
42           Cinder volume identifier to use to attach the bloc storage.
43
44           (required, string, no default)
45

SUPPORTED ACTIONS

47       This resource agent supports the following actions (operations):
48
49       start
50           Starts the resource. Suggested minimum timeout: 180s.
51
52       stop
53           Stops the resource. Suggested minimum timeout: 180s.
54
55       monitor
56           Performs a detailed status check. Suggested minimum timeout: 30s.
57           Suggested interval: 60s.
58
59       validate-all
60           Performs a validation of the resource configuration. Suggested
61           minimum timeout: 5s.
62
63       meta-data
64           Retrieves resource agent metadata (internal use only). Suggested
65           minimum timeout: 5s.
66

EXAMPLE CRM SHELL

68       The following is an example configuration for a openstack-cinder-volume
69       resource using the crm(8) shell:
70
71           primitive p_openstack-cinder-volume ocf:heartbeat:openstack-cinder-volume \
72             params \
73               openrc=string \
74               volume_id=string \
75             op monitor depth="0" timeout="30s" interval="60s"
76

EXAMPLE PCS

78       The following is an example configuration for a openstack-cinder-volume
79       resource using pcs(8)
80
81           pcs resource create p_openstack-cinder-volume ocf:heartbeat:openstack-cinder-volume \
82             openrc=string \
83             volume_id=string \
84             op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="60s"
85

AUTHOR

90       ClusterLabs contributors (see the resource agent source for information
91       about individual authors)
92
93
94
95resource-agents UNKNOWN           03/25/2021           OCF_HEARTBEAT_OPENST(7)