Configure project defaults or task specifics for Terraform.
This also allows the terraform executable to be set
It can be passed by a single map option.
// By tag (Gradle will download and cache the correct distribution).
executable tag : '0.10.1'
// By a physical path (
executable path : '/path/to/terraform'
// By using searchPath (will attempt to locate in search path).
executable searchPath()
If the build runs on a platform that supports downloading of the terraform executable
the default will be to use the version as specified by TerraformExtension.TERRAFORM_DEFAULT,
otherwise it will be in search mode.
| Modifiers | Name | Description |
|---|---|---|
static java.lang.String |
NAME |
The standard extension name. |
static java.lang.String |
TERRAFORM_DEFAULT |
The default version of Terraform that will be used on a supported platform if nothing else is configured. |
| Fields inherited from class | Fields |
|---|---|
class org.ysb33r.grolifant.api.exec.AbstractToolExtension |
__$stMC, __$stMC |
class org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension |
__$stMC |
| Type | Name and description |
|---|---|
java.util.Map<java.lang.String, ?> |
environment |
| Constructor and description |
|---|
TerraformExtension
(org.gradle.api.Project project)Function to return all Terraform variables from an extension. // * // |
TerraformExtension
(AbstractTerraformTask task, java.util.List<TerraformExtensionConfigTypes> configExtensions)Constructs a new extension which is attached to the provided task. |
| Type Params | Return Type | Name and description |
|---|---|---|
|
void |
environment(java.util.Map<java.lang.String, ?> args)Add environmental variables to be passed to the exe. |
|
Variables |
getAllVariables()Returns all terraform variables and descriptions of variables within files within the specific context |
|
java.util.Map<java.lang.String, java.lang.String> |
getEnvironment()Environment for running the exe |
|
boolean |
getWarnOnNewVersion()Print a warning message if a new version of terraform is available. |
|
static java.util.Map<java.lang.String, java.lang.Object> |
searchPath()Use this to configure a system path search for Terraform. |
|
void |
setEnvironment(java.util.Map<java.lang.String, ?> args)Replace current environment with new one. |
|
void |
setWarnOnNewVersion(boolean value)Turn checkpoint warning on or off |
|
java.lang.String |
terraformPath(java.lang.Object file)Converts a file path to a format suitable for interpretation by Terraform on the appropriate platform. |
|
void |
useAwsEnvironment()Adds AWS environmental variables to Terraform runtime environment. |
|
void |
warnOnNewVersion(boolean value)Turn checkpoint warning on or off |
| Methods inherited from class | Name |
|---|---|
class org.ysb33r.grolifant.api.exec.AbstractToolExtension |
org.ysb33r.grolifant.api.exec.AbstractToolExtension#getResolver(), org.ysb33r.grolifant.api.exec.AbstractToolExtension#getTypeResolver(), org.ysb33r.grolifant.api.exec.AbstractToolExtension#getResolvableExecutable(), org.ysb33r.grolifant.api.exec.AbstractToolExtension#getResolvableExecutableType(), org.ysb33r.grolifant.api.exec.AbstractToolExtension#executable(java.util.Map), org.ysb33r.grolifant.api.exec.AbstractToolExtension#getValueByMethod(java.lang.String), org.ysb33r.grolifant.api.exec.AbstractToolExtension#invokeMethod(java.lang.String, java.lang.Object), org.ysb33r.grolifant.api.exec.AbstractToolExtension#getMetaClass(), org.ysb33r.grolifant.api.exec.AbstractToolExtension#setMetaClass(groovy.lang.MetaClass), org.ysb33r.grolifant.api.exec.AbstractToolExtension#setProperty(java.lang.String, java.lang.Object), org.ysb33r.grolifant.api.exec.AbstractToolExtension#getProperty(java.lang.String), org.ysb33r.grolifant.api.exec.AbstractToolExtension#getValue(groovy.lang.Closure), org.ysb33r.grolifant.api.exec.AbstractToolExtension#wait(long, int), org.ysb33r.grolifant.api.exec.AbstractToolExtension#wait(long), org.ysb33r.grolifant.api.exec.AbstractToolExtension#wait(), org.ysb33r.grolifant.api.exec.AbstractToolExtension#equals(java.lang.Object), org.ysb33r.grolifant.api.exec.AbstractToolExtension#toString(), org.ysb33r.grolifant.api.exec.AbstractToolExtension#hashCode(), org.ysb33r.grolifant.api.exec.AbstractToolExtension#getClass(), org.ysb33r.grolifant.api.exec.AbstractToolExtension#notify(), org.ysb33r.grolifant.api.exec.AbstractToolExtension#notifyAll() |
class org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension |
org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#getValueByMethod(java.lang.String), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#invokeMethod(java.lang.String, java.lang.Object), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#getMetaClass(), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#setMetaClass(groovy.lang.MetaClass), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#setProperty(java.lang.String, java.lang.Object), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#getProperty(java.lang.String), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#getValue(groovy.lang.Closure), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#wait(long, int), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#wait(long), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#wait(), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#equals(java.lang.Object), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#toString(), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#hashCode(), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#getClass(), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#notify(), org.ysb33r.grolifant.api.AbstractCombinedProjectTaskExtension#notifyAll() |
The standard extension name.
The default version of Terraform that will be used on a supported platform if nothing else is configured.
Function to return all Terraform variables from an extension. // * //
Constructs a new extension which is attached to the provided task.
project - Project this extension is associated with.configExtensions - Configuration extensions that have to be added. Has to implement
TerraformExtensionEmbeddable interface.Add environmental variables to be passed to the exe.
args - Environmental variable key-value map.Returns all terraform variables and descriptions of variables within files within the specific context If this is a project extension only return the global varibale definitions are returned. If this is a task extension and globals are not ignored, then return a combination of the global variables, the source set variables and the local task extension variables. If this is a task extension and globals ignored, then return a combination of source set variables and the local task extension variables. Task extension variables overrides source set variables which in turn overrides global variables. Files ocntaining variables are simply added to a list in order of global, source set, local.
Environment for running the exe
Calling this will resolve all lazy-values in the variable map.
Print a warning message if a new version of terraform is available.
Use this to configure a system path search for Terraform.
Replace current environment with new one. If this is called on the task extension, no project extension environment will be used.
args - New environment key-value map of properties.Turn checkpoint warning on or off
value - true to warn on new terraform versions.Converts a file path to a format suitable for interpretation by Terraform on the appropriate platform.
file - Object that can be converted using project.file.Adds AWS environmental variables to Terraform runtime environment.
Turn checkpoint warning on or off
value - true to warn on new terraform versions.Groovy Documentation