Documentation / Topics / Repositories / Krew kubectl plugins

Krew kubectl plugins repositories

Artifact Hub is able to process kubectl plugins listed in Krew index repositories. Repositories are expected to be hosted in GitHub, GitLab or Bitbucket. When adding your repository to Artifact Hub, the url used must follow the following format:

  • https://github.com/user/repo
  • https://gitlab.com/user/repo
  • https://bitbucket.org/user/repo

By default the master branch is used, but it’s possible to specify a different one from the UI.

For more information about the structure of the Krew index repository, please see the Hosting Custom Plugin Indexes official documentation.

Most of the metadata Artifact Hub needs is extracted from the plugin’s manifest file. However, there is some extra Artifact Hub specific metadata that you can set using some special annotations in the plugin manifest file. For more information, please see the Artifact Hub Krew annotations documentation.

There is an extra metadata file that you can add to your repository named artifacthub-repo.yml, which can be used to setup features like Verified publisher or Ownership claim. This file must be located at the root of the repository.

Example repository: Krew Index