puppetlabs/vmpooler
2
0
Fork 0
mirror of https://github.com/puppetlabs/vmpooler.git synced 2026-01-26 01:58:41 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add documentation for new parameters to example configuration files

Browse source
This commit is contained in:
kirby@puppetlabs.com 2018-07-13 12:24:55 -07:00
parent c64a8afc3f
commit d9e1feadea
1 changed files with 25 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

25
vmpooler.yaml.example
View file

@ -11,6 +11,22 @@
# For multiple providers, specify one of the supported backing services (vsphere or dummy) # For multiple providers, specify one of the supported backing services (vsphere or dummy)
# (optional: will default to it's parent :key: name eg. 'vsphere') # (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
# 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
# (optional; default: nil)
#
# If you want to support more than one provider with different parameters (server, username or passwords) you have to specify the # If you want to support more than one provider with different parameters (server, username or passwords) you have to specify the
# backing service in the provider_class configuration parameter for example 'vsphere' or 'dummy'. Each pool can specify # backing service in the provider_class configuration parameter for example 'vsphere' or 'dummy'. Each pool can specify
# the provider to use. # the provider to use.
@ -298,6 +314,7 @@
# #
# - base # - base
# The base DN used for LDAP searches. # The base DN used for LDAP searches.
# This can be a string providing a single DN, or an array of DNs to search.
# #
# - user_object # - user_object
# The LDAP object-type used to designate a user object. # The LDAP object-type used to designate a user object.
@ -448,6 +465,14 @@
# Expects a boolean value # Expects a boolean value
# (optional; default: false) # (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'
# When enabled in the global configuration then purging is enabled for all providers
# Expects a boolean value
# (optional; default: false)
#
# Example: # Example:
:config: :config: