Browse the catalog in the Console
Use the Catalog page in the Console to find a package by name or by the APIs it introduces, read the schemas of those APIs, and see which control planes run the package.
Before you begin
- Sign in to the Hub Console.
- Your platform team turns on the
Catalogfeature flag. - At least one connected control plane installs Crossplane packages.
Open the catalog
Open the navigation menu, then choose Catalog under Insights. Each card is one package image, with its name, version, type, and how many control planes deploy it, or Not deployed:
The badges at the top of the page show your registry connections. See Check your registry connections.
Search the catalog
Type in the Search packages… box. Search matches a package's repository,
title, and description, and the kind, API group, version, short names, and
categories of every API it introduces. Searching bucket finds a package that
introduces a Bucket kind, even when its name doesn't contain bucket.
Filter and sort the catalog
- Select checkboxes under Type to show only Provider, Configuration, Function, or Container packages.
- Select Deployed or Not deployed under Deployment.
- Choose a sort order from the menu above the list: Name (A–Z), Name (Z–A), or Most deployed. While you search, Relevance is also available, and it's the default.
Inspect a package
Select a card to open the package's details. The Overview tab lists:
| Field | Shows |
|---|---|
| Repository | The package's OCI repository. |
| Version | The image tag. |
| Type | Provider, Configuration, Function, or Container. |
| Enrichment | How far Hub got reading the image: its status, such as succeeded or failed, and its level, from none to deep. |
| Digest | The image digest. |
| Discovered | When Hub first indexed the image. |
| Deployed on | How many control planes deploy the package. |
| APIs introduced | How many APIs the package introduces. |
Read an API's schema
- Open a package, then choose the APIs tab. Each API shows its kind, API group and version, and scope. A collapsed API also shows how many control planes and resources use it.
- Expand an API, then choose Schema to read its schema as YAML, or Control planes to see which control planes have resources of that kind, with their realm and resource count.
See where a package runs
Open a package, then choose the Deployed On tab. It lists each control plane that deploys the package, with its realm and resource count. Select a resource count to open the resource list, filtered to that control plane and the package's APIs.
Check your registry connections
Each badge at the top of the Catalog page is one registry connection, with a dot for its health:
| Dot | Means |
|---|---|
| Green | Hub verified the connection. |
| Red | Hub's last attempt to verify the connection, or to pull an image through it, failed. |
| Gray | Hub hasn't verified the connection yet. |
Hover over a badge to see its host, scope, authentication method, and number of repositories, when Hub last verified it, and the last error.
To add a connection, see Connect a registry.
Troubleshoot
| Symptom | Cause |
|---|---|
| Catalog is missing from the navigation menu | Your platform team hasn't turned on the Catalog feature flag. |
| A package a control plane runs is missing | Hub indexes a package when its package object is created after Catalog is on. See Requirements and limits. |
| Enrichment shows failed | Hub couldn't pull the image. Check the registry's connection. See Connect a registry. |
| The Deployed On tab says "This package is not installed on any control plane you can access." | No control plane you have permission to read deploys the package. See Access-scoped results. |
| A resource count in Deployed On isn't a link | The package introduces too many APIs on that control plane to filter the resource list by. |
| No connection badges appear | No realm you can read has a connection, or the Registry feature flag is off. |