Commit graph

47 commits

Author SHA1 Message Date
Lucas Bajolet
eb9e1a4795 packer: remove implicit required plugins
Since this feature is no longer something we plan to activate later, as
it contradicts with our efforts to remove bundled plugins, and
encouraging users to move to either manually installing plugins, or
managing them through `packer init', we clean-up the code for this
feature.
2023-08-17 16:51:49 -04:00
Wilken Rivera
c575946e4d
Update terminology to reflect community editions of Packer (#12571) 2023-08-11 15:20:50 -04:00
Lucas Bajolet
392232933f website: add usage notice to init
The `packer init' command's wording was not clear, so it was changed in
a preceding commit, and this commit aims to add more details on how the
command is meant to be used, along with a simple example.
2023-07-25 16:45:32 -04:00
Ernst-Christian Kloeden
8d93b3fbd4
website: fix typo in documentation of validate command (#12344) 2023-04-05 09:52:10 -04:00
Ashlee M Boyer
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 <kendallstrautman@gmail.com>
Co-authored-by: Wilken Rivera <wilken@hashicorp.com>
Co-authored-by: Kendall Strautman <36613477+kendallstrautman@users.noreply.github.com>
2023-01-27 09:47:08 -08:00
Lucas Bajolet
14cad650ca website: add docs for variable warning bypass opts
When the options for bypassing/enabling assigned and undeclared
variables were added to Packer, the website documentation for those
commands and options was not updated.

This commit adds some documentation for those options.
2022-11-17 09:29:55 -05:00
Lucas Bajolet
bb2384c56a command/validate: add option to eval datasources
When packer validate is invoked, it does not try to evaluate the
datasources before attempting to decide if the template is valid.

In many cases, this works, but sometimes it will fail as the value is
unknown by the validation code.

Since the validation code for all the elements of a Packer template is
left to be implemented by plugins, we cannot rely on checking for
unknown values everywhere, especially since the unknown references are
replaced automatically by a value of the right type for the
configuration expected.

So, in order for such configurations to be validable, we add an extra
option to packer validate, that will let users evaluate the datasources
from a template.
2022-11-17 09:29:55 -05: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
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
Johanan Liebermann
f8ea98d671
Add missing closing parenthesis (#11599)
* Add missing closing parenthesis

Signed-off-by: Johanan Liebermann <jliebermann@microsoft.com>
Co-authored-by: Adrien Delorme <azr@users.noreply.github.com>
2022-02-28 15:57:57 +01:00
Johanan Liebermann
a66a15bd35
Add missing closing parenthesis (#11593)
Signed-off-by: Johanan Liebermann <jliebermann@microsoft.com>
2022-02-25 11:09:56 -05:00
Adrien Delorme
9f4a1281dd
Add packer plugins command and subcommands to interact with plugins (#11553)
* add basic docs for plugins command

* refactor docs

Co-Authored-By: Wilken Rivera <1749304+nywilken@users.noreply.github.com>

* add plugins command

* add plugins subcommands

they do nothing for now

* add plugins installed command + tests

* add plugins install command

* add remove plugin command

* better docs for the plugins install command

* remove duplicate content

* better output for installed plugins

* add plugins required command

* Update plugins_install.go

* add newline after `Usage:`

* Update plugins_remove.go

* Update plugins_required.go

* Update plugins_remove.go

* Update plugins_installed.go

* Update plugins_install.go

* add docs

* Update plugins_install.go

* fix typos

* Update plugins_test.go

* fix typos

Co-Authored-By: Wilken Rivera <1749304+nywilken@users.noreply.github.com>

* Update core_wrapper.go

Co-Authored-By: Wilken Rivera <1749304+nywilken@users.noreply.github.com>

* Update website/content/docs/commands/plugins/remove.mdx

Co-authored-by: Wilken Rivera <wilken@hashicorp.com>

* Update website/content/docs/commands/plugins/required.mdx

Co-authored-by: Wilken Rivera <wilken@hashicorp.com>

* Update website/content/docs/commands/plugins/required.mdx

Co-authored-by: Wilken Rivera <wilken@hashicorp.com>

* Update plugins_required.go

* Update install.mdx

* Update required.mdx

* plugins requirement, warn when no plugin was found

* Update website/content/docs/commands/plugins/required.mdx

Co-authored-by: Wilken Rivera <wilken@hashicorp.com>

Co-authored-by: Wilken Rivera <1749304+nywilken@users.noreply.github.com>
Co-authored-by: Wilken Rivera <wilken@hashicorp.com>
2022-02-10 16:53:50 -05:00
Kerim Satirli
bc6f1e36e6
Fixes typos in docs (#11322)
* fixes typos in base docs

* fixes typos in example code

* fixes typos in website docs

* fixes link to Terraform provider

* fixes typo in function name
2021-10-11 10:19:49 +02:00
Megan Marsh
c56f34f9d3
add stdin to docs for fmt (#11132) 2021-07-07 10:11:02 -04:00
Megan Marsh
638be57e43
document gotcha around third party plugins (#11032)
* document gotcha around third party plugins
* Update website/content/docs/commands/hcl2_upgrade.mdx

Co-authored-by: Adrien Delorme <azr@users.noreply.github.com>
2021-05-25 13:55:25 +02:00
Kerim Satirli
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 <azr@users.noreply.github.com>

* fixes formatting

* improves example

* generate stuff

Co-authored-by: Adrien Delorme <azr@users.noreply.github.com>
2021-04-08 15:02:57 +02:00
Roshan Padaki
f65e1d5d55
Fix tiny typo in hcl2_upgrade.mdx (#10868) 2021-04-06 11:51:10 +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
0e3fcb589b
Implicit required_plugin blocks (#10732)
* used components that don't have a required_plugin block will make Packer 'implicitly' require those. These components are manually selected and commented for now.
* add tests
 * docs
2021-03-24 11:31:39 +01:00
Megan Marsh
751038cd6d
clarify onlyexcept docs further (#10679) 2021-03-01 11:45:58 +01:00
sylviamoss
a1a5cf0113 upgrade variables with other variables 2021-02-22 17:16:19 +01:00
sylviamoss
60017822e0 add docs 2021-02-22 16:19:55 +01:00
Megan Marsh
dd167925d7
add machine readable to the cli help func and docs (#10658) 2021-02-19 11:17:47 +01:00
Megan Marsh
1710590418
Merge pull request #10633 from hashicorp/azr_init_no_magic_host
Packer init: remove host and namespace guessing
2021-02-16 14:32:20 -08:00
sylviamoss
6e195f92e8 update components docs 2021-02-16 14:31:05 +01:00
Sylvia Moss
715fe51517
Update website/content/docs/commands/fix.mdx
Co-authored-by: Adrien Delorme <azr@users.noreply.github.com>
2021-02-16 14:09:32 +01:00
Sylvia Moss
1049db4f98
Update website/content/docs/commands/fix.mdx
Co-authored-by: Adrien Delorme <azr@users.noreply.github.com>
2021-02-16 12:48:33 +01:00
sylviamoss
1a20146993 update command section 2021-02-16 10:08:47 +01:00
Adrien Delorme
516e919c5e Update init.mdx 2021-02-15 15:15:00 +01:00
Adrien Delorme
72e4dc4cb5 update docs to remove 'magic' required_plugin block usages 2021-02-15 13:58:58 +01:00
Megan Marsh
bd7b31853e
Multi plugin naming (#10608) 2021-02-15 11:10:43 +01:00
sylviamoss
855ba9775a add docs 2021-02-12 15:31:13 +01: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
Wilken Rivera
4e2d2961b6 Update with suggestion from review 2021-02-10 10:37:24 -05:00
Wilken Rivera
9986834a62 website/commands/init: Add blurb on plugin selection
This change adds text around how plugin selection for plugins defined in
a require_plugins block work. It also adds a small call out to users
that third party plugins are not verified by HashiCorp.
2021-02-09 12:19:15 -05:00
Wilken Rivera
8c3b3ca00f
Update website/content/docs/commands/init.mdx 2021-02-08 13:34:14 -05:00
Adrien Delorme
a1b2e71005
Update website/content/docs/commands/init.mdx
Co-authored-by: Sylvia Moss <moss@hashicorp.com>
2021-02-08 13:53:29 +01:00
Adrien Delorme
4c02123142 init documentation: have less highlights and more text 2021-02-08 10:58:14 +01:00
Adrien Delorme
0f34592daa
packer init doc clarification (#10558)
* Packer has no state like Terraform has

* init command docs: tell where a plugin will be installed

* docs: add a note that packer init does not work with legacy JSON templates

* docs: add a not that packer init does not install single-plugin binaries

* the plugin getter => packer init

* Update init.mdx

* grammar

* link to how to install plugins manually

* Update website/content/docs/commands/init.mdx

Co-authored-by: Sylvia Moss <moss@hashicorp.com>

* Update website/content/docs/commands/init.mdx

Co-authored-by: Sylvia Moss <moss@hashicorp.com>

Co-authored-by: Sylvia Moss <moss@hashicorp.com>
2021-02-05 13:26:58 +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
Wilken Rivera
f36554fa0e
Update redirects and URLs to legacy JSON template docs (#10530) 2021-01-27 09:08:59 -05:00
Wilken Rivera
a91a8ec63b Ignore new links from markdown link checker because site isnt live
use relative pathing in links
fix vagrant docs link
2021-01-15 13:42:10 -08:00
Megan Marsh
927b539ee1 fix redirects according to Moss's suggestion, and fix double-slash docs prepending 2021-01-15 11:59:36 -08:00
Megan Marsh
54a75421ea regenerate 2021-01-15 11:59:36 -08:00
Megan Marsh
1cb9aea752 change markdown references to new pathing 2021-01-15 11:59:36 -08:00
Jeff Escalante
25380116f2
remove layout frontmatter prop 2020-12-14 18:20:03 -05:00
Jeff Escalante
2de270341c
refactor to mdx remote 2020-12-14 18:20:01 -05:00