blob: 38734eb49c6468bc9e86eb16ed0a0b5b750e6cc6 [file] [log] [blame]
Filip Pytlounda2a0792015-10-06 16:28:31 +02001==============================
2Openstack Cinder Block Storage
3==============================
4
Jakub Pavlikb513f132016-05-20 11:11:19 +02005Cinder provides an infrastructure for managing volumes in OpenStack. It was
6originally a Nova component called nova-volume, but has become an independent
7project since the Folsom release.
Filip Pytlounda2a0792015-10-06 16:28:31 +02008
9Sample pillars
10==============
11
Jakub Pavlikb513f132016-05-20 11:11:19 +020012New structure divides cinder-api,cinder-scheduler to role controller and
13cinder-volume to role volume.
Filip Pytlounda2a0792015-10-06 16:28:31 +020014
15.. code-block:: yaml
16
17 cinder:
18 controller:
19 enabled: true
20 version: juno
Jakub Pavlikaf96c2a2016-01-08 15:49:54 +010021 default_volume_type: 7k2SaS
Filip Pytlounda2a0792015-10-06 16:28:31 +020022 database:
23 engine: mysql
24 host: 127.0.0.1
25 port: 3306
26 name: cinder
27 user: cinder
28 password: pwd
29 identity:
30 engine: keystone
31 host: 127.0.0.1
32 port: 35357
33 tenant: service
34 user: cinder
35 password: pwd
36 message_queue:
37 engine: rabbitmq
38 host: 127.0.0.1
39 port: 5672
40 user: openstack
41 password: pwd
42 virtual_host: '/openstack'
Jakub Pavlikaf96c2a2016-01-08 15:49:54 +010043 backend:
44 7k2_SAS:
45 engine: storwize
Jakub Pavlikedd46102016-01-08 16:20:38 +010046 type_name: slow-disks
Jakub Pavlikaf96c2a2016-01-08 15:49:54 +010047 host: 192.168.0.1
48 port: 22
49 user: username
50 password: pass
51 connection: FC/iSCSI
52 multihost: true
53 multipath: true
54 pool: SAS7K2
Filip Pytlounda2a0792015-10-06 16:28:31 +020055
56 cinder:
57 volume:
58 enabled: true
59 version: juno
Jakub Pavlikaf96c2a2016-01-08 15:49:54 +010060 default_volume_type: 7k2SaS
Filip Pytlounda2a0792015-10-06 16:28:31 +020061 database:
62 engine: mysql
63 host: 127.0.0.1
64 port: 3306
65 name: cinder
66 user: cinder
67 password: pwd
68 identity:
69 engine: keystone
70 host: 127.0.0.1
71 port: 35357
72 tenant: service
73 user: cinder
74 password: pwd
75 message_queue:
76 engine: rabbitmq
77 host: 127.0.0.1
78 port: 5672
79 user: openstack
80 password: pwd
81 virtual_host: '/openstack'
Jakub Pavlikaf96c2a2016-01-08 15:49:54 +010082 backend:
83 7k2_SAS:
84 engine: storwize
Jakub Pavlikedd46102016-01-08 16:20:38 +010085 type_name: 7k2 SAS disk
Jakub Pavlikaf96c2a2016-01-08 15:49:54 +010086 host: 192.168.0.1
87 port: 22
88 user: username
89 password: pass
90 connection: FC/iSCSI
91 multihost: true
92 multipath: true
93 pool: SAS7K2
Jiri Konecny2dce35f2016-04-19 16:29:52 +020094 w
95
96Client-side RabbitMQ HA setup for controller
97
98.. code-block:: yaml
99
100 cinder:
101 controller:
102 ....
103 message_queue:
104 engine: rabbitmq
105 members:
106 - host: 10.0.16.1
107 - host: 10.0.16.2
108 - host: 10.0.16.3
109 user: openstack
110 password: pwd
111 virtual_host: '/openstack'
112 ....
113
114Client-side RabbitMQ HA setup for volume component
115
116.. code-block:: yaml
117
118 cinder:
119 volume:
120 ....
121 message_queue:
122 engine: rabbitmq
123 members:
124 - host: 10.0.16.1
125 - host: 10.0.16.2
126 - host: 10.0.16.3
127 user: openstack
128 password: pwd
129 virtual_host: '/openstack'
130 ....
Filip Pytlounda2a0792015-10-06 16:28:31 +0200131
132Cinder setup with zeroing deleted volumes
133
134 cinder:
135 controller:
136 enabled: true
137 wipe_method: zero
138 ...
139
140Cinder setup with shreding deleted volumes
141
142.. code-block:: yaml
143
144 cinder:
145 controller:
146 enabled: true
147 wipe_method: shred
148 ...
149
150
151Default Cinder setup with iSCSI target
152
153.. code-block:: yaml
154
155 cinder:
156 controller:
157 enabled: true
Jakub Pavlik3d437df2016-04-11 22:07:50 +0200158 version: mitaka
159 default_volume_type: lvmdriver-1
Filip Pytlounda2a0792015-10-06 16:28:31 +0200160 database:
161 engine: mysql
162 host: 127.0.0.1
163 port: 3306
164 name: cinder
165 user: cinder
166 password: pwd
167 identity:
168 engine: keystone
169 host: 127.0.0.1
170 port: 35357
171 tenant: service
172 user: cinder
173 password: pwd
174 message_queue:
175 engine: rabbitmq
176 host: 127.0.0.1
177 port: 5672
178 user: openstack
179 password: pwd
180 virtual_host: '/openstack'
Jakub Pavlikaf96c2a2016-01-08 15:49:54 +0100181 backend:
Jakub Pavlik3d437df2016-04-11 22:07:50 +0200182 lvmdriver-1:
183 engine: lvm
184 type_name: lvmdriver-1
185 volume_group: cinder-volume
Filip Pytlounda2a0792015-10-06 16:28:31 +0200186
Ales Komarekdf13bbd2016-01-05 21:33:36 +0100187Cinder setup for IBM Storwize
Filip Pytlounda2a0792015-10-06 16:28:31 +0200188
189.. code-block:: yaml
190
191 cinder:
Ales Komarekdf13bbd2016-01-05 21:33:36 +0100192 volume:
Filip Pytlounda2a0792015-10-06 16:28:31 +0200193 enabled: true
Ales Komarekdf13bbd2016-01-05 21:33:36 +0100194 backend:
195 7k2_SAS:
196 engine: storwize
Jakub Pavlikedd46102016-01-08 16:20:38 +0100197 type_name: 7k2 SAS disk
Ales Komarekdf13bbd2016-01-05 21:33:36 +0100198 host: 192.168.0.1
199 port: 22
200 user: username
201 password: pass
202 connection: FC/iSCSI
203 multihost: true
204 multipath: true
205 pool: SAS7K2
206 10k_SAS:
207 engine: storwize
Jakub Pavlikedd46102016-01-08 16:20:38 +0100208 type_name: 10k SAS disk
Ales Komarekdf13bbd2016-01-05 21:33:36 +0100209 host: 192.168.0.1
210 port: 22
211 user: username
212 password: pass
213 connection: FC/iSCSI
214 multihost: true
215 multipath: true
216 pool: SAS10K
217 15k_SAS:
218 engine: storwize
Jakub Pavlikedd46102016-01-08 16:20:38 +0100219 type_name: 15k SAS
Ales Komarekdf13bbd2016-01-05 21:33:36 +0100220 host: 192.168.0.1
221 port: 22
222 user: username
223 password: pass
224 connection: FC/iSCSI
225 multihost: true
226 multipath: true
227 pool: SAS15K
Filip Pytlounda2a0792015-10-06 16:28:31 +0200228
229Cinder setup with Hitachi VPS
230
231.. code-block:: yaml
232
233 cinder:
234 controller:
235 enabled: true
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100236 backend:
237 hus100_backend:
marcodaa52fa2016-01-25 23:49:50 +0100238 type_name: HUS100
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100239 backend: hus100_backend
240 engine: hitachi_vsp
241 connection: FC
Filip Pytlounda2a0792015-10-06 16:28:31 +0200242
243Cinder setup with CEPH
244
245.. code-block:: yaml
246
247 cinder:
248 controller:
249 enabled: true
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100250 backend:
251 ceph_backend:
Jakub Pavlikedd46102016-01-08 16:20:38 +0100252 type_name: standard-iops
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100253 backend: ceph_backend
254 pool: volumes
255 engine: ceph
256 user: cinder
257 secret_uuid: da74ccb7-aa59-1721-a172-0006b1aa4e3e
258 client_cinder_key: AQDOavlU6BsSJhAAnpFR906mvdgdfRqLHwu0Uw==
Filip Pytlounda2a0792015-10-06 16:28:31 +0200259
260http://ceph.com/docs/master/rbd/rbd-openstack/
261
262
263Cinder setup with HP3par
264
265.. code-block:: yaml
266
267 cinder:
268 controller:
269 enabled: true
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100270 backend:
271 hp3par_backend:
Jakub Pavlikedd46102016-01-08 16:20:38 +0100272 type_name: hp3par
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100273 backend: hp3par_backend
274 user: hp3paruser
275 password: something
276 url: http://10.10.10.10/api/v1
277 cpg: OpenStackCPG
278 host: 10.10.10.10
279 login: hp3paradmin
280 sanpassword: something
281 debug: True
282 snapcpg: OpenStackSNAPCPG
Filip Pytlounda2a0792015-10-06 16:28:31 +0200283
284Cinder setup with Fujitsu Eternus
285
286.. code-block:: yaml
287
288 cinder:
289 volume:
290 enabled: true
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100291 backend:
292 10kThinPro:
Jakub Pavlikedd46102016-01-08 16:20:38 +0100293 type_name: 10kThinPro
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100294 engine: fujitsu
295 pool: 10kThinPro
296 host: 192.168.0.1
297 port: 5988
298 user: username
299 password: pass
300 connection: FC/iSCSI
marcodaa52fa2016-01-25 23:49:50 +0100301 name: 10kThinPro
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100302 10k_SAS:
Jakub Pavlikedd46102016-01-08 16:20:38 +0100303 type_name: 10k_SAS
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100304 pool: SAS10K
305 engine: fujitsu
306 host: 192.168.0.1
307 port: 5988
308 user: username
309 password: pass
310 connection: FC/iSCSI
marcodaa52fa2016-01-25 23:49:50 +0100311 name: 10k_SAS
Filip Pytlounda2a0792015-10-06 16:28:31 +0200312
Jakub Pavlik9703c602015-10-15 18:52:47 +0200313Cinder setup with IBM GPFS filesystem
314
315.. code-block:: yaml
316
317 cinder:
318 volume:
319 enabled: true
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100320 backend:
321 GPFS-GOLD:
Jakub Pavlikedd46102016-01-08 16:20:38 +0100322 type_name: GPFS-GOLD
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100323 engine: gpfs
324 mount_point: '/mnt/gpfs-openstack/cinder/gold'
marcodaa52fa2016-01-25 23:49:50 +0100325 GPFS-SILVER:
Jakub Pavlikedd46102016-01-08 16:20:38 +0100326 type_name: GPFS-SILVER
Jakub Pavlik5d7df0d2016-01-06 13:08:30 +0100327 engine: gpfs
328 mount_point: '/mnt/gpfs-openstack/cinder/silver'
Jakub Pavlik9f5988a2016-01-11 13:44:57 +0100329
330Cinder setup with HP LeftHand
331
332.. code-block:: yaml
333
334 cinder:
335 volume:
336 enabled: true
337 backend:
338 HP-LeftHand:
339 type_name: normal-storage
340 engine: hp_lefthand
341 api_url: 'https://10.10.10.10:8081/lhos'
342 username: user
343 password: password
344 clustername: cluster1
345 iscsi_chap_enabled: false
346
Jakub Pavlika63764f2016-01-11 14:41:06 +0100347Extra parameters for HP LeftHand
Jakub Pavlika63764f2016-01-11 14:41:06 +0100348
Jakub Pavlik5050dda2016-01-11 16:52:32 +0100349.. code-block:: yaml
350
351 cinder type-key normal-storage set hplh:data_pl=r-10-2 hplh:provisioning=full
352
marcodaa52fa2016-01-25 23:49:50 +0100353Cinder setup with Solidfire
Jakub Pavlik5050dda2016-01-11 16:52:32 +0100354
355.. code-block:: yaml
356
357 cinder:
358 volume:
359 enabled: true
360 backend:
361 solidfire:
362 type_name: normal-storage
363 engine: solidfire
364 san_ip: 10.10.10.10
365 san_login: user
366 san_password: password
367 clustername: cluster1
368 sf_emulate_512: false
Filip Pytlounda2a0792015-10-06 16:28:31 +0200369
Jakub Pavlikb513f132016-05-20 11:11:19 +0200370Documentation and Bugs
371============================
372
373To learn how to deploy OpenStack Salt, consult the documentation available
374online at:
375
376 https://wiki.openstack.org/wiki/OpenStackSalt
377
378In the unfortunate event that bugs are discovered, they should be reported to
379the appropriate bug tracker. If you obtained the software from a 3rd party
380operating system vendor, it is often wise to use their own bug tracker for
381reporting problems. In all other cases use the master OpenStack bug tracker,
382available at:
383
384 http://bugs.launchpad.net/openstack-salt
385
386Developers wishing to work on the OpenStack Salt project should always base
387their work on the latest formulas code, available from the master GIT
388repository at:
389
390 https://git.openstack.org/cgit/openstack/salt-formula-cinder
391
392Developers should also join the discussion on the IRC list, at:
393
394 https://wiki.openstack.org/wiki/Meetings/openstack-salt