Puppet Class: cinder::volume::netapp

Defined in:
manifests/volume/netapp.pp

Overview

Class: cinder::volume::netapp

Configures Cinder to use the NetApp unified volume driver

Parameters

netapp_login

(required) Administrative user account name used to access the storage system or proxy server.

netapp_password

(required) Password for the administrative user account specified in the netapp_login option.

netapp_server_hostname

(required) The hostname (or IP address) for the storage system or proxy server.

netapp_server_port

(optional) The TCP port to use for communication with the storage system or proxy. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS. Defaults to 80

netapp_size_multiplier

(optional) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request. Defaults to 1.2

netapp_storage_family

(optional) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for NetApp E-Series. Defaults to ontap_cluster

netapp_storage_protocol

(optional) The storage protocol to be used on the data path with the storage system. Valid values are iscsi, fc, nfs. Defaults to nfs

netapp_transport_type

(optional) The transport protocol used when communicating with the storage system or proxy server. Valid values are http or https. Defaults to http

netapp_vfiler

(optional) The vFiler unit on which provisioning of block storage volumes will be done. This parameter is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this parameter when utilizing the MultiStore feature on the NetApp storage system. Defaults to undef

netapp_volume_list

(optional) This parameter is only utilized when the storage protocol is configured to use iSCSI or FC. This parameter is used to restrict provisioning to the specified controller volumes. Specify the value of this parameter to be a comma separated list of NetApp controller volume names to be used for provisioning. Defaults to undef

netapp_vserver

(optional) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur. Defaults to undef

netapp_partner_backend_name

(optional) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC. Defaults to undef

expiry_thres_minutes

(optional) This parameter specifies the threshold for last access time for images in the NFS image cache. When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share. Defaults to 720

thres_avl_size_perc_start

(optional) If the percentage of available space for an NFS share has dropped below the value specified by this parameter, the NFS image cache will be cleaned. Defaults to 20

thres_avl_size_perc_stop

(optional) When the percentage of available space on an NFS share has reached the percentage specified by this parameter, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes parameter. Defaults to 60

nfs_shares

(optional) Array of NFS exports in the form of host:/share; will be written into

file specified in nfs_shares_config
Defaults to undef
nfs_shares_config

(optional) File with the list of available NFS shares Defaults to ‘/etc/cinder/shares.conf’

nfs_mount_options

(optional) Mount options passed to the nfs client. See section of the nfs man page for details. Defaults to undef

netapp_copyoffload_tool_path

(optional) This option specifies the path of the NetApp Copy Offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file. Defaults to undef

netapp_controller_ips

(optional) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning. Defaults to undef

netapp_sa_password

(optional) Password for the NetApp E-Series storage array. Defaults to undef

netapp_storage_pools

(optional) This option is used to restrict provisioning to the specified storage pools. Only dynamic disk pools are currently supported. Specify the value of this option to be a comma separated list of disk pool names to be used for provisioning. Defaults to undef

netapp_host_type

(optional) This option is used to define how the controllers will work with the particular operating system on the hosts that are connected to it. Defaults to $::os_service_default

netapp_webservice_path

(optional) This option is used to specify the path to the E-Series proxy application on a proxy server. The value is combined with the value of the netapp_transport_type, netapp_server_hostname, and netapp_server_port options to create the URL used by the driver to connect to the proxy application. Defaults to ‘/devmgr/v2’

extra_options

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

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

DEPRECATED PARAMETERS

netapp_eseries_host_type

(optional) Deprecated. This option is used to define how the controllers in the E-Series storage array will work with the particular operating system on the hosts that are connected to it. Defaults to undef

Examples

class { 'cinder::volume::netapp':
  netapp_login => 'clusterAdmin',
  netapp_password => 'password',
  netapp_server_hostname => 'netapp.mycorp.com',
  netapp_server_port => '443',
  netapp_transport_type => 'https',
  netapp_vserver => 'openstack-vserver',
}

Authors

Bob Callaway <bob.callaway@netapp.com>

Copyright 2013 NetApp, Inc.

Parameters:

  • netapp_login (Any)
  • netapp_password (Any)
  • netapp_server_hostname (Any)
  • netapp_server_port (Any) (defaults to: '80')
  • netapp_size_multiplier (Any) (defaults to: '1.2')
  • netapp_storage_family (Any) (defaults to: 'ontap_cluster')
  • netapp_storage_protocol (Any) (defaults to: 'nfs')
  • netapp_transport_type (Any) (defaults to: 'http')
  • netapp_vfiler (Any) (defaults to: undef)
  • netapp_volume_list (Any) (defaults to: undef)
  • netapp_vserver (Any) (defaults to: undef)
  • netapp_partner_backend_name (Any) (defaults to: undef)
  • expiry_thres_minutes (Any) (defaults to: '720')
  • thres_avl_size_perc_start (Any) (defaults to: '20')
  • thres_avl_size_perc_stop (Any) (defaults to: '60')
  • nfs_shares (Any) (defaults to: undef)
  • nfs_shares_config (Any) (defaults to: '/etc/cinder/shares.conf')
  • netapp_copyoffload_tool_path (Any) (defaults to: undef)
  • netapp_controller_ips (Any) (defaults to: undef)
  • netapp_sa_password (Any) (defaults to: undef)
  • netapp_storage_pools (Any) (defaults to: undef)
  • netapp_host_type (Any) (defaults to: $::os_service_default)
  • netapp_webservice_path (Any) (defaults to: '/devmgr/v2')
  • nfs_mount_options (Any) (defaults to: undef)
  • extra_options (Any) (defaults to: {})
  • netapp_eseries_host_type (Any) (defaults to: undef) 


183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'manifests/volume/netapp.pp', line 183

class cinder::volume::netapp (
  $netapp_login,
  $netapp_password,
  $netapp_server_hostname,
  $netapp_server_port           = '80',
  $netapp_size_multiplier       = '1.2',
  $netapp_storage_family        = 'ontap_cluster',
  $netapp_storage_protocol      = 'nfs',
  $netapp_transport_type        = 'http',
  $netapp_vfiler                = undef,
  $netapp_volume_list           = undef,
  $netapp_vserver               = undef,
  $netapp_partner_backend_name  = undef,
  $expiry_thres_minutes         = '720',
  $thres_avl_size_perc_start    = '20',
  $thres_avl_size_perc_stop     = '60',
  $nfs_shares                   = undef,
  $nfs_shares_config            = '/etc/cinder/shares.conf',
  $netapp_copyoffload_tool_path = undef,
  $netapp_controller_ips        = undef,
  $netapp_sa_password           = undef,
  $netapp_storage_pools         = undef,
  $netapp_host_type             = $::os_service_default,
  $netapp_webservice_path       = '/devmgr/v2',
  $nfs_mount_options            = undef,
  $extra_options                = {},
  # DEPRECATED PARAMETERS
  $netapp_eseries_host_type     = undef,
) {

  include ::cinder::deps

  if $netapp_eseries_host_type {
    warning('The "netapp_eseries_host_type" parameter is deprecated. Use "netapp_host_type" instead.')
    $netapp_host_type_real = $netapp_eseries_host_type
  } else {
    $netapp_host_type_real = $netapp_host_type
  }

  warning('Usage of cinder::volume::netapp is deprecated, please use
cinder::backend::netapp instead.')

  cinder::backend::netapp { 'DEFAULT':
    netapp_login                 => $netapp_login,
    netapp_password              => $netapp_password,
    netapp_server_hostname       => $netapp_server_hostname,
    netapp_server_port           => $netapp_server_port,
    netapp_size_multiplier       => $netapp_size_multiplier,
    netapp_storage_family        => $netapp_storage_family,
    netapp_storage_protocol      => $netapp_storage_protocol,
    netapp_transport_type        => $netapp_transport_type,
    netapp_vfiler                => $netapp_vfiler,
    netapp_volume_list           => $netapp_volume_list,
    netapp_vserver               => $netapp_vserver,
    netapp_partner_backend_name  => $netapp_partner_backend_name,
    expiry_thres_minutes         => $expiry_thres_minutes,
    thres_avl_size_perc_start    => $thres_avl_size_perc_start,
    thres_avl_size_perc_stop     => $thres_avl_size_perc_stop,
    nfs_shares                   => $nfs_shares,
    nfs_shares_config            => $nfs_shares_config,
    netapp_copyoffload_tool_path => $netapp_copyoffload_tool_path,
    netapp_controller_ips        => $netapp_controller_ips,
    netapp_sa_password           => $netapp_sa_password,
    netapp_storage_pools         => $netapp_storage_pools,
    netapp_host_type             => $netapp_host_type_real,
    netapp_webservice_path       => $netapp_webservice_path,
    nfs_mount_options            => $nfs_mount_options,
    extra_options                => $extra_options,
  }
}