Skip to content

Commit ecb1dc1

Browse files
authored
[Add][Doc] Packer init hcl file suffix requirement
Closes issue #1
1 parent 4e4830e commit ecb1dc1

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@ This is a builder plugin for Packer which can be used to generate storage templa
99

1010
### Installing using Packer Packet Manager
1111

12-
In order to use `packer init` you need to have Packer version ">=1.7.0" installed. Config template should be in `hcl` format and contains `required_plugins` block. For example:
12+
In order to use `packer init`:
13+
14+
1. You need to have Packer version ">=1.7.0" installed.
15+
2. The config template should be in `hcl` format.
16+
3. The config template file, when in `hcl` format, must have the extension `.pkr.hcl`.
17+
4. The config template must contain `required_plugins` block. For example:
1318

1419
```hcl
1520
...
@@ -24,7 +29,7 @@ packer {
2429
...
2530
```
2631

27-
Runn following command and check the output:
32+
Run following command and check the output (NOTE: The file extension must be `*.pkr.hcl`):
2833
```sh
2934
$ packer init examples/basic_example.pkr.hcl
3035

0 commit comments

Comments
 (0)