Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: string templates #13049

Merged
merged 1 commit into from
Jun 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions website/content/docs/templates/hcl_templates/expressions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -429,3 +429,54 @@ beginning a template sequence, double the leading character: `$${` or `%%{`.
Within quoted and heredoc string expressions, the sequences `${` and `%{` begin
_template sequences_. Templates let you directly embed expressions into a string
literal, to dynamically construct strings from other values.

The following example demonstrates how a template sequence can be used to embed
the value of a variable into a string that can be used as script content:

```hcl
locals {
packages = ["git", "curl", "vim"]

install_packages = <<-EOF
#!/bin/bash
if [ ${length(local.packages)} -eq 0 ]; then
echo "No packages to install."
exit 1
fi
apt-get update
%{ for package in local.packages ~}
apt-get install -y ${package}
%{ endfor ~}
EOF
}

source "amazon-ebs" "example" {
# ...
}

build {
sources = ["source.amazon-ebs.example"]

provisioner "shell" {
inline = [local.install_packages]
}
}
```

This can be tested using the `packer console` command:

```shell
$ packer source.pkr.hcl

> local.install_packages

> #!/bin/bash
if [ 3 -eq 0 ]; then
echo "No packages to install."
exit 1
fi
apt-get update
apt-get install -y git
apt-get install -y curl
apt-get install -y vim
```
Loading