docs

The JFrog Artifactory plugin can be used with HashiCorp Packer to identify, retrieve, and upload artifacts, depending on the strategy you want to use. This plugin comes with two data sources and two post-processors.

One data source locates target image artifacts and retrieves information necessary to work with them. The other allows you to (optionally) download those image artifacts (OVA, OVF, or VMTX) from Artifactory and then import them into vCenter and mark them as VM Template. Prior to importing the image artifact, it will be evaluated, and if necessary converted, to the proper format to enable importing into vCenter.

One post-processor enables the upload of a newly created image artifact into Artifactory and the other enables the assignment of one or more properties to an image artifact.

Installation

To install this plugin, copy and paste this code into your Packer configuration, then run packer init.

packer {
  required_plugins {
    artifactory = {
      source  = "github.com/raynaluzier/artifactory"
      version = ">=1.0.27"
    }
  }
}

Alternatively, you can use packer plugins install to manage installation of this plugin.

$ packer plugins install github.com/raynaluzier/artifactory

Components

The following components are available with the Artifactory plugin.

Data Sources

• artifactory - Filter and locate target artifacts and retrieve information necessary to work with them.

• artifactory-import - Optionally download image artifacts (OVA, OVF, or VMTX) and/or import into vCenter as a template (for use with vsphere-clone builder plugin).

• artifactory-download-other - Download non-image artifacts that may support the image itself, such as script files, metadata, etc.

Post-Processors

• artifactory-upload - Upload newly built image artifacts (OVA, OVF, or VMTX) to JFrog Artifactory.

• artifactory-update-props - Update the properties of an existing or newly created image artifact stored in Jfrog Artifactory.

• artifactory-upload-other - Upload non-image artifacts that may support the image itself, such as script files, metadata, etc.

Authentication

There are several ways to provide credentials for JFrog Artifactory authentication, which uses a bearer token when making each underlying request. The following authentication methods are supported:

• Static credentials
• Variables file
• Environment variables
  • Exported
  • .env File

Static Credentials

Static credentials, though not recommended, can be provided using the server API address and identity token as follows:

data "artifactory" "basic-example" {
  artifactory_server = "https://server.domain.com:8081/artifactory/api"
  artifactory_token  = "1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t"
}

data "artifactory-import" "basic-example" {
  artifactory_server = "https://server.domain.com:8081/artifactory/api"
  artifactory_token  = "1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t"

  vcenter_server     = "vc01.domain.com"
  vcenter_user       = "[email protected]"
  vcenter_password   = "MyP@$$w0rd!"
}

Variables File

Input variables values can be supplied through the use of either a .pkrvars.hcl or .auto.pkrvars.hcl file.

Ensure a corresponding input variable definition is present for each as shown below, and use the var. reference in the data source.

Usage: Variables File Variable Definitions:

variable "artif_token" {
  type        = string
  description = "Identity token of the Artifactory account with access to execute commands"
  sensitive   = true
  default     = env("ARTIFACTORY_TOKEN")
}

variable "artif_server" {
  type        = string
  description = "The Artifactory API server address"
  default     = env("ARTIFACTORY_SERVER")
}

variable "vc_server" {
  type        = string
  description = "vCenter Server FQDN/IP address"
  default     = env("VCENTER_SERVER")
}

variable "vc_user" {
  type        = string
  description = "vCenter User account"
  default     = env("VCENTER_USER")
}

variable "vc_password" {
  type        = string
  description = "vCenter User account password"
  sensitive   = true
  default     = env("VCENTER_PASSWORD")
}

Set the Variables in a .auto.pkrvars.hcl File:

artif_server = "https://server.domain.com:8081/artifactory/api"
artif_token  = "1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t"
vc_server    = "vc01.domain.com"
vc_user      = "[email protected]"
vc_password  = "MyP@$$w0rd!"

Environment Variables

Credentials can be provided via the ARTIFACTORY_SERVER and ARTIFACTORY_TOKEN environment variables, which represent the target Artifactory server instance's API address and Artifactory identity token of the account with access to query artifacts and execute operations.

Ensure a corresponding input variable definition is present for each as shown below, and use the var. reference in the data source.

Usage: Exported Variable Definitions:

variable "artif_token" {
  type        = string
  description = "Identity token of the Artifactory account with access to execute commands"
  sensitive   = true
  default     = env("ARTIFACTORY_TOKEN")
}

variable "artif_server" {
  type        = string
  description = "The Artifactory API server address"
  default     = env("ARTIFACTORY_SERVER")
}

variable "vc_server" {
  type        = string
  description = "vCenter Server FQDN/IP address"
  default     = env("VCENTER_SERVER")
}

variable "vc_user" {
  type        = string
  description = "vCenter User account"
  default     = env("VCENTER_USER")
}

variable "vc_password" {
  type        = string
  description = "vCenter User account password"
  sensitive   = true
  default     = env("VCENTER_PASSWORD")
}

Set the Environment Variables:

export ARTIFACTORY_SERVER=https://server.domain.com:8081/artifactory/api
export ARTIFACTORY_TOKEN=1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t
export vc_server    = "vc01.domain.com"
export vc_user      = "[email protected]"
export vc_password  = "MyP@$$w0rd!"

Usage: .env If using a .env file, include it at the root of your configuration. Ensure an entry is added for it to your .gitignore file to prevent storing sensitive data in your repository.

Ensure a corresponding input variable definition is present for each as shown below, and use the var. reference in the data source.

Variable Definitions:

variable "artif_token" {
  type        = string
  description = "Identity token of the Artifactory account with access to execute commands"
  sensitive   = true
  default     = env("ARTIFACTORY_TOKEN")
}

variable "artif_server" {
  type        = string
  description = "The Artifactory API server address"
  default     = env("ARTIFACTORY_SERVER")
}

variable "vc_server" {
  type        = string
  description = "vCenter Server FQDN/IP address"
  default     = env("VCENTER_SERVER")
}

variable "vc_user" {
  type        = string
  description = "vCenter User account"
  default     = env("VCENTER_USER")
}

variable "vc_password" {
  type        = string
  description = "vCenter User account password"
  sensitive   = true
  default     = env("VCENTER_PASSWORD")
}

Set the Environment Variables in the .env File:

ARTIFACTORY_SERVER=https://server.domain.com:8081/artifactory/api
ARTIFACTORY_TOKEN=1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t
VCENTER_SERVER=vc01.domain.com
[email protected]
VCENTER_PASSWORD=MyP@$$w0rd!