From 187ed85c5c2ee58f5f234da5314e2e42e6bc77df Mon Sep 17 00:00:00 2001 From: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> Date: Fri, 31 May 2024 08:17:11 -0700 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Wilken Rivera --- website/content/docs/commands/init.mdx | 2 +- website/content/docs/configure.mdx | 2 +- website/content/docs/plugins/install.mdx | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/website/content/docs/commands/init.mdx b/website/content/docs/commands/init.mdx index 0159bd036..99b734ca9 100644 --- a/website/content/docs/commands/init.mdx +++ b/website/content/docs/commands/init.mdx @@ -1,6 +1,6 @@ --- description: | - Reference information about the `packer init` command, which downloads and installs Packer one or more plugin binaries specified in a Packer template written in HCL. + Reference information about the `packer init` command, which downloads and installs one or more plugin binaries specified in a Packer template written in HCL. page_title: packer init command line reference --- diff --git a/website/content/docs/configure.mdx b/website/content/docs/configure.mdx index 5e4b8aa3a..d71d08d7e 100644 --- a/website/content/docs/configure.mdx +++ b/website/content/docs/configure.mdx @@ -50,7 +50,7 @@ You use a JSON file to set core Packer settings. Packer checks the following pat Use basic JSON to configure the file. You can specify the configuration parameters for the core configuration file. All parameters are optional. None of these are required, since all have defaults. -- `plugin_min_port`: Number that specifies the lowest port that Packer can use for communicating with plugins. Packer communicates with plugins over TCP connections on your local Unix host. Default is `10000`. We recommend setting a wide range between `plugin_min_port` and `plugin_max_port` so that Packer has access to at least 25 ports on a single run. +- `plugin_min_port`: Number that specifies the lowest port that Packer can use for communicating with plugins. Packer communicates with plugins over TCP or Unix sockets on your local host. Default is `10000`. We recommend setting a wide range between `plugin_min_port` and `plugin_max_port` so that Packer has access to at least 25 ports on a single run. - `plugin_max_port`: Number that specifies highest port that Packer can for communicating with plugins. Packer communicates with plugins over TCP connections on your local Unix host. Default is `25000`. We recommend setting a wide range between `plugin_min_port` and `plugin_max_port` so that Packer has access to at least 25 ports on a single run. - `builders`: Specifies a type of object that installs plugins. Refer to [Builders](/packer/docs/builders) for additional information. - `commands`: Specifies a type of object that installs plugins. diff --git a/website/content/docs/plugins/install.mdx b/website/content/docs/plugins/install.mdx index cb3d600a9..ad35927c0 100644 --- a/website/content/docs/plugins/install.mdx +++ b/website/content/docs/plugins/install.mdx @@ -95,9 +95,8 @@ $ packer init --upgrade . Refer to [`packer init` command](/packer/docs/commands/init) for additional information. -## Install a plugin under development +## Use a plugin under development -You can install and use plugins that are still under development and report as `dev` versions. But if a final version of the plugin binary is available, Packer installs the final version according to the version constraints specified in the Packer template and uses it in the build. If a development binary, such as a manually-built binary, is available at the specified source, Packer uses it in the build if it is the highest compatible version installed and if no final plugin version with the same version number is installed alongside it. @@ -143,7 +142,6 @@ When a non-development version of 1.1.1 becomes available, the binary takes prec └── packer-plugin-amazon_v1.1.1_x5.0_darwin_arm64_SHA256SUM ``` -Refer to the documentation in the [Packer plugin scaffolding repository](https://github.com/hashicorp/packer-plugin-scaffolding?tab=readme-ov-file#build-from-source) for additional information. ### Example Docker plugin @@ -184,6 +182,8 @@ Complete the following steps to build and install a custom version of the Docker For convenience, the makefile in the Packer plugin scaffolding repository builds and installs development binaries using `make dev`. +Refer to the documentation in the [Packer plugin scaffolding repository](https://github.com/hashicorp/packer-plugin-scaffolding?tab=readme-ov-file#build-from-source) for additional information. + ## Authenticate requests to the GitHub API You can set the `PACKER_GITHUB_API_TOKEN` environment variable to send more requests per hour than the limits imposed by the GitHub API: