Publishing Meshery Designs to Artifact Hub

In this tutorial, we'll see how to export a design from Meshery, which we will use to populate an Artifact Hub repository.

Prerequisites

1. Access to Meshery. Install Meshery or access the Meshery Playground.
2. An Artifact Hub repository.

Steps

1. Navigate to the Designs page. You can access it from the left-hand menu in Meshery. The URL will be:
   • Locally: http://localhost:9081/configuration/designs?view=grid
   • Playground: https://playground.meshery.io/configuration/designs?view=grid

{{% alert color="info" title="Can't find your design?" %}} If you don't see your design, check your Organization and Workspace selections.

If you don't have any designs, you can create one by following the Create a Design tutorial. {{% /alert %}}

2. Click to download your design. You can find the download button in the design's card in the grid view, or in the design's details page. This will download a tar archive containing your design and the metadata files to publish it to Artifact Hub.

3. Prepare your Artifact Hub repository. You will need to have an Artifact Hub repository already created with Kind as Meshery Designs. See Artifact Hub documentation for more information on managing repositories.

Push Design to Artifact Hub repository

At this point, you should have downloaded your design as a tar archive. This archive contains a second archive which holds the metadata files to publish to your Artifact Hub repository. Expand the first tar archive and locate the resulting files. Expand the second archive you find there and you will have a folder containing two files: artifacthub-pkg.yml and design.yml. Move these files to your prepared Artifact Hub repository and push it upstream.

Verify repository in Artifact Hub

Once the files are pushed to the Artifact Hub repo you will need to wait until Artifact Hub indexes it. You can verify the status of the repository in the Artifact Hub control panel.