Commit Graph
22 Commits
Author SHA1 Message Date
Martin Grogan 43383a22e2 docs: add PACKER_GETTER_READ_TIMEOUT in config 2025-03-03 16:45:04 -05:00
trujillo-adamandrita 3ddaae6e68 Apply suggestions from code review
Co-authored-by: rita <[email protected]>
2025-01-31 14:09:46 -08:00
trujillo-adam cf46ce621f remaining packer content 2025-01-29 16:14:35 -08:00
Martin Grogan 024bf7259a docs: make TMPDIR clickable
The option is less visible than the other one and by adding the quote,
it creates an anchor that will make it easier to link.
2024-12-23 15:18:33 -05:00
Wilken RiveraandLucas Bajolet d406613387 Document use of TMPDIR required for remote plugin installation (#13056)
* Document use of TMPDIR required for remote plugin installation

* Update website/content/docs/configure.mdx

Co-authored-by: Lucas Bajolet <[email protected]>

---------

Co-authored-by: Lucas Bajolet <[email protected]>
2024-06-17 17:32:42 -04:00
d75975821f Update plugins install docs for v1.11.0 (#12995)
* IPE-727 first commit, adds release notes

* content for the 1.11 release notes

* updates to init CLI reference

* updates to install plugins CLI reference

* updates to source information on the packer block configuration reference

* updated Packer configuration page

* updated plugins installation overview page

* updated plugins installation usage page

* added Upgrades section

* added outline for an upgrade page for this version

* added comments for upgrade page outline

* renamed install plugins mdx and added redirects

* Apply suggestions from code review

Co-authored-by: Lucas Bajolet <[email protected]>

* fix nav

* fix bad links

* applying additional feedback

* Apply suggestions from code review

Co-authored-by: Lucas Bajolet <[email protected]>

* integrated rationale into release notes

* removed 'upgrade from older version' section in the upgrade instructions

* docs: fill-in the upgrade/1.11 document

* Apply suggestions from code review

Co-authored-by: Wilken Rivera <[email protected]>

* edits to upgrade 1.11 and release note

* Apply suggestions from code review

Co-authored-by: Lucas Bajolet <[email protected]>

* Apply suggestions from code review

Co-authored-by: Lucas Bajolet <[email protected]>

---------

Co-authored-by: Lucas Bajolet <[email protected]>
Co-authored-by: Lucas Bajolet <[email protected]>
Co-authored-by: Wilken Rivera <[email protected]>
2024-05-31 14:52:47 -04:00
Lucas Bajolet 266c4d99d2 website: update discovery/envvar documentation
With the changes coming up for 1.11.0, we update the Packer
configuration docs so they describe the one way to load plugins, and the
two environment variables which can be set to change this behaviour.
2024-05-14 14:05:17 -04:00
Lucas Bajolet f52502c464 website: remove trailing whitespace 2024-05-14 14:05:17 -04:00
Lucas Bajolet 8beddcf52a website: fix header on configure page
When the config file header was reworked, an erroneous link was
included and placed so close to the header that it was rendered verbatim
in the final documentation page.

By adding an extra empty line in between the anchor link and the header,
this renders correctly.
2023-07-12 12:45:42 -04:00
Wilken Rivera 9c85fc274a Update plugin loading documentation (#12485)
Packer checks a number of directories for plugins upon initialization,
with the introduction of multi-component plugins and underlying changes
to the Packer SDK the ordering changed slightly. These changes update
the related documentation to reflect the new ordering, and adds a plugin
loading ordering section to the docs to help users discover how plugin
loading works.

Include in this change are updates to the PACKER_CONFIG_DIR environment
variables to reflect the XDG base directory specification used as the
default Packer configuration directory layout.

* Update website/content/docs/configure.mdx
2023-07-06 16:00:36 -04:00
50da6c8dc8 docs: Migrate link formats (#12192)
* Adding check-legacy-links-format workflow

* Adding test-link-rewrites workflow

* Migrating links to new format

* Updating docs-content-check-legacy-links-format hash

* chore: update source

* Update generated partials from Packer plugin SDK

* Bump packer-plugin-sdk to get latest packer-sdc

* Update website/content/docs/templates/hcl_templates/blocks/build/provisioner.mdx

* Update Plugin SDK to fix shell-local regression

---------

Co-authored-by: Kendall Strautman <[email protected]>
Co-authored-by: Wilken Rivera <[email protected]>
Co-authored-by: Kendall Strautman <[email protected]>
2023-01-27 09:47:08 -08:00
Wilken RiveraandLaura Pacilio 414b576def [HPR-574] Add documentation for configuring Packer for HCP Packer (#12022)
* Add documentation for configuring Packer for HCP Packer

This change works to document the two configuration options for setting
up Packer to publish build artifacts to an active HCP Packer registry.
Currently the HashiCorp Cloud Platform documents the process for
configuring Packer via a HCL template, which is the preferred route.
This documentation focuses more on the use of environment variables for
configuring Packer for HCP Packer, which is necessary for legacy JSON
template users looking to publish to HCP Packer.

In light of the new HCP Packer documentation page we've opted for a shorter
version of the HCP Packer introduction section.

* Applying the first round of suggestions to tighten up the documentation.
* Move HCP Packer side bar to top
* Move intro into docs
* Add redirects for intro pages

Co-authored-by: Laura Pacilio <[email protected]>
2022-10-24 12:51:14 -04:00
Zach ShiltonandWilken Rivera 879fd9035c fix: update redirected and broken links (#12060)
* website: fix broken links on /docs/templates

* fix: redirected install-plugins link

* fix: debugging link

* fix: secrets manager link in docs

* fix: secrets manager link in source

* fix: amazon ami plugin link in docs

* fix: amazon ami plugin link in source

* fix: extending plugins link

* fix: plugins/builders/amazon links

* fix: various builders links

* fix: various amazon builder links

* fix: redirected terminology link

* fix: custom-provisioners link

* fix: docker-push redirected plugin link

* fix: googlecompute plugin links

* fix: hyperv iso plugin links

* website: update link to hcl upgrade guide

Co-authored-by: Wilken Rivera <[email protected]>

Co-authored-by: Wilken Rivera <[email protected]>
2022-10-21 11:00:58 -04:00
Dan Barr ab29b187b1 Fix capitalizations in docs
* Brands (HashiCorp, VMware)
* Various OS/languages (Windows, Unix, Linux, POSIX, Python, PowerShell)
* Various abbreviations (ID, VM, HTTP)
2022-08-05 13:42:56 -04:00
teddylear 36fc4a9f3d docs: Update unix packer config file location docs (#11797) 2022-05-23 15:47:23 -04:00
Matt Robinson fe425e533d fix typo in configure docs 2021-06-25 20:10:20 -04:00
Kerim SatirliandAdrien Delorme cf94fd1778 switches JSON and HCL2 tabs (#10888)
* switches JSON and HCL2 tabs for all provisioners

* corrects `packer` to `Packer`

* corrects `http` to `HTTP`

* corrects typos and highlighting consistency issues

* corrects typos and highlighting consistency issues

* corrects typos and highlighting consistency issues

* `ansible` -> `Ansible`

* `packer fmt` for HCL2 blocks in provisioners

* linting and spelling

* fixes formatting

* fixes formatting

* Update website/content/docs/provisioners/ansible.mdx

Co-authored-by: Adrien Delorme <[email protected]>

* fixes formatting

* improves example

* generate stuff

Co-authored-by: Adrien Delorme <[email protected]>
2021-04-08 15:02:57 +02:00
Zachary Shilton 830140157d website: remove obselete nav data (#10811)
* website: remove obselete sidebar_title frontmatter from docs

* website: bump to latest docs-page

* website: update plugin creation and registration docs

* website: fix broken links
2021-03-31 15:07:00 -04:00
Adrien Delorme 37769c2b95 Change PKR_GITHUB_API_TOKEN to PACKER_GITHUB_API_TOKEN to stay consistent with other env var settings (#10588) 2021-02-11 13:54:25 +01:00
Adrien Delorme b6cfe16444 Document the PKR_GITHUB_API_TOKEN setting in /configure#env vars 2021-02-08 10:59:04 +01:00
Adrien Delorme f588c46fb6 add some docs for the cache dir (#10568) 2021-02-05 10:56:03 +01:00
Adrien Delorme ed091163be HCL2 Parse packer.required_plugins block + packer init (#10304)
This adds the new `required_plugins` block to be nested under the packer block.

Example:
```hcl
packer {
  required_plugins {
    aws = {
      version = ">= 2.7.0"
      source = "azr/aws"
    }
    azure = ">= 2.7.0"
  }
}
```

For example on darwin_amd64 Packer will install those under :
* "${PACKER_HOME_DIR}/plugin/github.com/azr/amazon/packer-plugin-amazon_2.7.0_x5.0_darwin_amd64"
* "${PACKER_HOME_DIR}/plugin/github.com/hashicorp/azure/packer-plugin-azure_2.7.0_x5.0_darwin_amd64_x5"

+ docs
+ tests
2021-02-02 18:05:04 +01:00