mirror of
https://github.com/opentffoundation/opentf.git
synced 2026-04-22 12:02:11 -04:00
a303a03f2f
This is a secondary change to PR #28578 Details: According to the [Provisioner Connection](https://www.terraform.io/docs/language/resources/provisioners/connection.html) page, provisioners require the connection block. This change of behavior is shown prominently within a note on the [Provisioner Connection](https://www.terraform.io/docs/language/resources/provisioners/connection.html) page: > Note: In Terraform 0.11 and earlier, providers could set default values for some connection settings, so that connection blocks could sometimes be omitted. This feature was removed in 0.12 in order to make Terraform's behavior more predictable. However, this behavioral change is omitted from the [remote-exec provisioner](https://www.terraform.io/docs/language/resources/provisioners/remote-exec.html) page which is where a user will be if they are attempting to follow the prior behavior when this was permissible in versions prior to 0.12. This change prompts the user of that change and directs to the connection page.
88 lines
3.1 KiB
Markdown
88 lines
3.1 KiB
Markdown
---
|
|
layout: "language"
|
|
page_title: "Provisioner: remote-exec"
|
|
sidebar_current: "docs-provisioners-remote"
|
|
description: |-
|
|
The `remote-exec` provisioner invokes a script on a remote resource after it is created. This can be used to run a configuration management tool, bootstrap into a cluster, etc. To invoke a local process, see the `local-exec` provisioner instead. The `remote-exec` provisioner supports both `ssh` and `winrm` type connections.
|
|
---
|
|
|
|
# remote-exec Provisioner
|
|
|
|
The `remote-exec` provisioner invokes a script on a remote resource after it
|
|
is created. This can be used to run a configuration management tool, bootstrap
|
|
into a cluster, etc. To invoke a local process, see the `local-exec`
|
|
[provisioner](/docs/language/resources/provisioners/local-exec.html) instead. The `remote-exec`
|
|
provisioner requires a [connection](/docs/language/resources/provisioners/connection.html)
|
|
and supports both `ssh` and `winrm`.
|
|
|
|
-> **Note:** Provisioners should only be used as a last resort. For most
|
|
common situations there are better alternatives. For more information, see
|
|
[the main Provisioners page](./).
|
|
|
|
## Example usage
|
|
|
|
```hcl
|
|
resource "aws_instance" "web" {
|
|
# ...
|
|
|
|
# Establishes connection to be used by all
|
|
# generic remote provisioners (i.e. file/remote-exec)
|
|
connection {
|
|
type = "ssh"
|
|
user = "root"
|
|
password = var.root_password
|
|
host = self.public_ip
|
|
}
|
|
|
|
provisioner "remote-exec" {
|
|
inline = [
|
|
"puppet apply",
|
|
"consul join ${aws_instance.web.private_ip}",
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
## Argument Reference
|
|
|
|
The following arguments are supported:
|
|
|
|
* `inline` - This is a list of command strings. They are executed in the order
|
|
they are provided. This cannot be provided with `script` or `scripts`.
|
|
|
|
* `script` - This is a path (relative or absolute) to a local script that will
|
|
be copied to the remote resource and then executed. This cannot be provided
|
|
with `inline` or `scripts`.
|
|
|
|
* `scripts` - This is a list of paths (relative or absolute) to local scripts
|
|
that will be copied to the remote resource and then executed. They are executed
|
|
in the order they are provided. This cannot be provided with `inline` or `script`.
|
|
|
|
-> **Note:** Since `inline` is implemented by concatenating commands into a script, [`on_failure`](/docs/language/resources/provisioners/syntax.html#failure-behavior) applies only to the final command in the list. In particular, with `on_failure = fail` (the default behaviour) earlier commands will be allowed to fail, and later commands will also execute. If this behaviour is not desired, consider using `"set -o errexit"` as the first command.
|
|
|
|
## Script Arguments
|
|
|
|
You cannot pass any arguments to scripts using the `script` or
|
|
`scripts` arguments to this provisioner. If you want to specify arguments,
|
|
upload the script with the
|
|
[file provisioner](/docs/language/resources/provisioners/file.html)
|
|
and then use `inline` to call it. Example:
|
|
|
|
```hcl
|
|
resource "aws_instance" "web" {
|
|
# ...
|
|
|
|
provisioner "file" {
|
|
source = "script.sh"
|
|
destination = "/tmp/script.sh"
|
|
}
|
|
|
|
provisioner "remote-exec" {
|
|
inline = [
|
|
"chmod +x /tmp/script.sh",
|
|
"/tmp/script.sh args",
|
|
]
|
|
}
|
|
}
|
|
```
|