图像

Overview

An图像resource is used to add a reference to a Docker image to your pipeline.

An Image resource holds information of a docker image that is stored through aDocker Registry Integrationthat may in one of the following registry sources:

JFrog Artifactory / JFrog Container Registry
Amazon Container Registry
Google Container Registry
Azure Container Registry
Docker Hub

An Image resource can be used as both input and output. Step like DockerBuild will generate it as an output and steps like DockerPublish will use it as input to publish to a Docker registry.

Page Contents

YAML Schema

resources: - name:  type: Image configuration: registry:  sourceRepository:  # required if registry is Artifactory region:  # required if registry is on AWS imageName:  imageTag:  autoPull:  #(default false)

Tags

name

Analphanumericstring (underscores are permitted) that identifies the resource.

类型

Must be图像for this resource type.

configuration

Specifies all configuration selections for the resource.

Tag	Description	Required/Optional
`registry`	The name of aDocker Registry Integration	Required
`sourceRepository`	The name of the repository in Artifactory to which the images will be published	Required if registry is in JFrog Artifactory
`region`	AnAWS region identifier	Required if registry is on AWS
`imageName`	The file path of the Docker image, of the form imageRepo/imageName Once an`图像`resource is created, the`imageName`attribute cannot be changed, since Pipelines maintains a history of versions for that image name. If the image name needs to be changed: Delete the existing`图像`resource. Either: Create a new`图像`resource with a new image name. or Wait for an hour from the time of deletion and create the same`图像`resource with a new image name. Update the pipeline YAML to reference the new`图像`resource. Sync the pipeline source, if required.	Required
`imageTag`	The version tag of the initial version of the Docker image	Required
`autoPull`	Whentrue, the image is automatically pulled to the machine running the step. Defaults tofalse.	Optional

Environment Variables

Whenever图像is used in a step, a set of environment variables is automatically made available that you can use in your step.

Environment Variable	Description
res__name	Name of the resource
res__sourceRepository	The name of the repository in Artifactory
res__region	The AWS region identifier
res__imageName	The file path of the Docker image
res__imageTag	The version tag of the initial version of the Docker image
res__autoPull	Value of the autopull flag

Examples

The Pipelines DSL for this example is available int his repositoryin theJFrogGitHub account.

Example 1

resources: - name: Image_1 type: Image configuration: registry: PSSG_DockerRegistry imageName: docker/jfreq_win imageTag: latest autoPull: true pipelines: - name: pipelines_Image_1 steps: - name: step_Image_1 type: PowerShell configuration: nodePool: win_2019 inputResources: - name: Image_1 execution: onExecute: - write-output "executing step..." - if($Image_1_isTrigger -ne "true"){ Write-Error "Stop" -ErrorAction Stop }

Example 2

resources: - name: Image_2 type: Image configuration: registry: s_artifactory sourceRepository: docker-local imageName: ubuntu imageTag: latest pipelines: - name: pipelines_IMAGE_2 steps: - name: step_IMAGE_2 type: PowerShell configuration: nodePool: win_2019 inputResources: - name: Image_2 execution: onExecute: - write-output "executing step..."

Content

Space Tools

图像