[ { "title": "What is Packer?", "routes": [ { "title": "Overview", "path": "intro" }, { "title": "Why Use Packer?", "path": "intro/why" }, { "title": "Use Cases", "path": "intro/use-cases" } ] }, { "title": "HCP Packer", "path": "hcp" }, { "divider": true }, { "title": "Terminology", "path": "terminology" }, { "title": "Commands (CLI)", "routes": [ { "title": "Overview", "path": "commands" }, { "title": "init", "path": "commands/init" }, { "title": "plugins", "routes": [ { "title": "Overview", "path": "commands/plugins" }, { "title": "install", "path": "commands/plugins/install" }, { "title": "installed", "path": "commands/plugins/installed" }, { "title": "remove", "path": "commands/plugins/remove" }, { "title": "required", "path": "commands/plugins/required" } ] }, { "title": "build", "path": "commands/build" }, { "title": "console", "path": "commands/console" }, { "title": "fix", "path": "commands/fix" }, { "title": "fmt", "path": "commands/fmt" }, { "title": "inspect", "path": "commands/inspect" }, { "title": "validate", "path": "commands/validate" }, { "title": "hcl2_upgrade", "path": "commands/hcl2_upgrade" } ] }, { "title": "Templates", "routes": [ { "title": "Overview", "path": "templates" }, { "title": "JSON to HCL2", "path": "templates/json_to_hcl" }, { "title": "HCL Templates", "routes": [ { "title": "Overview", "path": "templates/hcl_templates" }, { "title": "Blocks", "routes": [ { "title": "Overview", "path": "templates/hcl_templates/blocks" }, { "title": "build", "routes": [ { "title": "Overview", "path": "templates/hcl_templates/blocks/build" }, { "title": "hcp_packer_registry", "path": "templates/hcl_templates/blocks/build/hcp_packer_registry" }, { "title": "source", "path": "templates/hcl_templates/blocks/build/source" }, { "title": "provisioner", "path": "templates/hcl_templates/blocks/build/provisioner" }, { "title": "post-processor", "path": "templates/hcl_templates/blocks/build/post-processor" }, { "title": "post-processors", "path": "templates/hcl_templates/blocks/build/post-processors" } ] }, { "title": "locals", "path": "templates/hcl_templates/blocks/locals" }, { "title": "source", "path": "templates/hcl_templates/blocks/source" }, { "title": "variable", "path": "templates/hcl_templates/blocks/variable" }, { "title": "packer", "path": "templates/hcl_templates/blocks/packer" }, { "title": "data", "path": "templates/hcl_templates/blocks/data" } ] }, { "title": "Functions", "routes": [ { "title": "Overview", "path": "templates/hcl_templates/functions" }, { "title": "Contextual Functions", "routes": [ { "title": "aws_secretsmanager", "path": "templates/hcl_templates/functions/contextual/aws_secretsmanager" }, { "title": "consul", "path": "templates/hcl_templates/functions/contextual/consul" }, { "title": "env", "path": "templates/hcl_templates/functions/contextual/env" }, { "title": "vault", "path": "templates/hcl_templates/functions/contextual/vault" } ] }, { "title": "Numeric Functions", "routes": [ { "title": "abs", "path": "templates/hcl_templates/functions/numeric/abs" }, { "title": "ceil", "path": "templates/hcl_templates/functions/numeric/ceil" }, { "title": "floor", "path": "templates/hcl_templates/functions/numeric/floor" }, { "title": "log", "path": "templates/hcl_templates/functions/numeric/log" }, { "title": "max", "path": "templates/hcl_templates/functions/numeric/max" }, { "title": "min", "path": "templates/hcl_templates/functions/numeric/min" }, { "title": "parseint", "path": "templates/hcl_templates/functions/numeric/parseint" }, { "title": "pow", "path": "templates/hcl_templates/functions/numeric/pow" }, { "title": "signum", "path": "templates/hcl_templates/functions/numeric/signum" }, { "title": "sum", "path": "templates/hcl_templates/functions/numeric/sum" } ] }, { "title": "String Functions", "routes": [ { "title": "chomp", "path": "templates/hcl_templates/functions/string/chomp" }, { "title": "endswith", "path": "templates/hcl_templates/functions/string/endswith" }, { "title": "format", "path": "templates/hcl_templates/functions/string/format" }, { "title": "formatlist", "path": "templates/hcl_templates/functions/string/formatlist" }, { "title": "indent", "path": "templates/hcl_templates/functions/string/indent" }, { "title": "join", "path": "templates/hcl_templates/functions/string/join" }, { "title": "lower", "path": "templates/hcl_templates/functions/string/lower" }, { "title": "replace", "path": "templates/hcl_templates/functions/string/replace" }, { "title": "regex_replace", "path": "templates/hcl_templates/functions/string/regex_replace" }, { "title": "regex", "path": "templates/hcl_templates/functions/string/regex" }, { "title": "regexall", "path": "templates/hcl_templates/functions/string/regexall" }, { "title": "split", "path": "templates/hcl_templates/functions/string/split" }, { "title": "startswith", "path": "templates/hcl_templates/functions/string/startswith" }, { "title": "strcontains", "path": "templates/hcl_templates/functions/string/strcontains" }, { "title": "strrev", "path": "templates/hcl_templates/functions/string/strrev" }, { "title": "substr", "path": "templates/hcl_templates/functions/string/substr" }, { "title": "title", "path": "templates/hcl_templates/functions/string/title" }, { "title": "trim", "path": "templates/hcl_templates/functions/string/trim" }, { "title": "trimprefix", "path": "templates/hcl_templates/functions/string/trimprefix" }, { "title": "trimsuffix", "path": "templates/hcl_templates/functions/string/trimsuffix" }, { "title": "trimspace", "path": "templates/hcl_templates/functions/string/trimspace" }, { "title": "upper", "path": "templates/hcl_templates/functions/string/upper" } ] }, { "title": "Collection Functions", "routes": [ { "title": "alltrue", "path": "templates/hcl_templates/functions/collection/alltrue" }, { "title": "anytrue", "path": "templates/hcl_templates/functions/collection/anytrue" }, { "title": "chunklist", "path": "templates/hcl_templates/functions/collection/chunklist" }, { "title": "coalesce", "path": "templates/hcl_templates/functions/collection/coalesce" }, { "title": "coalescelist", "path": "templates/hcl_templates/functions/collection/coalescelist" }, { "title": "compact", "path": "templates/hcl_templates/functions/collection/compact" }, { "title": "concat", "path": "templates/hcl_templates/functions/collection/concat" }, { "title": "contains", "path": "templates/hcl_templates/functions/collection/contains" }, { "title": "distinct", "path": "templates/hcl_templates/functions/collection/distinct" }, { "title": "element", "path": "templates/hcl_templates/functions/collection/element" }, { "title": "flatten", "path": "templates/hcl_templates/functions/collection/flatten" }, { "title": "index", "path": "templates/hcl_templates/functions/collection/index-fn" }, { "title": "keys", "path": "templates/hcl_templates/functions/collection/keys" }, { "title": "length", "path": "templates/hcl_templates/functions/collection/length" }, { "title": "lookup", "path": "templates/hcl_templates/functions/collection/lookup" }, { "title": "merge", "path": "templates/hcl_templates/functions/collection/merge" }, { "title": "range", "path": "templates/hcl_templates/functions/collection/range" }, { "title": "reverse", "path": "templates/hcl_templates/functions/collection/reverse" }, { "title": "setintersection", "path": "templates/hcl_templates/functions/collection/setintersection" }, { "title": "setproduct", "path": "templates/hcl_templates/functions/collection/setproduct" }, { "title": "setunion", "path": "templates/hcl_templates/functions/collection/setunion" }, { "title": "slice", "path": "templates/hcl_templates/functions/collection/slice" }, { "title": "sort", "path": "templates/hcl_templates/functions/collection/sort" }, { "title": "values", "path": "templates/hcl_templates/functions/collection/values" }, { "title": "zipmap", "path": "templates/hcl_templates/functions/collection/zipmap" } ] }, { "title": "Encoding Functions", "routes": [ { "title": "base64decode", "path": "templates/hcl_templates/functions/encoding/base64decode" }, { "title": "base64encode", "path": "templates/hcl_templates/functions/encoding/base64encode" }, { "title": "base64gzip", "path": "templates/hcl_templates/functions/encoding/base64gzip" }, { "title": "csvdecode", "path": "templates/hcl_templates/functions/encoding/csvdecode" }, { "title": "jsondecode", "path": "templates/hcl_templates/functions/encoding/jsondecode" }, { "title": "jsonencode", "path": "templates/hcl_templates/functions/encoding/jsonencode" }, { "title": "urlencode", "path": "templates/hcl_templates/functions/encoding/urlencode" }, { "title": "textencodebase64", "path": "templates/hcl_templates/functions/encoding/textencodebase64" }, { "title": "textdecodebase64", "path": "templates/hcl_templates/functions/encoding/textdecodebase64" }, { "title": "yamldecode", "path": "templates/hcl_templates/functions/encoding/yamldecode" }, { "title": "yamlencode", "path": "templates/hcl_templates/functions/encoding/yamlencode" } ] }, { "title": "Filesystem Functions", "routes": [ { "title": "abspath", "path": "templates/hcl_templates/functions/file/abspath" }, { "title": "basename", "path": "templates/hcl_templates/functions/file/basename" }, { "title": "dirname", "path": "templates/hcl_templates/functions/file/dirname" }, { "title": "file", "path": "templates/hcl_templates/functions/file/file" }, { "title": "filebase64", "path": "templates/hcl_templates/functions/file/filebase64" }, { "title": "fileexists", "path": "templates/hcl_templates/functions/file/fileexists" }, { "title": "fileset", "path": "templates/hcl_templates/functions/file/fileset" }, { "title": "pathexpand", "path": "templates/hcl_templates/functions/file/pathexpand" }, { "title": "templatefile", "path": "templates/hcl_templates/functions/file/templatefile" } ] }, { "title": "Date and Time Functions", "routes": [ { "title": "formatdate", "path": "templates/hcl_templates/functions/datetime/formatdate" }, { "title": "timeadd", "path": "templates/hcl_templates/functions/datetime/timeadd" }, { "title": "timestamp", "path": "templates/hcl_templates/functions/datetime/timestamp" }, { "title": "legacy_isotime", "path": "templates/hcl_templates/functions/datetime/legacy_isotime" }, { "title": "legacy_strftime", "path": "templates/hcl_templates/functions/datetime/legacy_strftime" } ] }, { "title": "Hash and Crypto Functions", "routes": [ { "title": "bcrypt", "path": "templates/hcl_templates/functions/crypto/bcrypt" }, { "title": "md5", "path": "templates/hcl_templates/functions/crypto/md5" }, { "title": "rsadecrypt", "path": "templates/hcl_templates/functions/crypto/rsadecrypt" }, { "title": "sha1", "path": "templates/hcl_templates/functions/crypto/sha1" }, { "title": "sha256", "path": "templates/hcl_templates/functions/crypto/sha256" }, { "title": "sha512", "path": "templates/hcl_templates/functions/crypto/sha512" } ] }, { "title": "UUID Functions", "routes": [ { "title": "uuidv4", "path": "templates/hcl_templates/functions/uuid/uuidv4" }, { "title": "uuidv5", "path": "templates/hcl_templates/functions/uuid/uuidv5" } ] }, { "title": "IP Network Functions", "routes": [ { "title": "cidrhost", "path": "templates/hcl_templates/functions/ipnet/cidrhost" }, { "title": "cidrnetmask", "path": "templates/hcl_templates/functions/ipnet/cidrnetmask" }, { "title": "cidrsubnet", "path": "templates/hcl_templates/functions/ipnet/cidrsubnet" }, { "title": "cidrsubnets", "path": "templates/hcl_templates/functions/ipnet/cidrsubnets" } ] }, { "title": "Type Conversion Functions", "routes": [ { "title": "can", "path": "templates/hcl_templates/functions/conversion/can" }, { "title": "convert", "path": "templates/hcl_templates/functions/conversion/convert" }, { "title": "try", "path": "templates/hcl_templates/functions/conversion/try" } ] } ] }, { "title": "Variables", "path": "templates/hcl_templates/variables" }, { "title": "Locals", "path": "templates/hcl_templates/locals" }, { "title": "Contextual Variables", "path": "templates/hcl_templates/contextual-variables" }, { "title": "Data Sources", "path": "templates/hcl_templates/datasources" }, { "title": "Path Variables", "path": "templates/hcl_templates/path-variables" }, { "title": "Syntax", "path": "templates/hcl_templates/syntax" }, { "title": "Only Except", "path": "templates/hcl_templates/onlyexcept" }, { "title": "Expressions", "path": "templates/hcl_templates/expressions" }, { "title": "JSON Syntax", "path": "templates/hcl_templates/syntax-json" } ] }, { "title": "JSON Templates", "routes": [ { "title": "Overview", "path": "templates/legacy_json_templates" }, { "title": "builders", "path": "templates/legacy_json_templates/builders" }, { "title": "Communicators", "path": "templates/legacy_json_templates/communicator" }, { "title": "Engine", "path": "templates/legacy_json_templates/engine" }, { "title": "post-processors", "path": "templates/legacy_json_templates/post-processors" }, { "title": "provisioners", "path": "templates/legacy_json_templates/provisioners" }, { "title": "variables", "path": "templates/legacy_json_templates/user-variables" } ] } ] }, { "divider": true }, { "title": "Communicators", "routes": [ { "title": "Overview", "path": "communicators" }, { "title": "SSH", "path": "communicators/ssh" }, { "title": "WINRM", "path": "communicators/winrm" } ] }, { "title": "Builders", "routes": [ { "title": "Overview", "path": "builders" }, { "title": "file", "path": "builders/file" }, { "title": "null", "path": "builders/null" }, { "title": "Custom builders", "href": "/packer/docs/plugins/creation/custom-builders" }, { "title": "Community builders", "path": "builders/community-supported" } ] }, { "title": "Data sources reference", "routes": [ { "title": "Overview", "path": "datasources" }, { "title": "HCP Packer", "routes": [ { "title": "Overview", "path": "datasources/hcp" }, { "title": "hcp-packer-version", "path": "datasources/hcp/hcp-packer-version" }, { "title": "hcp-packer-artifact", "path": "datasources/hcp/hcp-packer-artifact" }, { "title": "hcp-packer-iteration", "path": "datasources/hcp/hcp-packer-iteration", "badge" : { "text": "DEPRECATED", "type": "outlined", "color": "neutral" } }, { "title": "hcp-packer-image", "path": "datasources/hcp/hcp-packer-image", "badge" : { "text": "DEPRECATED", "type": "outlined", "color": "neutral" } } ] }, { "title": "http", "path": "datasources/http" } ] }, { "title": "Provisioners", "routes": [ { "title": "Overview", "path": "provisioners" }, { "title": "breakpoint", "path": "provisioners/breakpoint" }, { "title": "file", "path": "provisioners/file" }, { "title": "hcp-sbom", "path": "provisioners/hcp-sbom" }, { "title": "powershell", "path": "provisioners/powershell" }, { "title": "shell", "path": "provisioners/shell" }, { "title": "shell-Local", "path": "provisioners/shell-local" }, { "title": "windows-shell", "path": "provisioners/windows-shell" }, { "title": "windows-restart", "path": "provisioners/windows-restart" }, { "title": "Custom", "href": "/packer/docs/plugins/creation/custom-provisioners" }, { "title": "Community-Supported", "path": "provisioners/community-supported" } ] }, { "title": "Post-Processors", "routes": [ { "title": "Overview", "path": "post-processors" }, { "title": "Artifice", "path": "post-processors/artifice" }, { "title": "Compress", "path": "post-processors/compress" }, { "title": "Checksum", "path": "post-processors/checksum" }, { "title": "Manifest", "path": "post-processors/manifest" }, { "title": "Shell (Local)", "path": "post-processors/shell-local" }, { "title": "Community-Supported", "path": "post-processors/community-supported" } ] }, { "divider": true }, { "title": "Installing Packer", "href": "/packer/install" }, { "title": "Configuring Packer", "path": "configure" }, { "title": "Release notes", "routes": [ { "title": "v1.11", "path": "release-notes/v1_11" }, { "title": "v1.12", "path": "release-notes/v1_12" }, { "title": "v1.13", "path": "release-notes/v1_13" } ] }, { "title": "Upgrades", "routes": [ { "title": "Upgrade to v1.11", "path": "upgrade/v1_11" }, { "title": "Upgrade to v1.12", "path": "upgrade/v1_12" }, { "title": "Upgrade to v1.13", "path": "upgrade/v1_13" } ] }, { "divider": true }, { "title": "Plugins", "routes": [ { "title": "Overview", "path": "plugins" }, { "title": "Installing Plugins", "path": "plugins/install" }, { "title": "Developing Plugins", "routes": [ { "title": "Overview", "path": "plugins/creation" }, { "title": "Custom Builders", "path": "plugins/creation/custom-builders" }, { "title": "Custom Post-Processors", "path": "plugins/creation/custom-post-processors" }, { "title": "Custom Provisioners", "path": "plugins/creation/custom-provisioners" }, { "title": "Custom Data Sources", "path": "plugins/creation/custom-datasources" }, { "title": "HCP Packer Support", "path": "plugins/creation/hcp-support" }, { "title": "Plugin Loading Specification", "path": "plugins/creation/plugin-load-spec" } ] } ] }, { "title": "Integration Program", "path": "partnerships" }, { "title": "Community Tools", "path": "community-tools" }, { "divider": true }, { "title": "Debugging", "path": "debugging" } ]