From 2520cff40d73a512bc86f2603b2355b39aa95057 Mon Sep 17 00:00:00 2001 From: rajinir Date: Mon, 20 Apr 2020 14:51:30 -0500 Subject: [PATCH] Support for Dell EMC XTREMIO Driver Volume Config Dell EMC XTREMIO volume driver config support both iSCSI and FC drivers. Change-Id: I49ea347ba25120bbe18b5c6b1ee6da0f72dd2a57 --- manifests/backend/dellemc_xtremio.pp | 109 ++++++++++++++++ .../xtremio-driver-abc8e372280c44e6.yaml | 4 + spec/defines/cinder_dell_emc_xtremio_spec.rb | 120 ++++++++++++++++++ 3 files changed, 233 insertions(+) create mode 100644 manifests/backend/dellemc_xtremio.pp create mode 100644 releasenotes/notes/xtremio-driver-abc8e372280c44e6.yaml create mode 100644 spec/defines/cinder_dell_emc_xtremio_spec.rb diff --git a/manifests/backend/dellemc_xtremio.pp b/manifests/backend/dellemc_xtremio.pp new file mode 100644 index 00000000..6d96e4df --- /dev/null +++ b/manifests/backend/dellemc_xtremio.pp @@ -0,0 +1,109 @@ +# == define: cinder::backend::dellemc_xtremio +# +# Configure the Dell EMC XtremIO Driver for cinder. +# +# === Parameters +# +# [*san_ip*] +# (required) IP address of XMS. +# +# [*san_login*] +# (required) XMS user name. +# +# [*san_password*] +# (required) XMS user password. +# +# [*xtremio_cluster_name*] +# (required) XMS cluster id in multi-cluster environment. +# +# [*volume_backend_name*] +# (optional) The storage backend name. +# Defaults to the name of the backend +# +# [*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. +# +# [*xtremio_array_busy_retry_count*] +# (optional) Number of retries in case array is busy. +# Defaults to 5 +# +# [*xtremio_array_busy_retry_interval*] +# (optional) Interval between retries in case array is busy. +# Defaults to 5 +# +# [*xtremio_volumes_per_glance_cache*] +# (optional) Number of volumes created from each cached glance image. +# Defaults to 100 +# +# [*extra_options*] +# (optional) Hash of extra options to pass to the backend stanza. +# Defaults to: {} +# Example: +# { 'dellemc_xtremio_backend/param1' => { 'value' => value1 } } +# +# [*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. +# +# [*xtremio_storage_protocol*] +# (optional) The Storage protocol, iSCSI or FC. +# This will determine +# which Volume Driver will be configured; XtremIOISCSIDriver or XtremIOFCDriver. +# Defaults to 'iSCSI' +# +define cinder::backend::dellemc_xtremio ( + $san_ip, + $san_login, + $san_password, + $xtremio_cluster_name, + $volume_backend_name = $name, + $backend_availability_zone = $::os_service_default, + $xtremio_array_busy_retry_count = 5, + $xtremio_array_busy_retry_interval = 5, + $xtremio_volumes_per_glance_cache = 100, + $manage_volume_type = false, + $xtremio_storage_protocol = 'iSCSI', + $extra_options = {}, +) { + + include cinder::deps + + if $xtremio_storage_protocol == 'iSCSI' { + $driver = 'dell_emc.xtremio.XtremIOISCSIDriver' + } + elsif $xtremio_storage_protocol == 'FC' { + $driver = 'dell_emc.xtremio.XtremIOFCDriver' + } + else { + fail('The cinder::backend::dellemc_xtremio xtremio_storage_protocol specified is not valid. It should be iSCSI or FC') + } + + cinder_config { + "${name}/volume_backend_name": value => $volume_backend_name; + "${name}/backend_availability_zone": value => $backend_availability_zone; + "${name}/volume_driver": value => "cinder.volume.drivers.${driver}"; + "${name}/san_ip": value => $san_ip; + "${name}/san_login": value => $san_login; + "${name}/san_password": value => $san_password, secret => true; + "${name}/xtremio_cluster_name": value => $xtremio_cluster_name; + "${name}/xtremio_array_busy_retry_count": value => $xtremio_array_busy_retry_count; + "${name}/xtremio_array_busy_retry_interval": value => $xtremio_array_busy_retry_interval; + "${name}/xtremio_volumes_per_glance_cache": value => $xtremio_volumes_per_glance_cache; + + } + + if $manage_volume_type { + cinder_type { $volume_backend_name: + ensure => present, + properties => ["volume_backend_name=${volume_backend_name}"], + } + } + + create_resources('cinder_config', $extra_options) + +} diff --git a/releasenotes/notes/xtremio-driver-abc8e372280c44e6.yaml b/releasenotes/notes/xtremio-driver-abc8e372280c44e6.yaml new file mode 100644 index 00000000..a241c9e0 --- /dev/null +++ b/releasenotes/notes/xtremio-driver-abc8e372280c44e6.yaml @@ -0,0 +1,4 @@ +--- +features: + - Added Dell EMC XtremIO backend driver config that supports + both iSCSI and FC options. diff --git a/spec/defines/cinder_dell_emc_xtremio_spec.rb b/spec/defines/cinder_dell_emc_xtremio_spec.rb new file mode 100644 index 00000000..9453beb8 --- /dev/null +++ b/spec/defines/cinder_dell_emc_xtremio_spec.rb @@ -0,0 +1,120 @@ +require 'spec_helper' + +describe 'cinder::backend::dellemc_xtremio' do + let (:config_group_name) { 'dellemc_xtremio' } + + let (:title) { config_group_name } + + let :params do + { + :san_ip => '172.23.8.101', + :san_login => 'Admin', + :san_password => '12345', + :xtremio_cluster_name => 'Cluster01', + } + end + + let :default_params do + { + :backend_availability_zone => '', + :xtremio_array_busy_retry_count => 5, + :xtremio_array_busy_retry_interval => 5, + :xtremio_volumes_per_glance_cache => 100, + } + end + + let :custom_params do + { + :backend_availability_zone => 'my_zone', + :xtremio_array_busy_retry_count => 15, + :xtremio_array_busy_retry_interval => 25, + :xtremio_volumes_per_glance_cache => 10, + } + end + + shared_examples 'dellemc_xtremio volume driver' do + let :params_hash do + default_params.merge(params) + end + + it { + is_expected.to contain_cinder__backend__dellemc_xtremio(config_group_name) + is_expected.to contain_cinder_config("#{title}/volume_driver").with_value('cinder.volume.drivers.dell_emc.xtremio.XtremIOISCSIDriver') + } + + it { + params_hash.each_pair do |config,value| + is_expected.to contain_cinder_config("#{config_group_name}/#{config}").with_value( value ) + end + } + end + + context 'with xtremio_storage_protocol set to FC' do + before do + params.merge!(:xtremio_storage_protocol => 'FC',) + end + + it 'should configure the FC driver' do + is_expected.to contain_cinder_config("#{title}/volume_driver").with_value( + 'cinder.volume.drivers.dell_emc.xtremio.XtremIOFCDriver' + ) + end + end + + context 'with an invalid xtremio_storage_protocol' do + before do + params.merge!(:xtremio_storage_protocol => 'BAD',) + end + + it 'should raise an error' do + is_expected.to compile.and_raise_error( + /The cinder::backend::dellemc_xtremio xtremio_storage_protocol specified is not valid. It should be iSCSI or FC/ + ) + end + end + + shared_examples 'cinder::backend::dellemc_xtremio' do + context 'with default parameters' do + it_behaves_like 'dellemc_xtremio volume driver' + end + + context 'with custom parameters' do + before do + params.merge(custom_params) + end + + it_behaves_like 'dellemc_xtremio volume driver' + end + + context 'dellemc_xtremio backend with additional configuration' do + before do + params.merge!( :extra_options => {'dellemc_xtremio/param1' => { 'value' => 'value1' }} ) + end + + it { is_expected.to contain_cinder_config('dellemc_xtremio/param1').with_value('value1') } + end + + context 'dellemc_xtremio backend with cinder type' do + before do + params.merge!({:manage_volume_type => true}) + end + + it { is_expected.to contain_cinder_type('dellemc_xtremio').with( + :ensure => 'present', + :properties => ['volume_backend_name=dellemc_xtremio'] + )} + end + end + + on_supported_os({ + :supported_os => OSDefaults.get_supported_os + }).each do |os,facts| + context "on #{os}" do + let (:facts) do + facts.merge!(OSDefaults.get_facts()) + end + + it_behaves_like 'cinder::backend::dellemc_xtremio' + end + end +end