adjust builder nesting paths

This commit is contained in:
Jeff Escalante 2020-03-26 20:28:32 -04:00
parent 68e1ea2296
commit db48bf7d58
No known key found for this signature in database
GPG Key ID: 32D23C61AB5450DB
59 changed files with 170 additions and 121 deletions

View File

@ -24,10 +24,47 @@
/docs/machine-readable/* /docs/commands/index.html 301!
/docs/command-line/* /docs/commands/:splat 200
/docs/extend/* /docs/extending/:splat 200
/intro/getting-started/install /intro/getting-started 301!
/intro/getting-started/install.html /intro/getting-started 301!
/docs/basics/terminology /docs/terminology 301!
/docs/basics/terminology.html /docs/terminology 301!
/docs/configuration/from-1.5/:path /docs/from-1.5/:path 200
/docs/configuration/from-1.5/:path/overview /docs/from-1.5/:path 200
/docs/configuration/from-1.5/:path/overview.html /docs/from-1.5/:path 200
/docs/builders/amazon.html /docs/builders/amazon 301!
/docs/builders/amazon-:path.html /docs/builders/amazon/:path 200
/docs/builders/amazon-:path /docs/builders/amazon/:path 200
/docs/builders/azure.html /docs/builders/azure 301!
/docs/builders/azure-:path.html /docs/builders/azure/:path 200
/docs/builders/azure-:path /docs/builders/azure/:path 200
/docs/builders/hyperv.html /docs/builders/hyperv 301!
/docs/builders/hyperv-:path.html /docs/builders/hyperv/:path 200
/docs/builders/hyperv-:path /docs/builders/hyperv/:path 200
/docs/builders/oracle.html /docs/builders/oracle 301!
/docs/builders/oracle-:path.html /docs/builders/oracle/:path 200
/docs/builders/oracle-:path /docs/builders/oracle/:path 200
/docs/builders/outscale.html /docs/builders/outscale 301!
/docs/builders/osc-:path.html /docs/builders/outscale/:path 200
/docs/builders/osc-:path /docs/builders/outscale/:path 200
/docs/builders/parallels.html /docs/builders/parallels 301!
/docs/builders/parallels-:path.html /docs/builders/parallels/:path 200
/docs/builders/parallels-:path /docs/builders/parallels/:path 200
/docs/builders/virtualbox.html /docs/builders/virtualbox 301!
/docs/builders/virtualbox-:path.html /docs/builders/virtualbox/:path 200
/docs/builders/virtualbox-:path /docs/builders/virtualbox/:path 200
/docs/builders/vmware.html /docs/builders/vmware 301!
/docs/builders/vmware-:path.html /docs/builders/vmware/:path 200
/docs/builders/vmware-:path /docs/builders/vmware/:path 200
/docs/builders/vsphere-:path.html /docs/builders/vmware/vsphere-:path 200
/docs/builders/vsphere-:path /docs/builders/vmware/vsphere-:path 200

View File

@ -28,8 +28,8 @@ export default [
'min',
'parseint',
'pow',
'signum'
]
'signum',
],
},
{
category: 'string',
@ -50,8 +50,8 @@ export default [
'trimprefix',
'trimsuffix',
'trimspace',
'upper'
]
'upper',
],
},
{
category: 'collection',
@ -77,8 +77,8 @@ export default [
'slice',
'sort',
'values',
'zipmap'
]
'zipmap',
],
},
{
category: 'encoding',
@ -90,8 +90,8 @@ export default [
'jsonencode',
'urlencode',
'yamldecode',
'yamlencode'
]
'yamlencode',
],
},
{
category: 'file',
@ -102,38 +102,45 @@ export default [
'file',
'fileexists',
'fileset',
'pathexpand'
]
'pathexpand',
],
},
{
category: 'datetime',
content: ['formatdate', 'timeadd', 'timestamp']
content: ['formatdate', 'timeadd', 'timestamp'],
},
{
category: 'crypto',
content: ['bcrypt', 'md5', 'rsadecrypt', 'sha1', 'sha256', 'sha512']
content: [
'bcrypt',
'md5',
'rsadecrypt',
'sha1',
'sha256',
'sha512',
],
},
{
category: 'uuid',
content: ['uuidv4', 'uuidv5']
content: ['uuidv4', 'uuidv5'],
},
{
category: 'ipnet',
content: ['cidrhost', 'cidrnetmask', 'cidrsubnet']
content: ['cidrhost', 'cidrnetmask', 'cidrsubnet'],
},
{
category: 'conversion',
content: ['can', 'convert', 'try']
}
]
}
]
content: ['can', 'convert', 'try'],
},
],
},
],
},
'--------',
'terminology',
{
category: 'commands',
content: ['build', 'console', 'fix', 'inspect', 'validate']
content: ['build', 'console', 'fix', 'inspect', 'validate'],
},
{
category: 'templates',
@ -143,8 +150,8 @@ export default [
'engine',
'post-processors',
'provisioners',
'user-variables'
]
'user-variables',
],
},
'----------',
{ category: 'communicators', content: ['ssh', 'winrm'] },
@ -152,15 +159,14 @@ export default [
category: 'builders',
content: [
'alicloud-ecs',
'amazon',
'amazon-chroot',
'amazon-ebs',
'amazon-ebssurrogate',
'amazon-ebsvolume',
'amazon-instance',
'azure',
'azure-arm',
'azure-chroot',
{
category: 'amazon',
content: ['chroot', 'ebs', 'ebssurrogate', 'ebsvolume', 'instance'],
},
{
category: 'azure',
content: ['arm', 'chroot'],
},
'cloudstack',
'digitalocean',
'docker',
@ -168,9 +174,7 @@ export default [
'googlecompute',
'hetzner-cloud',
'hyperone',
'hyperv',
'hyperv-iso',
'hyperv-vmcx',
{ category: 'hyperv', content: ['iso', 'vmcx'] },
'linode',
'lxc',
'lxd',
@ -178,17 +182,12 @@ export default [
'null',
'oneandone',
'openstack',
'oracle',
'oracle-classic',
'oracle-oci',
'outscale',
'osc-chroot',
'osc-bsu',
'osc-bsusurrogate',
'osc-bsuvolume',
'parallels',
'parallels-iso',
'parallels-pvm',
{ category: 'oracle', content: ['classic', 'oci'] },
{
category: 'outscale',
content: ['chroot', 'bsu', 'bsusurrogate', 'bsuvolume'],
},
{ category: 'parallels', content: ['iso', 'pvm'] },
'profitbricks',
'proxmox',
'qemu',
@ -198,19 +197,18 @@ export default [
'triton',
'ucloud-uhost',
'vagrant',
'virtualbox',
'virtualbox-iso',
'virtualbox-ovf',
'virtualbox-vm',
'vmware',
'vmware-iso',
'vmware-vmx',
'vsphere-iso',
'vsphere-clone',
{
category: 'virtualbox',
content: ['iso', 'ovf', 'vm'],
},
{
category: 'vmware',
content: ['iso', 'vmx', 'vsphere-iso', 'vsphere-clone'],
},
'yandex',
'custom',
'community-supported'
]
'community-supported',
],
},
{
category: 'provisioners',
@ -232,8 +230,8 @@ export default [
'windows-shell',
'windows-restart',
'custom',
'community-supported'
]
'community-supported',
],
},
{
category: 'post-processors',
@ -257,8 +255,8 @@ export default [
'vagrant',
'vagrant-cloud',
'vsphere',
'vsphere-template'
]
'vsphere-template',
],
},
'----------',
'install',
@ -269,11 +267,11 @@ export default [
'plugins',
'custom-builders',
'custom-post-processors',
'custom-provisioners'
]
'custom-provisioners',
],
},
'---------',
'environment-variables',
'core-configuration',
'debugging'
'debugging',
]

View File

@ -35,7 +35,7 @@ Docker supports and how to install onto
them](https://docs.docker.com/engine/installation/) in the Docker
documentation.
Please note: Packer does not yet have support for Windows containers.
~> **Please note:** Packer does not yet have support for Windows containers.
## Basic Example: Export

View File

@ -126,24 +126,24 @@ You'll see these data types when you run `packer build`:
`timestamp, buildname, artifact, artifact_number, key, value` where `key`
and `value` contain information about the artifact.
For example:
For example:
```
1539967803,,ui,say,\n==> Builds finished. The artifacts of successful builds are:
1539967803,amazon-ebs,artifact-count,2
1539967803,amazon-ebs,artifact,0,builder-id,mitchellh.amazonebs
1539967803,amazon-ebs,artifact,0,id,eu-west-1:ami-04d23aca8bdd36e30
1539967803,amazon-ebs,artifact,0,string,AMIs were created:\neu-west-1: ami-04d23aca8bdd36e30\n
1539967803,amazon-ebs,artifact,0,files-count,0
1539967803,amazon-ebs,artifact,0,end
1539967803,,ui,say,--> amazon-ebs: AMIs were created:\neu-west-1: ami-04d23aca8bdd36e30\n
1539967803,amazon-ebs,artifact,1,builder-id,
1539967803,amazon-ebs,artifact,1,id,
1539967803,amazon-ebs,artifact,1,string,
1539967803,amazon-ebs,artifact,1,files-count,0
2018/10/19 09:50:03 waiting for all plugin processes to complete...
1539967803,amazon-ebs,artifact,1,end
```
```shell
1539967803,,ui,say,\n==> Builds finished. The artifacts of successful builds are:
1539967803,amazon-ebs,artifact-count,2
1539967803,amazon-ebs,artifact,0,builder-id,mitchellh.amazonebs
1539967803,amazon-ebs,artifact,0,id,eu-west-1:ami-04d23aca8bdd36e30
1539967803,amazon-ebs,artifact,0,string,AMIs were created:\neu-west-1: ami-04d23aca8bdd36e30\n
1539967803,amazon-ebs,artifact,0,files-count,0
1539967803,amazon-ebs,artifact,0,end
1539967803,,ui,say,--> amazon-ebs: AMIs were created:\neu-west-1: ami-04d23aca8bdd36e30\n
1539967803,amazon-ebs,artifact,1,builder-id,
1539967803,amazon-ebs,artifact,1,id,
1539967803,amazon-ebs,artifact,1,string,
1539967803,amazon-ebs,artifact,1,files-count,0
2018/10/19 09:50:03 waiting for all plugin processes to complete...
1539967803,amazon-ebs,artifact,1,end
```
You'll see these data types when you run `packer version`:
@ -163,7 +163,9 @@ can invoke a new shell and use the feature.
For example, assume a tab is typed at the end of each prompt line:
$ packer p
plugin build
$ packer build -
-color -debug -except -force -machine-readable -on-error -only -parallel -timestamp -var -var-file
```shell
$ packer p
plugin build
$ packer build -
-color -debug -except -force -machine-readable -on-error -only -parallel -timestamp -var -var-file
```

View File

@ -17,7 +17,7 @@ contains(list, value)
## Examples
```
```shell
> contains(["a", "b", "c"], "a")
true
> contains(["a", "b", "c"], "d")

View File

@ -16,7 +16,7 @@ these elements is preserved.
## Examples
```
```shell
> distinct(["a", "b", "a", "c", "d", "b"])
[
"a",

View File

@ -22,7 +22,7 @@ only for the special additional "wrap-around" behavior described below.
## Examples
```
```shell
> element(["a", "b", "c"], 1)
b
```
@ -30,7 +30,7 @@ b
If the given index is greater than the length of the list then the index is
"wrapped around" by taking the index modulo the length of the list:
```
```shell
> element(["a", "b", "c"], 3)
a
```

View File

@ -18,7 +18,7 @@ in the argument sequence takes precedence.
## Examples
```
```shell
> merge({"a"="b", "c"="d"}, {"e"="f", "c"="z"})
{
"a" = "b"

View File

@ -30,7 +30,7 @@ to `limit`. For a negative step, it's complete when less than or equal.
The sequence-building algorithm follows the following pseudocode:
```
```text
let num = start
while num < limit: (or, for negative step, num >= limit)
append num to the sequence

View File

@ -31,7 +31,7 @@ prefer to use [`try`](./try.html).
## Examples
```
```shell
> local.foo
{
"bar" = "baz"
@ -46,7 +46,7 @@ The `can` function will _not_ catch errors relating to constructs that are
provably invalid even before dynamic expression evaluation, such as a malformed
reference or a reference to a top-level object that has not been declared:
```
```shell
> can(local.nonexist)
Error: Reference to undeclared local value

View File

@ -27,7 +27,7 @@ All other values will produce an error.
## Examples
```
```shell
> convert(3, string)
"3"
> convert("3", number)

View File

@ -85,7 +85,7 @@ to understand and maintain.
## Examples
```
```shell
> local.foo
{
"bar" = "baz"
@ -100,7 +100,7 @@ The `try` function will _not_ catch errors relating to constructs that are
provably invalid even before dynamic expression evaluation, such as a malformed
reference or a reference to a top-level object that has not been declared:
```
```shell
> try(local.nonexist, "fallback")
Error: Reference to undeclared local value

View File

@ -23,7 +23,7 @@ relevant literature to understand the security implications.
## Examples
```
```shell
> sha1("hello world")
2aae6c35c94fcfb415dbe95f408b9ce91ee846ed
```

View File

@ -19,7 +19,7 @@ then encoded to lowercase hexadecimal digits before returning.
## Examples
```
```shell
> sha256("hello world")
b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9
```

View File

@ -19,7 +19,7 @@ then encoded to lowercase hexadecimal digits before returning.
## Examples
```
```shell
> sha512("hello world")
309ecc489c12d6eb4cc40f50c902f2b4d0ed77ee511a7c7a9bcd3ca86d4cd86f989dd35bc5ff499670da34255b45b0cfd830e81f605dcf7dc5542e93ae9cd76f
```

View File

@ -21,7 +21,7 @@ this syntax.
## Examples
```
```shell
> formatdate("DD MMM YYYY hh:mm ZZZ", "2018-01-02T23:12:01Z")
02 Jan 2018 23:12 UTC
> formatdate("EEEE, DD-MMM-YY hh:mm:ss ZZZ", "2018-01-02T23:12:01Z")

View File

@ -23,7 +23,7 @@ number of fields, or this function will produce an error.
## Examples
```
```shell
> csvdecode("a,b,c\n1,2,3\n4,5,6")
[
{

View File

@ -57,7 +57,7 @@ supports only a subset of YAML 1.2, with restrictions including the following:
## Examples
```
```shell
> yamldecode("{\"hello\": \"world\"}")
{
"hello" = "world"

View File

@ -54,7 +54,7 @@ mean that this is rarely a problem in practice.
## Examples
```
```shell
> yamlencode({"a":"b", "c":"d"})
"a": "b"
"c": "d"

View File

@ -20,7 +20,7 @@ only the contents are then stored) or in `connection` and `provisioner` blocks.
## Examples
```
```shell
> abspath(path.root)
/home/user/some/packer/root
```

View File

@ -49,7 +49,7 @@ releases of Packer.
## Examples
```
```shell
> pathexpand("~/.ssh/id_rsa")
/home/steve/.ssh/id_rsa
> pathexpand("/etc/resolv.conf")

View File

@ -59,7 +59,7 @@ Taking our example above of `cidrsubnet("10.1.2.0/24", 4, 15)`, the function
will first convert the given IP address string into an equivalent binary
representation:
```
```text
10 . 1 . 2 . 0
00001010 00000001 00000010 | 00000000
network | host
@ -74,7 +74,7 @@ The CLI tool [`ipcalc`](https://gitlab.com/ipcalc/ipcalc) is useful for
visualizing CIDR prefixes as binary numbers. We can confirm the conversion
above by providing the same prefix string to `ipcalc`:
```
```shell
$ ipcalc 10.1.2.0/24
Address: 10.1.2.0 00001010.00000001.00000010. 00000000
Netmask: 255.255.255.0 = 24 11111111.11111111.11111111. 00000000
@ -101,7 +101,7 @@ bits; in our example here we specified `4`, which means that the resulting
subnet will have a prefix length of 24 + 4 = 28 bits. We can imagine these
bits breaking down as follows:
```
```text
10 . 1 . 2 . ? 0
00001010 00000001 00000010 | XXXX | 0000
parent network | netnum | host
@ -118,7 +118,7 @@ four new subnet bits. In our current example we passed `15`, which is
represented in binary as `1111`, allowing us to fill in the `XXXX` segment
in the above:
```
```text
10 . 1 . 2 . 15 0
00001010 00000001 00000010 | 1111 | 0000
parent network | netnum | host
@ -130,7 +130,7 @@ gives 240, which can then be combined with our new prefix length of 28 to
produce the result `10.1.2.240/28`. Again we can pass this prefix string to
`ipcalc` to visualize it:
```
```shell
$ ipcalc 10.1.2.240/28
Address: 10.1.2.240 00001010.00000001.00000010.1111 0000
Netmask: 255.255.255.240 = 28 11111111.11111111.11111111.1111 0000
@ -149,7 +149,7 @@ the network's own address and the broadcast address. You can thus use
[`cidrhost`](./cidrhost.html) function to calculate those host addresses by
providing it a value between 1 and 14:
```
```shell
> cidrhost("10.1.2.240/28", 1)
10.1.2.241
> cidrhost("10.1.2.240/28", 14)

View File

@ -24,7 +24,7 @@ are too large for the given base then `parseint` will produce an error.
## Examples
```
```shell
> parseint("100", 10)
100

View File

@ -41,7 +41,7 @@ namespace ID directly in the first argument in the usual UUID string format.
Use the namespace keywords where possible, to make the intent more obvious to
a future reader:
```
```shell
> uuidv5("dns", "www.packer.io")
a5008fae-b28c-5ba5-96cd-82b4c53552d6
@ -59,7 +59,7 @@ The namespace keywords treated as equivalent to their corresponding namespace
UUIDs, and in some special cases it may be more appropriate to use the
UUID form:
```
```shell
> uuidv5("6ba7b810-9dad-11d1-80b4-00c04fd430c8", "www.packer.io")
a5008fae-b28c-5ba5-96cd-82b4c53552d6
```
@ -67,7 +67,7 @@ a5008fae-b28c-5ba5-96cd-82b4c53552d6
If you wish to use a namespace defined outside of RFC 4122, using the namespace
UUID is required because no corresponding keyword is available:
```
```shell
> uuidv5("743ac3c0-3bf7-4a5b-9e6c-59360447c757", "LIBS:diskfont.library")
ede1a974-df7e-5f17-84b9-76208818b2c8
```

View File

@ -280,7 +280,7 @@ precedence over earlier ones:
~> **Important:** Variables with map and object values behave the same way as
other variables: the last value found overrides the previous values.
### A variable value must be known :
### A variable value must be known:
Take the following variable for example:
@ -315,7 +315,7 @@ source "example" "foo" {
In the above case, as long as "arg" is optional for an "example" source, there is no error and arg wont be set.
### Setting an unknown variable will not always fail :
### Setting an unknown variable will not always fail:
| Usage | packer validate | any other packer command |
| :----------------------------: | :---------------------: | :-----------------------: |

View File

@ -6,9 +6,9 @@
- `disk_category` (string) - Category of the system disk. Optional values
are: - `cloud` - general cloud disk - `cloud_efficiency` - efficiency cloud disk - `cloud_ssd` - cloud SSD
For phased-out instance types and non-I/O optimized instances, the
default value is cloud. Otherwise, the default value is
cloud\_efficiency.
For phased-out instance types and non-I/O optimized instances, the
default value is cloud. Otherwise, the default value is
cloud_efficiency.
- `disk_description` (string) - The value of disk description is blank by
default. \[2, 256\] characters. The disk description will appear on the

View File

@ -9,7 +9,19 @@
- `/docs/from-1.5/functions.html` -> `/docs/from-1.5/functions/index.html`
- [BREAKING] `/docs/from-1.5/functions/collection/index.html` -> `/docs/from-1.5/functions/collection/index-fn.html`
- `/docs/from-1.5/functions/*/overview.html` -> `/docs/from-1.5/functions/*/index.html`
- `/docs/builders/amazon-*` -> `/docs/builders/amazon/*`
- `/docs/builders/azure-*` -> `/docs/builders/azure/*`
- `/docs/builders/hyperv-*` -> `/docs/builders/hyperv/*`
- `/docs/builders/oracle-*` -> `/docs/builders/oracle/*`
- `/docs/builders/osc-*` -> `/docs/builders/outscale/*`
- `/docs/builders/outscale.html` -> `/docs/builders/outscale/index.html`
- `/docs/builders/parallels-*` -> `/docs/builders/parallels/*`
- `/docs/builders/virtualbox-*` -> `/docs/builders/virtualbox/*`
- `/docs/builders/vmware-*` -> `/docs/builders/vmware/*`
- `/docs/builders/vsphere-*` -> `/docs/builders/vmware/vsphere-*`
# problems:
# notes:
- empty index files on all `from-1.5/functions/*`
- how do the generated docs work? can we keep it even with changes?
- should any of the other builders be nested under a subdirectory? like `alicloud-ecs`, `tencent-cvm` or `ucloud-uhost`?