Artifactory Repository

Pulls Artifactory repository files to disk for compile pipeline scanning.

Only downloads files whose SHA1 differs from existing symbol files in the input paths.

Configuration

To configure the Artifactory repository module, Edit these settings.

Below is the default configuration from: artifactory/config.yaml (* Required Fields).

# 🔟❎ 'compile' Artifactory configuration

# Pull artifacts (e.g., Java archives, .NET assemblies) from remote Artifactory instances to 
# scan for symbol values. To learn more see https://doc.log10x.com/compile/pull/artifactory

# Set the 10x pipeline to 'compile'
tenx: compile

# ============================= Artifactory Options ===========================

artifactory:

  # 'token' specifies an Artifactory API access token.
  #   To learn more see https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-tokens
  - token: $=TenXEnv.get("ARTIFACTORY_TOKEN") # (❗ REQUIRED)

  # 'instance' specifies the of location of the remote Artifactory instance (e.g., https://demo.jfrog.io/artifactory)
    instance: "" # (❗ REQUIRED)

  # 'repo' specifies the target Artifactory repository (e.g., pypi-local)
    repo: "" # (❗ REQUIRED)

  # 'files' specifies files to pull from the target Artifactory repository  # (❗ REQUIRED)
    files: [
      # dist/jfrog-pypi-example-1.0.0.tar.gz
    ] 

    # 'folders' specifies folders paths within the target Artifactory instance repository to pull # (❗ REQUIRED)
    folders: [ 
    ]

    # 'recursive' specifies whether to pull folders recursively (i.e., pull sub-folders as well).
    recursive: true

Options

Specify the options below to configure multiple Artifactory repository:

Name	Description
artifactoryInstance	Artifactory repository URL
artifactoryToken	Artifactory instance access token
artifactoryRepo	Artifactory repository name
artifactoryFiles	Remote repository file paths
artifactoryFolders	Remote repository folder paths
artifactoryRecursive	Pull files from remote repository folders recursively

`artifactoryInstance`

Artifactory repository URL.

Type	Required
String	✔

URL for the remote Artifactory instance (e.g., https://myusername.jfrog.io/artifactory).

`artifactoryToken`

Artifactory instance access token.

Type	Required
String	✔

Artifactory access token for this remote instance.

This value should be set via an environment variable:

artifactoryToken: $=TenXEnv.get("ARTIFACTORY_TOKEN")

`artifactoryRepo`

Artifactory repository name.

Type	Required
String	✔

Name of the repository within the target Artifactory instance from which to pull the specified file.

`artifactoryFiles`

Remote repository file paths.

Type	Default
List	[]

Paths of files within the target Artifactory instance repository to pull.

`artifactoryFolders`

Remote repository folder paths.

Type	Default
List	[]

Paths of folders within the target Artifactory instance repository to pull.

`artifactoryRecursive`

Pull files from remote repository folders recursively.

Type	Default
Boolean	false

Specifies whether to pull files from artifactoryFolders recursively (i.e., pull sub-folders as well).

This module is defined in artifactory/module.yaml.