Documentation

Welcome

Welcome to the Artifact Hub documentation. Artifact Hub is a web-based application that enables finding, installing, and publishing Kubernetes packages.

The documentation is organized in the following topics:

Topic Description
Repositories guide The repositories guide explains how to add repositories to Artifact Hub, as well as other related concepts like Verified Publisher or Ownership Claim.
Helm annotations Describes some custom annotations that allow enriching the existing metadata in Helm Charts to improve users' experience in Artifact Hub.
OLM annotations Describes some custom annotations that allow enriching the existing metadata in OLM operators to improve users' experience in Artifact Hub.
Krew annotations Describes some custom annotations that allow enriching the existing metadata in Krew kubectl plugins to improve users' experience in Artifact Hub.
Tekton annotations Describes some custom annotations that allow enriching the existing metadata in Tekton tasks to improve users' experience in Artifact Hub.
keptn annotations Describes some custom annotations that allow enriching the existing metadata in Keptn integrations to improve users' experience in Artifact Hub.
Packages security report Explains how packages are scanned for security vulnerabilities and the structure of the security report.
Authorization Explains how the authorization mechanism that allows organizations to define what actions can be performed by their members works and how to set it up.
Architecture Describes the components that form Artifact Hub, what each of them do and the layout of the source repository.
Development environment setup This guide will help contributors setup their development environment to do some work on Artifact Hub.
Infrastructure Describes the infrastructure used to deploy the production and staging environments of artifacthub.io.
CLI tool Explains how to install and use the Artifact Hub command line interface tool.