Defined Type: cinder::backend::san

Defined in:
manifests/backend/san.pp

Overview

Class: cinder::backend::san

Configures Cinder volume SAN driver. Parameters are particular to each volume driver.

Parameters

volume_driver

(required) Setup cinder-volume to use volume driver.

volume_backend_name

(optional) Allows for the volume_backend_name to be separate of $name. Defaults to: $name

backend_availability_zone

(Optional) Availability zone for this volume backend. If not set, the storage_availability_zone option value is used as the default for all backends. Defaults to $::os_service_default.

san_thin_provision

(optional) Use thin provisioning for SAN volumes? Defaults to $::os_service_default.

san_ip

(optional) IP address of SAN controller. Defaults to $::os_service_default.

san_login

(optional) Username for SAN controller. Defaults to ‘admin’. Defaults to $::os_service_default.

san_password

(optional) Password for SAN controller. Defaults to $::os_service_default.

san_private_key

(optional) Filename of private key to use for SSH authentication. Defaults to $::os_service_default.

san_clustername

(optional) Cluster name to use for creating volumes. Defaults to $::os_service_default.

san_ssh_port

(optional) SSH port to use with SAN. Defaults to $::os_service_default.

san_api_port

(optional) Port to use to access the SAN API. Defaults to $::os_service_default.

san_is_local

(optional) Execute commands locally instead of over SSH use if the volume service is running on the SAN device. Defaults to $::os_service_default.

ssh_conn_timeout

(optional) SSH connection timeout in seconds. Defaults to $::os_service_default.

ssh_min_pool_conn

(optional) Minimum ssh connections in the pool. Defaults to $::os_service_default.

ssh_max_pool_conn

(Optional) Maximum ssh connections in the pool. Defaults to $::os_service_default.

manage_volume_type

(Optional) Whether or not manage Cinder Volume type. If set to true, a Cinder Volume type will be created with volume_backend_name=$volume_backend_name key/value. Defaults to false.

extra_options

(optional) Hash of extra options to pass to the backend stanza Defaults to: {} Example :

{ 'san_backend/param1' => { 'value' => value1 } }

Parameters:

  • volume_driver (Any)
  • volume_backend_name (Any) (defaults to: $name)
  • backend_availability_zone (Any) (defaults to: $::os_service_default)
  • san_thin_provision (Any) (defaults to: $::os_service_default)
  • san_ip (Any) (defaults to: $::os_service_default)
  • san_login (Any) (defaults to: $::os_service_default)
  • san_password (Any) (defaults to: $::os_service_default)
  • san_private_key (Any) (defaults to: $::os_service_default)
  • san_clustername (Any) (defaults to: $::os_service_default)
  • san_ssh_port (Any) (defaults to: $::os_service_default)
  • san_api_port (Any) (defaults to: $::os_service_default)
  • san_is_local (Any) (defaults to: $::os_service_default)
  • ssh_conn_timeout (Any) (defaults to: $::os_service_default)
  • ssh_min_pool_conn (Any) (defaults to: $::os_service_default)
  • ssh_max_pool_conn (Any) (defaults to: $::os_service_default)
  • manage_volume_type (Any) (defaults to: false)
  • extra_options (Any) (defaults to: {}) 


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'manifests/backend/san.pp', line 82

define cinder::backend::san (
  $volume_driver,
  $volume_backend_name       = $name,
  $backend_availability_zone = $::os_service_default,
  $san_thin_provision        = $::os_service_default,
  $san_ip                    = $::os_service_default,
  $san_login                 = $::os_service_default,
  $san_password              = $::os_service_default,
  $san_private_key           = $::os_service_default,
  $san_clustername           = $::os_service_default,
  $san_ssh_port              = $::os_service_default,
  $san_api_port              = $::os_service_default,
  $san_is_local              = $::os_service_default,
  $ssh_conn_timeout          = $::os_service_default,
  $ssh_min_pool_conn         = $::os_service_default,
  $ssh_max_pool_conn         = $::os_service_default,
  $manage_volume_type        = false,
  $extra_options             = {},
) {

  include cinder::deps

  cinder_config {
    "${name}/volume_backend_name":       value => $volume_backend_name;
    "${name}/backend_availability_zone": value => $backend_availability_zone;
    "${name}/volume_driver":             value => $volume_driver;
    "${name}/san_thin_provision":        value => $san_thin_provision;
    "${name}/san_ip":                    value => $san_ip;
    "${name}/san_login":                 value => $san_login;
    "${name}/san_password":              value => $san_password, secret => true;
    "${name}/san_private_key":           value => $san_private_key;
    "${name}/san_clustername":           value => $san_clustername;
    "${name}/san_ssh_port":              value => $san_ssh_port;
    "${name}/san_api_port":              value => $san_api_port;
    "${name}/san_is_local":              value => $san_is_local;
    "${name}/ssh_conn_timeout":          value => $ssh_conn_timeout;
    "${name}/ssh_min_pool_conn":         value => $ssh_min_pool_conn;
    "${name}/ssh_max_pool_conn":         value => $ssh_max_pool_conn;
  }

  if $manage_volume_type {
    cinder_type { $volume_backend_name:
      ensure     => present,
      properties => ["volume_backend_name=${volume_backend_name}"],
    }
  }

  create_resources('cinder_config', $extra_options)

}