fix all local relative links
This commit is contained in:
Jeff Escalante
parent
bdd9f5bd08
commit
af257c2bb9
|
|
@ -17,7 +17,7 @@ type AlicloudDiskDevice struct {
|
|||
// 128] English or Chinese characters, must begin with an
|
||||
// uppercase/lowercase letter or Chinese character. Can contain numbers,
|
||||
// ., _ and -. The disk name will appear on the console. It cannot
|
||||
// begin with http:// or https://.
|
||||
// begin with `http:// or `https://`.
|
||||
DiskName string `mapstructure:"disk_name" required:"false"`
|
||||
// Category of the system disk. Optional values
|
||||
// are:
|
||||
|
|
@ -35,7 +35,7 @@ type AlicloudDiskDevice struct {
|
|||
SnapshotId string `mapstructure:"disk_snapshot_id" required:"false"`
|
||||
// The value of disk description is blank by
|
||||
// default. [2, 256] characters. The disk description will appear on the
|
||||
// console. It cannot begin with http:// or https://.
|
||||
// console. It cannot begin with `http://` or `https://`.
|
||||
Description string `mapstructure:"disk_description" required:"false"`
|
||||
// Whether or not the disk is
|
||||
// released along with the instance:
|
||||
|
|
@ -139,14 +139,14 @@ type AlicloudImageConfig struct {
|
|||
// The name of the user-defined image, [2, 128]
|
||||
// English or Chinese characters. It must begin with an uppercase/lowercase
|
||||
// letter or a Chinese character, and may contain numbers, _ or -. It
|
||||
// cannot begin with http:// or https://.
|
||||
// cannot begin with `http://` or `https://`.
|
||||
AlicloudImageName string `mapstructure:"image_name" required:"true"`
|
||||
// The version number of the image, with a length
|
||||
// limit of 1 to 40 English characters.
|
||||
AlicloudImageVersion string `mapstructure:"image_version" required:"false"`
|
||||
// The description of the image, with a length
|
||||
// limit of 0 to 256 characters. Leaving it blank means null, which is the
|
||||
// default value. It cannot begin with http:// or https://.
|
||||
// default value. It cannot begin with `http://` or `https://`.
|
||||
AlicloudImageDescription string `mapstructure:"image_description" required:"false"`
|
||||
// The IDs of to-be-added Aliyun
|
||||
// accounts to which the image is shared. The number of accounts is 1 to 10.
|
||||
|
|
@ -158,7 +158,7 @@ type AlicloudImageConfig struct {
|
|||
// The name of the destination image,
|
||||
// [2, 128] English or Chinese characters. It must begin with an
|
||||
// uppercase/lowercase letter or a Chinese character, and may contain numbers,
|
||||
// _ or -. It cannot begin with http:// or https://.
|
||||
// _ or -. It cannot begin with `http://` or `https://`.
|
||||
AlicloudImageDestinationNames []string `mapstructure:"image_copy_names" required:"false"`
|
||||
// Whether or not to encrypt the target images, including those copied if image_copy_regions is specified. If this option
|
||||
// is set to true, a temporary image will be created from the provisioned
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ type RunConfig struct {
|
|||
// The security group name. The default value
|
||||
// is blank. [2, 128] English or Chinese characters, must begin with an
|
||||
// uppercase/lowercase letter or Chinese character. Can contain numbers, .,
|
||||
// _ or -. It cannot begin with http:// or https://.
|
||||
// _ or -. It cannot begin with `http://` or `https://`.
|
||||
SecurityGroupName string `mapstructure:"security_group_name" required:"false"`
|
||||
// User data to apply when launching the instance. Note
|
||||
// that you need to be careful about escaping characters due to the templates
|
||||
|
|
@ -73,8 +73,8 @@ type RunConfig struct {
|
|||
// The VPC name. The default value is blank. [2, 128]
|
||||
// English or Chinese characters, must begin with an uppercase/lowercase
|
||||
// letter or Chinese character. Can contain numbers, _ and -. The disk
|
||||
// description will appear on the console. Cannot begin with http:// or
|
||||
// https://.
|
||||
// description will appear on the console. Cannot begin with `http://` or
|
||||
// `https://`.
|
||||
VpcName string `mapstructure:"vpc_name" required:"false"`
|
||||
// Value options: 192.168.0.0/16 and
|
||||
// 172.16.0.0/16. When not specified, the default value is 172.16.0.0/16.
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ customized images based on an existing base images.
|
|||
|
||||
The following configuration options are available for building Alicloud images.
|
||||
In addition to the options listed here, a
|
||||
[communicator](../templates/communicator) can be configured for this
|
||||
[communicator](/docs/templates/communicator) can be configured for this
|
||||
builder.
|
||||
|
||||
### Required:
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ machine. This can be done within a provisioner, but must be done before the
|
|||
builder finishes running.
|
||||
|
||||
~> Instance builds are not supported for Windows. Use
|
||||
[`amazon-ebs`](amazon-ebs) instead.
|
||||
[`amazon-ebs`](/docs/builders/amazon-ebs) instead.
|
||||
|
||||
## Configuration Reference
|
||||
|
||||
|
|
|
|||
|
|
@ -37,8 +37,8 @@ or earlier, we recommend you use Packer v1.1.2 or earlier version.
|
|||
~> **OpenStack Liberty or later requires OpenSSL!** To use the OpenStack
|
||||
builder with OpenStack Liberty (Oct 2015) or later you need to have OpenSSL
|
||||
installed _if you are using temporary key pairs_, i.e. don't use
|
||||
[`ssh_keypair_name`](openstack#ssh_keypair_name) nor
|
||||
[`ssh_password`](/docs/templates/communicator#ssh_password). All major
|
||||
[`ssh_keypair_name`](#ssh_keypair_name) nor
|
||||
[`ssh_password`](#ssh_password). All major
|
||||
OS'es have OpenSSL installed by default except Windows. This have been resolved
|
||||
in OpenStack Ocata(Feb 2017).
|
||||
|
||||
|
|
|
|||
|
|
@ -142,7 +142,7 @@ which discusses the strategy used here.
|
|||
If this is set, a few more options become available.
|
||||
|
||||
- `builder_communicator` (communicator) - This represents an
|
||||
[`ssh communicator`](/docs/templates/communicator#ssh-communicator),
|
||||
[`ssh communicator`](/docs/communicators/ssh),
|
||||
and can be configured as such. If you use a different builder image, you
|
||||
may need to change the `ssh_username`, for example. That might look like
|
||||
this:
|
||||
|
|
|
|||
|
|
@ -84,8 +84,8 @@ builder.
|
|||
operation available in the Core Services API.
|
||||
|
||||
Note: the subnet must be configured to allow access via your chosen
|
||||
[communicator](/docs/templates/communicator) (communicator defaults to
|
||||
[SSH tcp/22](/docs/templates/communicator#ssh_port)).
|
||||
[communicator](/docs/communicators) (communicator defaults to
|
||||
[SSH tcp/22](/docs/communicators/ssh#ssh_port)).
|
||||
|
||||
### Optional
|
||||
|
||||
|
|
|
|||
|
|
@ -43,20 +43,20 @@ segmented below into two categories: required and optional parameters. Within
|
|||
each category, the available configuration keys are alphabetized.
|
||||
|
||||
In addition to the options listed here, a
|
||||
[communicator](../templates/communicator) can be configured for this
|
||||
[communicator](/docs/templates/communicator) can be configured for this
|
||||
builder.
|
||||
|
||||
### Required:
|
||||
|
||||
- `access_key` (string) - The access key used to communicate with OUTSCALE. [Learn how to set this](outscale#authentication)
|
||||
- `access_key` (string) - The access key used to communicate with OUTSCALE. [Learn how to set this](/docs/builders/outscale#authentication)
|
||||
|
||||
- `omi_name` (string) - The name of the resulting OMIS that will appear when managing OMIs in the Outscale console or via APIs. This must be unique. To help make this unique, use a function like `timestamp` (see [template engine](../templates/engine) for more info).
|
||||
- `omi_name` (string) - The name of the resulting OMIS that will appear when managing OMIs in the Outscale console or via APIs. This must be unique. To help make this unique, use a function like `timestamp` (see [template engine](/docs/templates/engine) for more info).
|
||||
|
||||
- `vm_type` (string) - The Outscale VM type to use while building the OMI, such as `t2.small`.
|
||||
|
||||
- `region` (string) - The name of the region, such as `us-east-1`, in which to launch the Outscale VM to create the OMI.
|
||||
|
||||
- `secret_key` (string) - The secret key used to communicate with Outscale. [Learn how to set this](outscale#authentication)
|
||||
- `secret_key` (string) - The secret key used to communicate with Outscale. [Learn how to set this](/docs/builders/outscale#authentication)
|
||||
|
||||
- `source_omi` (string) - The initial OMI used as a base for the newly created machine. `source_omi_filter` may be used instead to populate this automatically.
|
||||
|
||||
|
|
@ -83,7 +83,7 @@ builder.
|
|||
|
||||
- `volume_type` (string) - The volume type. `gp2` for General Purpose (SSD) volumes, `io1` for Provisioned IOPS (SSD) volumes, and `standard` for Magnetic volumes
|
||||
|
||||
- `omi_description` (string) - The description to set for the resulting OMI(s). By default this description is empty. This is a [template engine](../templates/engine), see [Build template
|
||||
- `omi_description` (string) - The description to set for the resulting OMI(s). By default this description is empty. This is a [template engine](/docs/templates/engine), see [Build template
|
||||
data](#build-template-data) for more information.
|
||||
|
||||
- `omi_account_ids` (array of strings) - A list of account IDs that have access to launch the resulting OMI(s). By default no additional users other than the user creating the OMIS has permissions to launch it.
|
||||
|
|
@ -133,13 +133,13 @@ builder.
|
|||
- `run_tags` (object of key/value strings) - Tags to apply to the VM
|
||||
that is _launched_ to create the OMI. These tags are _not_ applied to the
|
||||
resulting OMIS unless they're duplicated in `tags`. This is a [template
|
||||
engine](../templates/engine), see [Build template
|
||||
engine](/docs/templates/engine), see [Build template
|
||||
data](#build-template-data) for more information.
|
||||
|
||||
- `run_volume_tags` (object of key/value strings) - Tags to apply to the
|
||||
volumes that are _launched_ to create the OMI. These tags are _not_ applied
|
||||
to the resulting OMIS unless they're duplicated in `tags`. This is a
|
||||
[template engine](../templates/engine), see [Build template
|
||||
[template engine](/docs/templates/engine), see [Build template
|
||||
data](#build-template-data) for more information.
|
||||
|
||||
- `security_group_id` (string) - The ID (_not_ the name) of the security
|
||||
|
|
@ -171,7 +171,7 @@ builder.
|
|||
|
||||
- `snapshot_tags` (object of key/value strings) - Tags to apply to snapshot.
|
||||
They will override OMIS tags if already applied to snapshot. This is a
|
||||
[template engine](../templates/engine), see [Build template
|
||||
[template engine](/docs/templates/engine), see [Build template
|
||||
data](#build-template-data) for more information.
|
||||
|
||||
- `source_omi_filter` (object) - Filters used to populate the `source_omi` field.
|
||||
|
|
@ -198,7 +198,7 @@ builder.
|
|||
This will fail unless _exactly_ one OMIS is returned. In the above example,
|
||||
`most_recent` will cause this to succeed by selecting the newest image.
|
||||
|
||||
- `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the machine. The key must match a key pair name loaded up into Outscale. By default, this is blank, and Packer will generate a temporary keypair unless [`ssh_password`](../templates/communicator#ssh_password) is used. [`ssh_private_key_file`](../templates/communicator#ssh_private_key_file) or `ssh_agent_auth` must be specified when `ssh_keypair_name` is utilized.
|
||||
- `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the machine. The key must match a key pair name loaded up into Outscale. By default, this is blank, and Packer will generate a temporary keypair unless [`ssh_password`](/docs/templates/communicator#ssh_password) is used. [`ssh_private_key_file`](/docs/templates/communicator#ssh_private_key_file) or `ssh_agent_auth` must be specified when `ssh_keypair_name` is utilized.
|
||||
|
||||
- `ssh_agent_auth` (boolean) - If true, the local SSH agent will be used to authenticate connections to the source VM. No temporary keypair will be created, and the values of `ssh_password` and `ssh_private_key_file` will be ignored. To use this option with a key pair already configured in the source OMI, leave the `ssh_keypair_name` blank. To associate an existing key pair in Outscale with the source VM, set the `ssh_keypair_name` field to the name of the key pair.
|
||||
|
||||
|
|
@ -208,7 +208,7 @@ builder.
|
|||
|
||||
- `subnet_id` (string) - If using Net, the ID of the subnet, such as `subnet-12345def`, where Packer will launch the VM. This field is required if you are using an non-default Net.
|
||||
|
||||
- `tags` (object of key/value strings) - Tags applied to the OMIS and relevant snapshots. This is a [template engine](../templates/engine), see [Build template data](#build-template-data) for more information.
|
||||
- `tags` (object of key/value strings) - Tags applied to the OMIS and relevant snapshots. This is a [template engine](/docs/templates/engine), see [Build template data](#build-template-data) for more information.
|
||||
|
||||
- `temporary_key_pair_name` (string) - The name of the temporary key pair to generate. By default, Packer generates a name that looks like `packer_<UUID>`, where <UUID> is a 36 character unique identifier.
|
||||
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ builder.
|
|||
|
||||
- `access_key` (string) - The access key used to communicate with OUTSCALE. [Learn how to set this](outscale#authentication)
|
||||
|
||||
- `omi_name` (string) - The name of the resulting OMIS that will appear when managing OMIs in the Outscale console or via APIs. This must be unique. To help make this unique, use a function like `timestamp` (see [template engine](../templates/engine) for more info).
|
||||
- `omi_name` (string) - The name of the resulting OMIS that will appear when managing OMIs in the Outscale console or via APIs. This must be unique. To help make this unique, use a function like `timestamp` (see [template engine](/docs/templates/engine) for more info).
|
||||
|
||||
- `vm_type` (string) - The Outscale VM type to use while building the OMI, such as `t2.small`.
|
||||
|
||||
|
|
@ -79,7 +79,7 @@ builder.
|
|||
|
||||
- `volume_type` (string) - The volume type. `gp2` for General Purpose (SSD) volumes, `io1` for Provisioned IOPS (SSD) volumes, and `standard` for Magnetic volumes
|
||||
|
||||
- `omi_description` (string) - The description to set for the resulting OMI(s). By default this description is empty. This is a [template engine](../templates/engine), see [Build template
|
||||
- `omi_description` (string) - The description to set for the resulting OMI(s). By default this description is empty. This is a [template engine](/docs/templates/engine), see [Build template
|
||||
data](#build-template-data) for more information.
|
||||
|
||||
- `omi_account_ids` (array of strings) - A list of account IDs that have access to launch the resulting OMI(s). By default no additional users other than the user creating the OMIS has permissions to launch it.
|
||||
|
|
@ -141,13 +141,13 @@ builder.
|
|||
- `run_tags` (object of key/value strings) - Tags to apply to the VM
|
||||
that is _launched_ to create the OMI. These tags are _not_ applied to the
|
||||
resulting OMIS unless they're duplicated in `tags`. This is a [template
|
||||
engine](../templates/engine), see [Build template
|
||||
engine](/docs/templates/engine), see [Build template
|
||||
data](#build-template-data) for more information.
|
||||
|
||||
- `run_volume_tags` (object of key/value strings) - Tags to apply to the
|
||||
volumes that are _launched_ to create the OMI. These tags are _not_ applied
|
||||
to the resulting OMIS unless they're duplicated in `tags`. This is a
|
||||
[template engine](../templates/engine), see [Build template
|
||||
[template engine](/docs/templates/engine), see [Build template
|
||||
data](#build-template-data) for more information.
|
||||
|
||||
- `security_group_id` (string) - The ID (_not_ the name) of the security
|
||||
|
|
@ -179,7 +179,7 @@ builder.
|
|||
|
||||
- `snapshot_tags` (object of key/value strings) - Tags to apply to snapshot.
|
||||
They will override OMIS tags if already applied to snapshot. This is a
|
||||
[template engine](../templates/engine), see [Build template
|
||||
[template engine](/docs/templates/engine), see [Build template
|
||||
data](#build-template-data) for more information.
|
||||
|
||||
- `source_omi_filter` (object) - Filters used to populate the `source_omi` field.
|
||||
|
|
@ -206,7 +206,7 @@ builder.
|
|||
This will fail unless _exactly_ one OMIS is returned. In the above example,
|
||||
`most_recent` will cause this to succeed by selecting the newest image.
|
||||
|
||||
- `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the machine. The key must match a key pair name loaded up into Outscale. By default, this is blank, and Packer will generate a temporary keypair unless [`ssh_password`](../templates/communicator#ssh_password) is used. [`ssh_private_key_file`](../templates/communicator#ssh_private_key_file) or `ssh_agent_auth` must be specified when `ssh_keypair_name` is utilized.
|
||||
- `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the machine. The key must match a key pair name loaded up into Outscale. By default, this is blank, and Packer will generate a temporary keypair unless [`ssh_password`](/docs/templates/communicator#ssh_password) is used. [`ssh_private_key_file`](/docs/templates/communicator#ssh_private_key_file) or `ssh_agent_auth` must be specified when `ssh_keypair_name` is utilized.
|
||||
|
||||
- `ssh_agent_auth` (boolean) - If true, the local SSH agent will be used to authenticate connections to the source VM. No temporary keypair will be created, and the values of `ssh_password` and `ssh_private_key_file` will be ignored. To use this option with a key pair already configured in the source OMI, leave the `ssh_keypair_name` blank. To associate an existing key pair in Outscale with the source VM, set the `ssh_keypair_name` field to the name of the key pair.
|
||||
|
||||
|
|
@ -216,7 +216,7 @@ builder.
|
|||
|
||||
- `subnet_id` (string) - If using Net, the ID of the subnet, such as `subnet-12345def`, where Packer will launch the VM. This field is required if you are using an non-default Net.
|
||||
|
||||
- `tags` (object of key/value strings) - Tags applied to the OMIS and relevant snapshots. This is a [template engine](../templates/engine), see [Build template data](#build-template-data) for more information.
|
||||
- `tags` (object of key/value strings) - Tags applied to the OMIS and relevant snapshots. This is a [template engine](/docs/templates/engine), see [Build template data](#build-template-data) for more information.
|
||||
|
||||
- `temporary_key_pair_name` (string) - The name of the temporary key pair to generate. By default, Packer generates a name that looks like `packer_<UUID>`, where <UUID> is a 36 character unique identifier.
|
||||
|
||||
|
|
|
|||
|
|
@ -161,7 +161,7 @@ builder.
|
|||
This will fail unless _exactly_ one OMIS is returned. In the above example,
|
||||
`most_recent` will cause this to succeed by selecting the newest image.
|
||||
|
||||
- `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the machine. The key must match a key pair name loaded up into Outscale. By default, this is blank, and Packer will generate a temporary keypair unless [`ssh_password`](../templates/communicator#ssh_password) is used. [`ssh_private_key_file`](../templates/communicator#ssh_private_key_file) or `ssh_agent_auth` must be specified when `ssh_keypair_name` is utilized.
|
||||
- `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the machine. The key must match a key pair name loaded up into Outscale. By default, this is blank, and Packer will generate a temporary keypair unless [`ssh_password`](/docs/templates/communicator#ssh_password) is used. [`ssh_private_key_file`](/docs/templates/communicator#ssh_private_key_file) or `ssh_agent_auth` must be specified when `ssh_keypair_name` is utilized.
|
||||
|
||||
- `ssh_interface` (string) - One of `public_ip`, `private_ip`, `public_dns`, or `private_dns`. If set, either the public IP address, private IP address, public DNS name or private DNS name will used as the host for SSH. The default behaviour if inside a Net is to use the public IP address if available, otherwise the private IP address will be used. If not in a Net the public DNS name will be used. Also works for WinRM.
|
||||
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ each category, the available configuration keys are alphabetized.
|
|||
|
||||
- `access_key` (string) - The access key used to communicate with OUTSCALE. [Learn how to set this](outscale#authentication)
|
||||
|
||||
- `omi_name` (string) - The name of the resulting OMIS that will appear when managing OMIs in the Outscale console or via APIs. This must be unique. To help make this unique, use a function like `timestamp` (see [template engine](../templates/engine) for more info).
|
||||
- `omi_name` (string) - The name of the resulting OMIS that will appear when managing OMIs in the Outscale console or via APIs. This must be unique. To help make this unique, use a function like `timestamp` (see [template engine](/docs/templates/engine) for more info).
|
||||
|
||||
- `secret_key` (string) - The secret key used to communicate with Outscale. [Learn how to set this](outscale#authentication)
|
||||
|
||||
|
|
@ -73,7 +73,7 @@ each category, the available configuration keys are alphabetized.
|
|||
### Optional:
|
||||
|
||||
- `omi_description` (string) - The description to set for the resulting OMI(s).
|
||||
By default this description is empty. This is a [template engine](../templates/engine),
|
||||
By default this description is empty. This is a [template engine](/docs/templates/engine),
|
||||
see [Build template data](#build-template-data) for more information.
|
||||
|
||||
- `omi_account_ids` (array of strings) - A list of account IDs that have access to launch the resulting OMI(s). By default no additional users other than the user creating the OMIS has permissions to launch it.
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ The following configuration options are available for building UCloud images. Th
|
|||
segmented below into two categories: required and optional parameters.
|
||||
|
||||
In addition to the options listed here, a
|
||||
[communicator](../templates/communicator) can be configured for this
|
||||
[communicator](/docs/templates/communicator) can be configured for this
|
||||
builder.
|
||||
|
||||
~> **Note:** The builder doesn't support Windows images for now and only supports CentOS and Ubuntu images via SSH authentication with `ssh_username` (Required) and `ssh_password` (Optional). The `ssh_username` must be `root` for CentOS images and `ubuntu` for Ubuntu images. The `ssh_password` may contain 8-30 characters, and must consist of at least 2 items out of the capital letters, lower case letters, numbers and special characters. The special characters include `()~!@#\$%^&\*-+=\_|{}\[]:;'<>,.?/`.
|
||||
|
|
|
|||
|
|
@ -125,7 +125,7 @@ types described above:
|
|||
|
||||
Key/value pairs can be separated by either a comma or a line break. Values
|
||||
can be arbitrary expressions. Keys are strings; they can be left unquoted if
|
||||
they are a valid [identifier](./syntax#identifiers), but must be quoted
|
||||
they are a valid [identifier](/docs/from-1.5/syntax#identifiers), but must be quoted
|
||||
otherwise. You can use a non-literal expression as a key by wrapping it in
|
||||
parentheses, like `(var.business_unit_tag_name) = "SRE"`.
|
||||
|
||||
|
|
@ -136,7 +136,7 @@ Packer makes one named values available.
|
|||
The following named values are available:
|
||||
|
||||
- `source.<SOURCE TYPE>.<NAME>` is an object representing a
|
||||
[source](./sources) of the given type
|
||||
[source](/docs/from-1.5/sources) of the given type
|
||||
and name.
|
||||
|
||||
### Available Functions
|
||||
|
|
|
|||
|
|
@ -19,37 +19,19 @@ chunklist(list, chunk_size)
|
|||
|
||||
## Examples
|
||||
|
||||
```shell
|
||||
```text
|
||||
> chunklist(["a", "b", "c", "d", "e"], 2)
|
||||
[
|
||||
[
|
||||
"a",
|
||||
"b",
|
||||
],
|
||||
[
|
||||
"c",
|
||||
"d",
|
||||
],
|
||||
[
|
||||
"e",
|
||||
],
|
||||
["a", "b"],
|
||||
["c", "d"],
|
||||
["e"]
|
||||
]
|
||||
> chunklist(["a", "b", "c", "d", "e"], 1)
|
||||
[
|
||||
[
|
||||
"a",
|
||||
],
|
||||
[
|
||||
"b",
|
||||
],
|
||||
[
|
||||
"c",
|
||||
],
|
||||
[
|
||||
"d",
|
||||
],
|
||||
[
|
||||
"e",
|
||||
],
|
||||
["a"],
|
||||
["b"],
|
||||
["c"],
|
||||
["d"],
|
||||
["e"]
|
||||
]
|
||||
```
|
||||
|
|
|
|||
|
|
@ -34,5 +34,5 @@ b
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`coalescelist`](./coalescelist) performs a similar operation with
|
||||
- [`coalescelist`](/docs/from-1.5/functions/collection/coalescelist) performs a similar operation with
|
||||
list arguments rather than individual arguments.
|
||||
|
|
|
|||
|
|
@ -41,5 +41,5 @@ symbol to expand the outer list as arguments:
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`coalesce`](./coalesce) performs a similar operation with string
|
||||
- [`coalesce`](/docs/from-1.5/functions/collection/coalesce) performs a similar operation with string
|
||||
arguments rather than list arguments.
|
||||
|
|
|
|||
|
|
@ -106,6 +106,6 @@ the associations between the subnets and their containing networks.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`setproduct`](./setproduct) finds all of the combinations of multiple
|
||||
- [`setproduct`](/docs/from-1.5/functions/collection/setproduct) finds all of the combinations of multiple
|
||||
lists or sets of values, which can also be useful when preparing collections
|
||||
for use with `for_each` constructs.
|
||||
|
|
|
|||
|
|
@ -26,5 +26,5 @@ value is not present in the list.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`element`](./element) retrieves a particular element from a list given
|
||||
- [`element`](/docs/from-1.5/functions/collection/element) retrieves a particular element from a list given
|
||||
its index.
|
||||
|
|
|
|||
|
|
@ -26,4 +26,4 @@ be identical as long as the keys in the map don't change.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`values`](./values) returns a list of the _values_ from a map.
|
||||
- [`values`](/docs/from-1.5/functions/collection/values) returns a list of the _values_ from a map.
|
||||
|
|
|
|||
|
|
@ -30,4 +30,4 @@ what?
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`element`](./element) retrieves a value from a _list_ given its _index_.
|
||||
- [`element`](/docs/from-1.5/functions/collection/element) retrieves a value from a _list_ given its _index_.
|
||||
|
|
|
|||
|
|
@ -24,4 +24,4 @@ with all of the same elements as the given sequence but in reverse order.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`strrev`](../string/strrev) reverses a string.
|
||||
- [`strrev`](/docs/from-1.5/functions/string/strrev) reverses a string.
|
||||
|
|
|
|||
|
|
@ -33,9 +33,9 @@ the ordering of the given elements is not preserved.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`contains`](./contains) tests whether a given list or set contains
|
||||
- [`contains`](/docs/from-1.5/functions/collection/contains) tests whether a given list or set contains
|
||||
a given element value.
|
||||
- [`setproduct`](./setproduct) computes the _Cartesian product_ of multiple
|
||||
- [`setproduct`](/docs/from-1.5/functions/collection/setproduct) computes the _Cartesian product_ of multiple
|
||||
sets.
|
||||
- [`setunion`](./setunion) computes the _union_ of
|
||||
- [`setunion`](/docs/from-1.5/functions/collection/setunion) computes the _union_ of
|
||||
multiple sets.
|
||||
|
|
|
|||
|
|
@ -214,12 +214,12 @@ elements in the input variables.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`contains`](./contains) tests whether a given list or set contains
|
||||
- [`contains`](/docs/from-1.5/functions/collection/contains) tests whether a given list or set contains
|
||||
a given element value.
|
||||
- [`flatten`](./flatten) is useful for flattening heirarchical data
|
||||
- [`flatten`](/docs/from-1.5/functions/collection/flatten) is useful for flattening heirarchical data
|
||||
into a single list, for situations where the relationships between two
|
||||
object types are defined explicitly.
|
||||
- [`setintersection`](./setintersection) computes the _intersection_ of
|
||||
- [`setintersection`](/docs/from-1.5/functions/collection/setintersection) computes the _intersection_ of
|
||||
multiple sets.
|
||||
- [`setunion`](./setunion) computes the _union_ of multiple
|
||||
- [`setunion`](/docs/from-1.5/functions/collection/setunion) computes the _union_ of multiple
|
||||
sets.
|
||||
|
|
|
|||
|
|
@ -36,9 +36,9 @@ the ordering of the given elements is not preserved.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`contains`](./contains) tests whether a given list or set contains
|
||||
- [`contains`](/docs/from-1.5/functions/collection/contains) tests whether a given list or set contains
|
||||
a given element value.
|
||||
- [`setintersection`](./setintersection) computes the _intersection_ of
|
||||
- [`setintersection`](/docs/from-1.5/functions/collection/setintersection) computes the _intersection_ of
|
||||
multiple sets.
|
||||
- [`setproduct`](./setproduct) computes the _Cartesian product_ of multiple
|
||||
- [`setproduct`](/docs/from-1.5/functions/collection/setproduct) computes the _Cartesian product_ of multiple
|
||||
sets.
|
||||
|
|
|
|||
|
|
@ -30,5 +30,5 @@ list.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`substr`](../string/substr) performs a similar function for characters in a
|
||||
- [`substr`](/docs/from-1.5/functions/string/substr) performs a similar function for characters in a
|
||||
string, although it uses a length instead of an end index.
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ in that map.
|
|||
|
||||
The values are returned in lexicographical order by their corresponding _keys_,
|
||||
so the values will be returned in the same order as their keys would be
|
||||
returned from [`keys`](./keys).
|
||||
returned from [`keys`](/docs/from-1.5/functions/collection/keys).
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -28,4 +28,4 @@ returned from [`keys`](./keys).
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`keys`](./keys) returns a list of the _keys_ from a map.
|
||||
- [`keys`](/docs/from-1.5/functions/collection/keys) returns a list of the _keys_ from a map.
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ whether the expression produced a result without any errors.
|
|||
|
||||
This is a special function that is able to catch errors produced when evaluating
|
||||
its argument. For most situations where you could use `can` it's better to use
|
||||
[`try`](./try) instead, because it allows for more concise definition of
|
||||
[`try`](/docs/from-1.5/functions/conversion/try) instead, because it allows for more concise definition of
|
||||
fallback values for failing expressions.
|
||||
|
||||
The `can` function can only catch and handle _dynamic_ errors resulting from
|
||||
|
|
@ -27,7 +27,7 @@ as a malformed resource reference.
|
|||
variable validation rules. Although it can technically accept any sort of
|
||||
expression and be used elsewhere in the configuration, we recommend against
|
||||
using it in other contexts. For error handling elsewhere in the configuration,
|
||||
prefer to use [`try`](./try).
|
||||
prefer to use [`try`](/docs/from-1.5/functions/conversion/try).
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -56,5 +56,5 @@ A local value with the name "nonexist" has not been declared.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`try`](./try), which tries evaluating a sequence of expressions and
|
||||
- [`try`](/docs/from-1.5/functions/conversion/try), which tries evaluating a sequence of expressions and
|
||||
returns the result of the first one that succeeds.
|
||||
|
|
|
|||
|
|
@ -110,5 +110,5 @@ A local value with the name "nonexist" has not been declared.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`can`](./can), which tries evaluating an expression and returns a
|
||||
- [`can`](/docs/from-1.5/functions/conversion/can), which tries evaluating an expression and returns a
|
||||
boolean value indicating whether it succeeded.
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@ configuration as needed:
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`format`](../string/format) is a more general formatting function for arbitrary
|
||||
- [`format`](/docs/from-1.5/functions/string/format) is a more general formatting function for arbitrary
|
||||
data.
|
||||
- [`timestamp`](./timestamp) returns the current date and time in a format
|
||||
- [`timestamp`](/docs/from-1.5/functions/datetime/timestamp) returns the current date and time in a format
|
||||
suitable for input to `formatdate`.
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ of adding the given direction to the given timestamp.
|
|||
-> **Breaking change note:** Packer previously let you decide your own "Date
|
||||
and Time format" syntax. With HCL2 and for parity with Terraform, Packer will
|
||||
be using the [RFC 3339](https://tools.ietf.org/html/rfc3339) "Date and Time
|
||||
format" syntax. As a string. [`formatdate`](./formatdate) still allows you
|
||||
format" syntax. As a string. [`formatdate`](/docs/from-1.5/functions/datetime/formatdate) still allows you
|
||||
to format a date.
|
||||
|
||||
## Examples
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ Packer run.
|
|||
-> **Breaking change note:** Packer previously let you decide your own "Date
|
||||
and Time format" syntax. With HCL2 and for parity with Terraform, Packer will
|
||||
be using the [RFC 3339](https://tools.ietf.org/html/rfc3339) "Date and Time
|
||||
format" syntax. As a string. [`formatdate`](./formatdate) still allows you
|
||||
format" syntax. As a string. [`formatdate`](/docs/from-1.5/functions/datetime/formatdate) still allows you
|
||||
to format a date.
|
||||
|
||||
## Examples
|
||||
|
|
@ -36,5 +36,5 @@ to format a date.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`formatdate`](./formatdate) can convert the resulting timestamp to
|
||||
- [`formatdate`](/docs/from-1.5/functions/datetime/formatdate) can convert the resulting timestamp to
|
||||
other date and time formats.
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ Hello World
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`base64encode`](./base64encode) performs the opposite operation,
|
||||
- [`base64encode`](/docs/from-1.5/functions/encoding/base64encode) performs the opposite operation,
|
||||
encoding the UTF-8 bytes for a string as Base64.
|
||||
- [`base64gzip`](./base64gzip) applies gzip compression to a string
|
||||
- [`base64gzip`](/docs/from-1.5/functions/encoding/base64gzip) applies gzip compression to a string
|
||||
and returns the result with Base64 encoding.
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ SGVsbG8gV29ybGQ=
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`base64decode`](./base64decode) performs the opposite operation,
|
||||
- [`base64decode`](/docs/from-1.5/functions/encoding/base64decode) performs the opposite operation,
|
||||
decoding Base64 data and interpreting it as a UTF-8 string.
|
||||
- [`base64gzip`](./base64gzip) applies gzip compression to a string
|
||||
- [`base64gzip`](/docs/from-1.5/functions/encoding/base64gzip) applies gzip compression to a string
|
||||
and returns the result with Base64 encoding all in one operation.
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ of the result of decoding that string.
|
|||
The JSON encoding is defined in [RFC 7159](https://tools.ietf.org/html/rfc7159).
|
||||
|
||||
This function maps JSON values to
|
||||
[Packer language values](../expressions#types-and-values)
|
||||
[Packer language values](/docs/from-1.5/expressions#types-and-values)
|
||||
in the following way:
|
||||
|
||||
| JSON type | Packer type |
|
||||
|
|
@ -45,5 +45,5 @@ true
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`jsonencode`](./jsonencode) performs the opposite operation, _encoding_
|
||||
- [`jsonencode`](/docs/from-1.5/functions/encoding/jsonencode) performs the opposite operation, _encoding_
|
||||
a value as JSON.
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ description: The jsonencode function encodes a given value as a JSON string.
|
|||
The JSON encoding is defined in [RFC 7159](https://tools.ietf.org/html/rfc7159).
|
||||
|
||||
This function maps
|
||||
[Packer language values](../expressions#types-and-values)
|
||||
[Packer language values](/docs/from-1.5/expressions#types-and-values)
|
||||
to JSON values in the following way:
|
||||
|
||||
| Packer type | JSON type |
|
||||
|
|
@ -42,5 +42,5 @@ rarely a problem in practice.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`jsondecode`](./jsondecode) performs the opposite operation, _decoding_
|
||||
- [`jsondecode`](/docs/from-1.5/functions/encoding/jsondecode) performs the opposite operation, _decoding_
|
||||
a JSON string to obtain its represented value.
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ This function supports a subset of [YAML 1.2](https://yaml.org/spec/1.2/spec.htm
|
|||
as described below.
|
||||
|
||||
This function maps YAML values to
|
||||
[Packer language values](../expressions#types-and-values)
|
||||
[Packer language values](/docs/from-1.5/expressions#types-and-values)
|
||||
in the following way:
|
||||
|
||||
| YAML type | Packer type |
|
||||
|
|
@ -96,7 +96,7 @@ Call to function "yamldecode" failed: unsupported tag "!not-supported".
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`jsondecode`](./jsondecode) is a similar operation using JSON instead
|
||||
- [`jsondecode`](/docs/from-1.5/functions/encoding/jsondecode) is a similar operation using JSON instead
|
||||
of YAML.
|
||||
- [`yamlencode`](./yamlencode) performs the opposite operation, _encoding_
|
||||
- [`yamlencode`](/docs/from-1.5/functions/encoding/yamlencode) performs the opposite operation, _encoding_
|
||||
a value as YAML.
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ description: The yamlencode function encodes a given value as a YAML string.
|
|||
result format may change in future versions of Packer, based on feedback.
|
||||
Do not use `yamldecode` to construct a value for any resource argument where
|
||||
changes to the result would be disruptive. To get a consistent string
|
||||
representation of a value use [`jsonencode`](./jsonencode) instead; its
|
||||
representation of a value use [`jsonencode`](/docs/from-1.5/functions/encoding/jsonencode) instead; its
|
||||
results are also valid YAML because YAML is a JSON superset.
|
||||
|
||||
<!--
|
||||
|
|
@ -29,7 +29,7 @@ results are also valid YAML because YAML is a JSON superset.
|
|||
-->
|
||||
|
||||
This function maps
|
||||
[Packer language values](../expressions#types-and-values)
|
||||
[Packer language values](/docs/from-1.5/expressions#types-and-values)
|
||||
to YAML tags in the following way:
|
||||
|
||||
| Packer type | YAML type |
|
||||
|
|
@ -77,12 +77,12 @@ mean that this is rarely a problem in practice.
|
|||
|
||||
`yamlencode` always uses YAML's "block style" for mappings and sequences, unless
|
||||
the mapping or sequence is empty. To generate flow-style YAML, use
|
||||
[`jsonencode`](./jsonencode) instead: YAML flow-style is a superset
|
||||
[`jsonencode`](/docs/from-1.5/functions/encoding/jsonencode) instead: YAML flow-style is a superset
|
||||
of JSON syntax.
|
||||
|
||||
## Related Functions
|
||||
|
||||
- [`jsonencode`](./jsonencode) is a similar operation using JSON instead
|
||||
- [`jsonencode`](/docs/from-1.5/functions/encoding/jsonencode) is a similar operation using JSON instead
|
||||
of YAML.
|
||||
- [`yamldecode`](./yamldecode) performs the opposite operation, _decoding_
|
||||
- [`yamldecode`](/docs/from-1.5/functions/encoding/yamldecode) performs the opposite operation, _decoding_
|
||||
a YAML string to obtain its represented value.
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ it uses backslash `\` as the path segment separator. On Unix systems, the slash
|
|||
Referring directly to filesystem paths in resource arguments may cause
|
||||
spurious diffs if the same configuration is applied from multiple systems or on
|
||||
different host operating systems. We recommend using filesystem paths only
|
||||
for transient values, such as the argument to [`file`](./file) (where
|
||||
for transient values, such as the argument to [`file`](/docs/from-1.5/functions/file) (where
|
||||
only the contents are then stored) or in `connection` and `provisioner` blocks.
|
||||
|
||||
## Examples
|
||||
|
|
@ -39,6 +39,6 @@ baz.txt
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`dirname`](./dirname) returns all of the segments of a filesystem path
|
||||
- [`dirname`](/docs/from-1.5/functions/file/dirname) returns all of the segments of a filesystem path
|
||||
_except_ the last, discarding the portion that would be returned by
|
||||
`basename`.
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ any slashes in the given path will be replaced by backslashes before returning.
|
|||
Referring directly to filesystem paths in resource arguments may cause
|
||||
spurious diffs if the same configuration is applied from multiple systems or on
|
||||
different host operating systems. We recommend using filesystem paths only
|
||||
for transient values, such as the argument to [`file`](./file) (where
|
||||
for transient values, such as the argument to [`file`](/docs/from-1.5/functions/file) (where
|
||||
only the contents are then stored) or in `connection` and `provisioner` blocks.
|
||||
|
||||
## Examples
|
||||
|
|
@ -38,5 +38,5 @@ foo/bar
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`basename`](./basename) returns _only_ the last portion of a filesystem
|
||||
- [`basename`](/docs/from-1.5/functions/file/basename) returns _only_ the last portion of a filesystem
|
||||
path, discarding the portion that would be returned by `dirname`.
|
||||
|
|
|
|||
|
|
@ -40,5 +40,5 @@ Hello World
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`fileexists`](./fileexists) determines whether a file exists
|
||||
- [`fileexists`](/docs/from-1.5/functions/file/fileexists) determines whether a file exists
|
||||
at a given path.
|
||||
|
|
|
|||
|
|
@ -34,4 +34,4 @@ fileexists("custom-section.sh") ? file("custom-section.sh") : local.default_cont
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`file`](./file) reads the contents of a file at a given path
|
||||
- [`file`](/docs/from-1.5/functions/file) reads the contents of a file at a given path
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ max(5, 12, 9)
|
|||
```
|
||||
|
||||
For more details on syntax, see
|
||||
[_Function Calls_](./expressions#function-calls)
|
||||
[_Function Calls_](/docs/from-1.5/expressions#function-calls)
|
||||
on the Expressions page.
|
||||
|
||||
The HCL language does not support user-defined functions, and so only
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ cidrhost(prefix, hostnum)
|
|||
no more than the number of digits remaining in the address after the given
|
||||
prefix. For more details on how this function interprets CIDR prefixes and
|
||||
populates host numbers, see the worked example for
|
||||
[`cidrsubnet`](./cidrsubnet).
|
||||
[`cidrsubnet`](/docs/from-1.5/functions/ipnet/cidrsubnet).
|
||||
|
||||
Conventionally host number zero is used to represent the address of the
|
||||
network itself and the host number that would fill all the host bits with
|
||||
|
|
@ -48,5 +48,5 @@ fd00:fd12:3456:7890::22
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`cidrsubnet`](./cidrsubnet) calculates a subnet address under a given
|
||||
- [`cidrsubnet`](/docs/from-1.5/functions/ipnet/cidrsubnet) calculates a subnet address under a given
|
||||
network address prefix.
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ additional bits added to the prefix.
|
|||
This function accepts both IPv6 and IPv4 prefixes, and the result always uses
|
||||
the same addressing scheme as the given prefix.
|
||||
|
||||
Unlike the related function [`cidrsubnets`](./cidrsubnets), `cidrsubnet`
|
||||
Unlike the related function [`cidrsubnets`](/docs/from-1.5/functions/ipnet/cidrsubnets), `cidrsubnet`
|
||||
allows you to give a specific network number to use. `cidrsubnets` can allocate
|
||||
multiple network addresses at once, but numbers them automatically starting
|
||||
with zero.
|
||||
|
|
@ -91,7 +91,7 @@ This gives us some additional information but also confirms (using a slightly
|
|||
different notation) the conversion from decimal to binary and shows the range
|
||||
of possible host addresses in this network.
|
||||
|
||||
While [`cidrhost`](./cidrhost) allows calculating single host IP addresses,
|
||||
While [`cidrhost`](/docs/from-1.5/functions/ipnet/cidrhost) allows calculating single host IP addresses,
|
||||
`cidrsubnet` on the other hand creates a new network prefix _within_ the given
|
||||
network prefix. In other words, it creates a subnet.
|
||||
|
||||
|
|
@ -146,7 +146,7 @@ Hosts/Net: 14 Class A, Private Internet
|
|||
The new subnet has four bits available for host numbering, which means
|
||||
that there are 14 host addresses available for assignment once we subtract
|
||||
the network's own address and the broadcast address. You can thus use
|
||||
[`cidrhost`](./cidrhost) function to calculate those host addresses by
|
||||
[`cidrhost`](/docs/from-1.5/functions/ipnet/cidrhost) function to calculate those host addresses by
|
||||
providing it a value between 1 and 14:
|
||||
|
||||
```shell
|
||||
|
|
@ -161,9 +161,9 @@ For more information on CIDR notation and subnetting, see
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`cidrhost`](./cidrhost) calculates the IP address for a single host
|
||||
- [`cidrhost`](/docs/from-1.5/functions/ipnet/cidrhost) calculates the IP address for a single host
|
||||
within a given network address prefix.
|
||||
- [`cidrnetmask`](./cidrnetmask) converts an IPv4 network prefix in CIDR
|
||||
- [`cidrnetmask`](/docs/from-1.5/functions/ipnet/cidrnetmask) converts an IPv4 network prefix in CIDR
|
||||
notation into netmask notation.
|
||||
- [`cidrsubnets`](./cidrsubnets) can allocate multiple consecutive
|
||||
- [`cidrsubnets`](/docs/from-1.5/functions/ipnet/cidrsubnets) can allocate multiple consecutive
|
||||
addresses under a prefix at once, numbering them automatically.
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ value is therefore a list with one element per `newbits` argument, each
|
|||
a string containing an address range in CIDR notation.
|
||||
|
||||
For more information on IP addressing concepts, see the documentation for the
|
||||
related function [`cidrsubnet`](./cidrsubnet). `cidrsubnet` calculates
|
||||
related function [`cidrsubnet`](/docs/from-1.5/functions/ipnet/cidrsubnet). `cidrsubnet` calculates
|
||||
a single subnet address within a prefix while allowing you to specify its
|
||||
subnet number, while `cidrsubnets` can calculate many at once, potentially of
|
||||
different sizes, and assigns subnet numbers automatically.
|
||||
|
|
@ -87,9 +87,9 @@ to concisely allocate groups of network address blocks:
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`cidrhost`](./cidrhost) calculates the IP address for a single host
|
||||
- [`cidrhost`](/docs/from-1.5/functions/ipnet/cidrhost) calculates the IP address for a single host
|
||||
within a given network address prefix.
|
||||
- [`cidrnetmask`](./cidrnetmask) converts an IPv4 network prefix in CIDR
|
||||
- [`cidrnetmask`](/docs/from-1.5/functions/ipnet/cidrnetmask) converts an IPv4 network prefix in CIDR
|
||||
notation into netmask notation.
|
||||
- [`cidrsubnet`](./cidrsubnet) calculates a single subnet address, allowing
|
||||
- [`cidrsubnet`](/docs/from-1.5/functions/ipnet/cidrsubnet) calculates a single subnet address, allowing
|
||||
you to specify its network number.
|
||||
|
|
|
|||
|
|
@ -24,5 +24,5 @@ given value, which may be a fraction.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`floor`](./floor), which rounds to the nearest whole number _less than_
|
||||
- [`floor`](/docs/from-1.5/functions/numeric/floor), which rounds to the nearest whole number _less than_
|
||||
or equal.
|
||||
|
|
|
|||
|
|
@ -24,5 +24,5 @@ given value, which may be a fraction.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`ceil`](./ceil), which rounds to the nearest whole number _greater than_
|
||||
- [`ceil`](/docs/from-1.5/functions/numeric/ceil), which rounds to the nearest whole number _greater than_
|
||||
or equal.
|
||||
|
|
|
|||
|
|
@ -27,4 +27,4 @@ to individual arguments:
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`min`](./min), which returns the _smallest_ number from a set.
|
||||
- [`min`](/docs/from-1.5/functions/numeric/min), which returns the _smallest_ number from a set.
|
||||
|
|
|
|||
|
|
@ -27,4 +27,4 @@ to individual arguments:
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`max`](./max), which returns the _greatest_ number from a set.
|
||||
- [`max`](/docs/from-1.5/functions/numeric/max), which returns the _greatest_ number from a set.
|
||||
|
|
|
|||
|
|
@ -49,5 +49,5 @@ Invalid value for "number" parameter: cannot parse "12" as a base 2 integer.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`format`](../string/format) can format numbers and other values into strings,
|
||||
- [`format`](/docs/from-1.5/functions/string/format) can format numbers and other values into strings,
|
||||
with optional zero padding, alignment, etc.
|
||||
|
|
|
|||
|
|
@ -26,5 +26,5 @@ hello
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`trimspace`](./trimspace), which removes all types of whitespace from
|
||||
- [`trimspace`](/docs/from-1.5/functions/string/trimspace), which removes all types of whitespace from
|
||||
both the start and the end of a string.
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@ for an unsupported format verb.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`formatdate`](../datetime/formatdate) is a specialized formatting function for
|
||||
- [`formatdate`](/docs/from-1.5/functions/datetime/formatdate) is a specialized formatting function for
|
||||
human-readable timestamps.
|
||||
- [`formatlist`](./formatlist) uses the same specification syntax to
|
||||
- [`formatlist`](/docs/from-1.5/functions/datetime/formatlist) uses the same specification syntax to
|
||||
produce a list of strings.
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ formatlist(spec, values...)
|
|||
```
|
||||
|
||||
The specification string uses
|
||||
[the same syntax as `format`](./format#specification-syntax).
|
||||
[the same syntax as `format`](/docs/from-1.5/functions/string/format#specification-syntax).
|
||||
|
||||
The given values can be a mixture of list and non-list arguments. Any given
|
||||
lists must be the same length, which decides the length of the resulting list.
|
||||
|
|
@ -48,5 +48,5 @@ once per element of the list arguments.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`format`](./format) defines the specification syntax used by this
|
||||
- [`format`](/docs/from-1.5/functions/string/format) defines the specification syntax used by this
|
||||
function and produces a single string as its result.
|
||||
|
|
|
|||
|
|
@ -28,5 +28,5 @@ foo
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`split`](./split) performs the opposite operation: producing a list
|
||||
- [`split`](/docs/from-1.5/functions/string/split) performs the opposite operation: producing a list
|
||||
by separating a single string using a given delimiter.
|
||||
|
|
|
|||
|
|
@ -25,5 +25,5 @@ This function uses Unicode's definition of letters and of upper- and lowercase.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`upper`](./upper) converts letters in a string to _uppercase_.
|
||||
- [`title`](./title) converts the first letter of each word in a string to uppercase.
|
||||
- [`upper`](/docs/from-1.5/functions/string/upper) converts letters in a string to _uppercase_.
|
||||
- [`title`](/docs/from-1.5/functions/string/title) converts the first letter of each word in a string to uppercase.
|
||||
|
|
|
|||
|
|
@ -43,5 +43,5 @@ hello everybody
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`replace`](./replace) searches a given string for another given
|
||||
- [`replace`](/docs/from-1.5/functions/string/replace) searches a given string for another given
|
||||
substring, and replaces all occurrences with a given replacement string.
|
||||
|
|
|
|||
|
|
@ -29,5 +29,5 @@ hello everybody
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`regexreplace`](./regexreplace) searches a given string for another given substring,
|
||||
- [`regexreplace`](/docs/from-1.5/functions/string/regexreplace) searches a given string for another given substring,
|
||||
and replaces each occurrence with a given replacement string.
|
||||
|
|
|
|||
|
|
@ -38,5 +38,5 @@ split(separator, string)
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`join`](./join) performs the opposite operation: producing a string
|
||||
- [`join`](/docs/from-1.5/functions/string/join) performs the opposite operation: producing a string
|
||||
joining together a list of strings with a given separator.
|
||||
|
|
|
|||
|
|
@ -26,4 +26,4 @@ olleh
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`reverse`](../collection/reverse) reverses a sequence.
|
||||
- [`reverse`](/docs/from-1.5/functions/collection/reverse) reverses a sequence.
|
||||
|
|
|
|||
|
|
@ -23,5 +23,5 @@ This function uses Unicode's definition of letters and of upper- and lowercase.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`upper`](./upper) converts _all_ letters in a string to uppercase.
|
||||
- [`lower`](./lower) converts all letters in a string to lowercase.
|
||||
- [`upper`](/docs/from-1.5/functions/string/upper) converts _all_ letters in a string to uppercase.
|
||||
- [`lower`](/docs/from-1.5/functions/string/lower) converts all letters in a string to lowercase.
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ hello
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`trimprefix`](./trimprefix) removes a word from the start of a string.
|
||||
- [`trimsuffix`](./trimsuffix) removes a word from the end of a string.
|
||||
- [`trimspace`](./trimspace) removes all types of whitespace from
|
||||
- [`trimprefix`](/docs/from-1.5/functions/string/trimprefix) removes a word from the start of a string.
|
||||
- [`trimsuffix`](/docs/from-1.5/functions/string/trimsuffix) removes a word from the end of a string.
|
||||
- [`trimspace`](/docs/from-1.5/functions/string/trimspace) removes all types of whitespace from
|
||||
both the start and the end of a string.
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ world
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`trim`](./trim) removes characters at the start and end of a string.
|
||||
- [`trimsuffix`](./trimsuffix) removes a word from the end of a string.
|
||||
- [`trimspace`](./trimspace) removes all types of whitespace from
|
||||
- [`trim`](/docs/from-1.5/functions/string/trim) removes characters at the start and end of a string.
|
||||
- [`trimsuffix`](/docs/from-1.5/functions/string/trimsuffix) removes a word from the end of a string.
|
||||
- [`trimspace`](/docs/from-1.5/functions/string/trimspace) removes all types of whitespace from
|
||||
both the start and the end of a string.
|
||||
|
|
|
|||
|
|
@ -26,5 +26,5 @@ hello
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`chomp`](./chomp) removes just line ending characters from the _end_ of
|
||||
- [`chomp`](/docs/from-1.5/functions/string/chomp) removes just line ending characters from the _end_ of
|
||||
a string.
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ hello
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`trim`](./trim) removes characters at the start and end of a string.
|
||||
- [`trimprefix`](./trimprefix) removes a word from the start of a string.
|
||||
- [`trimspace`](./trimspace) removes all types of whitespace from
|
||||
- [`trim`](/docs/from-1.5/functions/string/trim) removes characters at the start and end of a string.
|
||||
- [`trimprefix`](/docs/from-1.5/functions/string/trimprefix) removes a word from the start of a string.
|
||||
- [`trimspace`](/docs/from-1.5/functions/string/trimspace) removes all types of whitespace from
|
||||
both the start and the end of a string.
|
||||
|
|
|
|||
|
|
@ -25,5 +25,5 @@ This function uses Unicode's definition of letters and of upper- and lowercase.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`lower`](./lower) converts letters in a string to _lowercase_.
|
||||
- [`title`](./title) converts the first letter of each word in a string to uppercase.
|
||||
- [`lower`](/docs/from-1.5/functions/string/lower) converts letters in a string to _lowercase_.
|
||||
- [`title`](/docs/from-1.5/functions/string/title) converts the first letter of each word in a string to uppercase.
|
||||
|
|
|
|||
|
|
@ -27,4 +27,4 @@ b5ee72a3-54dd-c4b8-551c-4bdc0204cedb
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`uuidv5`](./uuidv5), which generates name-based UUIDs.
|
||||
- [`uuidv5`](/docs/from-1.5/functions/uuid/uuidv5), which generates name-based UUIDs.
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ description: |-
|
|||
uuidv5(namespace, name)
|
||||
```
|
||||
|
||||
Unlike the pseudo-random UUIDs generated by [`uuidv4`](./uuidv4),
|
||||
Unlike the pseudo-random UUIDs generated by [`uuidv4`](/docs/from-1.5/functions/uuid/uuidv4),
|
||||
name-based UUIDs derive from namespace and an name, producing the same UUID
|
||||
value every time if the namespace and name are unchanged.
|
||||
|
||||
|
|
@ -78,4 +78,4 @@ human-significant manner, such as by reference to the standard that defined it.
|
|||
|
||||
## Related Functions
|
||||
|
||||
- [`uuidv4`](./uuid), which generates pseudorandom UUIDs.
|
||||
- [`uuidv4`](/docs/from-1.5/functions/uuid), which generates pseudorandom UUIDs.
|
||||
|
|
|
|||
|
|
@ -56,14 +56,14 @@ source "amazon-ebs" "main" {
|
|||
|
||||
For full details about Packer's syntax, see:
|
||||
|
||||
- [Configuration Syntax](./syntax)
|
||||
- [Expressions](./expressions)
|
||||
- [Configuration Syntax](/docs/from-1.5/syntax)
|
||||
- [Expressions](/docs/from-1.5/expressions)
|
||||
|
||||
## Code Organization
|
||||
|
||||
The HCL language uses configuration files that are named with the `.pkr.hcl`
|
||||
file extension. There is also [a JSON-based variant of the
|
||||
language](./syntax-json) that is named with the `.pkr.json` file
|
||||
language](/docs/from-1.5/syntax-json) that is named with the `.pkr.json` file
|
||||
extension.
|
||||
|
||||
Configuration files must always use UTF-8 encoding, and by convention are
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ description: >-
|
|||
Local values assign a name to an expression, that can then be used multiple
|
||||
times within a folder.
|
||||
|
||||
If [variables](./variables) are analogous to function arguments then
|
||||
If [variables](/docs/from-1.5/variables) are analogous to function arguments then
|
||||
_local values_ are comparable to a function's local variables.
|
||||
|
||||
Input variable and local variable usage are introduced in the [_Variables
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ description: |-
|
|||
# JSON Configuration Syntax
|
||||
|
||||
Most Packer configurations are written in [the native HCL
|
||||
syntax](./syntax), which is designed to be easy for humans to read and
|
||||
syntax](/docs/from-1.5/syntax), which is designed to be easy for humans to read and
|
||||
update.
|
||||
|
||||
Packer also supports an alternative syntax that is JSON-compatible. This
|
||||
|
|
@ -94,7 +94,7 @@ rules apply in most cases:
|
|||
correspond either to argument names or to nested block type names.
|
||||
|
||||
- Where a property corresponds to an argument that accepts
|
||||
[arbitrary expressions](./expressions) in the native syntax, the
|
||||
[arbitrary expressions](/docs/from-1.5/expressions) in the native syntax, the
|
||||
property value is mapped to an expression as described under
|
||||
[_Expression Mapping_](#expression-mapping) below. For arguments that
|
||||
do _not_ accept arbitrary expressions, the interpretation of the property
|
||||
|
|
@ -111,20 +111,20 @@ rules apply in most cases:
|
|||
## Expression Mapping
|
||||
|
||||
Since JSON grammar is not able to represent all of the Packer language
|
||||
[expression syntax](./expressions), JSON values interpreted as expressions
|
||||
[expression syntax](/docs/from-1.5/expressions), JSON values interpreted as expressions
|
||||
are mapped as follows:
|
||||
|
||||
| JSON | Packer Language Interpretation |
|
||||
| ------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| Boolean | A literal `bool` value. |
|
||||
| Number | A literal `number` value. |
|
||||
| String | Parsed as a [string template](./expressions#string-templates) and then evaluated as described below. |
|
||||
| Object | Each property value is mapped per this table, producing an `object(...)` value with suitable attribute types. |
|
||||
| Array | Each element is mapped per this table, producing a `tuple(...)` value with suitable element types. |
|
||||
| Null | A literal `null`. |
|
||||
| JSON | Packer Language Interpretation |
|
||||
| ------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| Boolean | A literal `bool` value. |
|
||||
| Number | A literal `number` value. |
|
||||
| String | Parsed as a [string template](/docs/from-1.5/expressions#string-templates) and then evaluated as described below. |
|
||||
| Object | Each property value is mapped per this table, producing an `object(...)` value with suitable attribute types. |
|
||||
| Array | Each element is mapped per this table, producing a `tuple(...)` value with suitable element types. |
|
||||
| Null | A literal `null`. |
|
||||
|
||||
When a JSON string is encountered in a location where arbitrary expressions are
|
||||
expected, its value is first parsed as a [string template](./expressions#string-templates)
|
||||
expected, its value is first parsed as a [string template](/docs/from-1.5/expressions#string-templates)
|
||||
and then it is evaluated to produce the final result.
|
||||
|
||||
If the given template consists _only_ of a single interpolation sequence,
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ are built from.
|
|||
|
||||
This page describes the _native syntax_ of HCL, which is a rich language
|
||||
designed to be easy for humans to read and write. The constructs in HCL can
|
||||
also be expressed in [JSON syntax](./syntax-json), which is harder for
|
||||
also be expressed in [JSON syntax](/docs/from-1.5/syntax-json), which is harder for
|
||||
humans to read and edit but easier to generate and parse programmatically.
|
||||
|
||||
This low-level syntax of HCL is defined in terms of a syntax called _HCL_,
|
||||
|
|
@ -48,7 +48,7 @@ after the equals sign is the argument's value.
|
|||
The context where the argument appears determines what value types are valid
|
||||
(for example, each source type has a schema that defines the types of its
|
||||
arguments), but many arguments accept arbitrary
|
||||
[expressions](./expressions), which allow the value to
|
||||
[expressions](/docs/from-1.5/expressions), which allow the value to
|
||||
either be specified literally or generated from other values programmatically.
|
||||
|
||||
### Blocks
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ Guide_](/guides/hcl/variables).
|
|||
variable is being discussed. Other kinds of variables in Packer include
|
||||
_environment variables_ (set by the shell where Packer runs) and _expression
|
||||
variables_ (used to indirectly represent a value in an
|
||||
[expression](./expressions)).
|
||||
[expression](/docs/from-1.5/expressions)).
|
||||
|
||||
## Declaring an Input Variable
|
||||
|
||||
|
|
@ -84,7 +84,7 @@ configuration.
|
|||
## Using Input Variable Values
|
||||
|
||||
Within the build that declared a variable, its value can be accessed from
|
||||
within [expressions](./expressions) as `var.<NAME>`, where `<NAME>`
|
||||
within [expressions](/docs/from-1.5/expressions) as `var.<NAME>`, where `<NAME>`
|
||||
matches the label given in the declaration block:
|
||||
|
||||
```hcl
|
||||
|
|
@ -100,7 +100,7 @@ the folder where it was declared.
|
|||
## Type Constraints
|
||||
|
||||
The `type` argument in a `variable` block allows you to restrict the [type of
|
||||
value](./expressions#types-and-values) that will be accepted as the value
|
||||
value](/docs/from-1.5/expressions#types-and-values) that will be accepted as the value
|
||||
for a variable. If no type constraint is set then a value of any type is
|
||||
accepted.
|
||||
|
||||
|
|
@ -126,7 +126,7 @@ The type constructors allow you to specify complex types such as collections:
|
|||
The keyword `any` may be used to indicate that any type is acceptable. For more
|
||||
information on the meaning and behavior of these different types, as well as
|
||||
detailed information about automatic conversion of complex types, see [Type
|
||||
Constraints](./types).
|
||||
Constraints](/docs/from-1.5/types).
|
||||
|
||||
If both the `type` and `default` arguments are specified, the given default
|
||||
value must be convertible to the specified type.
|
||||
|
|
@ -236,7 +236,7 @@ case letters as in the above example.
|
|||
### Complex-typed Values
|
||||
|
||||
When variable values are provided in a variable definitions file, Packer's
|
||||
[usual syntax](./expressions#structural-types) can be used to assign
|
||||
[usual syntax](/docs/from-1.5/expressions#structural-types) can be used to assign
|
||||
complex-typed values, like lists and maps.
|
||||
|
||||
Some special rules apply to the `-var` command line option and to environment
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@ Optional parameters:
|
|||
shell-local, since the shell-local post-processor merely passes forward the
|
||||
artifact it receives. If your shell-local post-processor produces a file or
|
||||
files which you would like to have replace the input artifact, you may
|
||||
overwrite the input artifact using the [artifice](./artifice)
|
||||
overwrite the input artifact using the [artifice](/docs/post-processors/artifice)
|
||||
post-processor after your shell-local processor has run.
|
||||
|
||||
- `only_on` (array of strings) - This is an array of [runtime operating
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
- `security_group_name` (string) - The security group name. The default value
|
||||
is blank. [2, 128] English or Chinese characters, must begin with an
|
||||
uppercase/lowercase letter or Chinese character. Can contain numbers, .,
|
||||
\_ or -. It cannot begin with http:// or https://.
|
||||
\_ or -. It cannot begin with `http://` or `https://`.
|
||||
|
||||
- `user_data` (string) - User data to apply when launching the instance. Note
|
||||
that you need to be careful about escaping characters due to the templates
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@
|
|||
|
||||
- `snapshot_tags` (map[string]string) - Tags to apply to snapshot.
|
||||
They will override AMI tags if already applied to snapshot. This is a
|
||||
[template engine](../templates/engine), see [Build template
|
||||
[template engine](/docs/templates/engine), see [Build template
|
||||
data](#build-template-data) for more information.
|
||||
|
||||
- `snapshot_tag` ([]{name string, value string}) - Same as [`snapshot_tags`](#snapshot_tags) but defined as a singular
|
||||
|
|
|
|||
|
|
@ -3,4 +3,4 @@
|
|||
- `ami_name` (string) - The name of the resulting AMI that will appear when managing AMIs in the
|
||||
AWS console or via APIs. This must be unique. To help make this unique,
|
||||
use a function like timestamp (see [template
|
||||
engine](../templates/engine) for more info).
|
||||
engine](/docs/templates/engine) for more info).
|
||||
|
|
|
|||
|
|
@ -9,5 +9,5 @@
|
|||
When chroot building, this value is guessed from environment.
|
||||
|
||||
- `secret_key` (string) - The secret key used to communicate with AWS. [Learn how to set
|
||||
this](amazon#specifying-amazon-credentials). This is not required
|
||||
this](/docs/builders/amazon#specifying-amazon-credentials). This is not required
|
||||
if you are using `use_vault_aws_engine` for authentication instead.
|
||||
|
|
|
|||
Loading…
Reference in New Issue