Skip to main content

Artifactory Connector Settings Reference

Last updated on

Harness supports both cloud and on-prem versions of Artifactory.

This topic provides settings and permissions for the Artifactory Connector.

Artifactory Permissions​

Make sure the following permissions are granted to the user:

  • Privileged User is required to access API, whether Anonymous or a specific username (username and passwords are not mandatory).
  • Read permission to all Repositories.

If used as a Docker Repo, user needs:

  • List images and tags
  • Pull images

See Managing Permissions: JFrog Artifactory User Guide.

Supported sources and registry types​

The utility of the Artifactory connector depends on the module and file types you're using it with.

Continuous Delivery​

The following Artifactory sources are supported for Continuous Delivery:

  • Docker Image (Kubernetes): Metadata
  • Helm Chart: File
  • Zip: File

Metadata/File sources include Docker image and registry information. For AMI, this means AMI ID-only.

Support for the following sources is in development:

  • Terraform
  • AWS AMI
  • AWS CodeDeploy
  • AWS Lambda
  • JAR
  • RPM
  • TAR
  • WAR
  • Tanzu (PCF)
  • IIS

If you are new to using Artifactory as a Docker repo, go to the JFrog documentation on Getting Started with Artifactory as a Docker Registry.

Continuous Integration​

If you are pulling images or building/pushing images to JFrog Artifactory in Harness CI pipelines, you can use the Artifactory connector for JFrog non-Docker registries only.

For JFrog Docker registries, you must use the Docker connector. For more information, go to Build and push to JFrog Docker registries and Upload Artifacts to JFrog. This restriction also applies when pulling images from Artifactory for use in other steps, such as CI Run steps.

Artifactory connector settings​

The Artifactory connector has the following settings.

Connector metadata​

Artifactory Repository URL​

The Harness Artifactory Artifact server connects your Harness account to your Artifactory artifact resources.

For Artifactory Repository URL, enter your registry base URL followed by your module name, such as https://mycompany.jfrog.io/artifactory or https://*****server_name*****/artifactory.

The URL format depends on your Artifactory configuration, and whether your Artifactory instance is local, virtual, remote, or behind a proxy.

Get your JFrog URL​

You can get the URL from your Artifactory settings.

When examining a file in your registry, check the URL to file setting.

You can also select your repo in your JFrog instance, select Set Me Up, and get the repository URL from the server name in the docker-login command.

For more information, go to the JFrog documentation on Repository Management and Configuring Docker Repositories.

Authentication​

The Artifactory connector supports three authentication methods. Select one from the Authentication dropdown.

Username and Password​

Enter the Username for the Artifactory account user, and select or create a Harness encrypted text secret containing the corresponding Password.

Anonymous (no credentials required)​

Use this option for public Artifactory repositories that do not require authentication. No credentials are needed.

OIDC Authentication​

note

This feature is behind the feature flag CDS_ARTIFACTORY_OIDC_AUTHENTICATION. Contact Harness Support to enable the feature.

OIDC authentication enables credential-free, federated authentication with JFrog Artifactory. Harness acts as an OIDC Identity Provider and generates short-lived JWT tokens that Artifactory exchanges for access tokens.

Before using OIDC authentication, you must configure Harness as an OIDC provider in your JFrog Artifactory instance. For more information, go to the JFrog documentation on OpenID Connect Integration.

When you select OIDC Authentication, configure the following fields:

  • Provider Name: Enter the OIDC provider name you configured in JFrog Artifactory (for example, harness-oidc-provider). This value must match the provider name exactly (case-sensitive).

  • Audience (optional): Enter the audience value if you specified one when creating the OIDC provider in Artifactory. The audience value is included in the JWT token aud claim and must match the expected audience configured in JFrog.

  • JFrog Project Key (optional): Enter the JFrog project key if your Artifactory resources are scoped to a specific project. This field is required when accessing project-scoped repositories or artifacts.

Connectivity Mode​

Select how you want the connector to connect to your Artifactory instance:

  • Connect through Harness Delegate: The connector uses a Harness Delegate installed in your environment to connect to Artifactory. The delegate securely connects to the Harness Platform and performs tasks using your repositories. This option is required for on-premise Artifactory instances or when your Artifactory instance is behind a corporate firewall.

  • Connect through Harness Platform: The connector connects directly from the Harness Platform to your Artifactory instance. All credentials are encrypted and stored in the Secret Manager configured in Harness. A Harness Delegate is still used for deployment operations, even if this option is selected.

Delegates Setup​

If you selected Connect through Harness Delegate in the connectivity mode, specify which delegates the connector should use:

  • Use any available Delegate: The connector can use any delegate that is available.

  • Only use Delegates with all of the following tags: The connector only uses delegates that have all the specified tags. Enter or select delegate tags to filter which delegates can be used.

Additional artifact details​

These settings are for Artifactory deployments.

  • Repository URL: Go to Artifactory Repository URL.
  • Repository: Enter the name of the repository where the artifact source is located. Harness supports only the Docker repository format as the artifact source for deployments.
  • Artifact/Image Path: Enter the name of the artifact you want to deploy. The repository and artifact path must not begin or end with /.
  • Tag: Select a tag from the list.
info

The Artifactory user account you use in the Harness Artifact connector requires basic authentication to fetch the Artifact/Image Path and Tag.