Custom catalogs can be added into Rancher at any scope of Rancher.

Adding Global Catalogs

Prerequisites: In order to manage the built-in catalogs or manage global catalogs, you need one of the following permissions:

  1. From the Global view, choose Tools > Catalogs in the navigation bar. In versions prior to v2.2.0, you can select Catalogs directly in the navigation bar.
  2. Click Add Catalog.
  3. Complete the form and click Create.

Result: Your custom global catalog is added to Rancher. Once it is in Active state, it has completed synchronization and you will be able to start deploying multi-cluster apps or applications in any project from this catalog.

Adding Cluster Catalogs

Available as of v2.2.0

Prerequisites: In order to manage cluster scoped catalogs, you need one of the following permissions:

  1. From the Global view, navigate to your cluster that you want to start adding custom catalogs.
  2. Choose the Tools > Catalogs in the navigation bar.
  3. Click Add Catalog.
  4. Complete the form. By default, the form will provide the ability to select Scope of the catalog. When you have added a catalog from the Cluster scope, it is defaulted to Cluster.
  5. Click Create.

Result: Your custom cluster catalog is added to Rancher. Once it is in Active state, it has completed synchronization and you will be able to start deploying applications in any project in that cluster from this catalog.

Adding Project Level Catalogs

Available as of v2.2.0

Prerequisites: In order to manage project scoped catalogs, you need one of the following permissions:

  1. From the Global view, navigate to your project that you want to start adding custom catalogs.
  2. Choose the Tools > Catalogs in the navigation bar.
  3. Click Add Catalog.
  4. Complete the form. By default, the form will provide the ability to select Scope of the catalog. When you have added a catalog from the Project scope, it is defaulted to Cluster.
  5. Click Create.

Result: Your custom project catalog is added to Rancher. Once it is in Active state, it has completed synchronization and you will be able to start deploying applications in that project from this catalog.