Terraform Plugin Reference 9.0.x
The XL Deploy Terraform plugin adds capability for building, changing, and versioning infrastructure. The plugin uses the Terraform client to apply or destroy the Terraform configuration. For more information about the plugin features, see Introduction to the XL Deploy Terraform plugin.
Requirements
- XL Deploy 8.6.0 or later
- Terraform 0.11.3 or later
Release notes
XL Deploy Terraform plugin 9.0.5
Bug Fixes
- [XLINT-834] - Add support for remote source in modules
XL Deploy Terraform plugin 9.0.2
Bug Fixes
- [LOVE-1155] - Changed GKE cluster names
XL Deploy Terraform plugin 9.0.1
Bug Fixes
- [LOVE-1117] - Remove Kubernetes YAML view feature
- [LOVE-1151] - Fix escaping path
XL Deploy Terraform plugin 9.0.0
Bug Fixes
- [LOVE-529] - Automatically create deployeds(infrastructure) from Terraform deployables GCP-K8s
- [LOVE-670] - Having some special characters in K8SMasterPassword secrets breaks GKE deployment
- [LOVE-889] - Automatically create deployeds(infrastructure) from Terraform deployables Azure-K8s
- [LOVE-890] - Suppress Terraform parameters logging
- [LOVE-917] - Show Terraform modules in package explorer
- [LOVE-918] - Show Terraform plan output in step preview
- [LOVE-969] - Add a read-only type for XL Deploy synthetic fields
- [LOVE-1021] - Rollback fails for Terraform AWS itest
XL Deploy Terraform plugin 8.6.0
Improvements
- Updates from xl-platform and xl-deploy
XL Deploy Terraform plugin 8.0.1
Bug Fixes
- [DEPL-13558] - Exception is thrown while connecting to remote and windows machine
XL Deploy Terraform plugin 8.0.0
New features
- [DEPL-12847] - Apply and destroy the terraform configuration.
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| terraform.Module | Description unavailable (deployable) |
Deployeds
| CI | Description |
|---|---|
| terraform.ExecutedModule | Description unavailable |
Containers
| CI | Description |
|---|---|
| terraform.TerraformClient | Description unavailable |
Configuration Item Details
terraform.ExecutedModule
| Type Hierarchy | udm.BaseDeployedInfrastructureAsCode >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
automaticDictionary: BOOLEAN = true
|
|
If true, XL Deploy will automatically create a dictionary containing the output variables and add it to the environment.
|
||
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.BaseConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
dictionaryPath: STRING
|
|
Path to the dictionary containing the output variables. If empty, the dictionary name will be the name of the template concatenated with -dictionary. If you specify a dictionary name, it will be created in the same folder as the target environment or in the folder specified for the new environment. You can also specify a full path starting with 'Environments/'.
|
||
|
|
|
environmentPath: STRING
|
|
Path to the new environment. If empty, the generated CIs will be added to the target environment. If you specify an environment name, the new environment will be created in the same folder as the target environment. If you specify a folder and an environment name, they will be created in the same folder as the target environment. You can also specify a full path starting with 'Environments/'.
|
||
|
|
|
generateCIsFromResources: BOOLEAN = true
|
|
If true, XL Deploy will automatically create CIs based on resources that are deployed.
|
||
|
|
|
generatedConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
Set of infrastructure resources mapped to configuration items.
|
||
|
|
|
inputVariables: MAP_STRING_STRING
|
|
Input variables to be used in the Terraform configuration.
|
||
|
|
|
outputVariables: MAP_STRING_STRING
|
|
Output variables captured in deployed. Key is the alias name and value is the terraform output property value for a given resource.
|
||
|
|
|
parallelism: INTEGER = 10
|
|
Limit the number of parallel resource operations.
|
||
|
|
|
placeholders: MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
||
|
|
|
secretInputVariables: MAP_STRING_STRING
|
|
Secret input variables to be used in the Terraform configuration.
|
||
|
|
|
targets: LIST_OF_STRING
|
|
Resources to target. Operation will be limited to these resources and their dependencies.
|
terraform.Module
| Type Hierarchy | udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FolderArtifact, udm.SourceArtifact, udm.Taggable |
Description unavailable (deployable)
| Public properties | ||
|---|---|---|
|
|
|
automaticDictionary: STRING
|
|
If true, XL Deploy will automatically create a dictionary containing the output variables and add it to the environment. (boolean) default(true)
|
||
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
||
|
|
|
checksum: STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
credentials:
CI<credentials.Credentials>
|
|
Credentials of the URI.
|
||
|
|
|
dictionaryPath: STRING
|
|
Path to the dictionary containing the output variables. If empty, the dictionary name will be the name of the template concatenated with -dictionary. If you specify a dictionary name, it will be created in the same folder as the target environment or in the folder specified for the new environment. You can also specify a full path starting with 'Environments/'. (string) default()
|
||
|
|
|
environmentPath: STRING
|
|
Path to the new environment. If empty, the generated CIs will be added to the target environment. If you specify an environment name, the new environment will be created in the same folder as the target environment. If you specify a folder and an environment name, they will be created in the same folder as the target environment. You can also specify a full path starting with 'Environments/'. (string) default()
|
||
|
|
|
excludeFileNamesRegex: STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
fileUri: STRING
|
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
|
generateCIsFromResources: STRING
|
|
If true, XL Deploy will automatically create CIs based on resources that are deployed. (boolean) default(true)
|
||
|
|
|
inputVariables: MAP_STRING_STRING
|
|
Input variables to be used in the Terraform configuration. (map_string_string)
|
||
|
|
|
parallelism: STRING
|
|
Limit the number of parallel resource operations. (integer) default(10)
|
||
|
|
|
placeholders: SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
preScannedPlaceholders: BOOLEAN
|
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
|
proxySettings:
CI<credentials.ProxySettings>
|
|
Proxy Settings for artifact location
|
||
|
|
|
scanPlaceholders: BOOLEAN = true
|
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
|
secretInputVariables: MAP_STRING_STRING
|
|
Secret input variables to be used in the Terraform configuration. (map_string_string)
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
targets: LIST_OF_STRING
|
|
Resources to target. Operation will be limited to these resources and their dependencies. (list_of_string)
|
| Hidden properties | ||
|---|---|---|
|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files
|
||
|
|
|
delimiters: STRING = {{ }}
|
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
||
|
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
|
A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
|
||
|
|
|
outputVariables: MAP_STRING_STRING
|
|
Output variables captured in deployed. Key is the alias name and value is the terraform output property value for a given resource.
|
terraform.TerraformClient
| Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Container, udm.Taggable |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
host:
CI<overthere.Host>
|
|
Host
|
| Public properties | ||
|---|---|---|
|
|
|
cpCommand: STRING = cp -R
|
|
Copy command for UNIX systems.
|
||
|
|
|
path: STRING = /usr/local/bin
|
|
Terraform client installation path.
|
||
|
|
|
workingDirectory: STRING
|
|
Terraform working directory. The Terraform state file and downloaded plugins will reside in a sub directory with the name of the deployed CI
|
||
|
|
|
pluginDirectory: STRING
|
|
Terraform client plugins directory.
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|