[GH-3]Allow pool expansion if raid_groups changes (#5)

if you change the disk_num or add new raid groups, the pool
will be expanded as configured.

Author: Wang, Peter USD - DVT/SYSTEM TES

README.md

@@ -37,7 +37,7 @@ configure and deploy the Unity via Puppet code.
  * Ruby `1.9` or greater
  * rubypython `0.6.4` or greater (The bridge between Ruby and Python)
  * Python `2.7`.
- * Storops, 0.4.15 or greater (Python storage management library for Unity and VNX.)
+ * Storops, 0.5.1 or greater (Python storage management library for Unity and VNX.)
 
 
 - [rubypython](https://rubygems.org/gems/rubypython) is a bridge between the Ruby and
@@ -206,7 +206,7 @@ Please refer to the example file here: [example_multiple_systems](examples/examp
 
  * `unity_system`: Define a Unity system.
  * `unity_license`: Upload a license to a defined Unity system.
- * `unity_pool`: Create, destroy a storage pool.
+ * `unity_pool`: Create, modify, expand or destroy a storage pool.
  * `unity_iscsi_portal`: Create, update, or destroy a iSCSI portal. Applicable for both IPv4 and IPv6.
  * `unity_host`: Create, update, or destroy a Unity host.
  * `unity_io_limit_policy`: Create, update, or destroy a Unity IO limit policy.
@@ -346,6 +346,8 @@ Valid values are:
 
  * `disk_num`: Number of disks.
 
+For pool expansion, user can either increase the `disk_num` or add new raid group in `raid_groups`.
+ 
 ##### `alert_threshold`
 
 
@@ -405,6 +407,13 @@ Optional
 
 Create traditional/dynamic pool
 
+Valid values are:
+
+| Value   | Description       |
+|---------|-------------------|
+| `1`     | traditional pool  |
+| `2`     | dynamic pool      |
+
 
 #### Type: `unity_iscsi_portal`
 
@@ -649,6 +658,8 @@ peter.wang13 at emc.com
 
 ## Release Notes
 
-0.1.0 - Initial release.
-0.1.1 - Add license differential uploading.
-      - Pool expansion if new raid groups are added.
+- 0.1.0
+    * Initial release.
+- 0.1.1
+    * Add license differential uploading.
+    * Pool expansion if new raid groups are added.

examples/example_pool.pp

@@ -1,5 +1,5 @@
 unity_system { 'FNM00150600267':
-  ip       => '10.245.101.35',
+  ip       => '10.245.101.39',
   user     => 'admin',
   password => 'Password123!',
 }
@@ -16,10 +16,36 @@
     disk_num     => 5,
   }],
   alert_threshold         => 80,
-  is_snap_harvest_enabled => true,
+  is_snap_harvest_enabled => false,
+  snap_harvest_high_threshold => 24.0,
   is_harvest_enabled      => true,
-  ensure                  => present,
+  pool_type               => 2,
+  ensure                  => absent,
 }
 
+# uncomment the following manifest for a pool expansion
+
+# unity_pool { 'puppet_pool':
+#   unity_system            => Unity_system['FNM00150600267'],
+#   description             => 'created by puppet module',
+#   raid_groups             => [{
+#     disk_group   => 'dg_15',
+#     raid_type    => 1,
+#     stripe_width => 0,
+#     disk_num     => 5,
+#   }, {
+#     disk_group   => 'dg_8',
+#     raid_type    => 7,
+#     stripe_width => 0,
+#     disk_num     => 4,
+#   }],
+#   alert_threshold         => 80,
+#   is_snap_harvest_enabled => true,
+#   snap_harvest_high_threshold => 25.0,
+#   is_harvest_enabled      => true,
+#   pool_type               => 2,
+#   ensure                  => present,
+# }
+
 
 

lib/puppet/provider/unity_pool/pool_provider.rb

@@ -19,6 +19,14 @@
 Puppet::Type.type(:unity_pool).provide(:pool_provider) do
   @doc = 'Manage Unity system related information.'
 
+  mk_resource_methods
+
+  def initialize(*args)
+    super *args
+    # Define an instance variable that hold values to be synchronized.
+    @property_flush = {}
+  end
+
   def create
     Puppet.info "Creating pool #{@resource[:name]} with raid #{@resource[:raid_groups]}."
     unity = get_unity_system(resource[:unity_system])
@@ -36,6 +44,8 @@ def create
                        is_fast_cache_enabled: @resource[:is_fast_cache_enabled],
                        is_fastvp_enabled: @resource[:is_fastvp_enabled],
                        pool_type: @resource[:pool_type])
+    @property_hash[:ensure] = :present
+
   end
 
   def destroy
@@ -48,6 +58,7 @@ def destroy
       pool = nil
     end
     pool.delete
+    @property_hash[:ensure] = :absent
   end
 
   def exists?
@@ -65,5 +76,101 @@ def exists?
     end
     true
   end
+
+  def flush
+    Puppet.info 'Flushing pool info.'
+    return if @property_hash[:ensure] == :absent
+
+    diff = {}
+
+    pool = pool_get
+    @property_hash = pool_property pool
+
+    @property_hash.each do |key, value|
+
+      if @resource[key].nil?
+        next
+      end
+
+      # Compare whether contains new disks/disk groups
+      if key == :raid_groups
+        add_rgs= []
+        @resource[key].each do |raid_group|
+          # If disk_num increases, add to diff
+          dg_name = raid_group['disk_group']
+          if value.has_key? dg_name
+            if value[dg_name] < raid_group['disk_num']
+              Puppet.info "User increases the disk number to #{raid_group['disk_num']} for pool #{pool.id}"
+              add_rg = {}
+              add_rg['disk_group'] = dg_name
+              add_rg['raid_type'] = raid_group['raid_type']
+              add_rg['disk_num'] = -(value[dg_name] - raid_group['disk_num'])
+              add_rg['stripe_width'] = raid_group['stripe_width']
+              Puppet.info "Adding new disks from #{add_rg} to pool #{pool.id}."
+
+              add_rgs << add_rg
+            elsif value[dg_name] > raid_group['disk_num']
+              Puppet.warning "Cannot shrink the pool, did you decrease disk num for disk_group #{dg_name} occasionally?"
+            end
+          else
+            Puppet.info "Adding new raid group #{raid_group} to pool #{pool.id}."
+            add_rgs << raid_group
+          end
+        end
+        unless add_rgs.empty?
+          add_rgs = get_raid_group_parameters(add_rgs)
+          diff[key] = add_rgs
+        end
+        next
+      end # End of if key == :raid_groups
+      unless value == @resource[key]
+        diff[key] = @resource[key]
+      end
+    end
+    unless diff.empty?
+      Puppet.info "Modifying the pool properties with change #{diff}"
+      pool.modify!(diff)
+    end
+  end
+
+
+  def pool_get
+    unity = get_unity_system(@resource[:unity_system])
+    unity.get_pool!(name: @resource[:name])
+  end
+
+  def pool_property pool
+    if pool.nil?
+      pool = pool_get
+    end
+    curr = {}
+
+    curr[:description] = pool.description
+    dgs = {}
+    # We only care whether user add add new disk groups
+    # or new disks in existing disk group.
+    disk_groups = pool.disk_groups
+    disk_groups.to_enum.each do |dg_name|
+      dgs[dg_name.to_s] = disk_groups[dg_name.to_s].__len__
+    end
+    curr[:raid_groups] = dgs
+
+    curr[:alert_threshold] = pool.alert_threshold
+    curr[:is_harvest_enabled] = pool.is_harvest_enabled
+    curr[:is_snap_harvest_enabled] = pool.is_snap_harvest_enabled
+    curr[:pool_harvest_high_threshold] = pool.pool_space_harvest_high_threshold
+    curr[:pool_harvest_low_threshold] = pool.pool_space_harvest_low_threshold
+    curr[:snap_harvest_high_threshold] = pool.snap_space_harvest_high_threshold
+    curr[:snap_harvest_low_threshold] = pool.snap_space_harvest_low_threshold
+    curr[:is_fast_cache_enabled] = pool.is_fast_cache_enabled
+    if pool.pool_fast_vp.nil?
+      curr[:is_fastvp_enabled] = false
+    else
+      curr[:is_fastvp_enabled] = pool.pool_fast_vp.is_schedule_enabled
+
+    end
+    Puppet.info "Pool properties: #{curr}."
+    curr
+  end
 end
 

lib/puppet/type/unity_pool.rb

@@ -24,71 +24,70 @@
   end
 
 
-  newparam(:description) do
+  newproperty(:description) do
     desc 'Storage pool description.'
     defaultto do
       'Created by puppet.'
     end
   end
 
-  newparam(:raid_groups) do
+  newproperty(:raid_groups, :array_matching => :all) do
     desc 'Raid groups to be included in the storage pool.'
 
-    validate do |value|
-      value.each do |raid_group|
-        Puppet.info(raid_group)
-        if raid_group['disk_group'] == nil
-          raise(Puppet::Error, 'disk_group could not be empty, please specify a disk group id.')
-        end
-        if raid_group['raid_type'] == nil
-          Puppet.info('raid_type is not specified, using Automatic')
-          raid_group['raid_type'] = 'Automatic'
-        end
-        if raid_group['disk_num'] == nil
-          raise(Puppet::Error, 'disk_num cannot not be empty, please specify an integer.')
-        end
-        if raid_group['stripe_width'] == nil
-          Puppet.info('stripe_width is not specified, using BestFit.')
-          raid_group['stripe_width'] = 0
-        end
+    validate do |raid_group|
+      # value.each do |raid_group|
+      if raid_group['disk_group'] == nil
+        raise(Puppet::Error, 'disk_group could not be empty, please specify a disk group id.')
       end
+      if raid_group['raid_type'] == nil
+        Puppet.info('raid_type is not specified, using Automatic')
+        raid_group['raid_type'] = 'Automatic'
+      end
+      if raid_group['disk_num'] == nil
+        raise(Puppet::Error, 'disk_num cannot not be empty, please specify an integer.')
+      end
+      if raid_group['stripe_width'] == nil
+        Puppet.info('stripe_width is not specified, using BestFit.')
+        raid_group['stripe_width'] = 0
+      end
+      # end
     end
   end
 
-  newparam(:alert_threshold) do
+  newproperty(:alert_threshold) do
     desc 'Threshold at which the system will generate alerts about the free space in the pool, specified as a percentage'
 
   end
-  newparam(:is_harvest_enabled) do
+  newproperty(:is_harvest_enabled) do
     desc 'Enable/disable pool harvesting.'
 
   end
-  newparam(:is_snap_harvest_enabled) do
+  newproperty(:is_snap_harvest_enabled) do
     desc 'Enable/disable pool snapshot harvesting.'
 
   end
-  newparam(:pool_harvest_high_threshold) do
+  newproperty(:pool_harvest_high_threshold) do
     desc 'Pool used space high threshold at which the system will automatically starts to delete snapshots in the pool'
 
   end
-  newparam(:pool_harvest_low_threshold) do
+  newproperty(:pool_harvest_low_threshold) do
     desc 'Pool used space low threshold under which the system will automatically stop deletion of snapshots in the pool'
 
   end
-  newparam(:snap_harvest_high_threshold) do
+  newproperty(:snap_harvest_high_threshold) do
     desc 'Snapshot used space high threshold at which the system automatically starts to delete snapshots in the pool'
 
   end
-  newparam(:snap_harvest_low_threshold) do
+  newproperty(:snap_harvest_low_threshold) do
     desc 'Snapshot used space low threshold below which the system will stop automatically deleting snapshots in the pool'
 
   end
-  newparam(:is_fast_cache_enabled) do
+  newproperty(:is_fast_cache_enabled) do
     desc 'Enable/disable FAST Cache for this pool'
 
   end
 
-  newparam(:is_fastvp_enabled) do
+  newproperty(:is_fastvp_enabled) do
     desc 'Enable/disable scheduled data relocations for this pool.'
 
   end

lib/puppet/util/dellemc/unity_helper.rb

@@ -6,6 +6,7 @@
 RubyPython.start
 
 $storops = RubyPython.import('storops')
+
 $storops.enable_log
 
 $unity_info = {}