Merge pull request #59 from sirinek/windows_provider

add "update_provider" variable to plan

Author: nmaludy

CHANGELOG.md

@@ -12,6 +12,11 @@ All notable changes to this project will be documented in this file.
 
   Contributed by Haroon Rafique
 
+* Added new configuration option:
+  * `patching_update_provider`: Parameter sets the provider in the update tasks. 
+
+  Contributed by Bill Sirinek (@sirinek)
+
 ## Release 1.1.0 (2020-04-15)
 
 * Added new plans `patching::get_facts` to retrieve a set of facts from a list of targets

REFERENCE_CONFIGURATION.md

@@ -28,6 +28,7 @@
 - [patching_snapshot_description](#patching_snapshot_description)
 - [patching_snapshot_memory](#patching_snapshot_memory)
 - [patching_snapshot_quiesce](#patching_snapshot_quiesce)
+- [patching_update_provider](#patching_update_provider)
 - [vsphere_host](#vsphere_host)
 - [vsphere_username](#vsphere_username)
 - [vsphere_password](#vsphere_password)
@@ -566,6 +567,14 @@ default: true
 
 Enable or disable quiescing the VM's filesystem when creating snapshots during patching.
 
+### patching_update_provider
+
+``` yaml
+type: String
+default: <none>
+```
+
+
 ### vsphere_host
 
 ``` yaml

plans/available_updates.pp

@@ -29,6 +29,12 @@
 # @param [Boolean] noop
 #   Run this plan in noop mode, meaning no changes will be made to end systems.
 #   In this case, noop mode has no effect.
+# @param [Optional[String]] provider
+#   What update provider to use. For Linux (RHEL, Debian, SUSE, etc.) this parameter
+#   is not used. For Windows the available values are: 'windows', 'chocolatey', 'all'
+#   (both 'windows' and 'chocolatey'). The default value for Windows is 'all'. If 'all'
+#   is passed and Chocolatey isn't installed then Chocolatey will simply be skipped.
+#   If 'chocolatey' is passed and Chocolatey isn't installed, then this will error.
 #
 # @example CLI - Basic Usage
 #   bolt plan run patching::available_updates --targets linux_hosts
@@ -46,11 +52,13 @@
 plan patching::available_updates (
   TargetSpec $targets,
   # TODO JSON
-  Enum['none', 'pretty', 'csv'] $format = 'pretty',
-  Boolean                       $noop   = false,
+  Enum['none', 'pretty', 'csv'] $format   = 'pretty',
+  Boolean                       $noop     = false,
+  Optional[String]              $provider = undef,
 ) {
   $available_results = run_task('patching::available_updates', $targets,
-                                _noop => $noop)
+                                provider => $provider,
+                                _noop    => $noop)
   case $format {
     'none': {
       return($available_results)

plans/init.pp

@@ -27,6 +27,13 @@
 #   Name of the plan to use for disabling/enabling monitoring steps of the workflow.
 #   To configure this globally, use the `patching_monitoring_plan` var.
 #
+# @param [Optional[String]] update_provider
+#   What update provider to use. For Linux (RHEL, Debian, SUSE, etc.) this parameter
+#   is not used. For Windows the available values are: 'windows', 'chocolatey', 'all'
+#   (both 'windows' and 'chocolatey'). The default value for Windows is 'all'. If 'all'
+#   is passed and Chocolatey isn't installed then Chocolatey will simply be skipped.
+#   If 'chocolatey' is passed and Chocolatey isn't installed, then this will error.
+#
 # @param [Optional[String]] pre_update_plan
 #   Name of the plan to use for executing the pre-update step of the workflow.
 #
@@ -108,6 +115,7 @@
   Optional[Boolean] $monitoring_enabled   = undef,
   Optional[String]  $monitoring_plan      = undef,
   Optional[String]  $pre_update_plan      = undef,
+  Optional[String]  $update_provider      = undef,
   Optional[String]  $post_update_plan     = undef,
   Optional[Enum['only_required', 'never', 'always']] $reboot_strategy = undef,
   Optional[String]  $reboot_message       = undef,
@@ -165,6 +173,9 @@
     $reboot_message_group = pick($reboot_message,
                                   $group_vars['patching_reboot_message'],
                                   'NOTICE: This system is currently being updated.')
+    $update_provider_group = pick_default($update_provider,
+                                          $group_vars['patching_update_provider'],
+                                          undef)
     $reboot_wait_group = pick($reboot_wait,
                               $group_vars['patching_reboot_wait'],
                               300)
@@ -192,8 +203,9 @@
 
     ## Check for updates on hosts
     $available_results = run_plan('patching::available_updates', $ordered_targets,
-                                  format  => 'pretty',
-                                  noop    => $noop)
+                                  provider => $update_provider_group,
+                                  format   => 'pretty',
+                                  noop     => $noop)
     $update_targets = $available_results['has_updates']
     if $update_targets.empty {
       next()
@@ -219,6 +231,7 @@
 
     ## Run package update.
     $update_result = run_task('patching::update', $update_targets,
+                              provider       => $update_provider_group,
                               _catch_errors  => true,
                               _noop          => $noop)