|
| 1 | +--- |
| 2 | +title: Exploring the Catalog |
| 3 | +weight: 3 |
| 4 | +description: "Discover how to browse, find, and interact with designs in the Catalog." |
| 5 | +categories: [Catalog] |
| 6 | +tags: [Designer] |
| 7 | +--- |
| 8 | + |
| 9 | +[Meshery Catalog](https://cloud.layer5.io/catalog) is the central hub for well-architected cloud native patterns and best practices templates. Here, you can discover and share designs with the wider community. |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +## Viewing Catalog Items |
| 14 | + |
| 15 | +Meshery Catalog displays all published designs in an organized, searchable format. |
| 16 | + |
| 17 | +### Top Performers |
| 18 | + |
| 19 | +At the top of the page, you can find the **Top Performers** section. This provides a snapshot of the **Leaderboard**, highlighting the most popular designs based on various [metrics](/cloud/catalog/metrics/). |
| 20 | +- To see the complete rankings, click the **Open Leaderboard** button. |
| 21 | +- You can toggle the visibility of this section using the **Hide Performers** / **Show Performers** button. |
| 22 | + |
| 23 | +{{< alert type="info" title="Learn More About Leaderboard" >}} |
| 24 | +To learn more about Leaderboard, see the [Leaderboard documentation](/cloud/catalog/leaderboard/). |
| 25 | +{{< /alert >}} |
| 26 | + |
| 27 | +### Grid View |
| 28 | + |
| 29 | +The grid view offers a visual, card-based layout that's ideal for browsing designs by their thumbnail. |
| 30 | + |
| 31 | +Each card provides key information at a glance: |
| 32 | +- **Class:** The banner in the top-left corner shows the design's classification (e.g., Official) |
| 33 | +- **Type:** The tag in the top-right corner indicates the design's category (e.g., Deployment) |
| 34 | +- **Metrics:** A row of icons at the bottom displays key usage statistics (Opens, Downloads, Deploys, Clones, Shares) |
| 35 | +- **Detailed Information (on hover):** When you hover over a card, it flips to reveal more details, including the author, design version, technologies used, and the last updated time |
| 36 | + |
| 37 | +<img src="/cloud/catalog/images/card-view.png" alt="Card View" style="width: 40%" /> |
| 38 | + |
| 39 | +{{< alert type="info" title="Understanding Design Metrics" >}} |
| 40 | +To better understand what these Metrics represent, you can learn more about [design metrics](/cloud/catalog/metrics/). |
| 41 | +{{< /alert >}} |
| 42 | + |
| 43 | +### Table View |
| 44 | + |
| 45 | +Table view provides a dense, list-based format that's ideal for sorting and comparing items based on specific metrics. |
| 46 | + |
| 47 | +To customize the information displayed in this view, click the **View Columns icon** and select the attributes you want to see, such as Author, Created At, or Downloads. |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | +## Filtering and Sorting Catalog Items |
| 52 | + |
| 53 | +The filter bar helps you narrow down the catalog to find exactly what you need. You can sort the entire catalog or apply specific filters. |
| 54 | + |
| 55 | +### Sort By |
| 56 | +You can order all items in the catalog based on different criteria, such as alphabetically, by most recently updated, or by popularity metrics like most cloned or downloaded. |
| 57 | + |
| 58 | +### Owner |
| 59 | +Filter designs based on their owner, whether it's your entire Organization, specific Teams, or an individual Author. |
| 60 | + |
| 61 | +### Class |
| 62 | + |
| 63 | +The **Class** filter helps you find content based on its level of verification: |
| 64 | + - **Official:** Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. |
| 65 | + - **Verified:** Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. |
| 66 | + - **Community:** Content produced and shared by Meshery users. This includes a wide range of content with varying levels of support and reliability. |
| 67 | + |
| 68 | +### Technology and Type |
| 69 | +These filters correspond to the metadata authors provide when they publish designs. They allow you to find items based on the technologies they use or the function they perform. |
| 70 | + - **Technology:** A list of technologies included in the design, like `Argo CD`, `AWS API Gateway`, or `Apache ShardingSphere`. |
| 71 | + - **Type:** The category of the design, such as `deployment`, `observability`, `resiliency`, or `traffic-management`. |
| 72 | + |
| 73 | +## Viewing Design Details |
| 74 | + |
| 75 | +When you click on any design, you'll see its detail page. This page provides a complete overview of the design's purpose, technical details, and how you can use it. |
| 76 | + |
| 77 | + |
| 78 | + |
| 79 | +### Key Information |
| 80 | + |
| 81 | +- **Class, Created By, and Dates:** See the design's class, its original author, and when it was created and last updated. |
| 82 | +- **Version:** The design's version number. This increments automatically each time the design is updated. |
| 83 | +- **Visibility:** The status of the design. For all designs found in the public catalog, this will be **Published**. |
| 84 | + |
| 85 | +As you scroll down the page, you will find other useful sections: |
| 86 | + |
| 87 | +- **Caveats and Considerations:** Specific stipulations to consider and known behaviors to be aware of when using this design. |
| 88 | +- **Similar Designs by Type:** At the bottom, other designs of the same type, helping you discover other relevant patterns. |
| 89 | + |
| 90 | +## Available Actions |
| 91 | + |
| 92 | +### Open in Playground |
| 93 | + |
| 94 | +Clicking **Open in Playground** loads the design directly into [Kanvas](https://kanvas.new/). |
| 95 | + |
| 96 | +### Clone |
| 97 | + |
| 98 | +Cloning creates a personal, editable copy of the design in your own workspace. This is useful when you want to use an existing public design as a starting point for your own customizations. |
| 99 | + |
| 100 | +When you clone a design: |
| 101 | +- The new copy will appear in your **[My Designs](https://cloud.layer5.io/catalog/content/my-designs)** tab. |
| 102 | +- Its name will be appended with `(Copy)` to distinguish it from the original. |
| 103 | +- The visibility of the cloned design is set to **Private** by default, so only you can see it until you decide to publish it. |
| 104 | + |
| 105 | +### Download |
| 106 | + |
| 107 | +The **Download** button allows you to save the design as a `Meshery Design (YAML)` file. This is useful for offline backups or sharing the file directly. |
| 108 | + |
| 109 | +> For more advanced use cases, Meshery also supports exporting designs into other formats. To learn more, see the guide on [Exporting Designs](/kanvas/designer/export-designs/). |
| 110 | +
|
| 111 | +{{< alert type="warning" title="Metadata Not Included in Download" >}} |
| 112 | +Design downloads include only the core YAML definition, excluding associated catalog metadata such as descriptions, technology, or class. |
| 113 | +{{< /alert >}} |
| 114 | + |
| 115 | +### Edit |
| 116 | + |
| 117 | +After you've published a design, you might need to update its metadata or description. Clicking the **Edit** button opens a dialog where you can make your changes. |
| 118 | + |
| 119 | + |
| 120 | + |
| 121 | +You can modify the following fields: |
| 122 | +- **Type:** Change the design's category. |
| 123 | +- **Technology:** Add or remove associated technology tags. |
| 124 | +- **Description:** Update the main purpose and intended uses of the design. |
| 125 | +- **Caveats and Considerations:** Revise any special stipulations or known behaviors. |
| 126 | + |
| 127 | +{{< alert type="warning" title="Immutable Properties" >}} |
| 128 | +Some properties of a published design are immutable and cannot be changed: |
| 129 | +- **Name:** The original name of the published design cannot be modified. |
| 130 | +- **Visibility:** You cannot change a published design's visibility directly. To remove it from the catalog, you must **Unpublish** it instead. |
| 131 | +{{< /alert >}} |
| 132 | + |
| 133 | +### Unpublish |
| 134 | + |
| 135 | +If you no longer want a design to be published in the catalog, you can use the **Unpublish** button. This action will remove the design from Meshery Catalog but does **not delete** it. The design will remain as a private design in your account. |
| 136 | + |
| 137 | +{{< alert type="info" title="Permissions Required" >}} |
| 138 | +Editing/Unpublish published designs requires specific user roles and permissions. Learn more: [Default Permissions documentation](/cloud/reference/default-permissions/). |
| 139 | +{{< /alert >}} |
0 commit comments