Move vsphere specific methods out of vmpooler

vmpooler has the vsphere provider taken out, moving some vsphere related
methods to the provider:
1) pool_folders
2) get_base_folders
At the same time renaming some configuration and code items
to remove harmful terminology.
purge_unconfigured_folders DEPRECATED, use purge_unconfigured_resources
folder_whitelist DEPRECATED, use resources_allowlist
the above configuration items are still supported but will be removed in
the next major version.
base class method purge_unconfigured_folders was renamed to purge_unconfigured_resources
and requires the equivalent change in the provider classes

abc
This commit is contained in:
Samuel Beaulieu 2021-12-07 13:44:28 -06:00
parent be72bb46d8
commit f6bbef4245
No known key found for this signature in database
GPG key ID: 12030F74136D0F34
7 changed files with 69 additions and 127 deletions

View file

@ -11,20 +11,21 @@
# For multiple providers, specify one of the supported backing services (vsphere or dummy)
# (optional: will default to it's parent :key: name eg. 'vsphere')
#
# - purge_unconfigured_folders
# Enable purging of VMs and folders detected within the base folder path that are not configured for the provider
# Only a single layer of folders and their child VMs are evaluated from detected base folder paths
# Nested child folders will not be destroyed. An optional whitelist can be provided to exclude folders
# A base folder path for 'vmpooler/redhat-7' would be 'vmpooler'
# Setting this on the provider will enable folder purging for the provider
# - purge_unconfigured_folders DEPRECATED, use purge_unconfigured_resources
# - purge_unconfigured_resources
# Enable purging of resources (typically VMs) or other items based on the provider. Provides a high-level cleanup
# mechanism for things that are live but not found in the vmpooler config ie in a pool config. See the provider's
# implementation for more details.
# Setting this on the provider will enable purging for the provider
# Expects a boolean value
# (optional; default: false)
#
# - folder_whitelist
# Specify folders that are within the base folder path, not in the configuration, and should not be destroyed
# To exclude 'vmpooler/myfolder' from being destroyed when the base path is 'vmpooler' you would specify 'myfolder' in the whitelist
# This option is only evaluated when 'purge_unconfigured_folders' is enabled
# Expects an array of strings specifying the whitelisted folders by name
# - folder_whitelist DEPRECATED, use resources_allowlist
# - resources_allowlist
# Specify items names that should be ignored when purging. See the provider's
# implementation for more details.
# This option is only evaluated when 'purge_unconfigured_resources' is enabled
# Expects an array of strings specifying the allowed items by name
# (optional; default: nil)
#
# If you want to support more than one provider with different parameters (server, username or passwords) you have to specify the
@ -518,10 +519,11 @@
# Expects a boolean value
# (optional; default: false)
#
# - purge_unconfigured_folders (vSphere Provider only)
# Enable purging of VMs and folders detected within the base folder path that are not configured for the provider
# Only a single layer of folders and their child VMs are evaluated from detected base folder paths
# A base folder path for 'vmpooler/redhat-7' would be 'vmpooler'
# - purge_unconfigured_folders DEPRECATED, use purge_unconfigured_resources
# - purge_unconfigured_resources
# Enable purging of resources (typically VMs) or other items based on the provider. Provides a high-level cleanup
# mechanism for things that are live but not found in the vmpooler config ie in a pool config. See the provider's
# implementation for more details.
# When enabled in the global configuration then purging is enabled for all providers
# Expects a boolean value
# (optional; default: false)
@ -579,7 +581,8 @@
#
# Example:
:config: site_name: 'vmpooler'
:config:
site_name: 'vmpooler'
logfile: '/var/log/vmpooler.log'
task_limit: 10
timeout: 15