Add a Docker registry connector

Documentation for the provisioning of Docker Registry connectors.

You connect Harness to a Docker container registry using a Harness Docker Registry connector. This connector is platform-agnostic and can be used to connect to any Docker container registry, so you can pull container images for use in Harness pipelines.

This topic shows you how to add a Docker Registry connector to Harness.

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

AWS and GCP registries

Harness provides dedicated support for registries in AWS and GCP. For more details, see Add an AWS Connector and Google Cloud Platform (GCP) Connector Settings Reference. For Azure ACR, use the steps below.

---

What you will learn from this topic

• How to add a Docker Registry connector to a Harness project so you can pull container images in a pipeline.

---

Add a Docker Registry connector

You can add a Docker Registry connector at the project, org, or account scope. This procedure covers the project scope, and the process is the same for org and account. You can also add a Docker Registry connector directly when configuring the artifact source in a service.

Follow the interactive guide below for a step-by-step walkthrough:

Add a Docker Registry connector in Harness

Perform the following steps to add a Docker Registry connector:

1. Open your Harness project.

2. In Project Settings, select Connectors.

3. Click New Connector, then click Docker Registry. The Docker Registry settings appear.

Overview

1. In Name, enter a name for the connector. Optionally, add a description and tags. Click Continue.

Details

1. Select a Provider Type.

2. Enter the Docker Registry URL.

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

   • Username and Password: Enter the Username for the account. For Password, create a new Harness Encrypted Text secret or use an existing one.

   • Anonymous (no credentials required). Click Continue.

Select Connectivity Mode

1. Under Select Connectivity Mode, select how you want Harness to connect to Docker:

   • Connect through Harness Platform: Use a direct, secure communication between Harness and Docker.

   • Connect through a Harness Delegate: Harness communicates with Docker through a Harness Delegate.

Delegates Setup

1. In Delegates Setup, use any delegate or enter tags for the specific delegates that you want to allow to connect to this connector. Click Save and Continue.

Connection Test

1. Click Finish after the connection test succeeds. The connector is listed in Connectors.

Sample YAML

The following example shows a YAML for the Docker Registry connector created in this guide.

YAML - Docker Registry connector

connector:
  name: your-docker-connector          # Display name for the connector in Harness
  identifier: yourdockerconnector      # Unique ID used in pipelines and API references
  description: ""                      # Optional: brief description of this connector
  accountIdentifier: youraccountidentifier  # Your Harness account ID
  type: DockerRegistry
  spec:
    dockerRegistryUrl: yourdockerregistryurl  # Base URL of your Docker registry (e.g. https://index.docker.io/v2/ for Docker Hub)
    providerType: DockerHub            # Registry provider: DockerHub, Harbor, Quay, Other
    auth:
      type: UsernamePassword           # Authentication method: UsernamePassword or Anonymous
      spec:
        username: username             # Username for the registry account
        passwordRef: password          # Reference to a Harness Encrypted Text secret containing the registry password or access token
    executeOnDelegate: true            # Set to false to connect through the Harness Platform instead of a delegate
    proxy: false                       # Set to true if the delegate connects to the registry through an HTTP proxy
    ignoreTestConnection: false        # Set to true to skip the connection test and save the connector anyway

---

Next steps

• Connect to the Harness container image registry: Use a Docker Registry connector with the Harness Container Image Registry.

• Connect to IBM Cloud Container Registry: Use a Docker Registry connector with the IBM Cloud Container Registry.