Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/packer seo fy2025q4 #13286

Open
wants to merge 37 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 33 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
8eb277b
seo improvements data sources references
trujillo-adam Jan 22, 2025
711a38b
intro articles
trujillo-adam Jan 23, 2025
da35666
buiders, plugins, and some top-level pages
trujillo-adam Jan 24, 2025
7645ee0
updated provisioners reference topics
trujillo-adam Jan 24, 2025
ba3c07b
legacy json template ref
trujillo-adam Jan 24, 2025
9cf014f
Apply suggestions from code review
trujillo-adam Jan 24, 2025
85ff38f
Merge pull request #13267 from hashicorp/docs/packer-seo-ds-ref
trujillo-adam Jan 24, 2025
9fd83c1
Apply suggestions from code review
trujillo-adam Jan 24, 2025
b42e78a
Merge pull request #13272 from hashicorp/docs/packer-seo-builders-plu…
trujillo-adam Jan 24, 2025
f62463e
Apply suggestions from code review
trujillo-adam Jan 24, 2025
c5036e2
Merge pull request #13273 from hashicorp/docs/packer-seo-provs
trujillo-adam Jan 24, 2025
a9ada1d
hcl template blocks
trujillo-adam Jan 27, 2025
54da4b0
hcl templates content except functions
trujillo-adam Jan 28, 2025
953c814
crypto and collection functions references
trujillo-adam Jan 28, 2025
75678c5
file functions references
trujillo-adam Jan 28, 2025
2929047
contextual and datatime functions
trujillo-adam Jan 28, 2025
8ad24fd
encoding functions
trujillo-adam Jan 28, 2025
8b84cce
numeric and conversion functions
trujillo-adam Jan 29, 2025
ad18e70
Apply suggestions from code review
trujillo-adam Jan 29, 2025
8847805
Merge pull request #13283 from hashicorp/docs/packer-seo-templates-ba…
trujillo-adam Jan 29, 2025
f86801a
Apply suggestions from code review
trujillo-adam Jan 29, 2025
d8fa10e
string functions
trujillo-adam Jan 29, 2025
b417aba
ipnet and uuid funcs
trujillo-adam Jan 29, 2025
f46a435
Apply suggestions from code review
trujillo-adam Jan 29, 2025
0c0f7a6
Merge pull request #13282 from hashicorp/docs/packer-seo-templates-ba…
trujillo-adam Jan 29, 2025
8e6c32c
fix typo
trujillo-adam Jan 29, 2025
cf46ce6
remaining packer content
trujillo-adam Jan 30, 2025
06af5e6
Apply suggestions from code review
trujillo-adam Jan 30, 2025
3e3459b
Update website/content/docs/templates/hcl_templates/functions/encodin…
trujillo-adam Jan 30, 2025
c3df63a
removed 'learn to' keyword phrases
trujillo-adam Jan 30, 2025
4b45e15
fixed typo in redirects
trujillo-adam Jan 30, 2025
0f30246
formatting error in page desc
trujillo-adam Jan 30, 2025
090b30e
fix missing partials
trujillo-adam Jan 30, 2025
c310eac
Merge pull request #13284 from hashicorp/docs/packer-seo-functions-ba…
trujillo-adam Jan 30, 2025
3ddaae6
Apply suggestions from code review
trujillo-adam Jan 31, 2025
cf716c7
Merge pull request #13285 from hashicorp/docs/packer-seo-final-batch
trujillo-adam Jan 31, 2025
f46d0f6
Update website/content/docs/templates/legacy_json_templates/user-vari…
trujillo-adam Jan 31, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions website/content/docs/builders/community-supported.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
---
description: |
Community-maintained builders are not part of the core Packer binary, but
can run alongside Packer with minimal extra effort.
page_title: Community - Builders
Community-supported builders are developed and maintained by third-parties and not HashiCorp. Use them with Packer to extend Packer functionality.
page_title: Community-supported builders
---

# Community Builders
# Community-supported builders

The following builders are developed and maintained by various members of the
Packer community, not by HashiCorp. For more information on how to use community
builders, see our docs on [extending Packer](/packer/docs/plugins/creation).
builders, refer to our docs on [extending Packer](/packer/docs/plugins/creation).

@include 'builders/community_builders.mdx'
- ARM builders

- [packer-plugin-arm-image](https://github.com/solo-io/packer-plugin-arm-image): Lets you extend onto existing system images.
- [packer-builder-arm](https://github.com/mkaczanowski/packer-builder-arm): Lets you extend or build new images with a variety of options, such as custom partition tables.

- [Exoscale builder](https://github.com/exoscale/packer-plugin-exoscale) - Creates Exoscale custom templates based on a compute instance snapshot.

- [Citrix XenServer/Citrix Hypervisor](https://github.com/xenserver/packer-builder-xenserver) - Plugin for creating [Citrix XenServer/Citrix Hypervisor](https://xenserver.org/) images from an ISO image or from an existing template.

- [XCP-NG/Citrix XenServer/Citrix Hypervisor/Updated Fork](https://github.com/ddelnano/packer-plugin-xenserver) - Plugin for creating [XCP-NG/Citrix XenServer/Citrix Hypervisor](https://xcp-ng.org/) images from an ISO image or from an existing template. This is a fork of the orginal and reccomended by the developers of XCP-NG.
15 changes: 0 additions & 15 deletions website/content/docs/builders/custom.mdx

This file was deleted.

19 changes: 7 additions & 12 deletions website/content/docs/builders/file.mdx
Original file line number Diff line number Diff line change
@@ -1,23 +1,18 @@
---
description: |
The file Packer builder is not really a builder, it just creates an artifact
from a file. It can be used to debug post-processors without incurring high
wait times.
page_title: File - Builders
The `file` builder creates an artifact from a file. Use the `file` builder to debug post-processors without incurring long wait times.
page_title: file builder reference
---

<BadgesHeader>
<PluginBadge type="official" />
</BadgesHeader>

# File Builder
# `file` builder

Type: `file`
Artifact BuilderId: `packer.file`
The `file` builder creates an artifact from a file. You can use it to debug post-processors without incurring long wait times.

The `file` Packer builder is not really a builder, it just creates an artifact
from a file. It can be used to debug post-processors without incurring high
wait times.
Artifact `BuilderId`: `packer.file`

## Basic Example

Expand Down Expand Up @@ -60,12 +55,12 @@ described.

Any [communicator](/packer/docs/templates/legacy_json_templates/communicator) defined is ignored.

### Required:
### Required

- `target` (string) - The path for the artifact file that will be created. If
the path contains directories that don't exist, Packer will create them, too.

### Optional:
### Optional

You can only define one of `source` or `content`. If none of them is defined
the artifact will be empty.
Expand Down
17 changes: 8 additions & 9 deletions website/content/docs/builders/index.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
---
description: |
Builders are responsible for creating machines and generating images from them
for various platforms.
page_title: Builders
Builders create machines and generate images from them for various platforms. Learn about the types of builders you can use in your Packer templates.
page_title: Builders overview
---

# Builders
# Builders overview

Builders create machines and generate images from those machines for various platforms. Packer also has some builders that perform helper tasks, like running provisioners.
Builders create machines and generate images from those machines for various platforms. Some builders in Packer perform helper tasks, such as running provisioners.

Packer has the following types of builders:

- [Plugin](/packer/plugins): Each plugin has its own associated set of builders. For example, there are separate builders for EC2, VMware, VirtualBox, etc.
- [File](/packer/docs/builders/file): The `file` builder creates an artifact from a file.
- [Null](/packer/docs/builders/null): The `null` builder sets up an SSH connection and runs the provisioners.
- [Plugins](/packer/plugins): Plugins that you install have their own associated set of builders. For example, EC2, VMware, and VirtualBox use their own separate sets of builders.
- [`file`](/packer/docs/builders/file): The `file` builder creates an artifact from a file.
- [`null`](/packer/docs/builders/null): The `null` builder sets up an SSH connection and runs the provisioners.
- [Custom](/packer/docs/plugins/creation/custom-builders): You can write new builders for new or existing platforms.
- [Community-Supported](/packer/docs/builders/community-supported): The Packer community develops and maintains builders for several additional platforms.
- [Community-supported](/packer/docs/builders/community-supported): The Packer community develops and maintains builders for several additional platforms.

Refer to the [`source`](/packer/docs/templates/hcl_templates/blocks/source) block documentation to learn more about configuring builders in the Packer templating language.

Expand Down
16 changes: 4 additions & 12 deletions website/content/docs/builders/null.mdx
Original file line number Diff line number Diff line change
@@ -1,24 +1,16 @@
---
description: |
The null Packer builder is not really a builder, it just sets up an SSH
connection and runs the provisioners. It can be used to debug provisioners
without incurring high wait times. It does not create any kind of image or
artifact.
page_title: Null - Builders
The `null` builder creates an SSH connection and runs provisioners. Use the `null` builder to debug provisioners without incurring long wait times.
page_title: null builder reference
---

<BadgesHeader>
<PluginBadge type="official" />
</BadgesHeader>

# Null Builder
# `null` builder

Type: `null`

The `null` Packer builder is not really a builder, it just sets up an SSH
connection and runs the provisioners. It can be used to debug provisioners
without incurring high wait times. It does not create any kind of image or
artifact.
The `null` builder sets up an SSH connection and runs provisioners. You can use it to debug provisioners without incurring long wait times. It does not create a images or artifacts.

## Basic Example

Expand Down
24 changes: 10 additions & 14 deletions website/content/docs/community-tools.mdx
Original file line number Diff line number Diff line change
@@ -1,35 +1,31 @@
---
page_title: Download Packer Community Projects
description: >-
Packer has a vibrant community of contributors who have built a number of
great tools on top of Packer. There are also quite a few projects
demonstrating the power of Packer templates.
Packer community contributors have built many Packer tools and projects that demonstrate Packer templates. Learn about Packer community projects you can download.
---

# Download Community Projects
# Download Packer Community Projects

Packer has a vibrant community of contributors who have built a number of great
tools on top of Packer. There are also quite a few projects demonstrating the
power of Packer templates.

## Third-Party plugins

The plugins listed below have been built by the community of Packer users and
vendors. These plugins are not officially tested nor officially maintained by
HashiCorp, and are listed here in order to help users find them easily.

To learn more about how to use community plugins, or how to build your own,
check out the docs on [extending Packer](/packer/docs/plugins/install)
refer to the docs on [extending Packer](/packer/docs/plugins/install)

If you have built a plugin and would like to add it to this community list,
please make a pull request so that we can document your
contribution here!
make a pull request so that we can document your contribution.

Refer to the following topics to learn about plugins built by the community of Packer users and
vendors. We do not test or maintain community plugins.

@include "builders/community_builders.mdx"

@include "provisioners/community_provisioners.mdx"
- [Community Builders](/packer/docs/builders/community-supported)
- [Community Provisioners](/packer/docs/provisioners/community-supported)
- [Community Post-Processors](/packer/docs/post-processors/community-supported)

@include "post-processors/community_post-processors.mdx"

## Templates

Expand Down
15 changes: 6 additions & 9 deletions website/content/docs/datasources/hcp/hcp-packer-artifact.mdx
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
---
description: |
The HCP Packer Artifact Data Source retrieves information about an
artifact from the HCP Packer Registry. This information can be used to
provide a source artifact to various Packer builders.
page_title: HCP Packer Artifact - Data Sources
The `hcp-packer-artifact` data source retrieves information about an
artifact from the HCP Packer Registry. Use the information to provide a source artifact to Packer builders.
page_title: hcp-packer-artifact data source reference
---

<BadgesHeader>
<PluginBadge type="official" />
<PluginBadge type="hcp_packer_ready" />
</BadgesHeader>

# HCP Packer Artifact Data Source
# `hcp-packer-artifact`

Type: `hcp-packer-artifact`

The `HCP Packer Artifact` Data Source retrieves information about an
artifact from the HCP Packer Registry. This information can be used to
The `hcp-packer-artifact` data source retrieves information about an
artifact from the HCP Packer Registry. Use this retrieved information to
provide a source artifact to various Packer builders.

To get started with HCP Packer, refer to the [HCP Packer documentation](/hcp/docs/packer) or try
Expand Down
15 changes: 5 additions & 10 deletions website/content/docs/datasources/hcp/hcp-packer-image.mdx
Original file line number Diff line number Diff line change
@@ -1,23 +1,18 @@
---
description: |
This data source has been deprecated, please use HCP Packer Artifact data source instead.
The HCP Packer Image Data Source retrieves information about an
image from the HCP Packer registry. This information can be used to
provide a source image to various Packer builders.
page_title: HCP Packer Image - Data Sources
The `hcp-packer-image` data source retrieves information about an image from the HCP Packer registry. This data source is deprecated, use the `hcp-packer-artifact` data source instead.
page_title: hcp-packer-image data source reference
---

<BadgesHeader>
<PluginBadge type="official" />
</BadgesHeader>

# HCP Packer Image Data Source
# `hcp-packer-image`

~> **Note:** This data source has been deprecated, please use [HCP Packer Artifact](/packer/docs/datasources/hcp/hcp-packer-artifact) data source instead.
~> **This data source is deprecated**. Use the [`hcp-packer-artifact`](/packer/docs/datasources/hcp/hcp-packer-artifact) data source instead.

Type: `hcp-packer-image`

The `HCP Packer Image` Data Source retrieves information about an
The `hcp-packer-image` data source retrieves information about an
image from the HCP Packer registry. This information can be used to
provide a source image to various Packer builders.

Expand Down
13 changes: 4 additions & 9 deletions website/content/docs/datasources/hcp/hcp-packer-iteration.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,16 @@
---
description: |
This data source has been deprecated, please use HCP Packer Version data source instead.
The HCP Packer Iteration Data Source retrieves information about an
iteration from the HCP Packer registry. This information can be used to
query HCP for a source image for various Packer builders.
page_title: HCP Packer Iteration - Data Sources
The `hcp-packer-iteration` data source retrieves information about an iteration from the HCP Packer registry. This data source is deprecated. Use the `hcpe-packer-verion` data source instead.
page_title: hcp-packer-iteration data source reference
---

<BadgesHeader>
<PluginBadge type="official" />
</BadgesHeader>

# HCP Packer Iteration Data Source
# `hcp-packer-iteration`

~> **Note:** This data source has been deprecated, please use [HCP Packer Version](/packer/docs/datasources/hcp/hcp-packer-version) data source instead.

Type: `hcp-packer-iteration`
~> **This data source is deprecated**. Use the [`hcp-packer-version`](/packer/docs/datasources/hcp/hcp-packer-version) data source instead.

The `HCP Packer Iteration` Data Source retrieves information about an
iteration from the HCP Packer registry. This information can be used to query
Expand Down
23 changes: 10 additions & 13 deletions website/content/docs/datasources/hcp/hcp-packer-version.mdx
Original file line number Diff line number Diff line change
@@ -1,30 +1,27 @@
---
description: |
The HCP Packer Version Data Source retrieves information about
HCP Packer Version from the HCP Packer Registry. This information can be used to
query HCP for a source external identifier for various Packer builders.
page_title: HCP Packer Version - Data Sources
The `hcp-packer-version` data source retrieves information about
an HCP Packer version from the HCP Packer registry. Use this information to
get a source's external identifier.
page_title: hcp-packer-version data source reference
---

<BadgesHeader>
<PluginBadge type="official" />
<PluginBadge type="hcp_packer_ready" />
</BadgesHeader>

# HCP Packer Version Data Source
# `hcp-packer-version`

Type: `hcp-packer-version`

The `HCP Packer Version` Data Source retrieves information about
HCP Packer Version from the HCP Packer Registry. This information can be used to
query HCP for a source external identifier for various Packer builders.
The `hcp-packer-version` dsata source retrieves information about
an HCP Packer version from the HCP Packer registry. You can use the version information to
query HCP for a source's external identifier so that you can use it in various Packer builders.

To get started with HCP Packer, refer to the [HCP Packer documentation](/hcp/docs/packer) or try the
[Get Started with HCP Packer tutorials](/packer/tutorials/hcp-get-started).

~> **Note:** You will receive an error if you try to reference metadata from a deactivated or deleted registry.
An administrator can manually deactivate or delete a registry, and HCP Packer automatically deactivates registries
with billing issues. Contact [HashiCorp Support](https://support.hashicorp.com/) with questions.
Packer prints an error if you try to reference metadata from a deactivated or deleted registry.
An administrator can manually deactivate or delete a registry, and HCP Packer automatically deactivates registries with billing issues. Contact [HashiCorp Support](https://support.hashicorp.com/) with questions.

## Revoked Versions

Expand Down
42 changes: 17 additions & 25 deletions website/content/docs/datasources/hcp/index.mdx
Original file line number Diff line number Diff line change
@@ -1,47 +1,39 @@
---
description: |
Data sources used to data from the HCP Packer registry.
page_title: HCP - Data sources
HCP Packer data sources query data stored to the HCP Packer registry. Use the data sources when your artifact metadata is centralized in HCP.
page_title: HCP Packer Registry Data sources overview
sidebar_title: Overview
---

<BadgesHeader>
<PluginBadge type="official" />
</BadgesHeader>

# HCP Packer Registry Data sources
# HCP Packer Registry data sources overview

The HCP Packer Registry bridges the gap between artifact factories and artifact
deployments, allowing development and security teams to work together to create,
The HCP Packer Registry connects artifact factories and artifact
deployments so that development and security teams can work together to create,
manage, and consume artifacts in a centralized way.

## Introduction

The HCP Packer Registry stores metadata about your artifacts, including when they
were created, where the artifacts exists in the cloud, and what (if any) git commit
is associated with your build. You can use the registry to track
were created, where the artifacts exists in the cloud, and git commit
information associated with your build. You can use the registry to track
information about the artifacts your Packer builds produce, clearly
designate which artifacts are appropriate for test and production environments,
and query for the right artifacts to use in both Packer and Terraform
configurations.

Packer has two data sources that work together to retrieve information from the
The following Packer data sources work together to determine and retrieve information from the
HCP Packer registry:

- [hcp-packer-version](/packer/docs/datasources/hcp/hcp-packer-version) -
retrieves information about an HCP Packer Version in HCP Packer Registry
- [hcp-packer-artifact](/packer/docs/datasources/hcp/hcp-packer-artifact) - retrieves
information about a specific artifact created in the HCP Packer registry

Deprecated data sources: (Please use above given data sources instead)
- [hcp-packer-iteration](/packer/docs/datasources/hcp/hcp-packer-iteration) -
retrieves information about an iteration in HCP Packer registry
- [hcp-packer-image](/packer/docs/datasources/hcp/hcp-packer-image) - retrieves
information about a specific image created in the HCP Packer registry

These data sources are intended to be used together to determine source artifact
for pipelined Packer builds.
- [hcp-packer-version](/packer/docs/datasources/hcp/hcp-packer-version): Retrieves information about an HCP Packer version in the HCP Packer registry.
- [hcp-packer-artifact](/packer/docs/datasources/hcp/hcp-packer-artifact): Retrieves
information about a specific artifact created in the HCP Packer registry.

## How to use this plugin
The following data source types are deprecated since v1.10.1:

This plugin comes bundled with the Packer core, so you do not need to install
it separately. Please install Packer v1.7.7 or above to use the latest version
of the HCP Packer Registry data sources.
- [hcp-packer-iteration](/packer/docs/datasources/hcp/hcp-packer-iteration): Retrieves information about an iteration in HCP Packer registry. This data source type is deprecated. Use `hcp-packer-version` instead.
- [hcp-packer-image](/packer/docs/datasources/hcp/hcp-packer-image): Retrieves
information about a specific image created in the HCP Packer registry. This data source type is deprecated. Use `hcp-packer-artifact` instead.
Loading
Loading