Add support for cinder backend availability zones

Add the ability to override the "backend_availability_zone" parameter
in every cinder volume backend.

Implements: blueprint split-controlplane-cinder-volume-az
Depends-On: I11821a38d8ba5afc594b3d601cd1634207a6f093
Change-Id: Ic407b747474b567858ad36beabc8a7d8c5022343

manifests/profile/base/cinder/volume/dellemc_unity.pp

@@ -35,6 +35,7 @@ class tripleo::profile::base::cinder::volume::dellemc_unity (
 
   if $step >= 4 {
     cinder::backend::dellemc_unity { $backend_name :
+      backend_availability_zone => hiera('cinder::backend::dellemc_unity::backend_availability_zone', undef),
       san_ip                    => hiera('cinder::backend::dellemc_unity::san_ip', undef),
       san_login                 => hiera('cinder::backend::dellemc_unity::san_login', undef),
       san_password              => hiera('cinder::backend::dellemc_unity::san_password', undef),

manifests/profile/base/cinder/volume/dellemc_vmax_iscsi.pp

@@ -35,6 +35,7 @@ class tripleo::profile::base::cinder::volume::dellemc_vmax_iscsi (
 
   if $step >= 4 {
     cinder::backend::dellemc_vmax_iscsi { $backend_name :
+      backend_availability_zone => hiera('cinder::backend::dellemc_vmax_iscsi::backend_availability_zone', undef),
       cinder_emc_config_file    => hiera('cinder::backend::dellemc_vmax_iscsi::cinder_emc_config_file', undef),
     }
   }

manifests/profile/base/cinder/volume/dellemc_vnx.pp

@@ -40,6 +40,7 @@ class tripleo::profile::base::cinder::volume::dellemc_vnx (
                                         undef)))
 
     cinder::backend::emc_vnx { $backend_name :
+      backend_availability_zone     => hiera('cinder::backend::emc_vnx::backend_availability_zone', undef),
       san_ip                        => hiera('cinder::backend::emc_vnx::san_ip', undef),
       san_login                     => hiera('cinder::backend::emc_vnx::san_login', undef),
       san_password                  => hiera('cinder::backend::emc_vnx::san_password', undef),
@@ -51,7 +52,6 @@ class tripleo::profile::base::cinder::volume::dellemc_vnx (
       storage_vnx_auth_type         => hiera('cinder::backend::emc_vnx::storage_vnx_auth_type', undef),
       storage_vnx_security_file_dir => hiera('cinder::backend::emc_vnx::storage_vnx_security_file_dir', undef),
       naviseccli_path               => hiera('cinder::backend::emc_vnx::naviseccli_path', undef),
-
     }
   }
 

manifests/profile/base/cinder/volume/dellemc_xtremio_iscsi.pp

@@ -35,6 +35,7 @@ class tripleo::profile::base::cinder::volume::dellemc_xtremio_iscsi (
 
   if $step >= 4 {
     cinder::backend::dellemc_xtremio_iscsi { $backend_name :
+      backend_availability_zone         => hiera('cinder::backend::dellemc_xtremio_iscsi::backend_availability_zone', undef),
       san_ip                            => hiera('cinder::backend::dellemc_xtremio_iscsi::san_ip', undef),
       san_login                         => hiera('cinder::backend::dellemc_xtremio_iscsi::san_login', undef),
       san_password                      => hiera('cinder::backend::dellemc_xtremio_iscsi::san_password', undef),

manifests/profile/base/cinder/volume/dellps.pp

@@ -35,6 +35,7 @@ class tripleo::profile::base::cinder::volume::dellps (
 
   if $step >= 4 {
     cinder::backend::eqlx { $backend_name :
+      backend_availability_zone => hiera('cinder::backend::eqlx::backend_availability_zone', undef),
       san_ip                    => hiera('cinder::backend::eqlx::san_ip', undef),
       san_login                 => hiera('cinder::backend::eqlx::san_login', undef),
       san_password              => hiera('cinder::backend::eqlx::san_password', undef),

manifests/profile/base/cinder/volume/dellsc.pp

@@ -44,6 +44,7 @@ class tripleo::profile::base::cinder::volume::dellsc (
     }
 
     cinder::backend::dellsc_iscsi { $backend_name :
+      backend_availability_zone => hiera('cinder::backend::dellsc_iscsi::backend_availability_zone', undef),
       san_ip                    => hiera('cinder::backend::dellsc_iscsi::san_ip', undef),
       san_login                 => hiera('cinder::backend::dellsc_iscsi::san_login', undef),
       san_password              => hiera('cinder::backend::dellsc_iscsi::san_password', undef),

manifests/profile/base/cinder/volume/hpelefthand.pp

@@ -22,6 +22,10 @@
 #   (Optional) Name given to the Cinder backend stanza
 #   Defaults to 'tripleo_hpelefthand'
 #
+# [*backend_availability_zone*]
+#   (Optional) Availability zone for this volume backend
+#   Defaults to hiera('cinder::backend::hpelefthand_iscsi::backend_availability_zone', undef)
+#
 # [*cinder_hpelefthand_api_url*]
 #   (required) url for api access to lefthand - example https://10.x.x.x:8080/api/v1
 #
@@ -47,6 +51,7 @@
 #
 class tripleo::profile::base::cinder::volume::hpelefthand (
   $backend_name                          = hiera('cinder::backend::hpelefthand_iscsi::volume_backend_name', 'tripleo_hpelefthand'),
+  $backend_availability_zone             = hiera('cinder::backend::hpelefthand_iscsi::backend_availability_zone', undef),
   $cinder_hpelefthand_username           = hiera('cinder::backend::hpelefthand_iscsi::hpelefthand_username', undef),
   $cinder_hpelefthand_password           = hiera('cinder::backend::hpelefthand_iscsi::hpelefthand_password', undef),
   $cinder_hpelefthand_clustername        = hiera('cinder::backend::hpelefthand_iscsi::hpelefthand_clustername', undef),
@@ -59,6 +64,7 @@ class tripleo::profile::base::cinder::volume::hpelefthand (
 
   if $step >= 4 {
     cinder::backend::hpelefthand_iscsi { $backend_name :
+      backend_availability_zone      => $backend_availability_zone,
       hpelefthand_username           => $cinder_hpelefthand_username,
       hpelefthand_password           => $cinder_hpelefthand_password,
       hpelefthand_clustername        => $cinder_hpelefthand_clustername,

manifests/profile/base/cinder/volume/iscsi.pp

@@ -25,6 +25,10 @@
 #   (Optional) Name given to the Cinder backend stanza
 #   Defaults to 'tripleo_iscsi'
 #
+# [*backend_availability_zone*]
+#   (Optional) Availability zone for this volume backend
+#   Defaults to hiera('cinder::backend::iscsi::backend_availability_zone', undef)
+#
 # [*cinder_iscsi_helper*]
 #   (Optional) The iscsi helper to use
 #   Defaults to 'tgtadm'
@@ -45,6 +49,7 @@
 class tripleo::profile::base::cinder::volume::iscsi (
   $cinder_iscsi_address,
   $backend_name                = hiera('cinder::backend::iscsi::volume_backend_name', 'tripleo_iscsi'),
+  $backend_availability_zone   = hiera('cinder::backend::iscsi::backend_availability_zone', undef),
   $cinder_iscsi_helper         = 'tgtadm',
   $cinder_iscsi_protocol       = 'iscsi',
   $cinder_lvm_loop_device_size = '10280',
@@ -61,6 +66,7 @@ class tripleo::profile::base::cinder::volume::iscsi (
     # key: [ipv6]
     # as it will cause hiera parsing errors
     cinder::backend::iscsi { $backend_name :
+      backend_availability_zone => $backend_availability_zone,
       iscsi_ip_address          => normalize_ip_for_uri($cinder_iscsi_address),
       iscsi_helper              => $cinder_iscsi_helper,
       iscsi_protocol            => $cinder_iscsi_protocol,

manifests/profile/base/cinder/volume/netapp.pp

@@ -50,6 +50,7 @@ class tripleo::profile::base::cinder::volume::netapp (
       $netapp_pool_name_search_pattern_fallback = undef
     }
     cinder::backend::netapp { $backend_name :
+      backend_availability_zone       => hiera('cinder::backend::netapp::backend_availability_zone', undef),
       netapp_login                    => hiera('cinder::backend::netapp::netapp_login', undef),
       netapp_password                 => hiera('cinder::backend::netapp::netapp_password', undef),
       netapp_server_hostname          => hiera('cinder::backend::netapp::netapp_server_hostname', undef),

manifests/profile/base/cinder/volume/nfs.pp

@@ -25,6 +25,10 @@
 #   (Optional) Name given to the Cinder backend stanza
 #   Defaults to 'tripleo_nfs'
 #
+# [*backend_availability_zone*]
+#   (Optional) Availability zone for this volume backend
+#   Defaults to  hiera('cinder::backend::nfs::backend_availability_zone', undef)
+#
 # [*cinder_nfs_mount_options*]
 #   (Optional) List of mount options for the NFS share
 #   Defaults to ''
@@ -54,6 +58,7 @@
 class tripleo::profile::base::cinder::volume::nfs (
   $cinder_nfs_servers,
   $backend_name                       = hiera('cinder::backend::nfs::volume_backend_name', 'tripleo_nfs'),
+  $backend_availability_zone          = hiera('cinder::backend::nfs::backend_availability_zone', undef),
   $cinder_nfs_mount_options           = '',
   $cinder_nas_secure_file_operations  = $::os_service_default,
   $cinder_nas_secure_file_permissions = $::os_service_default,
@@ -64,6 +69,7 @@ class tripleo::profile::base::cinder::volume::nfs (
   if $step >= 4 {
     package {'nfs-utils': }
     -> cinder::backend::nfs { $backend_name :
+      backend_availability_zone   => $backend_availability_zone,
       nfs_servers                 => $cinder_nfs_servers,
       nfs_mount_options           => $cinder_nfs_mount_options,
       nfs_shares_config           => '/etc/cinder/shares-nfs.conf',

manifests/profile/base/cinder/volume/nvmeof.pp

@@ -33,6 +33,10 @@
 #   (Optional) Name given to the Cinder backend
 #   Defaults to 'tripleo_nvmeof'
 #
+# [*backend_availability_zone*]
+#   (Optional) Availability zone for this volume backend
+#   Defaults to hiera('cinder::backend::nvmeof::backend_availability_zone', undef)
+#
 # [*volume_driver*]
 #   (Optional) Driver to use for volume creation
 #   Defaults to 'cinder.volume.drivers.lvm.LVMVolumeDriver'
@@ -51,6 +55,7 @@ class tripleo::profile::base::cinder::volume::nvmeof (
   $nvmet_port_id             = '1',
   $nvmet_ns_id               = '10',
   $volume_backend_name       = hiera('cinder::backend::nvmeof::volume_backend_name', 'tripleo_nvmeof'),
+  $backend_availability_zone = hiera('cinder::backend::nvmeof::backend_availability_zone', undef),
   $volume_driver             = 'cinder.volume.drivers.lvm.LVMVolumeDriver',
   $step                      = Integer(hiera('step')),
 ) {
@@ -66,6 +71,7 @@ class tripleo::profile::base::cinder::volume::nvmeof (
       nvmet_port_id             => $nvmet_port_id,
       nvmet_ns_id               => $nvmet_ns_id,
       volume_backend_name       => $volume_backend_name,
+      backend_availability_zone => $backend_availability_zone,
       volume_driver             => $volume_driver,
     }
   }

manifests/profile/base/cinder/volume/pure.pp

@@ -54,6 +54,7 @@ class tripleo::profile::base::cinder::volume::pure (
 
   if $step >= 4 {
     cinder::backend::pure { $backend_name :
+      backend_availability_zone    => hiera('cinder::backend::pure::backend_availability_zone', undef),
       san_ip                       => hiera('cinder::backend::pure::san_ip', undef),
       pure_api_token               => hiera('cinder::backend::pure::pure_api_token', undef),
       pure_storage_protocol        => hiera('cinder::backend::pure::pure_storage_protocol', undef),

manifests/profile/base/cinder/volume/rbd.pp

@@ -22,6 +22,10 @@
 #   (Optional) Name given to the Cinder backend stanza
 #   Defaults to 'tripleo_ceph'
 #
+# [*backend_availability_zone*]
+#   (Optional) Availability zone for this volume backend
+#   Defaults to hiera('cinder::backend::rbd::backend_availability_zone', undef)
+#
 # [*cinder_rbd_backend_host*]
 #   (Optional) String to use as backend_host in the backend stanza
 #   Defaults to hiera('cinder::backend_host', hiera('cinder::host', 'hostgroup'))
@@ -54,6 +58,7 @@
 #
 class tripleo::profile::base::cinder::volume::rbd (
   $backend_name              = hiera('cinder::backend::rbd::volume_backend_name', 'tripleo_ceph'),
+  $backend_availability_zone = hiera('cinder::backend::rbd::backend_availability_zone', undef),
   $cinder_rbd_backend_host   = hiera('cinder::backend_host', hiera('cinder::host', 'hostgroup')),
   $cinder_rbd_ceph_conf      = hiera('cinder::backend::rbd::rbd_ceph_conf', '/etc/ceph/ceph.conf'),
   $cinder_rbd_pool_name      = 'volumes',
@@ -66,6 +71,7 @@ class tripleo::profile::base::cinder::volume::rbd (
 
   if $step >= 4 {
     cinder::backend::rbd { $backend_name :
+      backend_availability_zone => $backend_availability_zone,
       backend_host              => $cinder_rbd_backend_host,
       rbd_ceph_conf             => $cinder_rbd_ceph_conf,
       rbd_pool                  => $cinder_rbd_pool_name,
@@ -76,6 +82,7 @@ class tripleo::profile::base::cinder::volume::rbd (
     if $cinder_rbd_extra_pools {
       $cinder_rbd_extra_pools.each |$pool_name| {
         cinder::backend::rbd { "${backend_name}_${pool_name}" :
+          backend_availability_zone => $backend_availability_zone,
           backend_host              => $cinder_rbd_backend_host,
           rbd_ceph_conf             => $cinder_rbd_ceph_conf,
           rbd_pool                  => $pool_name,

manifests/profile/base/cinder/volume/scaleio.pp

@@ -35,6 +35,7 @@ class tripleo::profile::base::cinder::volume::scaleio (
 
   if $step >= 4 {
     cinder::backend::scaleio { $backend_name :
+      backend_availability_zone        => hiera('cinder::backend::scaleio::backend_availability_zone', undef),
       sio_login                        => hiera('cinder::backend::scaleio::sio_login', undef),
       sio_password                     => hiera('cinder::backend::scaleio::sio_password', undef),
       sio_server_hostname              => hiera('cinder::backend::scaleio::sio_server_hostname', undef),

manifests/profile/base/cinder/volume/veritas_hyperscale.pp

@@ -38,6 +38,7 @@ class tripleo::profile::base::cinder::volume::veritas_hyperscale (
 
   if $step >= 4 {
     cinder::backend::veritas_hyperscale { $backend_name :
+      backend_availability_zone => hiera('cinder::backend::veritas_hyperscale::backend_availability_zone', undef)
     }
   }
 

releasenotes/notes/add-cinder-backend-az-parameters-f9ab30b42b4df37b.yaml

@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Add the ability to override the "backend_availability_zone"
+    parameter in every cinder volume backend.

spec/classes/tripleo_profile_base_cinder_volume_iscsi_spec.rb

@@ -56,16 +56,21 @@ describe 'tripleo::profile::base::cinder::volume::iscsi' do
         end
       end
 
-      context 'with ipv6 address' do
+      context 'with customizations' do
         before :each do
-          params.merge!({ :cinder_iscsi_address => 'fe80::fc54:ff:fe9e:7846' })
+          params.merge!(
+            {
+              :backend_availability_zone => 'my_zone',
+              :cinder_iscsi_address      => 'fe80::fc54:ff:fe9e:7846',
+            })
         end
         it 'should trigger complete configuration' do
           is_expected.to contain_class('cinder::setup_test_volume').with(
             :size => '10280M'
           )
           is_expected.to contain_cinder__backend__iscsi('tripleo_iscsi').with(
-            :iscsi_ip_address => '[fe80::fc54:ff:fe9e:7846]'
+            :backend_availability_zone => 'my_zone',
+            :iscsi_ip_address          => '[fe80::fc54:ff:fe9e:7846]',
           )
         end
       end

spec/classes/tripleo_profile_base_cinder_volume_nfs_spec.rb

@@ -52,6 +52,20 @@ describe 'tripleo::profile::base::cinder::volume::nfs' do
         end
       end
 
+      context 'with customizations' do
+        before :each do
+          params.merge!(
+            {
+              :backend_availability_zone => 'my_zone',
+            })
+        end
+        it 'should trigger complete configuration' do
+          is_expected.to contain_cinder__backend__nfs('tripleo_nfs').with(
+            :backend_availability_zone => 'my_zone',
+          )
+        end
+      end
+
       context 'with selinux' do
         before :each do
           facts.merge!({ :selinux => 'true' })

spec/classes/tripleo_profile_base_cinder_volume_nvmeof_spec.rb

@@ -46,7 +46,29 @@ describe 'tripleo::profile::base::cinder::volume::nvmeof' do
         end
       end
 
+      context 'with customizations' do
+        before :each do
+          params.merge!(
+            {
+              :backend_availability_zone => 'my_zone',
+            })
+        end
+        it 'should trigger complete configuration' do
+          is_expected.to contain_cinder__backend__nvmeof('tripleo_nvmeof').with(
+            :backend_availability_zone => 'my_zone',
+          )
+        end
+      end
     end
   end
 
+  on_supported_os.each do |os, facts|
+    context "on #{os}" do
+      let(:facts) do
+        facts.merge({ :hostname => 'node.example.com' })
+      end
+
+      it_behaves_like 'tripleo::profile::base::cinder::volume::nvmeof'
+    end
+  end
 end

spec/classes/tripleo_profile_base_cinder_volume_rbd_spec.rb

@@ -53,6 +53,7 @@ describe 'tripleo::profile::base::cinder::volume::rbd' do
         before :each do
           params.merge!({
             :backend_name              => 'poodles',
+            :backend_availability_zone => 'my_zone',
             :cinder_rbd_backend_host   => 'fe80::fc54:ff:fe9e:7846',
             :cinder_rbd_ceph_conf      => '/etc/ceph/mycluster.conf',
             :cinder_rbd_pool_name      => 'poolname',
@@ -64,6 +65,7 @@ describe 'tripleo::profile::base::cinder::volume::rbd' do
         it 'should trigger complete configuration' do
           is_expected.to contain_cinder__backend__rbd('poodles').with(
             :backend_host              => 'fe80::fc54:ff:fe9e:7846',
+            :backend_availability_zone => 'my_zone',
             :rbd_ceph_conf             => '/etc/ceph/mycluster.conf',
             :rbd_pool                  => 'poolname',
             :rbd_user                  => 'kcatsnepo',
@@ -71,6 +73,7 @@ describe 'tripleo::profile::base::cinder::volume::rbd' do
           )
           is_expected.to contain_cinder__backend__rbd('poodles_aplenty').with(
             :backend_host              => 'fe80::fc54:ff:fe9e:7846',
+            :backend_availability_zone => 'my_zone',
             :rbd_ceph_conf             => '/etc/ceph/mycluster.conf',
             :rbd_pool                  => 'aplenty',
             :rbd_user                  => 'kcatsnepo',
@@ -78,6 +81,7 @@ describe 'tripleo::profile::base::cinder::volume::rbd' do
           )
           is_expected.to contain_cinder__backend__rbd('poodles_galore').with(
             :backend_host              => 'fe80::fc54:ff:fe9e:7846',
+            :backend_availability_zone => 'my_zone',
             :rbd_ceph_conf             => '/etc/ceph/mycluster.conf',
             :rbd_pool                  => 'galore',
             :rbd_user                  => 'kcatsnepo',