Commit Graph
109 Commits
Author SHA1 Message Date
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 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
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
pavedroad a27ef0d035 chore: remove repetitive words
Signed-off-by: pavedroad <[email protected]>
2024-03-12 09:36:26 -04: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
ygXXII 19c14fd1e2 docs: fix aws_secretsmanager Title Name (#12678)
Just a simple doc title fix.
2023-11-02 05:36:36 -04:00
Lucas Bajolet c528681dde docs: amend HCL templates/functions docs
The HCL2 docs on built-in functions contains a link to a non-existent
section of the expressions page, so we update it to link to the general
page, and to the string interpolation section, since it is a common use
case.
2023-10-30 09:36:03 -04:00
Wilken Rivera 0ec424aa25 Fix broken link to Consul's environment variables page (#12673) 2023-10-30 07:50:53 -04:00
Kévin Dunglas 739b2acd20 docs: fix typo (#12493) 2023-07-19 17:35:26 -04:00
GaryNgandLucas Bajolet 58b193f221 Use backtick to prevent html parsing
Co-authored-by: Lucas Bajolet <[email protected]>
2023-07-19 11:54:11 -04:00
GaryNg cc1e2fca78 Prefix url with product slug 2023-07-19 11:54:11 -04:00
GaryNg 5271c28749 Add closing code block 2023-07-19 11:54:11 -04:00
Samuel Phan 09e9643881 docs: add missing end quote 2023-05-29 13:33:17 -04:00
josiahsmythe-bah f81e9c2222 Fixed formatting issue 2023-05-03 11:38:52 -04:00
Wilken Rivera f809cbce5f Remove circular reference between data source documentation pages
* Update the data source documentation with a link to the amazon-ami configuration reference guide.

Closes #12336
2023-04-28 16:30:01 -04:00
Lucas Bajolet 1ad92b0759 docs: add docs to show diffs between JSON and HCL2 2023-04-28 13:58:45 -04:00
485e080725 clarify local and input variables (#12334)
* clarify local and input variables

* Apply suggestions from code review

Co-authored-by: Rose M Koron <[email protected]>

* Apply suggestions from code review

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

* Apply suggestions from code review

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

---------

Co-authored-by: Rose M Koron <[email protected]>
Co-authored-by: Wilken Rivera <[email protected]>
2023-04-12 18:05:29 -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
lonegunmanb 6137745cc1 Update variables documentation to refer to Packer not Terraform (#12220) 2023-01-25 10:39:33 -05:00
lonegunmanb ba546eb8cb correct document issue in provisioner block doc (#12210) 2023-01-24 10:21:54 -05:00
craigpero 38d0bc818d Update index.mdx
In trying the example, I found that you have to type "*.second-example" for the expected results.   I took the command line on line #78 literal and it didn't work as typed. When I used my proposed change... it worked for me.
Alternatively, "*.second*" works but that could grab builders that were not intended.
2023-01-20 14:53:53 -05:00
Wilken RiveraandLucas Bajolet bc55d6d2d6 [HPR-763] Update HCL variable documentation (#12058)
* Update HCL variable documentation

* Add supported arguments section for variables
* Add inpage links to key variable arguments
* Reorder content to cluster assignment documentation together
* Split variable definitions into two sub-sections

Co-authored-by: Lucas Bajolet <[email protected]>
2022-10-24 20:58:32 -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
Lucas Bajolet 84dc228a68 docs: move legacy JSON warning under title
With the move to Hashidocs, the version picker is within the text area
for the documentation being displayed. This negatively interacts with
the Note on top, as it obstructs part of the text.

To circumvent this problem, we move the Note after the title/intro.
2022-10-21 09:20:34 -04:00
Laura Pacilio 8765cd3cab Content munge devportal (#11982)
* Update content for devdot

* more edits

* Update website/content/docs/templates/hcl_templates/blocks/index.mdx

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

* Update website/content/docs/datasources/index.mdx
2022-09-14 16:16:39 -04:00
Dan Barr d2c83c4944 Update Golang references to Go
* Fix any "golang" to just "Go"
* Update golang.org URLs to go.dev
2022-08-05 13:42:56 -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
Wilken Rivera 6b03734b2f Document known limitation of locals being used within a data source (#11864)
* Document known limitation of locals being used within a data source

* Update website/content/partials/datasources/local-dependency-limitation.mdx
2022-07-07 12:48:23 -04:00
Mahyar Saffari Moqaddam 3c9fb89a9f Update engine.mdx (#11833)
Corrected "indended" typo
2022-06-03 18:41:29 -04:00
Zachary Shilton a88d54c310 fix(website): remove empty index pages (#11702) 2022-04-11 16:08:39 -04:00
Patrick BandSylvia Moss 93ea7a5fc2 fix missing closing bracket for build {} section (#11654)
Co-authored-by: Sylvia Moss <[email protected]>
2022-03-10 16:18:07 +01:00
Laura Pacilio 4a61d4ad0b Add notes about deactivated registries 2022-03-03 18:48:08 -05:00
Laura Pacilio d4447c3c17 Fix langauge on docs intro page and templates build block page 2022-03-03 18:38:15 -05:00
Johanan LiebermannandAdrien Delorme f8ea98d671 Add missing closing parenthesis (#11599)
* Add missing closing parenthesis

Signed-off-by: Johanan Liebermann <[email protected]>
Co-authored-by: Adrien Delorme <[email protected]>
2022-02-28 15:57:57 +01:00
Adrien DelormeandWilken Rivera e03ad29ca0 Sanitize var code (#11566)
* evaluateLocalVariables: modify code for readability and some (not benchmarked) perfs

* Make default input variable type the DynamicPseudoType

This should be the default, and avoids a panic. This type can represent situations where a type is not yet known. Its meaning is undefined in cty.

* do not take Empty types from default value

* Update types.variables.go

Co-authored-by: Wilken Rivera <[email protected]>
2022-02-14 11:00:41 -05:00
Wilken Rivera 6c713d1fd6 Add example of marking Vault values as sensitive variables (#11503)
* Add example of marking Vault values as sensitive variables

* Update website/content/docs/templates/hcl_templates/functions/contextual/vault.mdx
2022-01-24 11:14:48 +01:00
Wilken Rivera 9f86de317b Update agains to against in the note section 2021-12-12 06:29:50 -05:00
Felipe Crescencio de OliveiraandWilken Rivera 2a8001cd87 Fix docs about running specific provisioners (#11442)
* Fix docs about running specific provisioners

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

Co-authored-by: Wilken Rivera <[email protected]>
2021-12-12 06:27:39 -05:00
Adrien Delorme a2124eb594 Tiny tweaks and fixes for the PowerShell provisioner (#11410)
* add docs
* fix potential bug
2021-11-23 12:34:26 +01:00
Wilken Rivera 09b29bc4c0 Add a little specificity to the use of dynamic blocks (#11404) 2021-11-19 11:59:03 +01:00
Wilken RiveraandAdrien Delorme 06b35c39de hcp packer registry build labels (#11401)
* Add basic support for build_labels argument

* Update support for build_labels configuration argument

* Update complete test-fixture with a build_labels configuration
* Add test for deprecated labels argument
* Add deprecation for hcp_packer_registry.labels

When using the now deprecated labels argument of the new bucket_labels a
Warning will be presented to the user.

```
~>  HCP_PACKER_BUILD_FINGERPRINT=356786543567865456789656789 packer
build source.pkr.hcl
Warning: the argument hcp_packer_registry.labels has been deprecated and will be removed in a future release; please use hcp_packer_registry.bucket_labels
```

When trying to use both bucket_labels and labels together an error is
presented to the user.
```
~>  HCP_PACKER_BUILD_FINGERPRINT=ss6786543567865456789656789 packer
build source.pkr.hcl
Error: hcp_packer_registry.labels and hcp_packer_registry.bucket_labels are mutely exclusive; please use the recommended argument hcp_packer_registry.bucket_labels

  on source.pkr.hcl line 17:
    (source code not available)

```

* Update documentation for build_labels

* Apply suggestions from code review

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

* Update hcl2template/types.build.hcp_packer_registry.go

Co-authored-by: Adrien Delorme <[email protected]>
2021-11-18 09:40:08 +01:00
Elio B 2ff9bd5748 Fix typo (#11374) 2021-11-04 14:14:00 +01:00
Laura Pacilio da8ec95249 Updates for HCP Packer docs
Enable HCP Packer docs and add note about public beta (#11339)
format markdown and mention that registry block is available in v1.7.7
2021-10-19 08:03:32 -07:00
Megan Marsh e3719dd8a4 Merge pull request #11319 from hashicorp/add_iteration_id
Add iteration
2021-10-11 13:18:10 -07:00
Megan Marsh b763b79d9f implement contextual variable packer.iteration_id 2021-10-11 10:55:44 -07:00
Adrien Delorme e99e038a72 Docs: remove reference to undefined map function (#11324) 2021-10-11 10:09:34 -04:00