App Catalogs
A catalog is a library of curated Helm charts available for team members to deploy. Each catalog is hosted in a Git repository that contains Helm chart source code, with each chart stored in a separate directory. The catalog version refers to the Git repository tag, not the individual Helm chart versions contained within the catalog. As a platform administrator, you manage and register catalogs in the platform view.
Manage catalogs
Platform administrators manage catalogs through the Catalogs page in the platform view. Each catalog has a version that is set during registration and can be updated at any time.
Changing a catalog version does not affect existing team workloads. Version changes only apply to new workloads deployed from that catalog.
Add a catalog
To add a new catalog:
- Navigate to the platform view and select Catalogs from the sidebar.
- Click the Create Catalog button.
- Fill in the required fields:
- Catalog name
- Git Repository URL
- Git Tag
- Fill in the optional fields:
- Charts directory path
- Click Test Connection to verify platform access to the repository.
- Check the Enabled checkbox if you want the catalog to be immediately available to teams.
- Click Create Catalog to complete the registration.
Once created and enabled, the catalog becomes available for teams to use.
The Test Connection feature only verifies that the platform can access the repository URL. It does not validate whether the branch exists or contains valid chart content.
Edit a catalog
To edit an existing catalog:
- Navigate to the platform view and select Catalogs from the sidebar.
- Click on the catalog you want to edit from the table.
- Modify any of the following:
- Git Repository URL
- Git Tag
- Enabled status
Changes take effect immediately for new workload deployments.
Remove a catalog
To remove a catalog:
- Navigate to the platform view and select Catalogs from the sidebar.
- Click on the catalog you want to remove from the table.
- Click the Delete button.
Removing a catalog does not affect already deployed workloads that use charts from this catalog. Those workloads will continue to run normally.
Manage catalog content
Catalog content consists of Helm charts stored in the catalog's Git repository. The repository owner manages chart content directly in the Git repository.
Catalog content management operations include:
- Adding a new Helm chart to an existing catalog.
- Editing a Helm chart in an existing catalog.
- Removing a Helm chart from an existing catalog.
Content changes do not affect existing workloads as long as those workloads reference immutable Git tags.
Best practices for catalog management
Follow these recommendations to ensure reliable catalog operations:
- Use immutable Git tags (not branches) for catalog registration to ensure stable and repeatable deployments.
- Follow semantic versioning (SemVer) for catalog tags.
- Keep catalogs small. More than fifteen Helm charts in a given catalog is a signal to consider dividing it into smaller catalogs.
- Bump the catalog major version for breaking chart changes, and minor/patch versions for backward-compatible updates and fixes.
- Validate chart updates in a non-production environment before promoting a new catalog tag in the App Platform.
- Maintain release notes for each catalog tag so teams can see what changed and plan workload upgrades.
- Communicate to teams that they can upgrade existing workloads individually after a catalog update, as workload versions do not update automatically.
Updated 12 days ago
