DockerPush - Tags

JFrog Pipelines Documentation

Products

JFrog Pipelines

Content Type

User Guide

ft:sourceType

Paligo

This topic lists tags that can be used with DockerPush Pipeline steps. For more information on DockerPush Pipeline steps, see DockerPush.

name

An alphanumeric string (underscores are permitted) that identifies the step.

type

Must be DockerPush for this step type.

configuration

Specifies all configuration selections for the step's execution environment. This step inherits the Bash/ PowerShell step configuration tags, including these pertinent tags:

Tag	Description of usage	Required/Optional
`affinityGroup`	Must specify an affinity group string that is the same as specified in a prior DockerBuild step.	Optional
`integrations`	Must specify an Artifactory Integration or JFrog Platform Access Token Integration .	Required
`inputSteps`	Typically the DockerBuild step that built the image. The DockerBuild step must always be in the same affinity group, but other steps, such as Bash or PowerShell, are also permitted in the same affinity group, between DockerBuild and DockerPush.	May be Required
`outputResources`	May specify an Image resource. If one is specified, the `imageTag` property of that resource will be updated with the `dockerImageTag` of the preceding DockerBuild step. Must specify a BuildInfo resource if `autoPublishBuildInfo` is set to `true`. If `JFROG_CLI_BUILD_NAME` or `JFROG_CLI_BUILD_NUMBER` is set as an environment variable for the pipeline or the input DockerBuild step, that name and/or number is used for the output BuildInfo. Otherwise, the default `buildName`and `buildNumber` are `$pipeline_name` and `$run_number` respectively.	Optional May be required

In addition, these tags can be defined to support the step's native operation:

Tags derived from Bash

All native steps derive from the Bash step. This means that all steps share the same base set of tags from Bash, while native steps have their own additional tags as well as that support the step's particular function. So it's important to be familiar with the Bash step definition, since it's the core of the definition of all other steps.

Tag	Description of usage	Required/Optional
`targetRepository`	The name of the Docker repository in Artifactory. Required when using JFrog CLI v1 and not used when the pipeline is configured to use JFrog CLI v2. Note Must be a local repository. Virtual repositories are not supported.	May be required
`forceXrayScan`	When `true`, forces a scan of the pushed image by JFrog Xray. Default is `false`.	Optional
`failOnScan`	When set to `true`, and when the Xray Policy Rule Fail Build checkbox is checked in the Configure a Security Rule window, a failed Xray scan will result in a failure of the step.Configure a Security Rule Default is `true`.	Optional
`autoPublishBuildInfo`	When set to `true`, publishes build info with the Docker image. Default is `false`.	Optional

execution

Declares collections of shell command sequences to perform for pre- and post-execution phases:

Tag	Description of usage	Required/Optional
`onStart`	Commands to execute in advance of the native operation	Optional
`onSuccess`	Commands to execute on successful completion	Optional
`onFailure`	Commands to execute on failed completion	Optional
`onComplete`	Commands to execute on any completion	Optional

The actions performed for the onExecute phase are inherent to this step type and may not be overridden.

name

type

configuration

Tags derived from Bash

Note

execution