Overview
Global Templates are a set of templates that are shipped with Pipelines and available to all Pipelines users. Unlike other templates, such as system and local, global templates cannot be added as a template source and cannot be modified. |
To use global templates while adding a pipeline source, a values.yml file should be available in the pipeline source repository. As shown in the examples below, the values.yml file should contain the values required for the global template to create the pipeline definition.
Pipelines currently includes the following global templates:
HelloWorld
The HelloWorld template creates a simple pipeline that showcases a few of the basic features of JFrog Pipelines.
- Parallel steps
- Reading and writing variables that persist across different steps in your pipeline
- Reading from and writing to resources
- Setting environment variables
This template does not require any special configuration or pre-existing integration for you to try.
resources:
- name: {{ .Values.namePrefix }}_bag
type: PropertyBag
configuration:
releaseVersion: ""
{{ if .Values.repo.integrationName }}
- name: {{ .Values.namePrefix }}_repo
type: GitRepo
configuration:
path: {{ .Values.repo.path }}
gitProvider: {{ .Values.repo.integrationName }}
branches:
include: {{ .Values.repo.branchPattern }}
{{ end }}
pipelines:
- name: {{ .Values.namePrefix }}_hello_world
steps:
- name: first
type: Bash
{{ if .Values.repo.integrationName }}
configuration:
inputResources:
- name: {{ .Values.namePrefix }}_repo
{{ end }}
execution:
onStart:
- echo "onStart can be used to do some setup or initialization of your dependencies to prepare for the execution."
onExecute:
- echo "onExecute is the main section where you would issue your build/test commands"
- jfrog --version
{{ if .Values.repo.integrationName }}
- echo "{{ .Values.namePrefix }}_repo sha is $(find_resource_variable {{ .Values.namePrefix }}_repo commitSha)"
{{ end }}
onSuccess:
- echo "onSuccess executes if the onStart or onExecute sections completed without errors"
onFailure:
- echo "onFailure executes if either onStart or onExecute end in failure or error."
onComplete:
- echo "onComplete executes after onSuccess or onFailure"
- name: variable_selection
type: Bash
configuration:
inputSteps:
- name: first
environmentVariables:
forceFail:
default: "false"
description: "set to 'true' to force the step to fail."
values:
- "false"
- "true"
execution:
onStart:
- if [ ${forceFail} == "true" ]; then exit 1; fi
onExecute:
- echo "This step will succeed"
onFailure:
- echo "step has failed."
onSuccess:
- echo "step has succeeded."
onComplete:
- echo "onComplete executes regardless of success or failure. forceFail is ${forceFail}"
- name: add_run_variable
type: Bash
configuration:
inputSteps:
- name: first
execution:
onStart:
- echo "This step will save a value to a run variable."
onExecute:
- add_run_variables step_info="runNumber $run_number, step_name $step_name, pipeline_name $pipeline_name"
- name: write_to_resource
type: Bash
configuration:
inputSteps:
- name: add_run_variable
- name: variable_selection
outputResources:
- name: {{ .Values.namePrefix }}_bag
execution:
onStart:
- echo "Printing the run variable 'step_info' from previous step"
- echo "${step_info}"
onExecute:
- echo "Updating resource {{ .Values.namePrefix }}_bag with new key/value pairs"
- write_output {{ .Values.namePrefix }}_bag "timestamp=$(date +%s)"
- write_output {{ .Values.namePrefix }}_bag "releaseVersion=${pipeline_name}.${run_number}"
- write_output {{ .Values.namePrefix }}_bag "stepInfo=${step_info}"
- name: read_from_resource
type: Bash
configuration:
inputResources:
- name: {{ .Values.namePrefix }}_bag
execution:
onExecute:
- echo "printing resource details"
- echo "Release Version is -- ${res_{{ .Values.namePrefix }}_bag_releaseVersion}"
- echo "Release timestamp is -- ${res_{{ .Values.namePrefix }}_bag_timestamp}"
- echo "Step Info is -- ${res_{{ .Values.namePrefix }}_bag_stepInfo}" |
values.yml: This is a sample values.yml. This can be edited to create your own version of the file.
# This string will prefix the "HelloWorld" resource and pipeline. # it will allow you to add the pipeline multiple times with unique names namePrefix: intro ## # The following section is optional. If you have a repository you'd like to # experiment with, you can add it here. ## repo: # Before creating your Pipeline Source, create an integration for one of the # source control providers and put the integration name here. integrationName: myGitIntegration # this is the full repository path. Usually org/repo or user/project # depending on which source control you use. path: "myorgname/myreponame" # branchPattern is a regex, so you could listen to all # features, for example, with "^feature.*", or you can # just configure it for an individual branch branchPattern: "^main$" |
DockerBuildAndPush
The DockerBuildAndPush template creates a pipeline that builds a Docker image from an SCM repository and pushes it to a Docker registry. Version 1.0.0 of this template uses JFrog CLI v1 and version 1.1.0 uses JFrog CLI v2. Template version 1.0.0 requires targetRepository and sourceRepository settings (see template readme) and template version 1.1.0 does not use these settings.
resources:
- name: {{ .Values.GitRepo.name | default "GitRepoRes" }}
type: GitRepo
configuration:
gitProvider: {{ .Values.GitRepo.gitProvider }}
path: {{ .Values.GitRepo.path }}
{{- if or (.Values.GitRepo.branches.include) (.Values.GitRepo.branches.exclude) }}
branches:
{{- if .Values.GitRepo.branches.include }}
include: {{ .Values.GitRepo.branches.include }}
{{- end }}
{{- if .Values.GitRepo.branches.exclude }}
exclude: {{ .Values.GitRepo.branches.exclude }}
{{- end }}
{{- end }}
- name: {{ .Values.Image.name | default "ImageRes" }}
type: Image
configuration:
registry: {{ .Values.artifactoryIntegration }}
imageName: {{ .Values.DockerBuild.dockerImageName }}
imageTag: {{ .Values.DockerBuild.dockerImageTag | default "latest" }}
autoPull: {{ .Values.Image.autopull | default true }}
{{- if .Values.BuildInfo }}
- name: {{ .Values.BuildInfo.name | default "BuildInfo" }}
type: BuildInfo
configuration:
sourceArtifactory: {{ .Values.artifactoryIntegration }}
buildName: {{ .Values.DockerPush.name | default "DockerPush" }}
buildNumber: {{ .Values.BuildInfo.buildNumber | default 1 }}
{{- end }}
pipelines:
- name: {{ .Values.Pipeline.name | default "Pipeline" }}
configuration:
jfrogCliVersion: 2
steps:
- name: {{ .Values.DockerBuild.name | default "DockerBuild" }}
type: DockerBuild
configuration:
affinityGroup: DockerBuildAndPush
dockerFileLocation: {{ .Values.DockerBuild.dockerFileLocation | default "." | quote }}
dockerFileName: {{ .Values.DockerBuild.dockerFileName | default "Dockerfile" }}
dockerImageName: {{ .Values.DockerBuild.dockerImageName }}
dockerImageTag: {{ .Values.DockerBuild.dockerImageTag }}
inputResources:
- name: {{ .Values.GitRepo.name | default "GitRepoRes" }}
integrations:
- name: {{ .Values.artifactoryIntegration }}
- name: {{ .Values.DockerPush.name | default "DockerPush" }}
type: DockerPush
configuration:
{{- if .Values.BuildInfo }}
autoPublishBuildInfo: {{ .Values.BuildInfo.autoPublishBuildInfo | default true }}
{{- end }}
affinityGroup: DockerBuildAndPush
integrations:
- name: {{ .Values.artifactoryIntegration }}
inputSteps:
- name: {{ .Values.DockerBuild.name | default "DockerBuild" }}
outputResources:
- name: {{ .Values.Image.name | default "ImageRes" }}
{{- if .Values.BuildInfo }}
- name: {{ .Values.BuildInfo.name | default "BuildInfo" }}
{{- end }} |
values.yml: This is a sample
values.yml. This can be edited to create your own version of the file.
GitRepo: # Required.
name: fooGitRepo # Name of the GitRepo resource. Defaults to GitRepoRes.
gitProvider: github # Required. Name of the SCM integration which will be used to fetch the SCM. repository.
path: jfrog/jfrog-pipelines-simple-example # Required. Path to the SCM repository.
branches:
exclude: 'master' # Regex pattern to exclude branches.
include: ^{{gitBranch}}$ # Regex pattern to include branches.
artifactoryIntegration: art # Required. Name of the artifactory integration using which the docker image will be pushed.
Image: # Required.
name: fooImage # Name of the Image resource. Defaults to ImageRes.
autoPull: false # Defaults to true.
DockerBuild: # Required.
name: foobuild # Name of the DockerBuild step. Defaults to DockerBuild.
dockerImageName: foo # Required. Name of the docker image getting built.
dockerFileName: foo # Required. Name of the Dockerfile.
dockerFileLocation: '.' # Required. Path to Dockerfile.
dockerImageTag: ${run_number} # Name of the docker image tag. Defaults to latest.
Pipeline:
name: foo # Name of the pipeline. Defaults to Pipeline.
DockerPush: # Required.
name: foopush # Name of the DockerPush step. Defaults to DockerPush.
BuildInfo: # Optional, if the BuildInfo needs to be published.
autoPublishBuildInfo: true # Defaults to true.
name: fooBuildInfo # Name of the BuildInfo resource. Defaults to BuildInfo. |
HelmPublishAndDeploy
The HelmPublishAndDeploy template creates a pipeline that publishes a Helm Chart to a Helm repository in Artifactory, creates a Build Info, promotes the Build, and then deploys the Helm Chart from the promoted Build resource using the HelmDeploy native step. Version 1.0.0 of this template uses JFrog CLI v1 and version 1.1.0 uses JFrog CLI v2.
values.yml: This is a sample
values.yml, which can be edited to create your own version of the file.
artifactoryIntegration: artifactory_integration # Required. Name of the Artifactory integration.
kubernetesIntegration: kubernetes_integration # Required. Name of the Kubernetes integration.
GitRepo: # Required.
name: fooGitRepo # Name of the GitRepo resource. Defaults to GitRepoRes.
gitProvider: github # Required. Name of the SCM integration which will be used to fetch the SCM repository.
path: jfrog/jfrog-pipelines-simple-example # Required. Path to the SCM repository.
branches: # Optional.
exclude: ^master$ # Regex pattern to exclude branches.
include: ^{{gitBranch}}$ # Regex pattern to include branches.
files: # Optional.
exclude: ^fileName$ # Regex pattern to exclude files.
include: ^fileName$ # Regex pattern to include files.
BuildInfo: # Required.
name: fooBuild # Name of the BuildInfo resource. Defaults to BuildInfoRes.
buildName: foo # Optional. Name of the Artifactory Build that will be created. Defaults to $pipeline_name.
buildNumber: $run_number # Optional. Number of the Artifactory Build that will be created. Defaults to $run_number.
BuildInfoPromoted: # Optional.
name: fooBuildInfoPromoted # Name of the promoted BuildInfo resource. Defaults to BuildInfoPromotedRes.
autoPromotion: false # Optional. When set to false, indicates that Build promotion in the pipeline will be manually triggered. Defaults to true.
HelmChart: # Required.
name: fooHelmChart # Name of the HelmChart resource. Defaults to HelmChartRes.
chartName: foo # Required. Helm chart name.
chartVersion: 0.0.1 # Required. Helm chart version.
repository: foo # Required. The name of the Helm repository in Artifactory.
helmVersion: 3 # Optional. A number representing the major version of Helm to use. Defaults to 3.
namespace: foo # Optional. Set the namespace used for the Helm operations. Only supported when used with Helm 3.
Pipeline: # Optional.
name: foo # Name of the pipeline. Defaults to HelmDeployPipeline.
HelmPublish: # Required.
name: HelmPublish # Name of the HelmPublish step. Defaults to HelmPublish.
chartPath: '.' # Required. The path to the Helm chart YAML in the GitRepo resource.
flags: '--app-version=foo' # Optional. Command line options to pass to the helm package command.
lint: true # Optional. When set to true performs a lint to examine a Helm chart for possible issues. Defaults to false.
lintFlags: '--strict' # Optional. Flag string to pass to the helm lint command.
valueFilePaths: # Optional. Specifies values YAML file(s) that will be used in the lint command helm lint command.
- values.yaml # Optional. An exmaple of how to add a values YAML file.
- values2.yaml # Optional. An exmaple of how to add an additional values YAML file.
PromoteBuild: # Optional.
name: fooPromoteBuild # Name of the PromoteBuild step. Defaults to PromoteBuild.
targetRepository: fooPromote # Required. The name of the repository in Artifactory to promote the build to.
copy: false # Optional. When set to true, copies the artifacts to the targetRepository vs moving them to the targetRepository. Defaults to false.
HelmDeploy: # Required.
name: fooHelmDeploy # Name of the HelmDeploy step. Defaults to HelmDeploy.
chartPath: '.' # Required. The path to the Helm chart YAML in the input BuildInfo resource.
releaseName: foo # Required. The release name. Equivalent to the --name (-n) option of the helm install command.
flags: '--wait --timeout 900s' # Optional. Command line options to pass to the helm upgrade command.
lint: true # Optional. When set to true performs a lint to examine a Helm chart for possible issues. Defaults to false.
lintFlags: '--strict' # Optional. Flag string to pass to the helm lint command.
valueFilePaths: # Optional. Specifies values YAML file(s) for use with a --values (-f) option of the helm lint command.
- values.yaml
- values2.yaml
test: true # Optional. When set to true performs a test to run the tests for release. Defaults to false.
testFlags: # Optional. Flag string to pass to the helm test command. |
Using Global Templates to Create a Pipeline Source
Perform the following steps to use a Global Template to create a pipeline source:
Go to Administration | Pipelines | Pipeline Sources, and click Add Pipeline Source, and From Template.
- Complete the resulting Select Template form:
- Click the Select Template Namespace field and select the
jfrognamespace. - Click the Select Template Name field and select the
DockerBuildAndPushorHelmPublishAndDeployglobal template. Click the Select Template Version field and select the relevant version for the template.
- Click the Select Template Namespace field and select the
Click Next and complete the resulting Specify values file form to add the
values.ymlfile.
Click the Integration field and select your source control integration from the dropdown list.
- In the Repository Full Name field, enter the path of the repository where your
values.ymlis stored. - Specify the Branch of the repository (for example,
master). In the Values File Path field, provide the path to the
values.ymlfile, which contains the values for the global template. By default, this field is set to take the file from the root directory. If yourvalues.ymlfile is stored in a different directory, enter the full path.When you do this, the
values.ymlfile is parsed and values are added as configured in the file.For more information about the Specify values file form, see the section Adding a Pipeline Source.
- Click Create Source to add the Pipeline Source.
The combination of pipeline template name, namespace, version and values.yml is parsed to create the pipeline definition.
After your Pipeline Source syncs successfully, you can view the newly added pipeline by navigating to My Pipelines on the left navbar and clicking Pipelines → My Pipelines.