Overview

A RemoteFile resource enables using a file on a remote file server. 


This resource holds information of a RemoteFile that is stored on the following registries:

  • JFrog Artifactory
  • AWS S3
  • Google Cloud Storage
  • File Server


YAML Schema

resources:
  - name: 			<string>
    type: 			RemoteFile
    configuration:      
      source: 			<file server integration name>
      fileLocation: 	<string>  # optional
      fileName: 		<string>  # optional
      fileDateTime:     <string>  # optional

Tags

name 

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

type 

Must be RemoteFile for this resource type.

configuration

Specifies all configuration selections for the resource.

Tag

Description

Required/Optional
source

The name of an integration of one the following types:

Required
fileLocation 

Directory path on the remote file server where the file is located

Once a RemoteFile resource has been created, the fileLocation attribute cannot be changed, since Pipelines maintains a history of versions for that file location.

If the file location needs to be changed, create a new RemoteFile resource with the new location and then update your pipelines to reference the new RemoteFile resource. 

Optional
fileName

The name of the file

Once a RemoteFile resource has been created, the fileName attribute cannot be changed, since Pipelines maintains a history of versions for that file name.

If the file name needs to be changed, create a new RemoteFile resource with the new name and then update your pipelines to reference the new RemoteFile resource. 

Optional
fileDateTimeThe date and time of the fileOptional

Environment Variables

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

Environment VariableDescription
res_<resource_name>_nameName of the resource
res_<resource_name>_source_nameName of the integration the file is associated with
res_<resource_name>_fileLocationThe directory containing files for the resource
res_<resource_name>_fileNameThe name of the file
res_<resource_name>_fileDateTimeThe date and time of the file

Examples

resources:
  - name: RemoteFile_1
    type: RemoteFile
    configuration:
      source: s_artifactory
      fileLocation: example-repo-local/setup/help # optional
      fileName: something.txt # optional
	  fileDateTime: 19/12/19 # optional


pipelines:
  - name: pipelines_1
    steps:
      - name: REFILE_1
        type: PowerShell
        configuration:
          nodePool: win_2019
          integrations:
            - name: s_artifactory
          outputResources:
            - name: RemoteFile_1
        execution:
          onExecute:
            - write-output "executing step..."
            - jfrog rt dl example-repo-local/setup/test.sh