Have a question? Want to report an issue? Contact JFrog support

Skip to end of metadata
Go to start of metadata

Overview

Artifactory offers fully-featured operation with Helm through support for local, remote and virtual Helm chart repositories.

Artifactory's support for Helm charts includes:

  1. Secure, private repositories for Helm charts with fine-grained access control according to projects or development teams.
  2. Calculation of metadata for Helm charts hosted in Artifactory local repositories.
  3. Access to remote Helm chart repositories (in particular the Helm stable public repository and Official incubator repository) through remote repositories which provide proxy and caching functionality.
  4. Enterprise features such as high availability, repository replication for multi-site development and different options for massively scalability storage

For now, to use Artifactory as your Helm chart repository with authenticated access, you need to download the JFrog Helm client.

Page Contents


The JFrog Helm Client

Currently, the  public Helm client does not support authentication and can, therefore, only be used to access Artifactory anonymously. To allow authenticated access to Artifactory, JFrog has forked the public Helm client OSS project and added authentication capabilities.

Download the JFrog Helm client for authenticated access

To use all features of Artifactory Helm chart repositories, including resolution of Helm charts, you must use the JFrog Helm client for authenticated access to Artifactory.

The JFrog Helm client is available for download from JFrog Bintray.

The JFrog Helm client source files are available in JFrog's GitHub repository

Once JFrog's pull request has been accepted, you will be able to use the public Helm client for authenticated access to Artifactory.

Configuring the Helm Client

Before you can use the JFrog Helm client to resolve Helm charts from Artifactory, you need to configure it for authenticated access with your Artifactory user and password by adding the virtual Helm chart repository to be used for resolution as shown below:

helm repo add <REPO_KEY> http://<ARTIFACTORY_HOST>:<ARTIFACTORY_PORT>/artifactory/<REPO_KEY> <USERNAME> <PASSWORD>
helm repo update

For example:

helm repo add helm-virtual http://10.1.16.114:32775/artifactory/helm-virtual admin password
helm repo update

Use an encrypted password

We recommend using an encrypted password instead of clear-text. For details, please refer to Centrally Secure Passwords.


Configuration

Local Repositories

To enable calculation of Helm chart metadata, set Helm to be the Package Type when you create your local repository.

Resolving Helm charts

Artifactory only supports resolution of Helm charts from virtual repositories.

Remote Repositories

You can create Helm remote repository to proxy and cache remote repositories or other Artifactory instances.

In order for Artifactory to properly cache Helm charts, resolve the charts only through a virtual repository.

Virtual Repositories

A Virtual Repository defined in Artifactory aggregates packages from both local and remote repositories.

This allows you to access both locally hosted Helm charts and remote proxied Helm charts repositories from a single URL defined for the virtual repository.

To define a virtual Helm chart repository, create a virtual repository, set the Package Type to be Helm, and select the underlying local and remote Helm repositories to include in the Basic settings tab.

This repository will be configured in the Helm client.


Resolving Helm Charts

Virtual Repositories Only

Artifactory only supports resolution of Helm charts from virtual Helm chart repositories. To resolve Helm charts from other local or remote Helm chart repositories, you need to aggregate them in a virtual Helm chart repository.

To resolve a Helm chart through Artifactory, use the following command:

helm install <VIRTUAL_REPO_NAME>/<CHART_NAME>

For example:

helm install helm-virtual/artifactory

 


Deploying Helm Charts

Deploying Helm charts is done using cURL, Wget, JFrog CLI or any of the ways described in Deploying Artifacts

Setting the Default Deployment Repository 

To deploy Helm charts to a virtual Helm repository, make sure you have set the Default Deployment Repository

Reindexing a Helm Chart repository

You can trigger an asynchronous reindexing of a local Helm chart repository either through the UI or using the REST API.

Through the UI, select your Helm chart repository in the Tree Browser and select Recalculate Index from the right-click menu as shown below (requires Admin privileges)

To reindex a Helm chart repository through the REST API, please refer to Calculate Helm Chart Index 


Viewing Individual Helm Chart Information

Artifactory displays selected metadata of a Helm chart in its UI. 
Artifactory lets you view selected metadata of a Helm chart directly from the UI.

In the Tree Browser, select your virtual Helm chart repository and drill down to find and select the package you want to inspect. The metadata is displayed in the Chart Info tab. 

 


Watch the Screencast

 

 

  • No labels