Commit Graph
5094 Commits
Author SHA1 Message Date
Lucas Bajolet 5ce9b1867b datasource: add file datasource
The file datasource is meant to be used to pre-create a file that can
then be used elsewhere in the build process by its path.

This is useful for example when building a configuration file from a
template, so then the resulting file can be referenced by components
which only accept file paths.
2024-10-01 11:11:24 -04:00
Wenfeng Pan 1b160e5df0 Add base64gzip function support to Packer template 2024-08-13 14:53:29 -04:00
Lucas Bajolet 199a751353 docs: remove trailing whitespaces from the docs 2024-08-08 10:14:20 -04:00
Lucas Bajolet 6514a66131 docs: update manually installing plugins docs
The installing plugins docs had information on manually installing
plugins that was misleading a bit, so we update that section with this
commit.
2024-08-08 10:14:20 -04:00
graevyandWilken Rivera e4ec754985 doc fix for unattended debian/ubuntu installer linkrot (#13023)
* doc fix for unattended debian/ubuntu installer linkrot

the links for chef-maintained preseeds/autoinstallers for debian/ubuntu both rotted. i'm just getting started with packer, so i hope this edit is accurate.

* Remove webarchive links for legacy JSON

When possible point users to HCL2 templates for getting started examples.

* As per the style guide aim for inclusive language

---------

Co-authored-by: Wilken Rivera <[email protected]>
2024-06-21 16:00:38 -04: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
Ryan Johnson 5e9f5f4a99 docs: update provisioners
Updates the provisioners documentation for a better reader experience by including a list of the built-in provisioners and a link to the community supported provisioners that are all withing the navigation tree.

Ref: #12898

Signed-off-by: Ryan Johnson <[email protected]>
2024-06-17 11:26:32 -04:00
Ryan Johnson 66abaaeb4e docs: string templates
Adds an example of a string template being used.

The example demonstrates how a template sequence can be used to embed the value of a variable into a string that can be used as script content.

Ref: #12651

Signed-off-by: Ryan Johnson <[email protected]>
2024-06-14 18:12:34 -04:00
Ryan Johnson 51cbe0ba81 docs: update ssh
Adds documentation for `ssh_keypair_name`, `ssh_agent_auth`, `temporary_key_pair_name`, and `ssh_private_key_file`.

The note is updated noting that not all builders support these options.

Ref:  #10722

Signed-off-by: Ryan Johnson <[email protected]>
2024-06-13 14:30:48 -04:00
Ryan Johnson f7cf9ede19 docs: update init
Adds additional examples and help regarding the use of `packer init`.

Ref: #11541

Signed-off-by: Ryan Johnson <[email protected]>
2024-06-13 12:22:07 -04:00
Lucas BajoletandWilken Rivera 280266163c docs: add plugin loading spec documentation (#13024)
* docs: add plugin loading spec documentation

The logic for discovering and loading plugins is not well documented on
the current documentation.
This causes issues for users that have to troubleshoot why a particular
plugin cannot be found or installed, so this commit adds a specification
document, detailing what are Packer's expectations when it comes to
discovering plugins.

* Apply suggestions from code review

* Update plugin loading specification navbar

---------
Co-authored-by: Wilken Rivera <[email protected]>
2024-06-10 09:56:14 -04:00
Alex Boutin 3fb6b76701 Fixed wrong parameter in doc 2024-06-03 10:09:35 -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
Steven Kalt 766c3d7fef docs: consistent code blocks around types 2024-05-31 11:15:55 -04:00
Lucas Bajolet accbe97e1e hcl2template: add text(encode|decode)base64 funcs (#12997)
Compared to Terraform, Packer was lacking a capability to encode/decode
strings to/from base64-encoded text encoded with another encoding.

This could be problematic in some cases, mainly when working with
Windows, as most of the OS uses UTF-16LE as its standard encoding for
many operations.

Therefore, we take a page from Terraform here, and add those functions
to what Packer supports in an HCL2 context.
2024-05-30 14:24:46 +02:00
Lucas Bajolet a9ba14f505 website: fix myawesomecloud reference
When updating the docs in prevision for Packer 1.11.0, we changed the
templates that show how plugins are installed/discovered with commands
like packer init.

While doing so, a template had its component renamed to coolcloud, but
the following prose did not change, making the text inconsistent.

Since there are other mentions of myawesomecloud in the codebase, we
choose to settle on this one for that example too.
2024-05-20 12:39:14 -04:00
Wilken Rivera a7591c950a Add details on the importance of using required_plugins 2024-05-15 14:50:24 -04:00
Wilken Rivera 27b5f27ec9 Add section for Non-GitHub source addresses 2024-05-15 14:50:24 -04:00
Wilken Rivera ce7205ed79 required_plugins:Add source addresses section
* Document the purpose of a source address
* Add a note about non-GitHub source addresses containing one of more sub-folder parts
2024-05-15 14:50:24 -04:00
Wilken Rivera 4015e4d7be init:Document force flag option for init command 2024-05-15 14:50:24 -04:00
Estelle PoulinandWilken Rivera 47d8df33e9 Update Example of Parsing a Manifest to Use Only jq (#12894)
* Update manifest.mdx

* Remove extra space in split function

---------

Co-authored-by: Wilken Rivera <[email protected]>
2024-05-15 11:27:30 -04:00
Lucas Bajolet d8a95a741b docs: update plugins install command documentation
Since the plugins install subcommand can install both remotely and
locally sourced plugins, we update the documentation for it on the
web-docs to reflect this change.
2024-05-14 14:58:55 -04:00
Lucas Bajolet 9f3dd5b72a website: update install plugins docs
Since we're changing how packer manages plugin installation with 1.11.0,
we reflect those changes to the website documentation.

Now, we only describe the packer init and packer plugins install
commands, along with the `--path` flag for installing from a local
source.

The explanations of how packer discovers and picks which version of a
plugin to load are also included, along with the list of constraints
that determine whether a plugin can be considered or not to be loadable.
2024-05-14 14:05:17 -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
Wilken Rivera 9f2d6ce1fc docs/plugins/remove: Update command usage text
* Add an example of piping the results of `plugins installed` to `plugins remove`
2024-05-14 13:13:22 -04:00
Lucas Bajolet 5ced785f2f docs: fix typo in HCP Packer artifact/version docs
In the full example for both the hcp-packer-artifact and
hcp-packer-version the hcp-packer-version reference in the example
template was mistakenly spelled as "hcp_packer_version", which won't
work, so we fix that typo here.
2024-05-10 09:36:47 -04:00
Jiaqi Liu 00f39e72d3 Add missing option doc for 'packer fmt' (#12944) 2024-04-29 10:04:20 -04:00
pavedroad a27ef0d035 chore: remove repetitive words
Signed-off-by: pavedroad <[email protected]>
2024-03-12 09:36:26 -04:00
Wilken Rivera bb8e1947da Fix invalid path for copy command 2024-03-11 14:36:55 -04:00
Jenna Goldstrich 72db1c35e9 Don't use old nomenclature in terminology docs (#12843) 2024-02-16 10:40:58 -08:00
Wilken Rivera 4d38323ae1 Remove external Plugins from left navbar 2024-02-08 09:19:54 -05:00
Heat Hamilton 767005149c website: fix husky command (#12821)
* Change husky pre-commit hook to work in sub-directory of .git

* Added dart-linkcheck back in for linkcheck command
2024-01-30 17:25:03 -05:00
Wilken Rivera 08d41c2679 Fix URL rewrite check error for DevDot portal (#12818)
Refer to job https://github.com/hashicorp/packer/actions/runs/7709708630/job/21011464094
2024-01-30 15:33:21 -05:00
Wilken Rivera 1e6041ab05 docs/plugins:Fix incorrect plugin directory path 2024-01-30 05:25:57 -05:00
Heat Hamilton ec403555dc Updated next, node, npm, nvmrc and Docker node versions; added husky pre-commit hook v9 2024-01-29 16:24:27 -05:00
Wilken Rivera da65323918 Remove all external plugin docs
This change removes all external plugin docs using the old remote docs framework
from the Packer core documentation in favor of the Packer integration framework.
Remove plugins will be enabled on the integration portal and contacted to merge their PRs to finalize the integration migration.
2024-01-29 15:06:08 -05:00
Devashish 4b591d6937 Add PR suggestions 2024-01-26 14:31:04 -05:00
Devashish 14ce2a559c fix shell session in the docs 2024-01-26 14:31:04 -05:00
Devashish b77d581cda Add the deprecation warning and update docs 2024-01-26 14:31:04 -05:00
3fa637c608 Migrate HCP Packer to API V2 and new nomenclature changes (#12794)
* add hcp packer new nomenclature updates

* Update docs with nomenclature changes

* Update navigation bar links

* Bump github.com/hashicorp/hcp-sdk-go from 0.81.0 to 0.82.0

* fix acceptance test template

---------

Co-authored-by: sylviamoss <[email protected]>
Co-authored-by: Wilken Rivera <[email protected]>
2024-01-24 13:17:35 -05:00
Wilken Rivera 96755d2f7b Remove migrated integrations from plugin manifest
This change removes Scaleway and Mondoo from the external plugins manifest in favor
of the integration framework, which they have migrated to.
2024-01-17 10:23:37 -05:00
Lucas Bajolet 311a3b1d6a website: remove UpCloud from manifest
Since the UpCloud plugin has moved to the integrations model, we don't
want to continue looking for a docs.zip in their repo, as it doesn't
exist anymore with this migration.
2024-01-08 09:37:45 -05:00
Brian McClain 9afafd962f Pin UpCloud plugin version 2024-01-03 13:36:05 -05:00
9d46c90c03 Apply suggestions from code review
Co-authored-by: Lucas Bajolet <[email protected]>
Co-authored-by: Sylvia Moss <[email protected]>
2023-12-05 16:15:12 -05:00
Wilken Rivera 9565eca354 Remove reference to deprecated single components 2023-12-05 16:15:12 -05:00
Wilken Rivera e2a2a08f56 Add example shell commands for copying integration files into plugin repository 2023-12-05 16:15:12 -05:00
Wilken Rivera 149a8095e1 Address review feedback 2023-12-05 16:15:12 -05:00
Wilken Rivera 6d7d266bb6 Replace relative links 2023-12-05 16:15:12 -05:00
Wilken Rivera c0de07c32e Document process for registering a plugin as a Packer Integration 2023-12-05 16:15:12 -05:00