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       cloud
19           Openstack cloud (from ~/.config/openstack/clouds.yaml or
20           /etc/openstack/clouds.yaml).
21
22           (optional, string, no default)
23
24       openrc
25           Openstack credentials as openrc file from api_access/openrc.
26
27           (optional, string, no default)
28
29       auth_url
30           Keystone Auth URL
31
32           (optional, string, no default)
33
34       username
35           Username.
36
37           (optional, string, no default)
38
39       password
40           Password.
41
42           (optional, string, no default)
43
44       project_name
45           Keystone Project.
46
47           (optional, string, no default)
48
49       user_domain_name
50           Keystone User Domain Name.
51
52           (optional, string, default "Default")
53
54       project_domain_name
55           Keystone Project Domain Name.
56
57           (optional, string, default "Default")
58
59       openstackcli
60           Path to command line tools for openstack.
61
62           (optional, string, default "/usr/bin/openstack")
63
64       insecure
65           Allow insecure connections
66
67           (optional, boolean, default false)
68
69       volume_local_check
70           This option allows the cluster to monitor the cinder volume
71           presence without calling the API.
72
73           (optional, boolean, default true)
74
75       volume_id
76           Cinder volume identifier to use to attach the block storage.
77
78           (required, string, no default)
79

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

102       The following is an example configuration for a openstack-cinder-volume
103       resource using the crm(8) shell:
104
105           primitive p_openstack-cinder-volume ocf:heartbeat:openstack-cinder-volume \
106             params \
107               volume_id=string \
108             op monitor depth="0" timeout="180s" interval="60s"
109

EXAMPLE PCS

111       The following is an example configuration for a openstack-cinder-volume
112       resource using pcs(8)
113
114           pcs resource create p_openstack-cinder-volume ocf:heartbeat:openstack-cinder-volume \
115             volume_id=string \
116             op monitor OCF_CHECK_LEVEL="0" timeout="180s" interval="60s"
117

AUTHOR

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