📌 Hard Pin Website Dependencies (#9543)

* Update and pin dependencies
* Update NextJS Scripts
* npm run lint
* npm run format
* docs generator: indent docs by two and make spacing better

Co-authored-by: Adrien Delorme <azr@users.noreply.github.com>
This commit is contained in:
Jonathan Neal 2020-07-13 06:33:16 -04:00 committed by GitHub
parent 5de8278449
commit d8b67f8520
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
294 changed files with 6948 additions and 7189 deletions

View File

@ -65,7 +65,7 @@ func main() {
SourcePath: sourcePath,
Name: typeSpec.Name.Name,
Filename: typeSpec.Name.Name + ".mdx",
Header: typeDecl.Doc.Text(),
Header: strings.TrimSpace(typeDecl.Doc.Text()),
}
required := Struct{
SourcePath: sourcePath,

View File

@ -24,12 +24,14 @@ var structDocsTemplate = template.Must(template.New("structDocsTemplate").
"indent": indent,
}).
Parse(`<!-- Code generated from the comments of the {{ .Name }} struct in {{ .SourcePath }}; DO NOT EDIT MANUALLY -->
{{ .Header -}}
{{range .Fields}}
- ` + "`" + `{{ .Name}}` + "`" + ` ({{ .Type }}) - {{ .Docs | indent 4 }}
{{- end -}}`))
{{ if .Header }}
{{ .Header }}
{{ end -}}
{{ range .Fields }}
- ` + "`" + `{{ .Name}}` + "`" + ` ({{ .Type }}) - {{ .Docs | indent 2 }}
{{ end }}`))
func indent(spaces int, v string) string {
pad := strings.Repeat(" ", spaces)
return strings.Replace(v, "\n", "\n"+pad, -1)
return strings.TrimSpace(strings.Replace(v, "\n", "\n"+pad, -1))
}

View File

@ -1,4 +1,4 @@
module.exports = {
presets: ['next/babel'],
plugins: ['import-glob-array']
plugins: ['import-glob-array'],
}

View File

@ -16,7 +16,10 @@ export default [
category: 'build',
content: ['source', 'provisioner', 'post-processor'],
},
'locals', 'source', 'variable'],
'locals',
'source',
'variable',
],
},
{
category: 'functions',

View File

@ -8,11 +8,11 @@
export default [
{
category: 'hcl',
content: ['from-json-v1', 'variables', 'component-object-spec']
content: ['from-json-v1', 'variables', 'component-object-spec'],
},
{
category: 'automatic-operating-system-installs',
content: ['autounattend_windows', 'preseed_ubuntu']
content: ['autounattend_windows', 'preseed_ubuntu'],
},
{
@ -20,8 +20,8 @@ export default [
content: [
'isotime-template-function',
'veewee-to-packer',
'use-packer-with-comment'
]
'use-packer-with-comment',
],
},
{
category: 'packer-on-cicd',
@ -30,7 +30,7 @@ export default [
'build-virtualbox-image',
'pipelineing-builds',
'trigger-tfe',
'upload-images-to-artifact'
]
}
'upload-images-to-artifact',
],
},
]

View File

@ -3,21 +3,21 @@ export default [
{
text: 'Intro',
url: '/intro',
type: 'inbound'
type: 'inbound',
},
{
text: 'Guides',
url: '/guides',
type: 'inbound'
type: 'inbound',
},
{
text: 'Docs',
url: '/docs',
type: 'inbound'
type: 'inbound',
},
{
text: 'Community',
url: '/community',
type: 'inbound'
}
type: 'inbound',
},
]

2726
website/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -4,35 +4,31 @@
"version": "1.0.0",
"author": "HashiCorp",
"dependencies": {
"@hashicorp/nextjs-scripts": "^10.0.2",
"@hashicorp/react-button": "^2.2.1",
"@hashicorp/react-content": "^4.0.0",
"@hashicorp/react-docs-page": "^4.0.0",
"@hashicorp/react-docs-sidenav": "^3.2.5",
"@hashicorp/react-global-styles": "^4.4.0",
"@hashicorp/react-head": "^1.1.1",
"@hashicorp/react-mega-nav": "^4.0.1-2",
"@hashicorp/react-product-downloader": "^4.0.2",
"@hashicorp/react-section-header": "^2.0.0",
"@hashicorp/react-subnav": "^3.2.3",
"@hashicorp/react-vertical-text-block-list": "^2.0.1",
"algoliasearch": "^4.3.0",
"babel-plugin-import-glob-array": "^0.2.0",
"dotenv": "^8.2.0",
"gray-matter": "^4.0.2",
"imagemin-mozjpeg": "^9.0.0",
"imagemin-optipng": "^8.0.0",
"imagemin-svgo": "^8.0.0",
"@hashicorp/nextjs-scripts": "11.1.0",
"@hashicorp/react-button": "2.2.1",
"@hashicorp/react-content": "4.0.0",
"@hashicorp/react-docs-page": "4.0.0",
"@hashicorp/react-docs-sidenav": "3.2.5",
"@hashicorp/react-global-styles": "4.4.0",
"@hashicorp/react-head": "1.1.1",
"@hashicorp/react-mega-nav": "4.0.1-2",
"@hashicorp/react-product-downloader": "4.0.2",
"@hashicorp/react-section-header": "2.0.0",
"@hashicorp/react-subnav": "3.2.3",
"@hashicorp/react-vertical-text-block-list": "2.0.1",
"algoliasearch": "4.3.0",
"babel-plugin-import-glob-array": "0.2.0",
"dotenv": "8.2.0",
"gray-matter": "4.0.2",
"next": "9.4.4",
"react": "^16.13.1",
"react-dom": "^16.13.1"
"react": "16.13.1",
"react-dom": "16.13.1"
},
"devDependencies": {
"dart-linkcheck": "^2.0.15",
"glob": "^7.1.6",
"husky": "^4.2.5",
"inquirer": "^7.1.0",
"prettier": "^2.0.5"
"dart-linkcheck": "2.0.15",
"glob": "7.1.6",
"husky": "4.2.5",
"prettier": "2.0.5"
},
"husky": {
"hooks": {

View File

@ -110,7 +110,6 @@ Block devices can be nested in the
## Basic Example
<Tabs>
<Tab heading="JSON">

View File

@ -49,7 +49,6 @@ build {
</Tab>
</Tabs>
## Configuration Reference
Configuration options are organized below into two categories: required and

View File

@ -53,7 +53,6 @@ build {
</Tab>
</Tabs>
## Configuration Reference
The null builder has no configuration parameters other than the

View File

@ -103,7 +103,6 @@ In addition to the options listed here, a
[communicator](/docs/templates/communicator) can be configured for this
builder.
### Required:
@include 'builder/virtualbox/vm/Config-required.mdx'
@ -186,7 +185,6 @@ builder.
@include 'helper/communicator/WinRM-not-required.mdx'
### Boot Configuration
@include 'common/bootcommand/BootConfig.mdx'
@ -220,7 +218,6 @@ contention. If you notice missing keys, you can tune this delay by specifying
@include 'builders/virtualbox-ssh-key-pair.mdx'
## Guest Additions
Packer will automatically download the proper guest additions for the version of

View File

@ -147,13 +147,13 @@ can be done via environment variable:
@include 'helper/communicator/SSH-Agent-Auth-not-required.mdx'
-> **NOTE:** Packer uses vApp Options to inject ssh public keys to the Virtual Machine.
The [temporary_key_pair_name](/docs/builders/vmware/vsphere-clone#temporary_key_pair_name) will only work
if the template being cloned contains the vApp property `public-keys`.
If using [ssh_private_key_file](/docs/builders/vmware/vsphere-clone#ssh_private_key_file), provide
the public key via [configuration_parameters](/docs/builders/vmware/vsphere-clone#configuration_parameters) or
[vApp Options Configuration](/docs/builders/vmware/vsphere-clone#vapp-options-configuration) whenever the `guestinto.userdata`
is available. See [VMware Guestinfo datasource](https://github.com/vmware/cloud-init-vmware-guestinfo) for more information
about the key.
The [temporary_key_pair_name](/docs/builders/vmware/vsphere-clone#temporary_key_pair_name) will only work
if the template being cloned contains the vApp property `public-keys`.
If using [ssh_private_key_file](/docs/builders/vmware/vsphere-clone#ssh_private_key_file), provide
the public key via [configuration_parameters](/docs/builders/vmware/vsphere-clone#configuration_parameters) or
[vApp Options Configuration](/docs/builders/vmware/vsphere-clone#vapp-options-configuration) whenever the `guestinto.userdata`
is available. See [VMware Guestinfo datasource](https://github.com/vmware/cloud-init-vmware-guestinfo) for more information
about the key.
#### Optional WinRM fields:

View File

@ -43,7 +43,6 @@ To get more information about this kind of authentication check [documentaion](h
-> **NB** Do not forget to assigne proper roles to Service Account, if you use this type of auth.
## Basic Example
```json

View File

@ -36,6 +36,7 @@ artifacts that are created will be outputted at the end of the build.
- `-on-error=cleanup` (default), `-on-error=abort`, `-on-error=ask`, `-on-error=run-cleanup-provisioner` -
Selects what to do when the build fails.
- `cleanup` cleans up after the previous steps, deleting temporary files and virtual machines.
- `abort` exits without any cleanup, which might require the next build to use `-force`.
- `ask` presents a prompt and waits for you to decide to clean up, abort, or retry

View File

@ -15,14 +15,13 @@ and if necessary what to do with their artifacts using `post-process`.
To use builders in a `build` block you can either:
* Set the `sources` array of string with references to pre-defined sources.
- Set the `sources` array of string with references to pre-defined sources.
* Define [build-level `source` blocks](/docs/from-1.5/blocks/build/source) or
`sources` to use builders. This also allows you to set specific fields.
- Define [build-level `source` blocks](/docs/from-1.5/blocks/build/source) or
`sources` to use builders. This also allows you to set specific fields.
`@include 'from-1.5/builds/example-block.mdx'`
Define [top-level `source` blocks](/docs/from-1.5/blocks/source) to configure
your builders. The list of available builders can be found in the
[builders](/docs/builders) section.
@ -90,12 +89,11 @@ Build 'a.null.second-example' finished.
Here `'a.null.first-example'` was skipped.
-> Note: It is not yet possible to match a named `build` block to do this, but
this is soon going to be possible. So here "a.*" will match nothing.
this is soon going to be possible. So here "a.\*" will match nothing.
## Related
* A list of [community
builders](/community-tools#community-builders) is available.
- A list of [community
builders](/community-tools#community-builders) is available.
* Create your own [custom builder](/docs/extending/custom-builders) !
- Create your own [custom builder](/docs/extending/custom-builders) !

View File

@ -29,7 +29,7 @@ upload artifacts, re-package, or more. The list of available post-processors
can be found in the [post-processors](/docs/post-processors) section.
-> Note: The input 'artifact' received by a post-processor will be automatically
deleted.
deleted.
# Keep an input artifact

View File

@ -77,7 +77,6 @@ build {
The values within `only` or `except` are _build names_, not builder types.
## Pausing Before Running
With certain provisioners it is sometimes desirable to pause for some period of
@ -111,7 +110,6 @@ executing the shell script.
With certain provisioners it is sometimes desirable to retry when it fails.
Specifically, in cases where the provisioner depends on external processes that are not done yet.
Every provisioner definition in a Packer template can take a special
configuration `max_retries` that is the maximum number of times a provisioner will retry on error.
By default, there `max_retries` is zero and there is no retry on error. An example is shown below:

View File

@ -49,6 +49,6 @@ This allows to have commonly defined source settings with specific parts of it
defined inside the specific build block.
-> **Note:** It is **not allowed** to set the same field in a top-level source
block and in a used source block. For example, if in the above example, the
top-level "amazon-ebs.example" source block also had an `output` field;
Packer would error.
block and in a used source block. For example, if in the above example, the
top-level "amazon-ebs.example" source block also had an `output` field;
Packer would error.

View File

@ -24,16 +24,16 @@ list of all of the available built-in HCL2 blocks.
`@include 'from-1.5/variables/foo-block.mdx'`
* [Variable block documentation](/docs/from-1.5/blocks/variable).
- [Variable block documentation](/docs/from-1.5/blocks/variable).
`@include 'from-1.5/locals/example-block.mdx'`
* [Locals block documentation](/docs/from-1.5/blocks/locals).
- [Locals block documentation](/docs/from-1.5/blocks/locals).
`@include 'from-1.5/sources/example-block.mdx'`
* [source block documentation](/docs/from-1.5/blocks/source).
- [source block documentation](/docs/from-1.5/blocks/source).
`@include 'from-1.5/builds/example-block.mdx'`
* [build block documentation](/docs/from-1.5/blocks/build).
- [build block documentation](/docs/from-1.5/blocks/build).

View File

@ -41,10 +41,10 @@ build {
## Related
* The list of available builders can be found in the [builders](/docs/builders)
- The list of available builders can be found in the [builders](/docs/builders)
section.
* A list of [community
- A list of [community
builders](/community-tools#community-builders) is available.
* Create your own [custom builder](/docs/extending/custom-builders) !
- Create your own [custom builder](/docs/extending/custom-builders) !

View File

@ -61,7 +61,7 @@ Example of using [upper](/docs/from-1.5/functions/string/upper) to upper case th
For builder-specific builder variables, please also refer to the builder docs:
- Amazon EC2: [chroot](/docs/builders/amazon/chroot#build-shared-information-variables),
- Amazon EC2: [chroot](/docs/builders/amazon/chroot#build-shared-information-variables),
[EBS Volume](/docs/builders/amazon/ebsvolume#build-shared-information-variables),
[EBS](/docs/builders/amazon/ebs#build-shared-information-variables),
[EBS Surrogate](/docs/builders/amazon/ebssurrogate#build-shared-information-variables),

View File

@ -259,8 +259,7 @@ set.
## `dynamic` blocks
Within top-level block constructs like sources, expressions can usually be used
only when assigning a value to an argument using the `name = expression` or `key
= expression` form. This covers many uses, but some source types include
only when assigning a value to an argument using the `name = expression` or `key = expression` form. This covers many uses, but some source types include
repeatable _nested blocks_ in their arguments, which do not accept expressions:
```hcl

View File

@ -4,4 +4,3 @@ page_title: Collection - Functions - Configuration Language
sidebar_title: Collection Functions
description: Overview of available collection functions
---

View File

@ -4,4 +4,3 @@ page_title: conversion - Functions - Configuration Language
sidebar_title: Type Conversion Functions
description: Overview of available conversion functions
---

View File

@ -4,4 +4,3 @@ page_title: crypto - Functions - Configuration Language
sidebar_title: Hash and Crypto Functions
description: Overview of available crypto functions
---

View File

@ -4,4 +4,3 @@ page_title: datetime - Functions - Configuration Language
sidebar_title: Date and Time Functions
description: Overview of available datetime functions
---

View File

@ -4,4 +4,3 @@ page_title: encoding - Functions - Configuration Language
sidebar_title: Encoding Functions
description: Overview of available encoding functions
---

View File

@ -97,7 +97,8 @@ build {
```
List of provisioners with a `scripts` field:
* [`shell`](/docs/provisioners/shell)
* [`powershell`](/docs/provisioners/powershell)
* [`shell-local`](/docs/provisioners/shell-local)
* [`windows-shell`](/docs/provisioners/windows-shell)
- [`shell`](/docs/provisioners/shell)
- [`powershell`](/docs/provisioners/powershell)
- [`shell-local`](/docs/provisioners/shell-local)
- [`windows-shell`](/docs/provisioners/windows-shell)

View File

@ -4,4 +4,3 @@ page_title: filesystem - Functions - Configuration Language
sidebar_title: Filesystem Functions
description: Overview of available filesystem functions
---

View File

@ -4,4 +4,3 @@ page_title: ipnet - Functions - Configuration Language
sidebar_title: IP Network Functions
description: Overview of available ipnet functions
---

View File

@ -4,4 +4,3 @@ page_title: Numeric - Functions - Configuration Language
sidebar_title: Numeric Functions
description: Overview of available numeric functions
---

View File

@ -4,4 +4,3 @@ page_title: string - Functions - Configuration Language
sidebar_title: String Functions
description: Overview of available string functions
---

View File

@ -4,4 +4,3 @@ page_title: uuid - Functions - Configuration Language
sidebar_title: UUID Functions
description: Overview of available uuid functions
---

View File

@ -58,15 +58,15 @@ build {
Note that cli arguments can be used with a glob operator, using the previous
configuration:
* `packer build -only 'my_build.*' dir`: will only run the builds in blocks
- `packer build -only 'my_build.*' dir`: will only run the builds in blocks
named `my_build`.
* `packer build -only '*.amazon-ebs.*' dir`: will only run the builds with a
source of type `amazon-ebs`.
- `packer build -only '*.amazon-ebs.*' dir`: will only run the builds with a
source of type `amazon-ebs`.
* `packer build -only '*.second-example-local-name' dir`: will only run that
specifically named build.
- `packer build -only '*.second-example-local-name' dir`: will only run that
specifically named build.
-> Note: In the cli `only` and `except` will match agains **build names** (for
example:`my_build.amazon-ebs.first-example`) but in a provisioner they will
match on the **source type** (for example:`source.amazon-ebs.third-example`).
example:`my_build.amazon-ebs.first-example`) but in a provisioner they will
match on the **source type** (for example:`source.amazon-ebs.third-example`).

View File

@ -289,11 +289,11 @@ that apply to each top-level block type.
All arguments inside `variable` blocks have non-standard mappings to JSON:
* `type`: a string containing a type expression, like `"string"` or `"list(string)"`.
* `default`: a literal JSON value that can be converted to the given type.
- `type`: a string containing a type expression, like `"string"` or `"list(string)"`.
- `default`: a literal JSON value that can be converted to the given type.
Strings within this value are taken literally and _not_ interpreted as
string templates.
* `description`: a literal JSON string, _not_ interpreted as a template.
- `description`: a literal JSON string, _not_ interpreted as a template.
```json
{

View File

@ -37,6 +37,7 @@ post-processors such as Docker and Artifice.
### Optional:
@include 'post-processor/manifest/Config-not-required.mdx'
- `keep_input_artifact` (boolean) - Unlike most other post-processors, the
keep_input_artifact option will have no effect for the manifest
post-processor. We will always retain the input artifact for manifest,

View File

@ -29,10 +29,8 @@ As such, assigned Service Account must have write permissions to the Yandex Obje
`paths`. A new temporary static access keys from assigned Service Account used to upload
image.
## Configuration
### Required:
@include 'post-processor/yandex-export/Config-required.mdx'
@ -41,7 +39,6 @@ image.
@include 'post-processor/yandex-export/Config-not-required.mdx'
## Basic Example
The following example builds a Compute image in the folder with id `b1g8jvfcgmitdrslcn86`, with an
@ -67,7 +64,7 @@ must have write access to both `s3://packer-export/my-exported-image.qcow2` and
"source_image_family": "ubuntu-1604-lts",
"ssh_username": "ubuntu",
"use_ipv4_nat": true,
"use_ipv4_nat": true
}
],
"post-processors": [

View File

@ -17,15 +17,12 @@ The Yandex.Cloud Compute Image Import post-processor create new Compute Image
from a qcow2 file. As Compute service support image creation from Storage service object
just before request to create its upload file into Storage service.
Assigned Service Account must have write permissions to the Yandex Object Storage.
A new temporary static access keys from assigned Service Account used to upload
file.
## Configuration
### Required:
@include 'post-processor/yandex-import/Config-required.mdx'
@ -34,7 +31,6 @@ file.
@include 'post-processor/yandex-import/Config-not-required.mdx'
## Basic Example
TBD

View File

@ -17,7 +17,6 @@ The `salt-masterless` Packer provisioner provisions machines built by Packer
using [Salt](http://saltstack.com/) states, without connecting to a Salt
master.
## Basic Example
The example below is fully functional.

View File

@ -182,7 +182,6 @@ executing the shell script.
With certain provisioners it is sometimes desirable to retry when it fails.
Specifically, in cases where the provisioner depends on external processes that are not done yet.
Every provisioner definition in a Packer template can take a special
configuration `max_retries` that is the maximum number of times a provisioner will retry on error.
By default, there `max_retries` is zero and there is no retry on error. An example is shown below:

View File

@ -26,12 +26,11 @@ It also makes it so that a failing build takes less time to debug and re-run.
In this example, we will use the Virtualbox builders, but the concepts from
this example can be applied to other builders as well.
## Starting from an ISO
Here is an extremely basic virtualbox-iso template:
``` json
```json
{
"builders": [
{
@ -102,7 +101,7 @@ That output filename generated in the first stage can be used as the
[source_path](https://www.packer.io/docs/builders/virtualbox/ovf#source_path)
for the virtualbox-ovf builder.
``` json
```json
{
"builders": [
{
@ -119,9 +118,7 @@ for the virtualbox-ovf builder.
],
"provisioners": [
{
"inline": [
"echo secondary provisioning"
],
"inline": ["echo secondary provisioning"],
"type": "shell"
}
]
@ -140,18 +137,22 @@ the behavior you want. The below example shows a "vagrant" post-processor
being used with a null builder, and manually sets the artifact from our
stage-2 ovf build:
``` json
```json
{
"builders": [{
"builders": [
{
"type": "null",
"communicator": "none"
}],
}
],
"post-processors": [
[
{
"type": "artifice",
"files": ["output-virtualbox-ovf/virtualbox-example-ovf.ovf",
"output-virtualbox-ovf/virtualbox-example-ovf-disk001.vmdk"]
"files": [
"output-virtualbox-ovf/virtualbox-example-ovf.ovf",
"output-virtualbox-ovf/virtualbox-example-ovf-disk001.vmdk"
]
},
{
"type": "vagrant",

View File

@ -23,9 +23,8 @@
width: 80%;
margin: 0 10%;
}
}
& > *:first-child {
&:first-child {
margin-right: 15px;
@media (max-width: 350px) {
@ -34,6 +33,7 @@
}
}
}
}
& #infrastructure-as-code {
display: flex;

View File

@ -14,4 +14,3 @@
- `security_token` (string) - STS access token, can be set through template or by exporting as
environment variable such as `export SECURITY_TOKEN=value`.

View File

@ -8,4 +8,3 @@
- `region` (string) - Alicloud region must be provided unless `profile` is set, but it can
also be sourced from the `ALICLOUD_REGION` environment variable.

View File

@ -1,2 +1,3 @@
<!-- Code generated from the comments of the AlicloudAccessConfig struct in builder/alicloud/ecs/access_config.go; DO NOT EDIT MANUALLY -->
Config of alicloud

View File

@ -36,4 +36,3 @@
data disk. Otherwise, Packer will keep the encryption setting to what
it was in the source image. Please refer to Introduction of ECS disk encryption
for more details.

View File

@ -77,4 +77,3 @@
data disk. Otherwise, Packer will keep the encryption setting to what
it was in the source image. Please refer to Introduction of [ECS disk encryption](https://www.alibabacloud.com/help/doc-detail/59643.htm)
for more details.

View File

@ -12,6 +12,7 @@
this parameter is ignored.
- `image_unshare_account` ([]string) - Alicloud Image UN Share Accounts
- `image_copy_regions` ([]string) - Copy to the destination regionIds.
- `image_copy_names` ([]string) - The name of the destination image, [2, 128] English or Chinese
@ -40,6 +41,7 @@
command, this option can be omitted and taken as true.
- `image_force_delete_instances` (bool) - Alicloud Image Force Delete Instances
- `image_ignore_data_disks` (bool) - If this value is true, the image created will not include any snapshot
of data disks. This option would be useful for any circumstance that
default data disks with instance types are not concerned. The default
@ -55,4 +57,3 @@
containing a `key` and a `value` field. In HCL2 mode the
[`dynamic_block`](/docs/configuration/from-1.5/expressions#dynamic-blocks)
will allow you to create those programatically.

View File

@ -4,4 +4,3 @@
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://`.

View File

@ -1,6 +1,7 @@
<!-- Code generated from the comments of the RunConfig struct in builder/alicloud/ecs/run_config.go; DO NOT EDIT MANUALLY -->
- `associate_public_ip_address` (bool) - Associate Public Ip Address
- `zone_id` (string) - ID of the zone to which the disk belongs.
- `io_optimized` (boolean) - Whether an ECS instance is I/O optimized or not. If this option is not
@ -8,6 +9,7 @@
`instance_type` is used.
- `description` (string) - Description
- `force_stop_instance` (bool) - Whether to force shutdown upon device
restart. The default value is `false`.
@ -91,4 +93,3 @@
- `ssh_private_ip` (bool) - If this value is true, packer will connect to
the ECS created through private ip instead of allocating a public ip or an
EIP. The default value is false.

View File

@ -9,4 +9,3 @@
- `source_image` (string) - This is the base image id which you want to
create your customized images.

View File

@ -132,4 +132,3 @@
- `ami_architecture` (string) - what architecture to use when registering the final AMI; valid options
are "x86_64" or "arm64". Defaults to "x86_64".

View File

@ -4,4 +4,3 @@
currently running instance. This must be an EBS-backed AMI with a root
volume snapshot that you have access to. Note: this is not used when
from_scratch is set to true.

View File

@ -1,3 +1,4 @@
<!-- Code generated from the comments of the Config struct in builder/amazon/chroot/builder.go; DO NOT EDIT MANUALLY -->
Config is the configuration that is chained through the steps and settable
from the template.

View File

@ -117,4 +117,3 @@
create volumes from the snapshot(s). By default no groups have permission
to create volumes from the snapshot(s). all will make the snapshot
publicly accessible.

View File

@ -4,4 +4,3 @@
AWS 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).

View File

@ -1,2 +1,3 @@
<!-- Code generated from the comments of the AMIConfig struct in builder/amazon/common/ami_config.go; DO NOT EDIT MANUALLY -->
AMIConfig is for common configuration related to creating AMIs.

View File

@ -30,6 +30,7 @@
validation of the ami_regions configuration option. Default false.
- `skip_metadata_api_check` (bool) - Skip Metadata Api Check
- `token` (string) - The access token to use. This is different from the
access key and secret key. If you're not sure what this is, then you
probably don't need it. This will also be read from the AWS_SESSION_TOKEN
@ -68,4 +69,3 @@
}
}
```

View File

@ -12,4 +12,3 @@
- `secret_key` (string) - The secret key used to communicate with AWS. [Learn how to set
this](/docs/builders/amazon#specifying-amazon-credentials). This is not required
if you are using `use_vault_aws_engine` for authentication instead.

View File

@ -1,2 +1,3 @@
<!-- Code generated from the comments of the AccessConfig struct in builder/amazon/common/access_config.go; DO NOT EDIT MANUALLY -->
AccessConfig is for common configuration related to AWS access

View File

@ -40,4 +40,3 @@
CopyImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CopyImage.html)
This field is validated by Packer, when using an alias, you will have to
prefix kms_key_id with alias/.

View File

@ -1,4 +1,5 @@
<!-- Code generated from the comments of the BlockDevice struct in builder/amazon/common/block_device.go; DO NOT EDIT MANUALLY -->
These will be attached when booting a new instance from your AMI. Your
options here may vary depending on the type of VM you use.

View File

@ -322,4 +322,3 @@
- `session_manager_port` (int) - Which port to connect the local end of the session tunnel to. If
left blank, Packer will choose a port for you from available ports.
This option is only used when `ssh_interface` is set `session_manager`.

View File

@ -7,4 +7,3 @@
provisioned on the currently running instance. This must be an EBS-backed
AMI with a root volume snapshot that you have access to. Note: this is not
used when from_scratch is set to true.

View File

@ -1,3 +1,4 @@
<!-- Code generated from the comments of the RunConfig struct in builder/amazon/common/run_config.go; DO NOT EDIT MANUALLY -->
RunConfig contains configuration for running an instance from a source
AMI and details on how to access that launched image.

View File

@ -1,4 +1,5 @@
<!-- Code generated from the comments of the SubnetFilterOptions struct in builder/amazon/common/run_config.go; DO NOT EDIT MANUALLY -->
- `most_free` (bool) - Most Free
- `random` (bool) - Random

View File

@ -1,7 +1,9 @@
<!-- Code generated from the comments of the VaultAWSEngineOptions struct in builder/amazon/common/access_config.go; DO NOT EDIT MANUALLY -->
- `name` (string) - Name
- `role_arn` (string) - Role ARN
- `ttl` (string) - Specifies the TTL for the use of the STS token. This
is specified as a string with a duration suffix. Valid only when
credential_type is assumed_role or federation_token. When not

View File

@ -36,4 +36,3 @@
Because we don't validate the OS type of your guest, it is up to you to
make sure you don't set this for *nix guests; behavior may be
unpredictable.

View File

@ -5,4 +5,3 @@
false, the block device will be mapped into the final created AMI. Set
this option to true if you need a block device mounted in the surrogate
AMI but not in the final created AMI.

View File

@ -29,4 +29,3 @@
- `ami_architecture` (string) - what architecture to use when registering the
final AMI; valid options are "x86_64" or "arm64". Defaults to "x86_64".

View File

@ -7,4 +7,3 @@
- `source_device_name` (string) - The device name of the block device on
the source instance to be used as the root device for the AMI. This
must correspond to a block device in `launch_block_device_mapping`.

View File

@ -1,6 +1,7 @@
<!-- Code generated from the comments of the RootBlockDevice struct in builder/amazon/ebssurrogate/root_block_device.go; DO NOT EDIT MANUALLY -->
- `source_device_name` (string) - Source Device Name
- `device_name` (string) - The device name exposed to the instance (for
example, /dev/sdh or xvdh). Required for every device in the block
device mapping.
@ -23,4 +24,3 @@
- `volume_size` (int64) - The size of the volume, in GiB. Required if
not specifying a snapshot_id.

View File

@ -8,4 +8,3 @@
containing a `key` and a `value` field. In HCL2 mode the
[`dynamic_block`](/docs/configuration/from-1.5/expressions#dynamic-blocks)
will allow you to create those programatically.

View File

@ -41,4 +41,3 @@
the
[`dynamic_block`](/docs/configuration/from-1.5/expressions#dynamic-blocks)
will allow you to create those programatically.

View File

@ -36,4 +36,3 @@
certificates are uploaded after provisioning is run, so it is perfectly
okay to create this directory as part of the provisioning process.
Defaults to /tmp.

View File

@ -13,4 +13,3 @@
- `x509_key_path` (string) - The local path to the private key for the X509 certificate specified by
x509_cert_path. This is used for bundling the AMI.

View File

@ -1,3 +1,4 @@
<!-- Code generated from the comments of the Config struct in builder/amazon/instance/builder.go; DO NOT EDIT MANUALLY -->
Config is the configuration that is chained through the steps and settable
from the template.

View File

@ -257,4 +257,3 @@
temporary resource group asynchronously set this value. It's a boolean
value and defaults to false. Important Setting this true means that
your builds are faster, however any failed deletes are not reported.

View File

@ -36,4 +36,3 @@
`custom_managed_image_name` must also be set. See
[documentation](https://docs.microsoft.com/en-us/azure/storage/storage-managed-disks-overview#images)
to learn more about managed images.

View File

@ -1,6 +1,9 @@
<!-- Code generated from the comments of the PlanInformation struct in builder/azure/arm/config.go; DO NOT EDIT MANUALLY -->
- `plan_name` (string) - Plan Name
- `plan_product` (string) - Plan Product
- `plan_publisher` (string) - Plan Publisher
- `plan_promotion_code` (string) - Plan Promotion Code

View File

@ -1,12 +1,15 @@
<!-- Code generated from the comments of the SharedImageGallery struct in builder/azure/arm/config.go; DO NOT EDIT MANUALLY -->
- `subscription` (string) - Subscription
- `resource_group` (string) - Resource Group
- `gallery_name` (string) - Gallery Name
- `image_name` (string) - Image Name
- `image_version` (string) - Specify a specific version of an OS to boot from.
Defaults to latest. There may be a difference in versions available
across regions due to image synchronization latency. To ensure a consistent
version across regions set this value to one that is available in all
regions where you are deploying.

View File

@ -1,7 +1,11 @@
<!-- Code generated from the comments of the SharedImageGalleryDestination struct in builder/azure/arm/config.go; DO NOT EDIT MANUALLY -->
- `resource_group` (string) - Sig Destination Resource Group
- `gallery_name` (string) - Sig Destination Gallery Name
- `image_name` (string) - Sig Destination Image Name
- `image_version` (string) - Sig Destination Image Version
- `replication_regions` ([]string) - Sig Destination Replication Regions

View File

@ -62,4 +62,3 @@
- `image_resource_id` (string) - The managed image to create using this build.
- `shared_image_destination` (SharedImageGalleryDestination) - The shared image to create using this build.

View File

@ -4,4 +4,3 @@
- a shared image version resource ID
- a managed disk resource ID
- a publisher:offer:sku:version specifier for plaform image sources.

View File

@ -1,3 +1,4 @@
<!-- Code generated from the comments of the Config struct in builder/azure/chroot/builder.go; DO NOT EDIT MANUALLY -->
Config is the configuration that is chained through the steps and settable
from the template.

View File

@ -1,4 +1,5 @@
<!-- Code generated from the comments of the SharedImageGalleryDestination struct in builder/azure/chroot/shared_image_gallery_destination.go; DO NOT EDIT MANUALLY -->
- `target_regions` ([]TargetRegion) - Target Regions
- `exlude_from_latest` (bool) - Exclude From Latest

View File

@ -1,6 +1,9 @@
<!-- Code generated from the comments of the SharedImageGalleryDestination struct in builder/azure/chroot/shared_image_gallery_destination.go; DO NOT EDIT MANUALLY -->
- `resource_group` (string) - Resource Group
- `gallery_name` (string) - Gallery Name
- `image_name` (string) - Image Name
- `image_version` (string) - Image Version

View File

@ -1,3 +1,4 @@
<!-- Code generated from the comments of the SharedImageGalleryDestination struct in builder/azure/chroot/shared_image_gallery_destination.go; DO NOT EDIT MANUALLY -->
SharedImageGalleryDestination models an image version in a Shared
Image Gallery that can be used as a destination.

View File

@ -3,4 +3,3 @@
- `replicas` (int32) - Number of replicas in this region. Default: 1
- `storage_account_type` (string) - Storage account type: Standard_LRS or Standard_ZRS. Default: Standard_ZRS

View File

@ -1,4 +1,3 @@
<!-- Code generated from the comments of the TargetRegion struct in builder/azure/chroot/shared_image_gallery_destination.go; DO NOT EDIT MANUALLY -->
- `name` (string) - Name of the Azure region

View File

@ -1,2 +1,3 @@
<!-- Code generated from the comments of the TargetRegion struct in builder/azure/chroot/shared_image_gallery_destination.go; DO NOT EDIT MANUALLY -->
TargetRegion describes a region where the shared image should be replicated

View File

@ -23,4 +23,3 @@
looked up using `subscription_id`.
- `subscription_id` (string) - The subscription to use.

View File

@ -1,4 +1,5 @@
<!-- Code generated from the comments of the Config struct in builder/azure/common/client/config.go; DO NOT EDIT MANUALLY -->
Config allows for various ways to authenticate Azure clients.
When `client_id` and `subscription_id` are specified, Packer will use the
specified Azure Active Directory (AAD) Service Principal (SP).

View File

@ -1,5 +1,7 @@
<!-- Code generated from the comments of the ArtifactParameter struct in builder/azure/dtl/config.go; DO NOT EDIT MANUALLY -->
- `name` (string) - Name
- `value` (string) - Value
- `type` (string) - Type

View File

@ -3,6 +3,7 @@
- `capture_name_prefix` (string) - Capture
- `capture_container_name` (string) - Capture Container Name
- `shared_image_gallery` (SharedImageGallery) - Use a [Shared Gallery
image](https://azure.microsoft.com/en-us/blog/announcing-the-public-preview-of-shared-image-gallery/)
as the source for this build. *VHD targets are incompatible with this
@ -91,6 +92,7 @@
to learn more about managed images.
- `location` (string) - Location
- `vm_size` (string) - Size of the VM used for building. This can be changed when you deploy a
VM from your VHD. See
[pricing](https://azure.microsoft.com/en-us/pricing/details/virtual-machines/)
@ -153,8 +155,13 @@
- `storage_type` (string) - DTL values
- `lab_virtual_network_name` (string) - Lab Virtual Network Name
- `lab_name` (string) - Lab Name
- `lab_subnet_name` (string) - Lab Subnet Name
- `lab_resource_group_name` (string) - Lab Resource Group Name
- `dtl_artifacts` ([]DtlArtifact) - Dtl Artifacts
- `vm_name` (string) - VM Name

View File

@ -1,6 +1,9 @@
<!-- Code generated from the comments of the DtlArtifact struct in builder/azure/dtl/config.go; DO NOT EDIT MANUALLY -->
- `artifact_name` (string) - Artifact Name
- `repository_name` (string) - Repository Name
- `artifact_id` (string) - Artifact Id
- `parameters` ([]ArtifactParameter) - Parameters

View File

@ -1,7 +1,11 @@
<!-- Code generated from the comments of the SharedImageGallery struct in builder/azure/dtl/config.go; DO NOT EDIT MANUALLY -->
- `subscription` (string) - Subscription
- `resource_group` (string) - Resource Group
- `gallery_name` (string) - Gallery Name
- `image_name` (string) - Image Name
- `image_version` (string) - Image Version

View File

@ -1,7 +1,11 @@
<!-- Code generated from the comments of the SharedImageGalleryDestination struct in builder/azure/dtl/config.go; DO NOT EDIT MANUALLY -->
- `resource_group` (string) - Sig Destination Resource Group
- `gallery_name` (string) - Sig Destination Gallery Name
- `image_name` (string) - Sig Destination Image Name
- `image_version` (string) - Sig Destination Image Version
- `replication_regions` ([]string) - Sig Destination Replication Regions

View File

@ -105,4 +105,5 @@
false.
- `template_tag` (string) -
- `tags` (map[string]string) - Tags

Some files were not shown because too many files have changed in this diff Show More