From 4ee3ed64a7f9b85b3fc71ffb2c5e0fb010833a27 Mon Sep 17 00:00:00 2001 From: Wilken Rivera Date: Fri, 31 May 2024 18:49:56 +0000 Subject: [PATCH] backport of commit 47a92575d3006b909dd466299d56b2090993652d --- website/content/docs/commands/plugins/install.mdx | 2 +- website/content/docs/configure.mdx | 6 +----- website/content/docs/plugins/index.mdx | 2 +- 3 files changed, 3 insertions(+), 7 deletions(-) diff --git a/website/content/docs/commands/plugins/install.mdx b/website/content/docs/commands/plugins/install.mdx index f3dafc819..82bda2e0d 100644 --- a/website/content/docs/commands/plugins/install.mdx +++ b/website/content/docs/commands/plugins/install.mdx @@ -29,7 +29,7 @@ Use the following syntax to run the `packer plugins install` command: Specify a version number to install a specific version of the plugin. The following example installs the version `1.0.1` of `my-plugin` from a remote source: ```shell-session -$ packer plugins install github.com/hashicorp/my-plugin 1.0.0 +$ packer plugins install github.com/hashicorp/my-plugin 1.0.1 ``` Use the `--path` option to specify a local plugin binary. The following example installs `my-plugin` from a local binary: diff --git a/website/content/docs/configure.mdx b/website/content/docs/configure.mdx index d71d08d7e..e01eef0dc 100644 --- a/website/content/docs/configure.mdx +++ b/website/content/docs/configure.mdx @@ -52,17 +52,13 @@ configuration file. All parameters are optional. None of these are required, sin - `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. -- `post-processors`: Specifies a type of object that installs plugins. Refer to [Post-Processors](/packer/docs/post-processors) for additional information. -- `provisioners`: Specifies a type of object that installs plugins. Refer to [Provisioners](/packer/docs/provisioners) for additional information. The [`packer init`](/packer/docs/commands/init) command takes precedence over JSON-configure settings when installing plugins. ## Configure the cache directory -Packer uses a cache directory to download large files and for logistics around large file download. By default, Packer caches files in the `./packer_cache/` folder of the current directory. Use the `PACKER_CACHE_DIR` environment variable to configure the cache directory. Refer to [`PACKER_CACHE_DIR`](/packer/docs/configure#packer_config_dir) for details. +Packer uses a cache directory to download large files and for logistics around large file download. By default, Packer caches files in the `.packer_cache` folder of the current directory. Use the `PACKER_CACHE_DIR` environment variable to configure the cache directory. Refer to [`PACKER_CACHE_DIR`](/packer/docs/configure#packer_config_dir) for details. We recommend using the same Packer cache directory across your builds if multiple builds perform similar actions. This is to avoid downloading the same large file, such as an ISO, multiple times. diff --git a/website/content/docs/plugins/index.mdx b/website/content/docs/plugins/index.mdx index 2b73ec624..81a1df03b 100644 --- a/website/content/docs/plugins/index.mdx +++ b/website/content/docs/plugins/index.mdx @@ -10,7 +10,7 @@ This topic provides overview information about installing and loading Packer plu ## Introduction -The Packer binary includes a set of built-in plugins that run automatically, but you can also define a list of external plugins in your template for Packer to run and communicate with throughout the build. These external plugins extend Packer functionality without modifying the core source code. Packer launches one plugin process for each component in the build. +The Packer binary includes a set of built-in components that are automatically usable. You can also install external plugins for Packer to run and communicate with throughout the build. These external plugins extend Packer functionality without modifying the core source code. Packer launches one plugin process for each component in the build. ## Workflows