diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1d08d09a0..8df28705d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -15,20 +15,20 @@ can quickly merge or address your contributions. ### Reporting an Issue -* Make sure you test against the latest released version. It is possible we +- Make sure you test against the latest released version. It is possible we already fixed the bug you're experiencing. -* Run the command with debug output with the environment variable `PACKER_LOG`. +- Run the command with debug output with the environment variable `PACKER_LOG`. For example: `PACKER_LOG=1 packer build template.json`. Take the _entire_ output and create a [gist](https://gist.github.com) for linking to in your issue. Packer should strip sensitive keys from the output, but take a look through just in case. -* Provide a reproducible test case. If a contributor can't reproduce an issue, +- Provide a reproducible test case. If a contributor can't reproduce an issue, then it dramatically lowers the chances it'll get fixed. And in some cases, the issue will eventually be closed. -* Respond promptly to any questions made by the Packer team to your issue. Stale +- Respond promptly to any questions made by the Packer team to your issue. Stale issues will be closed. ### Issue Lifecycle @@ -86,23 +86,23 @@ The instructions below are for go 1.7. or later. submitting a pull-request. ### Windows Systems + On windows systems you need at least the [MinGW Tools](http://www.mingw.org/), e.g. install via [choco](https://chocolatey.org/): ``` choco install mingw -y ``` -This installs the GCC compiler, as well as a ```mingw32-make``` which can be used wherever -this documentation mentions ```make``` +This installs the GCC compiler, as well as a `mingw32-make` which can be used wherever +this documentation mentions `make` -when building using ```go``` you also need to mention the windows +when building using `go` you also need to mention the windows executable extension ``` go build -o bin/packer.exe ``` - ### Opening an Pull Request Thank you for contributing! When you are ready to open a pull-request, you will @@ -131,37 +131,36 @@ to use `git push ...`. ### Pull Request Lifecycle 1. You are welcome to submit your pull request for commentary or review before - it is fully completed. Please prefix the title of your pull request with - "[WIP]" to indicate this. It's also a good idea to include specific questions - or items you'd like feedback on. + it is fully completed. Please prefix the title of your pull request with + "[WIP]" to indicate this. It's also a good idea to include specific questions + or items you'd like feedback on. 2. Once you believe your pull request is ready to be merged, you can remove any - "[WIP]" prefix from the title and a core team member will review. + "[WIP]" prefix from the title and a core team member will review. 3. One of Packer's core team members will look over your contribution and - either merge, or provide comments letting you know if there is anything left - to do. We do our best to provide feedback in a timely manner, but it may take - some time for us to respond. We may also have questions that we need answered - about the code, either because something doesn't make sense to us or because - we want to understand your thought process. + either merge, or provide comments letting you know if there is anything left + to do. We do our best to provide feedback in a timely manner, but it may take + some time for us to respond. We may also have questions that we need answered + about the code, either because something doesn't make sense to us or because + we want to understand your thought process. 4. If we have requested changes, you can either make those changes or, if you - disagree with the suggested changes, we can have a conversation about our - reasoning and agree on a path forward. This may be a multi-step process. Our - view is that pull requests are a chance to collaborate, and we welcome - conversations about how to do things better. It is the contributor's - responsibility to address any changes requested. While reviewers are happy to - give guidance, it is unsustainable for us to perform the coding work necessary - to get a PR into a mergeable state. + disagree with the suggested changes, we can have a conversation about our + reasoning and agree on a path forward. This may be a multi-step process. Our + view is that pull requests are a chance to collaborate, and we welcome + conversations about how to do things better. It is the contributor's + responsibility to address any changes requested. While reviewers are happy to + give guidance, it is unsustainable for us to perform the coding work necessary + to get a PR into a mergeable state. 5. Once all outstanding comments and checklist items have been addressed, your - contribution will be merged! Merged PRs will be included in the next - Packer release. The core team takes care of updating the - [CHANGELOG.md](../CHANGELOG.md) as they merge. + contribution will be merged! Merged PRs will be included in the next + Packer release. The core team takes care of updating the + [CHANGELOG.md](../CHANGELOG.md) as they merge. 6. In rare cases, we might decide that a PR should be closed without merging. - We'll make sure to provide clear reasoning when this happens. - + We'll make sure to provide clear reasoning when this happens. ### Tips for Working on Packer @@ -250,7 +249,7 @@ does not attempt to track the latest version for each dependency. Packer relies on `go generate` to generate a [peg parser for boot commands](https://github.com/hashicorp/packer/blob/master/common/bootcommand/boot_command.go), -[docs](https://github.com/hashicorp/packer/blob/master/website/source/partials/builder/amazon/chroot/_Config-not-required.html.md) +[docs](https://github.com/hashicorp/packer/blob/master/website/pages/partials/builder/amazon/chroot/_Config-not-required.mdx) and HCL2's bridging code. Packer's testing suite will run `make check-generate` to check that all the generated files Packer needs are what they should be. `make generate` re-generates all these file and can take a while depending on @@ -266,11 +265,13 @@ Packer relies on [golangci-lint](https://github.com/golangci/golangci-lint) for The main configuration for golangci-lint is the `.golangci.yml` in the project root. See `golangci-lint --help` for a list of flags that can be used to override the default configuration. Run golangci-lint on the entire Packer code base. + ``` make lint ``` Run golangci-lint on a single pkg or directory; PKG_NAME expands to /builder/amazon/... + ``` make lint PKG_NAME=builder/amazon ``` diff --git a/CODEOWNERS b/CODEOWNERS index e9dfc2d82..460d74671 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -3,61 +3,61 @@ # builders /builder/alicloud/ @chhaj5236 @alexyueer -/website/source/docs/builders/alicloud* @chhaj5236 @alexyueer +/website/pages/docs/builders/alicloud* @chhaj5236 @alexyueer /builder/azure/ @paulmey -/website/source/docs/builders/azure* @paulmey +/website/pages/docs/builders/azure* @paulmey /builder/hyperv/ @taliesins -/website/source/docs/builders/hyperv* @taliesins +/website/pages/docs/builders/hyperv* @taliesins /builder/jdcloud/ @XiaohanLiang @remrain -/website/source/docs/builders/jdcloud* @XiaohanLiang @remrain +/website/pages/docs/builders/jdcloud* @XiaohanLiang @remrain /builder/linode/ @displague @ctreatma @stvnjacobs -/website/source/docs/builders/linode* @displague @ctreatma @stvnjacobs +/website/pages/docs/builders/linode* @displague @ctreatma @stvnjacobs /builder/lxc/ @ChrisLundquist -/website/source/docs/builders/lxc* @ChrisLundquist +/website/pages/docs/builders/lxc* @ChrisLundquist /builder/lxd/ @ChrisLundquist -/website/source/docs/builders/lxd* @ChrisLundquist +/website/pages/docs/builders/lxd* @ChrisLundquist /builder/oneandone/ @jasmingacic -/website/source/docs/builders/oneandone* @jasmingacic +/website/pages/docs/builders/oneandone* @jasmingacic /builder/oracle/ @prydie @owainlewis -/website/source/docs/builders/oracle* @prydie @owainlewis +/website/pages/docs/builders/oracle* @prydie @owainlewis /builder/profitbricks/ @jasmingacic -/website/source/docs/builders/profitbricks* @jasmingacic +/website/pages/docs/builders/profitbricks* @jasmingacic /builder/triton/ @sean- -/website/source/docs/builders/triton* @sean- +/website/pages/docs/builders/triton* @sean- /builder/ncloud/ @YuSungDuk -/website/source/docs/builders/ncloud* @YuSungDuk +/website/pages/docs/builders/ncloud* @YuSungDuk /builder/proxmox/ @carlpett -/website/source/docs/builders/proxmox* @carlpett +/website/pages/docs/builders/proxmox* @carlpett /builder/scaleway/ @sieben @mvaude @jqueuniet @fflorens @brmzkw -/website/source/docs/builders/scaleway* @sieben @mvaude @jqueuniet @fflorens @brmzkw +/website/pages/docs/builders/scaleway* @sieben @mvaude @jqueuniet @fflorens @brmzkw /builder/hcloud/ @LKaemmerling -/website/source/docs/builders/hcloud* @LKaemmerling +/website/pages/docs/builders/hcloud* @LKaemmerling /builder/hyperone/ @m110 @gregorybrzeski @ad-m -/website/source/docs/builders/hyperone* @m110 @gregorybrzeski @ad-m +/website/pages/docs/builders/hyperone* @m110 @gregorybrzeski @ad-m /builder/ucloud/ @shawnmssu -/website/source/docs/builders/ucloud* @shawnmssu +/website/pages/docs/builders/ucloud* @shawnmssu /builder/yandex/ @GennadySpb @alexanderKhaustov @seukyaso -/website/source/docs/builders/yandex* @GennadySpb @alexanderKhaustov @seukyaso +/website/pages/docs/builders/yandex* @GennadySpb @alexanderKhaustov @seukyaso /builder/osc/ @marinsalinas -/website/source/docs/builders/osc* @marinsalinas +/website/pages/docs/builders/osc* @marinsalinas # provisioners diff --git a/Makefile b/Makefile index 6b254bf7f..96494ebf6 100644 --- a/Makefile +++ b/Makefile @@ -108,7 +108,7 @@ mode-check: ## Check that only certain files are executable echo "Check passed."; \ fi fmt-docs: - @find ./website/source/docs -name "*.md" -exec pandoc --wrap auto --columns 79 --atx-headers -s -f "markdown_github+yaml_metadata_block" -t "markdown_github+yaml_metadata_block" {} -o {} \; + @find ./website/pages/docs -name "*.md" -exec pandoc --wrap auto --columns 79 --atx-headers -s -f "markdown_github+yaml_metadata_block" -t "markdown_github+yaml_metadata_block" {} -o {} \; # Install js-beautify with npm install -g js-beautify fmt-examples: diff --git a/builder/alicloud/ecs/image_config.go b/builder/alicloud/ecs/image_config.go index 778399b1d..e97efbed0 100644 --- a/builder/alicloud/ecs/image_config.go +++ b/builder/alicloud/ecs/image_config.go @@ -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: @@ -61,9 +61,9 @@ type AlicloudDiskDevices struct { // - `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 diff --git a/builder/amazon/instance/builder.go b/builder/amazon/instance/builder.go index b1b388b70..06af0acc6 100644 --- a/builder/amazon/instance/builder.go +++ b/builder/amazon/instance/builder.go @@ -61,7 +61,7 @@ type Config struct { // exist and be writable. BundleDestination string `mapstructure:"bundle_destination" required:"false"` // The prefix for files created from bundling the root volume. By default - // this is `image-{{timestamp}}``. The timestamp variable should be used to + // this is `image-{{timestamp}}`. The timestamp variable should be used to // make sure this is unique, otherwise it can collide with other created // AMIs by Packer in your account. BundlePrefix string `mapstructure:"bundle_prefix" required:"false"` diff --git a/builder/cloudstack/config.go b/builder/cloudstack/config.go index d3b08fcc5..183b6f6d5 100644 --- a/builder/cloudstack/config.go +++ b/builder/cloudstack/config.go @@ -114,7 +114,7 @@ type Config struct { SourceTemplate string `mapstructure:"source_template" required:"true"` // The name of the temporary SSH key pair // to generate. By default, Packer generates a name that looks like - // packer_, where is a 36 character unique identifier. + // `packer_`, where `` is a 36 character unique identifier. TemporaryKeypairName string `mapstructure:"temporary_keypair_name" required:"false"` // Set to true to indicate that the // provisioners should connect to the local IP address of the instance. diff --git a/builder/lxc/config.go b/builder/lxc/config.go index 592c2a5e4..c9a58026b 100644 --- a/builder/lxc/config.go +++ b/builder/lxc/config.go @@ -20,11 +20,11 @@ type Config struct { // The path to the lxc configuration file. ConfigFile string `mapstructure:"config_file" required:"true"` // The directory in which to save the exported - // tar.gz. Defaults to output- in the current directory. + // tar.gz. Defaults to `output-` in the current directory. OutputDir string `mapstructure:"output_directory" required:"false"` // The name of the LXC container. Usually stored - // in /var/lib/lxc/containers/. Defaults to - // packer-. + // in `/var/lib/lxc/containers/`. Defaults to + // `packer-`. ContainerName string `mapstructure:"container_name" required:"false"` // Allows you to specify a wrapper command, such // as ssh so you can execute packer builds on a remote host. Defaults to @@ -53,7 +53,7 @@ type Config struct { Name string `mapstructure:"template_name" required:"true"` // Options to pass to the given // lxc-template command, usually located in - // /usr/share/lxc/templates/lxc-. Note: This gets passed as + // `/usr/share/lxc/templates/lxc-`. Note: This gets passed as // ARGV to the template command. Ensure you have an array of strings, as a // single string with spaces probably won't work. Defaults to []. Parameters []string `mapstructure:"template_parameters" required:"false"` diff --git a/builder/openstack/run_config.go b/builder/openstack/run_config.go index 719cf89a6..c03e55481 100644 --- a/builder/openstack/run_config.go +++ b/builder/openstack/run_config.go @@ -66,13 +66,9 @@ type RunConfig struct { // following are valid: // // - name (string) - // // - owner (string) - // // - tags (array of strings) - // // - visibility (string) - // // - properties (map of strings to strings) (fields that can be set // with `openstack image set --property key=value`) // diff --git a/builder/virtualbox/common/export_config.go b/builder/virtualbox/common/export_config.go index 79618cf07..6c9710cb2 100644 --- a/builder/virtualbox/common/export_config.go +++ b/builder/virtualbox/common/export_config.go @@ -39,8 +39,7 @@ type ExportConfig struct { // packer call like this (shell `>` continuation character snipped for easier // copy & paste): // - // ``` {.shell} - // + // ``` shell // vm_description='some // multiline // description' diff --git a/builder/vmware/common/hw_config.go b/builder/vmware/common/hw_config.go index 114227ab3..e854d18be 100644 --- a/builder/vmware/common/hw_config.go +++ b/builder/vmware/common/hw_config.go @@ -46,39 +46,39 @@ type HWConfig struct { // * `FILE:path(,yield)` - Specifies the path to the local file to be used // as the serial port. // - // * `yield` (bool) - This is an optional boolean that specifies - // whether the vm should yield the cpu when polling the port. By - // default, the builder will assume this as `FALSE`. + // * `yield` (bool) - This is an optional boolean that specifies + // whether the vm should yield the cpu when polling the port. By + // default, the builder will assume this as `FALSE`. // // * `DEVICE:path(,yield)` - Specifies the path to the local device to be //  used as the serial port. If `path` is empty, then default to the first // serial port. // - // * `yield` (bool) - This is an optional boolean that specifies - // whether the vm should yield the cpu when polling the port. By - // default, the builder will assume this as `FALSE`. + // * `yield` (bool) - This is an optional boolean that specifies + // whether the vm should yield the cpu when polling the port. By + // default, the builder will assume this as `FALSE`. // // * `PIPE:path,endpoint,host(,yield)` - Specifies to use the named-pipe // "path" as a serial port. This has a few options that determine how the // VM should use the named-pipe. // - // * `endpoint` (string) - Chooses the type of the VM-end, which can be - // either a `client` or `server`. + // * `endpoint` (string) - Chooses the type of the VM-end, which can be + // either a `client` or `server`. // - // * `host` (string) - Chooses the type of the host-end, which can - // be either `app` (application) or `vm` (another virtual-machine). + // * `host` (string) - Chooses the type of the host-end, which can + // be either `app` (application) or `vm` (another virtual-machine). // - // * `yield` (bool) - This is an optional boolean that specifies - // whether the vm should yield the cpu when polling the port. By - // default, the builder will assume this as `FALSE`. + // * `yield` (bool) - This is an optional boolean that specifies + // whether the vm should yield the cpu when polling the port. By + // default, the builder will assume this as `FALSE`. // // * `AUTO:(yield)` - Specifies to use auto-detection to determine the // serial port to use. This has one option to determine how the VM should // support the serial port. // - // * `yield` (bool) - This is an optional boolean that specifies - // whether the vm should yield the cpu when polling the port. By - // default, the builder will assume this as `FALSE`. + // * `yield` (bool) - This is an optional boolean that specifies + // whether the vm should yield the cpu when polling the port. By + // default, the builder will assume this as `FALSE`. // // * `NONE` - Specifies to not use a serial port. (default) // diff --git a/cmd/struct-markdown/main.go b/cmd/struct-markdown/main.go index 724bde2da..a9d26870f 100644 --- a/cmd/struct-markdown/main.go +++ b/cmd/struct-markdown/main.go @@ -64,18 +64,18 @@ func main() { header := Struct{ SourcePath: sourcePath, Name: typeSpec.Name.Name, - Filename: "_" + typeSpec.Name.Name + ".html.md", + Filename: typeSpec.Name.Name + ".mdx", Header: typeDecl.Doc.Text(), } required := Struct{ SourcePath: sourcePath, Name: typeSpec.Name.Name, - Filename: "_" + typeSpec.Name.Name + "-required.html.md", + Filename: typeSpec.Name.Name + "-required.mdx", } notRequired := Struct{ SourcePath: sourcePath, Name: typeSpec.Name.Name, - Filename: "_" + typeSpec.Name.Name + "-not-required.html.md", + Filename: typeSpec.Name.Name + "-not-required.mdx", } for _, field := range fields { @@ -133,7 +133,7 @@ func main() { } } - dir := filepath.Join(packerDir, "website", "source", "partials", builderName) + dir := filepath.Join(packerDir, "website", "pages", "partials", builderName) os.MkdirAll(dir, 0755) for _, str := range []Struct{header, required, notRequired} { diff --git a/helper/communicator/config.go b/helper/communicator/config.go index 9aaa14095..35b802dc8 100644 --- a/helper/communicator/config.go +++ b/helper/communicator/config.go @@ -175,7 +175,7 @@ type WinRM struct { // // NOTE: If using an Amazon EBS builder, you can specify the interface // WinRM connects to via - // [`ssh_interface`](https://www.packer.io/docs/builders/amazon-ebs#ssh_interface) + // [`ssh_interface`](/docs/builders/amazon-ebs#ssh_interface) WinRMHost string `mapstructure:"winrm_host"` // The WinRM port to connect to. This defaults to `5985` for plain // unencrypted connection and `5986` for SSL when `winrm_use_ssl` is set to diff --git a/website/pages/partials/builder/alicloud/ecs/AlicloudDiskDevice-not-required.mdx b/website/pages/partials/builder/alicloud/ecs/AlicloudDiskDevice-not-required.mdx index 0cec4e795..ddebe9349 100644 --- a/website/pages/partials/builder/alicloud/ecs/AlicloudDiskDevice-not-required.mdx +++ b/website/pages/partials/builder/alicloud/ecs/AlicloudDiskDevice-not-required.mdx @@ -4,7 +4,7 @@ 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://`. - `disk_category` (string) - Category of the system disk. Optional values are: - cloud - general cloud disk - cloud_efficiency - efficiency cloud disk - cloud_ssd - cloud SSD @@ -19,7 +19,7 @@ - `disk_description` (string) - 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://`. - `disk_delete_with_instance` (bool) - Whether or not the disk is released along with the instance: diff --git a/website/pages/partials/builder/alicloud/ecs/AlicloudImageConfig-not-required.mdx b/website/pages/partials/builder/alicloud/ecs/AlicloudImageConfig-not-required.mdx index 71f84fcdb..0db265757 100644 --- a/website/pages/partials/builder/alicloud/ecs/AlicloudImageConfig-not-required.mdx +++ b/website/pages/partials/builder/alicloud/ecs/AlicloudImageConfig-not-required.mdx @@ -5,7 +5,7 @@ - `image_description` (string) - 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://`. - `image_share_account` ([]string) - The IDs of to-be-added Aliyun accounts to which the image is shared. The number of accounts is 1 to 10. @@ -17,7 +17,7 @@ - `image_copy_names` ([]string) - 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://`. - `image_encrypted` (boolean) - 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 diff --git a/website/pages/partials/builder/alicloud/ecs/AlicloudImageConfig-required.mdx b/website/pages/partials/builder/alicloud/ecs/AlicloudImageConfig-required.mdx index 10fce3473..e153f3da3 100644 --- a/website/pages/partials/builder/alicloud/ecs/AlicloudImageConfig-required.mdx +++ b/website/pages/partials/builder/alicloud/ecs/AlicloudImageConfig-required.mdx @@ -3,4 +3,4 @@ - `image_name` (string) - 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://`. diff --git a/website/pages/partials/builder/alicloud/ecs/RunConfig-not-required.mdx b/website/pages/partials/builder/alicloud/ecs/RunConfig-not-required.mdx index 156df98c3..8ad740191 100644 --- a/website/pages/partials/builder/alicloud/ecs/RunConfig-not-required.mdx +++ b/website/pages/partials/builder/alicloud/ecs/RunConfig-not-required.mdx @@ -48,8 +48,8 @@ - `vpc_name` (string) - 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://`. - `vpc_cidr_block` (string) - 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. diff --git a/website/pages/partials/builder/amazon/common/AccessConfig.mdx b/website/pages/partials/builder/amazon/common/AccessConfig.mdx index 198f9c266..092224e9c 100644 --- a/website/pages/partials/builder/amazon/common/AccessConfig.mdx +++ b/website/pages/partials/builder/amazon/common/AccessConfig.mdx @@ -1,3 +1,2 @@ - AccessConfig is for common configuration related to AWS access diff --git a/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx b/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx index 51383f2ab..69969ab8c 100644 --- a/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx +++ b/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx @@ -58,7 +58,7 @@ Instances, e.g. when the `spot_price` option has been configured. Attempting to do so will cause an error. - !> **Warning!** Additional costs may be incurred by enabling T2 + !> **Warning!** Additional costs may be incurred by enabling T2 Unlimited - even for instances that would usually qualify for the [AWS Free Tier](https://aws.amazon.com/free/). diff --git a/website/pages/partials/builder/amazon/common/RunConfig.mdx b/website/pages/partials/builder/amazon/common/RunConfig.mdx index ee0844c3d..c67a8fb25 100644 --- a/website/pages/partials/builder/amazon/common/RunConfig.mdx +++ b/website/pages/partials/builder/amazon/common/RunConfig.mdx @@ -1,4 +1,3 @@ - RunConfig contains configuration for running an instance from a source AMI and details on how to access that launched image. diff --git a/website/pages/partials/builder/lxd/Config-not-required.mdx b/website/pages/partials/builder/lxd/Config-not-required.mdx index a4f5a7b9b..9f148d888 100644 --- a/website/pages/partials/builder/lxd/Config-not-required.mdx +++ b/website/pages/partials/builder/lxd/Config-not-required.mdx @@ -5,7 +5,7 @@ - `container_name` (string) - Container Name - `command_wrapper` (string) - Lets you prefix all builder commands, such as - with ssh for a remote build host. Defaults to "{{.Command}}"; i.e. no + with ssh for a remote build host. Defaults to `{{.Command}}`; i.e. no wrapper. - `profile` (string) - Profile diff --git a/website/pages/partials/builder/openstack/RunConfig-required.mdx b/website/pages/partials/builder/openstack/RunConfig-required.mdx index e9ec0041b..7bf5b8209 100644 --- a/website/pages/partials/builder/openstack/RunConfig-required.mdx +++ b/website/pages/partials/builder/openstack/RunConfig-required.mdx @@ -40,12 +40,12 @@ [ImageService](https://developer.openstack.org/api-ref/image/v2/), the following are valid: - - name (string) - - owner (string) - - tags (array of strings) - - visibility (string) - - properties (map of strings to strings) (fields that can be set - with `openstack image set --property key=value`) + - name (string) + - owner (string) + - tags (array of strings) + - visibility (string) + - properties (map of strings to strings) (fields that can be set + with `openstack image set --property key=value`) - `most_recent` (boolean) - Selects the newest created image when true. diff --git a/website/pages/partials/builder/qemu/Config-not-required.mdx b/website/pages/partials/builder/qemu/Config-not-required.mdx index d5bb0790f..40b693ba0 100644 --- a/website/pages/partials/builder/qemu/Config-not-required.mdx +++ b/website/pages/partials/builder/qemu/Config-not-required.mdx @@ -9,17 +9,17 @@ accelerator you specified. When no accelerator is specified, Packer will try to use `kvm` if it is available but will default to `tcg` otherwise. - -> The `hax` accelerator has issues attaching CDROM ISOs. This is an + -> The `hax` accelerator has issues attaching CDROM ISOs. This is an upstream issue which can be tracked [here](https://github.com/intel/haxm/issues/20). - -> The `hvf` and `whpx` accelerator are new and experimental as of + -> The `hvf` and `whpx` accelerator are new and experimental as of [QEMU 2.12.0](https://wiki.qemu.org/ChangeLog/2.12#Host_support). You may encounter issues unrelated to Packer when using these. You may need to add [ "-global", "virtio-pci.disable-modern=on" ] to `qemuargs` depending on the guest operating system. - -> For `whpx`, note that [Stefan Weil's QEMU for Windows distribution](https://qemu.weilnetz.de/w64/) + -> For `whpx`, note that [Stefan Weil's QEMU for Windows distribution](https://qemu.weilnetz.de/w64/) does not include WHPX support and users may need to compile or source a build of QEMU for Windows themselves with WHPX support. @@ -121,7 +121,7 @@ as an empty string is ignored. All values after the switch are concatenated with no separator. - ~> **Warning:** The qemu command line allows extreme flexibility, so + ~> **Warning:** The qemu command line allows extreme flexibility, so beware of conflicting arguments causing failures of your run. For instance, using --no-acpi could break the ability to send power signal type commands (e.g., shutdown -P now) to the virtual machine, thus @@ -156,7 +156,7 @@ virtio-net,netdev=mynet0" ``` - ~> **Windows Users:** [QEMU for Windows](https://qemu.weilnetz.de/) + ~> **Windows Users:** [QEMU for Windows](https://qemu.weilnetz.de/) builds are available though an environmental variable does need to be set for QEMU for Windows to redirect stdout to the console instead of stdout.txt. diff --git a/website/pages/partials/builder/virtualbox/common/ExportConfig-not-required.mdx b/website/pages/partials/builder/virtualbox/common/ExportConfig-not-required.mdx index 3a0b101c5..8b06cc3b7 100644 --- a/website/pages/partials/builder/virtualbox/common/ExportConfig-not-required.mdx +++ b/website/pages/partials/builder/virtualbox/common/ExportConfig-not-required.mdx @@ -33,6 +33,7 @@ copy & paste): ```shell + vm_description='some multiline description'