Skip to main content
Version: v2.0-v2.4

Custom Catalog Configuration Reference

Any user can create custom catalogs to add into Rancher. Besides the content of the catalog, users must ensure their catalogs are able to be added into Rancher.

Types of Repositories

Rancher supports adding in different types of repositories as a catalog:

  • Custom Git Repository
  • Custom Helm Chart Repository

Custom Git Repository

The Git URL needs to be one that git clone can handle and must end in .git. The branch name must be a branch that is in your catalog URL. If no branch name is provided, it will default to use the master branch. Whenever you add a catalog to Rancher, it will be available almost immediately.

Custom Helm Chart Repository

A Helm chart repository is an HTTP server that contains one or more packaged charts. Any HTTP server that can serve YAML files and tar files and can answer GET requests can be used as a repository server.

Helm comes with Helm serve, a built-in package server for developer testing. The Helm team has tested other servers, including Google Cloud Storage with website mode enabled, S3 with website mode enabled or hosting custom chart repository server using open-source projects like ChartMuseum.

In Rancher, you can add the custom Helm chart repository with only a catalog name and the URL address of the chart repository.

Catalog Fields

When adding your catalog to Rancher, you'll provide the following information:

NameName for your custom catalog to distinguish the repositories in Rancher
Catalog URLURL of your custom chart repository
Use Private CatalogSelected if you are using a private repository that requires authentication
Username (Optional)Username or OAuth Token
Password (Optional)If you are authenticating using a username, enter the associated password. If you are using an OAuth token, use x-oauth-basic.
BranchFor a Git repository, the branch name. Default: master. For a Helm Chart repository, this field is ignored.
Helm versionThe Helm version that will be used to deploy all of the charts in the catalog. This field cannot be changed later. For more information, refer to the section on Helm versions.

Private Repositories

Available as of v2.2.0

Private Git or Helm chart repositories can be added into Rancher using either credentials, i.e. Username and Password. Private Git repositories also support authentication using OAuth tokens.

Using Username and Password

  1. When adding the catalog, select the Use private catalog checkbox.

  2. Provide the Username and Password for your Git or Helm repository.

Using an OAuth token

Read using Git over HTTPS and OAuth for more details on how OAuth authentication works.

  1. Create an OAuth token with repo permission selected, and click Generate token.

  2. When adding the catalog, select the Use private catalog checkbox.

  3. For Username, provide the Git generated OAuth token. For Password, enter x-oauth-basic.