Cloud customer?
Start for Free >
Upgrade in MyJFrog >
What's New in Cloud >

Search





Overview

The HelmChart resource maps to a specific chart in an Artifactory Helm Repository.


The HelmChart resource can be used in two native steps.  The HelmPublish step takes a HelmChart as a required outputResource .  HelmPublish will create a new version of the chart, push it to Artifactory, and store the new version in the HelmChart resource.  Then that HelmChart resource can be used as an inputResource  to the HelmDeploy native step. This will automatically download the HelmChart, and use the Helm CLI to deploy it to the configured cluster.

Page Contents


YAML Schema

resources:
  - name: 		<string>
     type: 		HelmChart
     configuration:
       sourceArtifactory:    artifactoryIntegration
       repository:           <string>
       chart:                <string>
       version:              <version string>

Tags

name 

An alphanumeric string (underscores are permitted) that identifies the resource.

type 

Must be HelmChart for this resource type.

configuration

Specifies all configuration selections for the resource.

Tag

Description

Required/Optional
sourceArtifactory The name of an Artifactory IntegrationRequired
repository The name of the Helm repository in ArtifactoryRequired
chartThe name of the Helm chartRequired
version A string that identifies the version number of the Helm chartRequired

Environment Variables

Whenever HelmChart is used in a step, a set of environment variables is automatically made available that you can use in your step.

Environment Variable

Description

res_<resource_name>_name
Name of the resource
res_<resource_name>_sourceArtifactory
The name of the Helm repository in Artifactory
res_<resource_name>_chart
The name of the Helm chart
res_<resource_name>_version 
A string that identifies the version number of the Helm chart

Example

resources:
  - name: git_repo
    type: GitRepo
    configuration:
      gitProvider: git_r
      path: jfrog/charts
   
  - name: helm_repo
    type: HelmChart
    configuration: 
      sourceArtifactory: art_r
      repository: helm-local/
      chart: test
      version: 1.0.0

pipelines:
  - name: test_helm
    configuration:
      nodePool: win_2019

    steps:
      - name: helm_pub
        type: HelmPublish
        configuration:
          chartPath: ./simplehelm
 
          inputResources:
            - name: git_repo                    
          outputResources:
            - name: helm_repo                  # required
 
        execution:
          onStart:
            - write-output "executing step..."
            - Get-Variable | format-table
          onSuccess:
            - write-output "executing step..."
            - Get-Variable | format-table
          onFailure:
            - write-output "executing step..."
            - Get-Variable | format-table

          onComplete: #always
            - write-output "executing step..."
            - Get-Variable | format-table


Copyright © 2021 JFrog Ltd.