Hcl beta tag (#10493)

* change beta tag

* remove beta tag from hcl2_upgrade comment

* add a partial to describe the legacy json limitations

* exclude legacy category from templates until it is deployed to the website
This commit is contained in:
Megan Marsh 2021-01-18 06:08:04 -08:00 committed by GitHub
parent 94e22e6664
commit 4cb6e07900
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 35 additions and 8 deletions

View File

@ -55,7 +55,7 @@ func (c *HCL2UpgradeCommand) ParseArgs(args []string) (*HCL2UpgradeArgs, int) {
}
const (
hcl2UpgradeFileHeader = `# This file was autogenerated by the BETA 'packer hcl2_upgrade' command. We
hcl2UpgradeFileHeader = `# This file was autogenerated by the 'packer hcl2_upgrade' command. We
# recommend double checking that everything is correct before going forward. We
# also recommend treating this file as disposable. The HCL2 blocks in this
# file can be moved to other files. For example, the variable blocks could be

View File

@ -1,4 +1,4 @@
# This file was autogenerated by the BETA 'packer hcl2_upgrade' command. We
# This file was autogenerated by the 'packer hcl2_upgrade' command. We
# recommend double checking that everything is correct before going forward. We
# also recommend treating this file as disposable. The HCL2 blocks in this
# file can be moved to other files. For example, the variable blocks could be

View File

@ -20,6 +20,12 @@
},
{
"pattern": "^/docs/templates/hcl_templates/"
},
{
"pattern": "^/docs/templates/legacy_json_templates"
},
{
"pattern": "^https://packer.io/docs/templates/legacy_json_templates"
}
],
"replacementPatterns": [

View File

@ -8,6 +8,8 @@ page_title: Builders - Templates
sidebar_title: Builders
---
`@include 'from-1.5/legacy-json-warning.mdx'`
# Template Builders
Within the template, the builders section contains an array of all the builders

View File

@ -6,6 +6,8 @@ page_title: Communicators - Templates
sidebar_title: Communicators
---
`@include 'from-1.5/legacy-json-warning.mdx'`
# Template Communicators
Communicators are the mechanism Packer uses to upload files, execute scripts,

View File

@ -7,6 +7,8 @@ page_title: Template Engine - Templates
sidebar_title: Engine
---
`@include 'from-1.5/legacy-json-warning.mdx'`
# Template Engine
All strings within templates are processed by a common Packer templating

View File

@ -10,6 +10,8 @@ page_title: JSON Templates
sidebar_title: JSON Templates
---
`@include 'from-1.5/legacy-json-warning.mdx'`
# JSON Templates
These Packer templates are JSON files that configure the various components

View File

@ -7,6 +7,8 @@ page_title: Post-Processors - Templates
sidebar_title: Post-Processors
---
`@include 'from-1.5/legacy-json-warning.mdx'`
# Template Post-Processors
The post-processor section within a template configures any post-processing

View File

@ -7,6 +7,8 @@ page_title: Provisioners - Templates
sidebar_title: Provisioners
---
`@include 'from-1.5/legacy-json-warning.mdx'`
# Template Provisioners
Within the template, the provisioners section contains an array of all the

View File

@ -9,6 +9,8 @@ page_title: User Variables - Templates
sidebar_title: User Variables
---
`@include 'from-1.5/legacy-json-warning.mdx'`
# Template User Variables
User variables allow your templates to be further configured with variables

View File

@ -1,6 +1,7 @@
-> **Note:** This page is about HCL2 in Packer 1.5 and later. HCL2 support for
Packer is still in Beta. Please see the [Packer Issue
Tracker](https://github.com/hashicorp/packer/issues/9176) for a list of
supported features. For the old-style stable configuration language see
[template docs](/docs/templates). You can now transform your JSON file into an
HCL2 config file using the [hcl2_upgrade command](/docs/commands/hcl2_upgrade).
-> **Note:** This page is about HCL2 Packer templates. HCL2 templates
were first introduced as a beta feature into Packer version 1.5. As of v1.7,
HCL2 support is no longer in beta, and is the preferred way to write Packer
configuration. For the old-style stable configuration language see
[template docs](/docs/templates/legacy_json_templates). As of v1.6.2, you can
convert your legacy JSON template into an HCL2 config file using the
[hcl2_upgrade command](/docs/commands/hcl2_upgrade).

View File

@ -0,0 +1,6 @@
-> **Note:** This page is about older-style JSON Packer templates. JSON
templates are still supported by the Packer core, but new features added to the
Packer core may not be implemented for JSON templates. We recommend you
transition to HCL templates as soon as is convenient for you, in order to have
the best possible experience with Packer. To help you upgrade your templates,
we have written an [hcl2_upgrade command](/docs/commands/hcl2_upgrade) command.