update checksum post-processor docs
This commit is contained in:
parent
dcacf7ad4c
commit
fd683daa22
|
@ -24,7 +24,6 @@ import (
|
||||||
type Config struct {
|
type Config struct {
|
||||||
common.PackerConfig `mapstructure:",squash"`
|
common.PackerConfig `mapstructure:",squash"`
|
||||||
|
|
||||||
Keep bool `mapstructure:"keep_input_artifact"`
|
|
||||||
ChecksumTypes []string `mapstructure:"checksum_types"`
|
ChecksumTypes []string `mapstructure:"checksum_types"`
|
||||||
OutputPath string `mapstructure:"output"`
|
OutputPath string `mapstructure:"output"`
|
||||||
ctx interpolate.Context
|
ctx interpolate.Context
|
||||||
|
|
|
@ -16,7 +16,6 @@ type FlatConfig struct {
|
||||||
PackerOnError *string `mapstructure:"packer_on_error" cty:"packer_on_error" hcl:"packer_on_error"`
|
PackerOnError *string `mapstructure:"packer_on_error" cty:"packer_on_error" hcl:"packer_on_error"`
|
||||||
PackerUserVars map[string]string `mapstructure:"packer_user_variables" cty:"packer_user_variables" hcl:"packer_user_variables"`
|
PackerUserVars map[string]string `mapstructure:"packer_user_variables" cty:"packer_user_variables" hcl:"packer_user_variables"`
|
||||||
PackerSensitiveVars []string `mapstructure:"packer_sensitive_variables" cty:"packer_sensitive_variables" hcl:"packer_sensitive_variables"`
|
PackerSensitiveVars []string `mapstructure:"packer_sensitive_variables" cty:"packer_sensitive_variables" hcl:"packer_sensitive_variables"`
|
||||||
Keep *bool `mapstructure:"keep_input_artifact" cty:"keep_input_artifact" hcl:"keep_input_artifact"`
|
|
||||||
ChecksumTypes []string `mapstructure:"checksum_types" cty:"checksum_types" hcl:"checksum_types"`
|
ChecksumTypes []string `mapstructure:"checksum_types" cty:"checksum_types" hcl:"checksum_types"`
|
||||||
OutputPath *string `mapstructure:"output" cty:"output" hcl:"output"`
|
OutputPath *string `mapstructure:"output" cty:"output" hcl:"output"`
|
||||||
}
|
}
|
||||||
|
@ -40,7 +39,6 @@ func (*FlatConfig) HCL2Spec() map[string]hcldec.Spec {
|
||||||
"packer_on_error": &hcldec.AttrSpec{Name: "packer_on_error", Type: cty.String, Required: false},
|
"packer_on_error": &hcldec.AttrSpec{Name: "packer_on_error", Type: cty.String, Required: false},
|
||||||
"packer_user_variables": &hcldec.AttrSpec{Name: "packer_user_variables", Type: cty.Map(cty.String), Required: false},
|
"packer_user_variables": &hcldec.AttrSpec{Name: "packer_user_variables", Type: cty.Map(cty.String), Required: false},
|
||||||
"packer_sensitive_variables": &hcldec.AttrSpec{Name: "packer_sensitive_variables", Type: cty.List(cty.String), Required: false},
|
"packer_sensitive_variables": &hcldec.AttrSpec{Name: "packer_sensitive_variables", Type: cty.List(cty.String), Required: false},
|
||||||
"keep_input_artifact": &hcldec.AttrSpec{Name: "keep_input_artifact", Type: cty.Bool, Required: false},
|
|
||||||
"checksum_types": &hcldec.AttrSpec{Name: "checksum_types", Type: cty.List(cty.String), Required: false},
|
"checksum_types": &hcldec.AttrSpec{Name: "checksum_types", Type: cty.List(cty.String), Required: false},
|
||||||
"output": &hcldec.AttrSpec{Name: "output", Type: cty.String, Required: false},
|
"output": &hcldec.AttrSpec{Name: "output", Type: cty.String, Required: false},
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,18 +1,10 @@
|
||||||
---
|
---
|
||||||
description: >
|
description: >
|
||||||
The checksum post-processor computes specified checksum for the artifact list
|
The checksum post-processor computes specified checksum for the artifact list
|
||||||
|
from an upstream builder or post-processor. All downstream post-processors will
|
||||||
from an upstream builder or post-processor. All downstream post-processors
|
|
||||||
will
|
|
||||||
|
|
||||||
see the new artifacts. The primary use-case is compute checksum for artifacts
|
see the new artifacts. The primary use-case is compute checksum for artifacts
|
||||||
|
allows to verify it later. So firstly this post-processor get artifact, compute
|
||||||
allows to verify it later. So firstly this post-processor get artifact,
|
it checksum and pass to next post-processor original artifacts and checksum files.
|
||||||
compute
|
|
||||||
|
|
||||||
it checksum and pass to next post-processor original artifacts and checksum
|
|
||||||
|
|
||||||
files.
|
|
||||||
layout: docs
|
layout: docs
|
||||||
page_title: Checksum - Post-Processors
|
page_title: Checksum - Post-Processors
|
||||||
sidebar_title: Checksum
|
sidebar_title: Checksum
|
||||||
|
@ -36,24 +28,42 @@ a third-party post-processor.
|
||||||
|
|
||||||
## Basic example
|
## Basic example
|
||||||
|
|
||||||
The example below is fully functional.
|
<Tabs>
|
||||||
|
<Tab heading="JSON">
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"type": "checksum"
|
"type": "checksum",
|
||||||
|
"checksum_types": ["sha1", "sha256"],
|
||||||
|
"output": "packer_{{.BuildName}}_{{.ChecksumType}}.checksum"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
</Tab>
|
||||||
|
<Tab heading="HCL2">
|
||||||
|
|
||||||
|
```hcl
|
||||||
|
post-processor "checksum" {
|
||||||
|
checksum_types = ["sha1", "sha256"]
|
||||||
|
output = "packer_{{.BuildName}}_{{.ChecksumType}}.checksum"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</Tab>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
## Configuration Reference
|
## Configuration Reference
|
||||||
|
|
||||||
Optional parameters:
|
Optional parameters:
|
||||||
|
|
||||||
- `checksum_types` (array of strings) - An array of strings of checksum types
|
- `checksum_types` (array of strings) - An array of strings of checksum types
|
||||||
to compute. Allowed values are md5, sha1, sha224, sha256, sha384, sha512.
|
to compute. If empty, Defaults to md5. Allowed values are:
|
||||||
|
* md5
|
||||||
- `keep_input_artifact` (boolean) - Unlike most post-processors, setting
|
* sha1
|
||||||
`keep_input_artifact` will have no effect; the checksum post-processor
|
* sha224
|
||||||
always saves the artifact that it is calculating the checksum for.
|
* sha256
|
||||||
|
* sha384
|
||||||
|
* sha512
|
||||||
|
|
||||||
- `output` (string) - Specify filename to store checksums. This defaults to
|
- `output` (string) - Specify filename to store checksums. This defaults to
|
||||||
`packer_{{.BuildName}}_{{.BuilderType}}_{{.ChecksumType}}.checksum`. For
|
`packer_{{.BuildName}}_{{.BuilderType}}_{{.ChecksumType}}.checksum`. For
|
||||||
|
|
Loading…
Reference in New Issue