Skip to main content

Connect to an Artifact repository

You connect Harness to an artifact repo by adding an Artifact Repositories connector.

You can connect to an artifact repo inline when developing your Pipeline, or separately in your Account/Org/Project Connectors. Once add the Connector, it'll be available in Pipelines and Connectors of the same Account/Org/Project.

AWS, Azure, and Google Cloud Storage artifacts​

Connectors for artifacts stored in Google Cloud Storage or Amazon S3 are added as Cloud Providers Connectors, not Artifact Repositories.

If you are using Google Cloud Storage or Amazon S3, see Cloud Platform Connectors.

For Azure ACR, use the Docker Registry Connector, described below.

Artifact repository connectors scope​

You can add an artifact repository connector at the account, org, or project scope.

This topic will explain how to add it at the project scope. The process is same for org and account.

Steps on adding the artifact repository connector inline when developing a pipeline are covered in the relevant How-to and Technical Reference topics. For example, adding a Docker Registry is covered in the Kubernetes CD Quickstart and Docker Connector Settings Reference.

Add an Artifactory repository​

For details on settings and permissions, see Artifactory Connector Settings Reference.

  1. Open a Harness Project.
  2. In Project Setup, click Connectors.
  3. Click New Connector, and click Artifactory in Artifact Repositories. The Artifactory Repository settings appear.
  4. In Name, enter a name for this connector.
  5. Click Continue.
  6. Enter the Artifactory Repository URL.
  7. In Authentication, select one of the following options:
    1. Username and Password - Once you choose this option, you need to enter the Username and Password. For Password you can either create a new Secret or use an existing one.
    2. Anonymous (no credentials required).
  8. Click Continue.
  9. In Delegates Setup, use any delegate or enter Tags for specific Delegates that you want to allow to connect to his Connector.
  10. Click Save and Continue.
  11. Once the Test Connection succeeds, click Finish. The Connector is listed in Connectors.

Add a Docker registry​

For details on settings and permissions, see Docker Connector Settings Reference.The Docker Connector is platform-agnostic and can be used to connect to any Docker container registry, but Harness provides first class support for registries in AWS and GCR. See Add an AWS Connector, Google Cloud Platform (GCP) Connector Settings Reference.

  1. Open a Harness Project.
  2. In Project Setup, click Connectors.
  3. Click New Connector, and click Docker Registry in Artifact Repositories. The Docker Registry settings appear.
  4. In Name, enter a name for this connector.
  5. Click Continue.
  6. Enter the Docker Registry URL.
  7. Select a Provider Type.
  8. In Authentication, select one of the following options:
    1. Username and Password - Once you choose this option, you need to enter the Username and Password. For Password you can either create a new Secret or use an existing one.
    2. Anonymous (no credentials required).
  9. Click Continue.
  10. In Delegates Setup, use any Delegate or enter Tags for specific Delegates that you want to allow to connect to his Connector.
  11. Click Save and Continue.
  12. Once the Test Connection succeeds, click Finish. The Connector is listed in Connectors.

Add an HTTP Helm repository​

You can add Helm Charts from an HTTP Helm Repo. Once you set up the Connector, you can use it in a Stage to add your Helm Chart.

Since Harness lets you use the <+artifact.image> expression in your Helm Chart Values YAML files, Helm Charts are added to the service Manifests section and not its Artifacts section.

If you use the <+artifact.image> expression in your Helm Chart Values YAML files, then Harness will pull the image you add to the service Artifacts section. See Deploy Helm Charts.

For details on settings and permissions, see HTTP Helm Repo Connector Settings Reference.

  1. Open a Harness Project.
  2. In Project Setup, click Connectors.
  3. Click New Connector, and click HTTP Helm in Artifact Repositories. The HTTP Helm Repo settings appear.
  4. In Name, enter a name for this connector.
  5. Click Continue.
  6. Enter the Helm Repository URL.
  7. In Authentication, select one of the following options:
    1. Username and Password - Once you choose this option, you need to enter the Username and Password. For Password you can either create a new Secret or use an existing one.
    2. Anonymous (no credentials required).
  8. Click Continue.
  9. In Delegates Setup, use any Delegate or enter Tags for specific Delegates that you want to allow to connect to his Connector.
  10. Click Save and Continue.
  11. Once the Test Connection succeeds, click Finish. The Connector is listed in Connectors.

Add a Helm 3 OCI Helm registry​

You can add Helm Charts from an OCI Helm Registry. Once you set up the Connector, you can use it in a Stage to add your Helm Chart.

Since Harness lets you use the <+artifact.image> expression in your Helm Chart Values YAML files, Helm Charts are added a Stage Service in Manifests and not Artifacts. If you use the <+artifact.image> expression in your Helm Chart Values YAML files, then Harness will pull the image you add to Artifacts. See Deploy Helm Charts.

  1. Open a Harness Project.
  2. In Project Setup, click Connectors.
  3. Click New Connector, and click OCI Helm Registry in Artifact Repositories. The OCI Helm Registry settings appear.
  4. In Name, enter a name for this connector.
  5. Click Continue.
  6. Enter the Helm Repository URL.
    info

    The following URL types are supported for the OCI Helm connector.

    • URL without the oci:// prefix. For example, public.ecr.aws.
    • URL with the oci:// prefix. For example, oci://public.ecr.aws.
    • URL with port number. For example, public.ecr.aws:443.
    • URL with the oci:// prefix and port number. For example, oci://public.ecr.aws:443.
  7. In Authentication, in Username and Password, enter the Username and Password. For Password you can either create a new Secret or use an existing one.
  8. Click Continue.
  9. In Delegates Setup, use any Delegate or enter Tags for specific Delegates that you want to allow to connect to his Connector.
  10. Click Save and Continue.
  11. Once the Test Connection succeeds, click Finish. The Connector is listed in Connectors.

OCI registry notes​

  • Helm supports OCI registries officially for Helm version 3.8 and above. Experimental support is available with versions below 3.8.
  • You cannot use OCI Helm Registries with Helm Chart Triggers.
  • Harness OCI support is cloud-agnostic. You can use OCI registries in ACR, GCR, and ECR.

Google GCR Authentication Supported​

For GCR as an OCI registry, Harness support authentication using the following:

  • Access token
  • A JSON key file where username is _json_key_base64 and password is base64-encoded JSON key file content.

Harness does not support a username of _json_key and password as unencrypted JSON key file content.

AWS ECR authentication supported​

For Helm Repository URL, enter the URL for the repo in the format https://<aws_account_id>.dkr.ecr.<region>.amazonaws.com.

For example, something like https://0838475738302113.dkr.ecr.us-west-2.amazonaws.com.

For Username, enter AWS.

For Password, create a new Harness text secret.

Use the following command to retrieve the password from AWS ECR:

aws ecr get-login-password --region <region>

For example: aws ecr get-login-password --region us-west-2

Copy the password and paste it into a Harness text secret.

The AWS ECR authorization token in only valid for 12 hours. This is an AWS limitation.For information on ECR authentication, go to Private registry authentication from AWS.

Add a Nexus repository​

For details on settings and permissions, see Nexus Connector Settings Reference.

  1. Open a Harness Project.

  2. In Project Setup, select Connectors.

  3. Select New Connector, and then select Nexus in Artifact Repositories. The Nexus Repository settings appear.

  4. In Name, enter a name for this connector.

  5. Select Continue.

  6. In Nexus Repository URL, enter the URL that you use to connect to your Nexus server. For example, https://nexus3.dev.mycompany.io/repository/your-repo-name.

  7. Select a Version.

    info

    For Nexus 2.x, Harness supports repository formats Maven, npm, and NuGet. Go to Sonatype's website, Supported Formats for more information.

    For Nexus 3.x, Harness supports repository formats Docker 3.0 and greater, Maven, npm, NuGet.

  8. In Authentication, select one of the following options:

    • Username and Password - Once you choose this option, you need to enter the Username and Password. For Password you can either create a new Secret or use an existing one.
    • Anonymous (no credentials required).

  9. Select Continue.

  10. In Delegates Setup, use any delegate or enter Tags for specific delegates that you want to allow to connect to his connector.

  11. Select Save and Continue.

  12. Once the Test Connection succeeds, select Finish. The connector is listed in Connectors.

See also​