Hcl2 input variables, local variables and functions (#8588)
Mainly redefine or reused what Terraform did.
* allow to used `variables`, `variable` and `local` blocks
* import the following functions and their docs from Terraform: abs, abspath, basename, base64decode, base64encode, bcrypt, can, ceil, chomp, chunklist, cidrhost, cidrnetmask, cidrsubnet, cidrsubnets, coalesce, coalescelist, compact, concat, contains, convert, csvdecode, dirname, distinct, element, file, fileexists, fileset, flatten, floor, format, formatdate, formatlist, indent, index, join, jsondecode, jsonencode, keys, length, log, lookup, lower, max, md5, merge, min, parseint, pathexpand, pow, range, reverse, rsadecrypt, setintersection, setproduct, setunion, sha1, sha256, sha512, signum, slice, sort, split, strrev, substr, timestamp, timeadd, title, trim, trimprefix, trimspace, trimsuffix, try, upper, urlencode, uuidv4, uuidv5, values, yamldecode, yamlencode, zipmap.
2020-02-06 11:49:21 +01:00
|
|
|
---
|
2020-03-18 18:46:47 -04:00
|
|
|
page_title: pathexpand - Functions - Configuration Language
|
2020-04-02 19:39:47 -04:00
|
|
|
sidebar_title: pathexpand
|
Hcl2 input variables, local variables and functions (#8588)
Mainly redefine or reused what Terraform did.
* allow to used `variables`, `variable` and `local` blocks
* import the following functions and their docs from Terraform: abs, abspath, basename, base64decode, base64encode, bcrypt, can, ceil, chomp, chunklist, cidrhost, cidrnetmask, cidrsubnet, cidrsubnets, coalesce, coalescelist, compact, concat, contains, convert, csvdecode, dirname, distinct, element, file, fileexists, fileset, flatten, floor, format, formatdate, formatlist, indent, index, join, jsondecode, jsonencode, keys, length, log, lookup, lower, max, md5, merge, min, parseint, pathexpand, pow, range, reverse, rsadecrypt, setintersection, setproduct, setunion, sha1, sha256, sha512, signum, slice, sort, split, strrev, substr, timestamp, timeadd, title, trim, trimprefix, trimspace, trimsuffix, try, upper, urlencode, uuidv4, uuidv5, values, yamldecode, yamlencode, zipmap.
2020-02-06 11:49:21 +01:00
|
|
|
description: |-
|
|
|
|
|
The pathexpand function expands a leading ~ character to the current user's
|
|
|
|
|
home directory.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# `pathexpand` Function
|
|
|
|
|
|
|
|
|
|
`pathexpand` takes a filesystem path that might begin with a `~` segment,
|
|
|
|
|
and if so it replaces that segment with the current user's home directory
|
|
|
|
|
path.
|
|
|
|
|
|
|
|
|
|
This function works only with the path string and does not access the
|
|
|
|
|
filesystem itself. It is therefore unable to take into account filesystem
|
|
|
|
|
features such as symlinks.
|
|
|
|
|
|
|
|
|
|
If the leading segment in the path is not `~` then the given path is returned
|
|
|
|
|
unmodified.
|
|
|
|
|
|
|
|
|
|
Using this function in resource arguments will cause spurious diffs if the
|
|
|
|
|
same configuration is run by multiple users with different home directory
|
|
|
|
|
paths, or used on different host operating systems. We recommend using this
|
|
|
|
|
function only for transient values, such as in `connection` and `provisioner`
|
|
|
|
|
blocks to locate SSH keys, etc.
|
|
|
|
|
|
|
|
|
|
The rules for determining the "home directory" for the current user vary
|
|
|
|
|
depending on host operating system.
|
|
|
|
|
|
|
|
|
|
**For Unix systems**, the following sources are consulted, in order of preference:
|
|
|
|
|
|
2020-03-18 18:46:47 -04:00
|
|
|
- The `HOME` environment variable.
|
|
|
|
|
- The result of running `getent passwd` followed by the Packer process uid.
|
|
|
|
|
- The result of running `cd && pwd` in `sh`.
|
Hcl2 input variables, local variables and functions (#8588)
Mainly redefine or reused what Terraform did.
* allow to used `variables`, `variable` and `local` blocks
* import the following functions and their docs from Terraform: abs, abspath, basename, base64decode, base64encode, bcrypt, can, ceil, chomp, chunklist, cidrhost, cidrnetmask, cidrsubnet, cidrsubnets, coalesce, coalescelist, compact, concat, contains, convert, csvdecode, dirname, distinct, element, file, fileexists, fileset, flatten, floor, format, formatdate, formatlist, indent, index, join, jsondecode, jsonencode, keys, length, log, lookup, lower, max, md5, merge, min, parseint, pathexpand, pow, range, reverse, rsadecrypt, setintersection, setproduct, setunion, sha1, sha256, sha512, signum, slice, sort, split, strrev, substr, timestamp, timeadd, title, trim, trimprefix, trimspace, trimsuffix, try, upper, urlencode, uuidv4, uuidv5, values, yamldecode, yamlencode, zipmap.
2020-02-06 11:49:21 +01:00
|
|
|
|
|
|
|
|
**For Windows systems**, there is not really the concept of a home directory
|
|
|
|
|
in the same sense as on Unix, but the following sources are consulted in
|
|
|
|
|
order of preference:
|
|
|
|
|
|
2020-03-18 18:46:47 -04:00
|
|
|
- The `HOME` environment variable.
|
|
|
|
|
- The `HOMEDRIVE` and `HOMEPATH` environment variables, if both are set.
|
|
|
|
|
- The `USERPROFILE` environment variable.
|
Hcl2 input variables, local variables and functions (#8588)
Mainly redefine or reused what Terraform did.
* allow to used `variables`, `variable` and `local` blocks
* import the following functions and their docs from Terraform: abs, abspath, basename, base64decode, base64encode, bcrypt, can, ceil, chomp, chunklist, cidrhost, cidrnetmask, cidrsubnet, cidrsubnets, coalesce, coalescelist, compact, concat, contains, convert, csvdecode, dirname, distinct, element, file, fileexists, fileset, flatten, floor, format, formatdate, formatlist, indent, index, join, jsondecode, jsonencode, keys, length, log, lookup, lower, max, md5, merge, min, parseint, pathexpand, pow, range, reverse, rsadecrypt, setintersection, setproduct, setunion, sha1, sha256, sha512, signum, slice, sort, split, strrev, substr, timestamp, timeadd, title, trim, trimprefix, trimspace, trimsuffix, try, upper, urlencode, uuidv4, uuidv5, values, yamldecode, yamlencode, zipmap.
2020-02-06 11:49:21 +01:00
|
|
|
|
|
|
|
|
The exact rules employed for each operating system may change in future
|
|
|
|
|
releases of Packer.
|
|
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
2020-05-29 17:12:05 -04:00
|
|
|
```shell-session
|
Hcl2 input variables, local variables and functions (#8588)
Mainly redefine or reused what Terraform did.
* allow to used `variables`, `variable` and `local` blocks
* import the following functions and their docs from Terraform: abs, abspath, basename, base64decode, base64encode, bcrypt, can, ceil, chomp, chunklist, cidrhost, cidrnetmask, cidrsubnet, cidrsubnets, coalesce, coalescelist, compact, concat, contains, convert, csvdecode, dirname, distinct, element, file, fileexists, fileset, flatten, floor, format, formatdate, formatlist, indent, index, join, jsondecode, jsonencode, keys, length, log, lookup, lower, max, md5, merge, min, parseint, pathexpand, pow, range, reverse, rsadecrypt, setintersection, setproduct, setunion, sha1, sha256, sha512, signum, slice, sort, split, strrev, substr, timestamp, timeadd, title, trim, trimprefix, trimspace, trimsuffix, try, upper, urlencode, uuidv4, uuidv5, values, yamldecode, yamlencode, zipmap.
2020-02-06 11:49:21 +01:00
|
|
|
> pathexpand("~/.ssh/id_rsa")
|
|
|
|
|
/home/steve/.ssh/id_rsa
|
|
|
|
|
> pathexpand("/etc/resolv.conf")
|
|
|
|
|
/etc/resolv.conf
|
|
|
|
|
```
|
