Artifact Hub is able to process chart repositories as defined by the Helm project. For more information about the repository structure and different options to host your own, please check their documentation.
Most of the metadata Artifact Hub needs is extracted from the
Chart.yaml file and other files in the chart package, like the
LICENSE files. However, there is some extra Artifact Hub specific metadata that you can set using some special annotations in the
Chart.yaml file. For more information, please see the Artifact Hub Helm annotations documentation.
There is an extra metadata file that you can add at the repository URL’s path named artifacthub-repo.yml, which can be used to setup features like Verified publisher or Ownership claim. Please note that the artifacthub-repo.yml metadata file must be located at the same level of the chart repository index.yaml file, and it must be served from the chart repository HTTP server as well.
Once you have added your repository, you are all set up. As you add new versions of your charts or even new charts to your repository, they’ll be automatically indexed and listed in Artifact Hub.
Artifact Hub is able to process chart repositories stored in OCI registries.
To add a repository stored in a OCI registry, the url used must follow the following format:
Each of the chart versions are expected to match an OCI reference tag, which are expected to be valid semver versions. OCI specific installation instructions will be provided in the Artifact Hub UI when appropriate (only for Helm >=3.7). For additional information about Helm OCI support, please see the HIP-0006.
There is an extra Artifact Hub specific metadata file named artifacthub-repo.yml, which can be used to setup features like Verified publisher or Ownership claim. Once your repository metadata file is ready, you can push it to the OCI registry using oras:
oras push \ registry/namespace/chart-name:artifacthub.io \ --config /dev/null:application/vnd.cncf.artifacthub.config.v1+yaml \ artifacthub-repo.yml:application/vnd.cncf.artifacthub.repository-metadata.layer.v1.yaml
The repository metadata file is pushed to the registry using a special tag named
artifacthub.io. Artifact Hub will pull that artifact looking for the
application/vnd.cncf.artifacthub.repository-metadata.layer.v1.yaml layer when the repository metadata is needed.
Please note that there are some features that are not yet available for Helm repositories stored in OCI registries:
- Force an existing version to be reindexed by changing its digest