Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.
Getting StartedOnboarding

Quickstart

Create a registry, generate an identity token, and push your first artifact to Harness Artifacts in under 15 minutes, with steps for every format.

By the end of this guide, you will have a working private registry and your first artifact stored safely inside it. Pick your format below (Docker is shown first) and follow the five steps in order. The whole thing takes under 15 minutes.

Before you begin

Three things to have ready:

  • A Harness account with the Artifact Registries: Create/Edit permission at the scope (account, organization, or project) where you want to work. Go to RBAC and permissions if you need help checking your permissions.

  • The CLI for your format installed locally: Docker, Maven, npm, pip, NuGet, Helm, or curl.

  • An identity token. You will generate one in Step 3, so there is no need to find one now.

FORMAT NOT IN THE LIST?

Registry types roll out progressively. If the type you need is missing from the create form, contact Harness Support to have it enabled on your account.


Step 1: Open Artifact Registry

Artifact Registry lives in the More menu in the Harness sidebar.

  1. In the left sidebar, select More.

  2. Select Artifacts.

You land on the Registries view, your home base for creating and managing registries.

SCOPE

Registries are scoped to the level where you create them: account, organization, or project. A registry created at the account level is visible across all organizations and projects under it. Check the scope selector in the top-left corner before you continue.


Step 2: Create a registry

A registry is the container that holds your artifacts. Give it a name, pick a type, and you are done in about 30 seconds.

  1. Select + Create Registry.

  2. Specify a Registry name. Names must start with a letter, can only contain lowercase alphanumerics, hyphens (-), underscores (_), and periods (.), and must be unique to your Harness account.

  3. Optionally, add a Description.

  4. Choose visibility between Public and Private. The default is Private.

  5. Select Docker as the Registry type.

  6. Select Save.

  7. Select Create to finalize.

Your registry is ready. The URL you will use in your client is:

  1. Select + Create Registry.

  2. Specify a Registry name. Names must start with a letter, can only contain lowercase alphanumerics, hyphens (-), underscores (_), and periods (.), and must be unique to your Harness account.

  3. Optionally, add a Description.

  4. Choose visibility between Public and Private. The default is Private.

  5. Select Maven as the Registry type.

  6. Select Save.

  7. Select Create to finalize.

Your registry is ready. The URL you will use in your client is:

  1. Select + Create Registry.

  2. Specify a Registry name. Names must start with a letter, can only contain lowercase alphanumerics, hyphens (-), underscores (_), and periods (.), and must be unique to your Harness account.

  3. Optionally, add a Description.

  4. Choose visibility between Public and Private. The default is Private.

  5. Select npm as the Registry type.

  6. Select Save.

  7. Select Create to finalize.

Your registry is ready. The URL you will use in your client is:

  1. Select + Create Registry.

  2. Specify a Registry name. Names must start with a letter, can only contain lowercase alphanumerics, hyphens (-), underscores (_), and periods (.), and must be unique to your Harness account.

  3. Optionally, add a Description.

  4. Choose visibility between Public and Private. The default is Private.

  5. Select Python as the Registry type.

  6. Select Save.

  7. Select Create to finalize.

Your registry is ready. The URL you will use in your client is:

  1. Select + Create Registry.

  2. Specify a Registry name. Names must start with a letter, can only contain lowercase alphanumerics, hyphens (-), underscores (_), and periods (.), and must be unique to your Harness account.

  3. Optionally, add a Description.

  4. Choose visibility between Public and Private. The default is Private.

  5. Select NuGet as the Registry type.

  6. Select Save.

  7. Select Create to finalize.

Your registry is ready. The URL you will use in your client is:

  1. Select + Create Registry.

  2. Specify a Registry name. Names must start with a letter, can only contain lowercase alphanumerics, hyphens (-), underscores (_), and periods (.), and must be unique to your Harness account.

  3. Optionally, add a Description.

  4. Choose visibility between Public and Private. The default is Private.

  5. Select Helm OCI as the Registry type.

  6. Select Save.

  7. Select Create to finalize.

Your registry is ready. The URL you will use in your client is:

  1. Select + Create Registry.

  2. Specify a Registry name. Names must start with a letter, can only contain lowercase alphanumerics, hyphens (-), underscores (_), and periods (.), and must be unique to your Harness account.

  3. Optionally, add a Description.

  4. Choose visibility between Public and Private. The default is Private.

  5. Select Generic as the Registry type.

  6. Select Save.

  7. Select Create to finalize.

Your registry is ready. Files you upload are available under:


Step 3: Generate an identity token

Your identity token is the password your tools use to authenticate with the registry. You generate it directly from the registry you just created.

  1. Open your registry. Select Set Up Client, which appears in the row menu on the Registries list and at the top of the registry detail page.

  2. Select Generate Token.

  3. Select an Expiration for the token:

    • 30 Days

    • 90 Days

    • 180 Days

    • Custom

  4. Copy the token now; it is shown only once.

Store it somewhere safe, like a password manager or secrets vault, before closing the panel.


Step 4: Connect your client and push

Now point your local tools at the registry and push something. In the commands below, replace the placeholders with your real values: <account-id> and <registry-name> are both visible in the registry URL from Step 2, and <identity-token> is the token you just copied.

Log in to the registry

At the prompts, enter your Harness account email as the Username and <identity-token> as the Password.

Tag a local image for the registry

Push the image

Pull the image back down

Tell Maven where to publish: add this to pom.xml

Add your credentials: create or update ~/.m2/settings.xml (macOS/Linux) or %USERPROFILE%\.m2\settings.xml (Windows)

The <id> here must match the one you used in pom.xml.

Push your artifact

Pull a dependency

Add a <repositories> block to pom.xml with the same <id> and URL, then resolve:

Point npm at your registry: create or update ~/.npmrc

Publish a package

Install a package from the registry

Configure Twine: create or update ~/.pypirc

Build and publish your package

Install a package from the registry

Encode @ as %40 in your email address in the URL (for example, user@example.com becomes user%40example.com).

Add the registry as a package source

Push a package

Install a package from the registry

Log in to the registry

At the prompts, enter your Harness account email as the Username and <identity-token> as the Password.

Package and push a chart

Pull a chart

Publish a file

Download the file


Step 5: Verify your artifact in the registry

Head back to Artifact Registry and confirm the push worked.

  1. In Artifact Registry, select Artifacts in the left navigation.

  2. Find your artifact in the list. The row should show the artifact name and, for Docker images, the tag you pushed.

  3. Select the artifact row to open the version detail page. Confirm the following to verify the push was successful:

    • The digest matches what your CLI reported after the push.

    • For Docker images: the Artifact Details tab shows the image layers.

    • For Maven: the Artifact Details tab lists the .jar, .pom, and checksum files.

    • For npm, PyPI, NuGet, Helm: the Overview tab shows the version and package metadata.

    • For Generic: the Overview tab shows the file name, size, and checksum.

  4. The Vulnerabilities column on the Artifacts list updates automatically once the security scan completes; it may show Not scanned for a minute or two while the evaluation runs.


What to do next

Now that your registry is running, here are the most useful things to set up:

  • Scan for vulnerabilities: Go to Configure security scanning to turn on Aqua Trivy or Grype. Every artifact you push is evaluated automatically, and anything that fails a policy gets quarantined before it can cause problems downstream.

  • Cache upstream packages: Go to Add and prioritise upstream proxies to pull and cache artifacts from Docker Hub, Maven Central, npm, PyPI, and other sources. Your builds stop hitting rate limits and keep working even when upstream registries are down.

  • Clean up old versions automatically: Go to Create a lifecycle rule to set policies that delete artifact versions based on age, usage, or count. Storage stays tidy without manual intervention.

Last updated

Was this helpful?