Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 1 | ============================== |
| 2 | Openstack Cinder Block Storage |
| 3 | ============================== |
| 4 | |
Jakub Pavlik | b513f13 | 2016-05-20 11:11:19 +0200 | [diff] [blame] | 5 | Cinder provides an infrastructure for managing volumes in OpenStack. It was |
| 6 | originally a Nova component called nova-volume, but has become an independent |
| 7 | project since the Folsom release. |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 8 | |
| 9 | Sample pillars |
| 10 | ============== |
| 11 | |
Jakub Pavlik | b513f13 | 2016-05-20 11:11:19 +0200 | [diff] [blame] | 12 | New structure divides cinder-api,cinder-scheduler to role controller and |
| 13 | cinder-volume to role volume. |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 14 | |
| 15 | .. code-block:: yaml |
| 16 | |
| 17 | cinder: |
| 18 | controller: |
| 19 | enabled: true |
| 20 | version: juno |
Jakub Pavlik | af96c2a | 2016-01-08 15:49:54 +0100 | [diff] [blame] | 21 | default_volume_type: 7k2SaS |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 22 | 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 Pavlik | af96c2a | 2016-01-08 15:49:54 +0100 | [diff] [blame] | 43 | backend: |
| 44 | 7k2_SAS: |
| 45 | engine: storwize |
Jakub Pavlik | edd4610 | 2016-01-08 16:20:38 +0100 | [diff] [blame] | 46 | type_name: slow-disks |
Jakub Pavlik | af96c2a | 2016-01-08 15:49:54 +0100 | [diff] [blame] | 47 | 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 |
Petr Michalec | a1c7ff1 | 2016-11-29 16:32:50 +0100 | [diff] [blame] | 55 | audit: |
| 56 | enabled: false |
Simon Pasquier | 9089de4 | 2017-02-03 16:13:22 +0100 | [diff] [blame^] | 57 | osapi_max_limit: 500 |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 58 | |
| 59 | cinder: |
| 60 | volume: |
| 61 | enabled: true |
| 62 | version: juno |
Jakub Pavlik | af96c2a | 2016-01-08 15:49:54 +0100 | [diff] [blame] | 63 | default_volume_type: 7k2SaS |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 64 | database: |
| 65 | engine: mysql |
| 66 | host: 127.0.0.1 |
| 67 | port: 3306 |
| 68 | name: cinder |
| 69 | user: cinder |
| 70 | password: pwd |
| 71 | identity: |
| 72 | engine: keystone |
| 73 | host: 127.0.0.1 |
| 74 | port: 35357 |
| 75 | tenant: service |
| 76 | user: cinder |
| 77 | password: pwd |
| 78 | message_queue: |
| 79 | engine: rabbitmq |
| 80 | host: 127.0.0.1 |
| 81 | port: 5672 |
| 82 | user: openstack |
| 83 | password: pwd |
| 84 | virtual_host: '/openstack' |
Jakub Pavlik | af96c2a | 2016-01-08 15:49:54 +0100 | [diff] [blame] | 85 | backend: |
| 86 | 7k2_SAS: |
| 87 | engine: storwize |
Jakub Pavlik | edd4610 | 2016-01-08 16:20:38 +0100 | [diff] [blame] | 88 | type_name: 7k2 SAS disk |
Jakub Pavlik | af96c2a | 2016-01-08 15:49:54 +0100 | [diff] [blame] | 89 | host: 192.168.0.1 |
| 90 | port: 22 |
| 91 | user: username |
| 92 | password: pass |
| 93 | connection: FC/iSCSI |
| 94 | multihost: true |
| 95 | multipath: true |
| 96 | pool: SAS7K2 |
Petr Michalec | a1c7ff1 | 2016-11-29 16:32:50 +0100 | [diff] [blame] | 97 | audit: |
| 98 | enabled: false |
Jiri Konecny | 2dce35f | 2016-04-19 16:29:52 +0200 | [diff] [blame] | 99 | |
| 100 | Client-side RabbitMQ HA setup for controller |
| 101 | |
| 102 | .. code-block:: yaml |
| 103 | |
| 104 | cinder: |
| 105 | controller: |
| 106 | .... |
| 107 | message_queue: |
| 108 | engine: rabbitmq |
| 109 | members: |
| 110 | - host: 10.0.16.1 |
| 111 | - host: 10.0.16.2 |
| 112 | - host: 10.0.16.3 |
| 113 | user: openstack |
| 114 | password: pwd |
| 115 | virtual_host: '/openstack' |
| 116 | .... |
| 117 | |
| 118 | Client-side RabbitMQ HA setup for volume component |
| 119 | |
| 120 | .. code-block:: yaml |
| 121 | |
| 122 | cinder: |
| 123 | volume: |
| 124 | .... |
| 125 | message_queue: |
| 126 | engine: rabbitmq |
| 127 | members: |
| 128 | - host: 10.0.16.1 |
| 129 | - host: 10.0.16.2 |
| 130 | - host: 10.0.16.3 |
| 131 | user: openstack |
| 132 | password: pwd |
| 133 | virtual_host: '/openstack' |
| 134 | .... |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 135 | |
| 136 | Cinder setup with zeroing deleted volumes |
| 137 | |
| 138 | cinder: |
| 139 | controller: |
| 140 | enabled: true |
| 141 | wipe_method: zero |
| 142 | ... |
| 143 | |
| 144 | Cinder setup with shreding deleted volumes |
| 145 | |
| 146 | .. code-block:: yaml |
| 147 | |
| 148 | cinder: |
| 149 | controller: |
| 150 | enabled: true |
| 151 | wipe_method: shred |
| 152 | ... |
| 153 | |
| 154 | |
| 155 | Default Cinder setup with iSCSI target |
| 156 | |
| 157 | .. code-block:: yaml |
| 158 | |
| 159 | cinder: |
| 160 | controller: |
| 161 | enabled: true |
Jakub Pavlik | 3d437df | 2016-04-11 22:07:50 +0200 | [diff] [blame] | 162 | version: mitaka |
| 163 | default_volume_type: lvmdriver-1 |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 164 | database: |
| 165 | engine: mysql |
| 166 | host: 127.0.0.1 |
| 167 | port: 3306 |
| 168 | name: cinder |
| 169 | user: cinder |
| 170 | password: pwd |
| 171 | identity: |
| 172 | engine: keystone |
| 173 | host: 127.0.0.1 |
| 174 | port: 35357 |
| 175 | tenant: service |
| 176 | user: cinder |
| 177 | password: pwd |
| 178 | message_queue: |
| 179 | engine: rabbitmq |
| 180 | host: 127.0.0.1 |
| 181 | port: 5672 |
| 182 | user: openstack |
| 183 | password: pwd |
| 184 | virtual_host: '/openstack' |
Jakub Pavlik | af96c2a | 2016-01-08 15:49:54 +0100 | [diff] [blame] | 185 | backend: |
Jakub Pavlik | 3d437df | 2016-04-11 22:07:50 +0200 | [diff] [blame] | 186 | lvmdriver-1: |
| 187 | engine: lvm |
| 188 | type_name: lvmdriver-1 |
| 189 | volume_group: cinder-volume |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 190 | |
Ales Komarek | df13bbd | 2016-01-05 21:33:36 +0100 | [diff] [blame] | 191 | Cinder setup for IBM Storwize |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 192 | |
| 193 | .. code-block:: yaml |
| 194 | |
| 195 | cinder: |
Ales Komarek | df13bbd | 2016-01-05 21:33:36 +0100 | [diff] [blame] | 196 | volume: |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 197 | enabled: true |
Ales Komarek | df13bbd | 2016-01-05 21:33:36 +0100 | [diff] [blame] | 198 | backend: |
| 199 | 7k2_SAS: |
| 200 | engine: storwize |
Jakub Pavlik | edd4610 | 2016-01-08 16:20:38 +0100 | [diff] [blame] | 201 | type_name: 7k2 SAS disk |
Ales Komarek | df13bbd | 2016-01-05 21:33:36 +0100 | [diff] [blame] | 202 | host: 192.168.0.1 |
| 203 | port: 22 |
| 204 | user: username |
| 205 | password: pass |
| 206 | connection: FC/iSCSI |
| 207 | multihost: true |
| 208 | multipath: true |
| 209 | pool: SAS7K2 |
| 210 | 10k_SAS: |
| 211 | engine: storwize |
Jakub Pavlik | edd4610 | 2016-01-08 16:20:38 +0100 | [diff] [blame] | 212 | type_name: 10k SAS disk |
Ales Komarek | df13bbd | 2016-01-05 21:33:36 +0100 | [diff] [blame] | 213 | host: 192.168.0.1 |
| 214 | port: 22 |
| 215 | user: username |
| 216 | password: pass |
| 217 | connection: FC/iSCSI |
| 218 | multihost: true |
| 219 | multipath: true |
| 220 | pool: SAS10K |
| 221 | 15k_SAS: |
| 222 | engine: storwize |
Jakub Pavlik | edd4610 | 2016-01-08 16:20:38 +0100 | [diff] [blame] | 223 | type_name: 15k SAS |
Ales Komarek | df13bbd | 2016-01-05 21:33:36 +0100 | [diff] [blame] | 224 | host: 192.168.0.1 |
| 225 | port: 22 |
| 226 | user: username |
| 227 | password: pass |
| 228 | connection: FC/iSCSI |
| 229 | multihost: true |
| 230 | multipath: true |
| 231 | pool: SAS15K |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 232 | |
| 233 | Cinder setup with Hitachi VPS |
| 234 | |
| 235 | .. code-block:: yaml |
| 236 | |
| 237 | cinder: |
| 238 | controller: |
| 239 | enabled: true |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 240 | backend: |
| 241 | hus100_backend: |
marco | daa52fa | 2016-01-25 23:49:50 +0100 | [diff] [blame] | 242 | type_name: HUS100 |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 243 | backend: hus100_backend |
| 244 | engine: hitachi_vsp |
| 245 | connection: FC |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 246 | |
Ondrej Smola | 16d66bd | 2017-01-15 13:56:03 +0100 | [diff] [blame] | 247 | Cinder setup with Hitachi VPS with defined ldev range |
| 248 | |
| 249 | .. code-block:: yaml |
| 250 | |
| 251 | cinder: |
| 252 | controller: |
| 253 | enabled: true |
| 254 | backend: |
| 255 | hus100_backend: |
| 256 | type_name: HUS100 |
| 257 | backend: hus100_backend |
| 258 | engine: hitachi_vsp |
| 259 | connection: FC |
| 260 | ldev_range: 0-1000 |
| 261 | |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 262 | Cinder setup with CEPH |
| 263 | |
| 264 | .. code-block:: yaml |
| 265 | |
| 266 | cinder: |
| 267 | controller: |
| 268 | enabled: true |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 269 | backend: |
| 270 | ceph_backend: |
Jakub Pavlik | edd4610 | 2016-01-08 16:20:38 +0100 | [diff] [blame] | 271 | type_name: standard-iops |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 272 | backend: ceph_backend |
| 273 | pool: volumes |
| 274 | engine: ceph |
| 275 | user: cinder |
| 276 | secret_uuid: da74ccb7-aa59-1721-a172-0006b1aa4e3e |
| 277 | client_cinder_key: AQDOavlU6BsSJhAAnpFR906mvdgdfRqLHwu0Uw== |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 278 | |
| 279 | http://ceph.com/docs/master/rbd/rbd-openstack/ |
| 280 | |
| 281 | |
| 282 | Cinder setup with HP3par |
| 283 | |
| 284 | .. code-block:: yaml |
| 285 | |
| 286 | cinder: |
| 287 | controller: |
| 288 | enabled: true |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 289 | backend: |
| 290 | hp3par_backend: |
Jakub Pavlik | edd4610 | 2016-01-08 16:20:38 +0100 | [diff] [blame] | 291 | type_name: hp3par |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 292 | backend: hp3par_backend |
| 293 | user: hp3paruser |
| 294 | password: something |
| 295 | url: http://10.10.10.10/api/v1 |
| 296 | cpg: OpenStackCPG |
| 297 | host: 10.10.10.10 |
| 298 | login: hp3paradmin |
| 299 | sanpassword: something |
| 300 | debug: True |
| 301 | snapcpg: OpenStackSNAPCPG |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 302 | |
| 303 | Cinder setup with Fujitsu Eternus |
| 304 | |
| 305 | .. code-block:: yaml |
| 306 | |
| 307 | cinder: |
| 308 | volume: |
| 309 | enabled: true |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 310 | backend: |
| 311 | 10kThinPro: |
Jakub Pavlik | edd4610 | 2016-01-08 16:20:38 +0100 | [diff] [blame] | 312 | type_name: 10kThinPro |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 313 | engine: fujitsu |
| 314 | pool: 10kThinPro |
| 315 | host: 192.168.0.1 |
| 316 | port: 5988 |
| 317 | user: username |
| 318 | password: pass |
| 319 | connection: FC/iSCSI |
marco | daa52fa | 2016-01-25 23:49:50 +0100 | [diff] [blame] | 320 | name: 10kThinPro |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 321 | 10k_SAS: |
Jakub Pavlik | edd4610 | 2016-01-08 16:20:38 +0100 | [diff] [blame] | 322 | type_name: 10k_SAS |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 323 | pool: SAS10K |
| 324 | engine: fujitsu |
| 325 | host: 192.168.0.1 |
| 326 | port: 5988 |
| 327 | user: username |
| 328 | password: pass |
| 329 | connection: FC/iSCSI |
marco | daa52fa | 2016-01-25 23:49:50 +0100 | [diff] [blame] | 330 | name: 10k_SAS |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 331 | |
Jakub Pavlik | 9703c60 | 2015-10-15 18:52:47 +0200 | [diff] [blame] | 332 | Cinder setup with IBM GPFS filesystem |
| 333 | |
| 334 | .. code-block:: yaml |
| 335 | |
| 336 | cinder: |
| 337 | volume: |
| 338 | enabled: true |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 339 | backend: |
| 340 | GPFS-GOLD: |
Jakub Pavlik | edd4610 | 2016-01-08 16:20:38 +0100 | [diff] [blame] | 341 | type_name: GPFS-GOLD |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 342 | engine: gpfs |
| 343 | mount_point: '/mnt/gpfs-openstack/cinder/gold' |
marco | daa52fa | 2016-01-25 23:49:50 +0100 | [diff] [blame] | 344 | GPFS-SILVER: |
Jakub Pavlik | edd4610 | 2016-01-08 16:20:38 +0100 | [diff] [blame] | 345 | type_name: GPFS-SILVER |
Jakub Pavlik | 5d7df0d | 2016-01-06 13:08:30 +0100 | [diff] [blame] | 346 | engine: gpfs |
| 347 | mount_point: '/mnt/gpfs-openstack/cinder/silver' |
Jakub Pavlik | 9f5988a | 2016-01-11 13:44:57 +0100 | [diff] [blame] | 348 | |
| 349 | Cinder setup with HP LeftHand |
| 350 | |
| 351 | .. code-block:: yaml |
| 352 | |
| 353 | cinder: |
| 354 | volume: |
| 355 | enabled: true |
| 356 | backend: |
| 357 | HP-LeftHand: |
| 358 | type_name: normal-storage |
| 359 | engine: hp_lefthand |
| 360 | api_url: 'https://10.10.10.10:8081/lhos' |
| 361 | username: user |
| 362 | password: password |
| 363 | clustername: cluster1 |
| 364 | iscsi_chap_enabled: false |
| 365 | |
Jakub Pavlik | a63764f | 2016-01-11 14:41:06 +0100 | [diff] [blame] | 366 | Extra parameters for HP LeftHand |
Jakub Pavlik | a63764f | 2016-01-11 14:41:06 +0100 | [diff] [blame] | 367 | |
Jakub Pavlik | 5050dda | 2016-01-11 16:52:32 +0100 | [diff] [blame] | 368 | .. code-block:: yaml |
| 369 | |
| 370 | cinder type-key normal-storage set hplh:data_pl=r-10-2 hplh:provisioning=full |
| 371 | |
marco | daa52fa | 2016-01-25 23:49:50 +0100 | [diff] [blame] | 372 | Cinder setup with Solidfire |
Jakub Pavlik | 5050dda | 2016-01-11 16:52:32 +0100 | [diff] [blame] | 373 | |
| 374 | .. code-block:: yaml |
| 375 | |
| 376 | cinder: |
| 377 | volume: |
| 378 | enabled: true |
| 379 | backend: |
| 380 | solidfire: |
| 381 | type_name: normal-storage |
| 382 | engine: solidfire |
| 383 | san_ip: 10.10.10.10 |
| 384 | san_login: user |
| 385 | san_password: password |
| 386 | clustername: cluster1 |
| 387 | sf_emulate_512: false |
Filip Pytloun | da2a079 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 388 | |
Petr Michalec | a1c7ff1 | 2016-11-29 16:32:50 +0100 | [diff] [blame] | 389 | |
| 390 | |
| 391 | Enable auditing filter, ie: CADF |
| 392 | |
| 393 | .. code-block:: yaml |
| 394 | |
| 395 | cinder: |
| 396 | controller: |
| 397 | audit: |
| 398 | enabled: true |
| 399 | .... |
| 400 | filter_factory: 'keystonemiddleware.audit:filter_factory' |
| 401 | map_file: '/etc/pycadf/cinder_api_audit_map.conf' |
| 402 | .... |
| 403 | volume: |
| 404 | audit: |
| 405 | enabled: true |
| 406 | .... |
| 407 | filter_factory: 'keystonemiddleware.audit:filter_factory' |
| 408 | map_file: '/etc/pycadf/cinder_api_audit_map.conf' |
| 409 | |
Jakub Pavlik | b513f13 | 2016-05-20 11:11:19 +0200 | [diff] [blame] | 410 | Documentation and Bugs |
| 411 | ============================ |
| 412 | |
| 413 | To learn how to deploy OpenStack Salt, consult the documentation available |
| 414 | online at: |
| 415 | |
Petr Michalec | a1c7ff1 | 2016-11-29 16:32:50 +0100 | [diff] [blame] | 416 | https://wiki.openstack.org/wiki/OpenStackSalt |
Jakub Pavlik | b513f13 | 2016-05-20 11:11:19 +0200 | [diff] [blame] | 417 | |
| 418 | In the unfortunate event that bugs are discovered, they should be reported to |
| 419 | the appropriate bug tracker. If you obtained the software from a 3rd party |
| 420 | operating system vendor, it is often wise to use their own bug tracker for |
| 421 | reporting problems. In all other cases use the master OpenStack bug tracker, |
| 422 | available at: |
| 423 | |
| 424 | http://bugs.launchpad.net/openstack-salt |
| 425 | |
| 426 | Developers wishing to work on the OpenStack Salt project should always base |
| 427 | their work on the latest formulas code, available from the master GIT |
| 428 | repository at: |
| 429 | |
| 430 | https://git.openstack.org/cgit/openstack/salt-formula-cinder |
| 431 | |
| 432 | Developers should also join the discussion on the IRC list, at: |
| 433 | |
| 434 | https://wiki.openstack.org/wiki/Meetings/openstack-salt |
Filip Pytloun | b0f5c1f | 2017-02-02 13:02:03 +0100 | [diff] [blame] | 435 | |
| 436 | Documentation and Bugs |
| 437 | ====================== |
| 438 | |
| 439 | To learn how to install and update salt-formulas, consult the documentation |
| 440 | available online at: |
| 441 | |
| 442 | http://salt-formulas.readthedocs.io/ |
| 443 | |
| 444 | In the unfortunate event that bugs are discovered, they should be reported to |
| 445 | the appropriate issue tracker. Use Github issue tracker for specific salt |
| 446 | formula: |
| 447 | |
| 448 | https://github.com/salt-formulas/salt-formula-cinder/issues |
| 449 | |
| 450 | For feature requests, bug reports or blueprints affecting entire ecosystem, |
| 451 | use Launchpad salt-formulas project: |
| 452 | |
| 453 | https://launchpad.net/salt-formulas |
| 454 | |
| 455 | You can also join salt-formulas-users team and subscribe to mailing list: |
| 456 | |
| 457 | https://launchpad.net/~salt-formulas-users |
| 458 | |
| 459 | Developers wishing to work on the salt-formulas projects should always base |
| 460 | their work on master branch and submit pull request against specific formula. |
| 461 | |
| 462 | https://github.com/salt-formulas/salt-formula-cinder |
| 463 | |
| 464 | Any questions or feedback is always welcome so feel free to join our IRC |
| 465 | channel: |
| 466 | |
| 467 | #salt-formulas @ irc.freenode.net |