url:"/managed-helm-repository"

-title:Helm Charts and repositories

url:"/helm-charts-and-repositories"

-title:CustomHelmuploads

-title:Creating and uploadingHelmpackages

url:"/custom-helm-uploads"

-title:Promoting Helm environments

url:"/helm-environment-promotion"

This pipeline references some predefined environment variables such as`GOOGLE_BUCKET_NAME`,`GOOGLE_PROJECT_ID` and`GOOGLE_CREDENTIALS`.

For this example, we created a service account with appropriate permissions in Google Cloud, and saved the credentials into`GOOGLE_CREDENTIALS` as a Codefresh Secret. <br>

For more information, see:

[Authenticating with Google services](https://cloud.google.com/storage/docs/authentication#service_accounts){:target="_blank"}. <br>

[Codefresh pipeline configuration and secrets](https://codefresh.io/docs/docs/codefresh-yaml/variables/#user-provided-variables){:target="_blank"}.

[Authenticating with Google services](https://cloud.google.com/storage/docs/authentication#service_accounts){:target="_blank"}

[Codefresh pipeline configuration and secrets]({{site.baseurl}}/pipelines/variables/#user-provided-variables)

Chart Museum is a Helm repository*server* that has an HTTP API, pluggable backends, authentication, and more.

[Using Helm in a Codefresh pipeline]({{site.baseurl}}/docs/deployments/helm/using-helm-in-codefresh-pipeline/)

[Using a managed Helm repository]({{site.baseurl}}/docs/deployments/helm/managed-helm-repository/)

[Helmenvironment promotion]({{site.baseurl}}/docs/deployments/helm/helm-environment-promotion)

[PromotingHelmenvironments]({{site.baseurl}}/docs/deployments/helm/helm-environment-promotion)

title:"Using externalHelmrepos in Codefresh pipelines"

description:"Use external HelmCharts and repositories in Codefresh pipelines"

title:"Helmcharts and repositories"

description:"Use external Helmcharts and repositories in Codefresh pipelines"

group:deployments

sub_group:helm

toc:true

Easily add your own Helm charts.

By default, we show charts from the[official Helm repository](https://github.com/kubernetes/charts){:target="_blank"}.

1. In the Codefresh UI, fromtheArtifacts section in the sidebar, select[**Helm Charts**](https://g.codefresh.io/helm/releases/releasesNew/){:target="\_blank"}.

1. In the Codefresh UI, from Artifacts in the sidebar, select[**Helm Charts**](https://g.codefresh.io/helm/releases/releasesNew/){:target="\_blank"}.

1. On the top right, click**Add Existing Helm Repository**.

You are taken to Pipeline Integrations.

1. In the Integrations page, click**Add Helm Repository**, and then select the type of Helm repo to add from the list.

* Variables available for custom pipelines:

If you select a custom pipeline, the following variables are available:

*`CF_HELM_RELEASE` - name of release

*`CF_HELM_KUBE_CONTEXT` - kubectl context name of target cluster (cluster name from[dashboard]({{site.baseurl}}/docs/deploy-to-kubernetes/manage-kubernetes/#work-with-your-services))

*`CF_HELM_KUBE_CONTEXT` - kubectl context name of target cluster (cluster name from[dashboard]({{site.baseurl}}/docs/deployments/kubernetes/manage-kubernetes/#work-with-your-services))

*`CF_HELM_INSTALLATION_NAMESPACE` - desired namespace for the release

*`CF_HELM_CHART_VERSION` - Chart Version,

*`CF_HELM_CHART_NAME` - Chart Name

*`CF_HELM_CONTEXTS` - values from[shared configuration]({{site.baseurl}}/docs/pipelines/shared-configuration/#using-shared-helm-values)

*`CF_HELM_CONTEXTS` - values from[shared configuration]({{site.baseurl}}/docs/pipelines/configuration/shared-configuration/#using-shared-helm-values)

*`CF_HELM_VALUES` - extra values

*`CF_HELM_SET` - extra values,

*`CF_HELM_CHART_REPO_URL` - URL of Chart repository

<br />

**Before you begin**

* Make suretht you have a Kubernetes integration with the cluster and namespace, as described[here]({{site.baseurl}}/docs/deploy-to-kubernetes/add-kubernetes-cluster/)

* Make surethat you have a Kubernetes integration with the cluster and namespace, as described[here]({{site.baseurl}}/docs//integrations/kubernetes/#connect-a-kubernetes-cluster)

**How to**

1. In the Codefresh UI, fromtheArtifacts section in the sidebar, select[**Helm Charts**](https://g.codefresh.io/helm/releases/releasesNew/){:target="\_blank"}.

1. In the Codefresh UI, from Artifacts in the sidebar, select[**Helm Charts**](https://g.codefresh.io/helm/releases/releasesNew/){:target="\_blank"}.

1. In the row with the chart to install, click**Install**.

1. Enter the**Release name** for the chart, and select the**Chart version** to install.

1. From Cluster Information, select a Kubernetes**Cluster** and the**Namespace** to install to.

[Using Helm in a Codefresh pipeline]({{site.baseurl}}/docs/deployments/helm/using-helm-in-codefresh-pipeline/)

[Helm integrations]({{site.baseurl}}/docs/integrations/helm/)

[Helm Dashboard]({{site.baseurl}}/docs/deployments/helm/helm-releases-management)

[Helm best practices]({{site.baseurl}}/docs/ci-cd-guides/helm-best-practices/)

sub_group:helm

toc:true

Apart from the[Helm Releases]({{site.baseurl}}/docs/deployments/helm/helm-releases-management) thatshow your Kubernetes clusters at the application level, Codefresh also comes with a special environment board that allows you to track one or more applications as they move within your infrastructure (example, Dev, QA, Prod).

Apart from the[Helm Releases]({{site.baseurl}}/docs/deployments/helm/helm-releases-management)dashbaordthatshows your Kubernetes clusters at the application level, Codefresh also comes with a special environment board that allows you to track one or more applications as they move within your infrastructure (example, Dev, QA, Prod).

The environment board can function both as an overview of the whole lifecycle of the application, as well as a tool to shift-left/right Helm releases between environments.

Create your own Helm board with a single or multiple Helm applications. You can create as many boards as you want.

1. In the Codefresh UI, fromtheDevOps Insights section in the sidebar, select[**Helm Boards**](https://g.codefresh.io/helm/helm-kanban/){:target="\_blank"}.

1. In the Codefresh UI, from DevOps Insights in the sidebar, select[**Helm Boards**](https://g.codefresh.io/helm/helm-kanban/){:target="\_blank"}.

{% include

image.html

max-width="40%"

%}

By default Codefresh will use a built-in install/upgrade pipeline for performing the promotion. You can choose your own pipeline from the promotion dialog. That pipeline will be automatically provided with the following[environment variables]({{site.baseurl}}/docs/deployments/helm/helm-releases-management/#overriding-the-default-helm-actions):

By default Codefresh will use a built-in install/upgrade pipeline for performing the promotion. You can choose your own pipeline from the promotion dialog. That pipeline will be automatically provided with the following[environment variables]({{site.baseurl}}/docs/deployments/helm/helm-releases-management/#environment-variables-for-custom-helm-commands):

*`CF_HELM_RELEASE` - name of release

*`CF_HELM_KUBE_CONTEXT` -`kubectl` context name of target cluster (cluster name from[dashboard]({{site.baseurl}}/docs/deploy-to-kubernetes/manage-kubernetes/#work-with-your-services))

*`CF_HELM_KUBE_CONTEXT` -`kubectl` context name of target cluster (cluster name from[dashboard]({{site.baseurl}}/docs/deployments/kubernetes/manage-kubernetes/#work-with-your-services))

*`CF_HELM_NAMESPACE` - Tiller Namespace if you use Helm 2

*`CF_HELM_INSTALLATION_NAMESPACE` - namespace where release is promoted to

*`CF_HELM_CONTEXTS` -[shared configuration]({{site.baseurl}}/docs/configure-ci-cd-pipeline/shared-configuration) Helm contexts

*`CF_HELM_CONTEXTS` -[shared configuration]({{site.baseurl}}/docs/pipelines/configuration/shared-configuration) Helm contexts

*`CF_HELM_VALUES` - Helm chart values

*`CF_HELM_SET` - Additional values there were overriden

*`CF_HELM_CHART_JSON_GZIP` - Gzipped JSON of Helm chart (only for Helm 3)

Note that the variable`CF_HELM_CHART_JSON_GZIP` is both compressed and base64 encoded. To get the raw value you need a command like`echo $CF_HELM_CHART_JSON_GZIP | base64 -d | gunzip`

Once you click the*update* button, a new build will run that will perform the deployment.

[Using Helm in a Codefresh pipeline]({{site.baseurl}}/docs/deployments/helm/using-helm-in-codefresh-pipeline/)

[Managing Helm releases]({{site.baseurl}}/docs/deployments/helm/helm-releases-management)

[Environment Dashboard]({{site.baseurl}}/docs/deploy-to-kubernetes/environment-dashboard/)

[Environment Dashboard]({{site.baseurl}}/docs/deployments/kubernetes/environment-dashboard/)

Codefresh has built-in integration for Helm that provides a unique view into your production Kubernetes cluster.

In Helm Releases, you can see the current status of your cluster, including the currently deployed releases, their previous revisions including change tracking, and even roll back to a previous release.

Codefresh also offers[an environment view for Helm releases]({{site.baseurl}}/docs/deploy-to-kubernetes/environment-dashboard/) as well as[a promotion dashboard]({{site.baseurl}}/docs/deployments/helm/helm-environment-promotion).

Codefresh also offers[an environment view for Helm releases]({{site.baseurl}}/docs/deployments/kubernetes/environment-dashboard/) as well as[a promotion dashboard]({{site.baseurl}}/docs/deployments/helm/helm-environment-promotion).

View all the Helm releases in your cluster, and drill down into a specific release to see its services, deployed versions, manifests and more.

1. In the Codefresh UI, fromtheDevOps Insights section in the sidebar, select[**Helm Releases**](https://g.codefresh.io/helm/releases/releasesNew/){:target="\_blank"}.

1. In the Codefresh UI, from DevOps Insights in the sidebar, select[**Helm Releases**](https://g.codefresh.io/helm/releases/releasesNew/){:target="\_blank"}.

{% include

image.html

You can set this message for your Helm release in three ways:

1. When you manually install a Helm release from the[Helm charts screen]({{site.baseurl}}/docs/deployments/helm/helm-charts-and-repositories/#install-chart-from-your-helm-repository), there is a field for this message.

1. When you manually install a Helm release from the[Helm charts screen]({{site.baseurl}}/docs/deployments/helm/helm-charts-and-repositories/#install-a-chart-from-your-helm-repository), there is a field for this message.

1. Set the property`commit_message` inside the[notes.txt](https://helm.sh/docs/chart_template_guide/notes_files/){:target="\_blank"} file of your chart.

1. By providing an environment variable called`COMMIT_MESSAGE` within your[pipelineHelm step]({{site.baseurl}}/docs/deployments/helm/using-helm-in-codefresh-pipeline/).

1. By providing an environment variable called`COMMIT_MESSAGE` within your[Helm pipeline step]({{site.baseurl}}/docs/deployments/helm/using-helm-in-codefresh-pipeline/).

max-width="50%"

%}

From the main release screen, you have some additional actions.

You can issue a[Helm test](https://github.com/kubernetes/helm/blob/master/docs/chart_tests.md) by clicking on the 'Run Test' button on the desired chart row.

You can issue aHelm test<!---[Helm test](https://github.com/kubernetes/helm/blob/master/docs/chart_tests.md)--> by clicking on the 'Run Test' button on the desired chart row.

You can delete a release by clicking on the 'Delete' button on the desired chart row.

For deletion options, see the[helm delete documentation](https://github.com/kubernetes/helm/blob/master/docs/helm/helm_delete.md){:target="\_blank"}, for example,*purge* will remove the revision from the release history.

Similar to a[build badge]({{site.baseurl}}/docs/pipelines/build-status/#using-the-build-badge), you can also get a deployment badge for a Helm release.

Similar to a[build badge]({{site.baseurl}}/docs/pipelines/configuration/build-status/#using-the-build-badge), you can also get a deployment badge for a Helm release.

1. In the Codefresh UI, from the DevOps Insights section in the sidebar, select[**Helm Releases**](https://g.codefresh.io/helm/releases/releasesNew/){:target="\_blank"}.

1. In the row with the Helm release for which to add a deployment badge, click the**Settings** (gear) icon.

You can override these actions for a specific Helm release by defining custom pipelines for each action. This way you can add your extra logic on top of these actions. For example your own Helm uninstall pipeline might also have a notification step that posts a message to a Slack channel after a release is removed.

1. In the Codefresh UI, from the DevOps Insights section in the sidebar, select[**Helm Releases**](https://g.codefresh.io/helm/releases/releasesNew/){:target="\_blank"}.

1. In the row with the Helm release for which to override default actions, click the**Settings** (gear) icon.

1. Select the pipeline to use for the respective actions.

If you do override any of these actions, the following[environment variables]({{site.baseurl}}/docs/codefresh-yaml/variables/) are available in the respective pipeline, so that you can use your own custom Helm command.

If you do override any of these actions, the following[environment variables]({{site.baseurl}}/docs/pipelines/variables/) are available in the respective pipeline, so that you can use your own custom Helm command.

**Helm Test pipeline**

*`CF_HELM_RELEASE`: Name of release

[Using Helm in a Codefresh pipeline]({{site.baseurl}}/docs/deployments/helm/using-helm-in-codefresh-pipeline/)

[Helm charts and repositories]({{site.baseurl}}/docs/deployments/helm/helm-charts-and-repositories/)

[Codefresh-managed HelmRepositories]({{site.baseurl}}/docs/deployments/helm/managed-helm-repository/)

[Helmpromotion boards]({{site.baseurl}}/docs/deployments/helm/helm-environment-promotion)

[Using amanaged Helmrepository]({{site.baseurl}}/docs/deployments/helm/managed-helm-repository/)

[PromotingHelmEnvironments]({{site.baseurl}}/docs/deployments/helm/helm-environment-promotion)

Replace values in`<>` with your own (also removing`<>` in the process).

Generate an api key from[https://g.codefresh.io/user/settings](https://g.codefresh.io/user/settings) as explained in the[API page]({{site.baseurl}}/docs/integrations/codefresh-api/).

Generate an API key from the Codefresh UI:

* From your avatar dropdown, select[**User Settings**](https://g.codefresh.io/user/settings){:target="\_blank"}. See[Codefresh API integration]({{site.baseurl}}/docs/integrations/codefresh-api/).

[Using Helm in a Codefresh pipeline]({{site.baseurl}}/docs/deployments/helm/using-helm-in-codefresh-pipeline/)