234c5334a55898d1449ff9c458565631949079b6
[mirror/dsa-puppet.git] / 3rdparty / modules / cinder / manifests / backend / quobyte.pp
1 #
2 # == Class: cinder::backend::quobyte
3 #
4 # Configures Cinder to use Quobyte USP as a volume driver
5 #
6 # === Parameters
7 #
8 # [*quobyte_volume_url*]
9 #   (required) The URL of the Quobyte volume to use.
10 #   Not an array as a Quobyte driver instance supports exactly one volume
11 #   at a time - but you can load the driver more than once.
12 #   Example: quobyte://quobyte.cluster.example.com/volume-name
13 #
14 # [*quobyte_client_cfg*]
15 #   (optional) Path to a Quobyte client configuration file.
16 #   This is needed if client certificate authentication is enabled on the
17 #   Quobyte cluster. The config file includes the certificate and key.
18 #
19 # [*quobyte_qcow2_volumes*]
20 #   (optional) Boolean if volumes should be created as qcow2 volumes.
21 #   Defaults to True. qcow2 volumes allow snapshots, at the cost of a small
22 #   performance penalty. If False, raw volumes will be used.
23 #
24 # [*quobyte_sparsed_volumes*]
25 #   (optional) Boolean if raw volumes should be created as sparse files.
26 #   Defaults to True. Non-sparse volumes may have a very small performance
27 #   benefit, but take a long time to create.
28 #
29 # [*quobyte_mount_point_base*]
30 #   (optional) Path where the driver should create mountpoints.
31 #   Defaults to a subdirectory "mnt" under the Cinder state directory.
32 #
33 # [*volume_backend_name*]
34 #   (optional) Allows for the volume_backend_name to be separate of $name.
35 #   Defaults to: $name
36 #
37 # === Examples
38 #
39 # cinder::backend::quobyte { 'quobyte1':
40 #   quobyte_volume_url => 'quobyte://quobyte.cluster.example.com/volume-name',
41 # }
42 #
43 define cinder::backend::quobyte (
44   $quobyte_volume_url,
45   $quobyte_client_cfg       = undef,
46   $quobyte_qcow2_volumes    = undef,
47   $quobyte_sparsed_volumes  = undef,
48   $quobyte_mount_point_base = undef,
49   $volume_backend_name      = $name,
50 ) {
51
52   cinder_config {
53     "${name}/volume_backend_name":       value => $volume_backend_name;
54     "${name}/volume_driver":             value =>
55       'cinder.volume.drivers.quobyte.QuobyteDriver';
56     "${name}/quobyte_volume_url":        value => $quobyte_volume_url;
57     "${name}/quobyte_client_cfg":        value => $quobyte_client_cfg;
58     "${name}/quobyte_qcow2_volumes":     value => $quobyte_qcow2_volumes;
59     "${name}/quobyte_sparsed_volumes":   value => $quobyte_sparsed_volumes;
60     "${name}/quobyte_mount_point_base":  value => $quobyte_mount_point_base;
61   }
62
63 }