spec the purge method and align it with the new base method signature

This commit is contained in:
Samuel Beaulieu 2021-12-08 10:33:25 -06:00
parent 761c96fd38
commit fc7a628063
No known key found for this signature in database
GPG key ID: 12030F74136D0F34
4 changed files with 176 additions and 62 deletions

View file

@ -14,8 +14,8 @@
#
# - purge_unconfigured_resources
# Enable purging of VMs detected
# For GCE: by default any VM in the project but without a "pool" label, or a "pool" label with the value for an unconfigured pool
# An optional allowlist can be provided to ignore purging certain folders or pool labels
# By default will purge VMs in the project without a "pool" label, or a "pool" label with the value for an unconfigured pool
# An optional allowlist can be provided to ignore purging certain VMs based on pool labels
#
# Setting this on the provider will enable purging for the provider
# Expects a boolean value
@ -25,7 +25,7 @@
# For GCE: Specify pool labels that should be ignored when purging VMs, for pools that are not configured. For example if the label is
# set to 'pool=donotdelete' and there is no pool with that name configured, adding "donotdelete" to the allowlist would not purge the VM.
# adding "" (empty string) to the allowlist has a special meaning whereas VMs that do not have the "pool" label are also not purged.
# This option is only evaluated when 'purge_unconfigured_folders' is enabled
# This option is only evaluated when 'purge_unconfigured_resources' is enabled
# Expects an array of strings specifying the allowlisted labels by name
# (optional; default: nil)
#