Skip to content
This repository has been archived by the owner on Jul 2, 2021. It is now read-only.

Next step in turning down the Helm Hub #481

Merged
merged 1 commit into from
Oct 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 0 additions & 58 deletions .circleci/config.yml

This file was deleted.

76 changes: 31 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,51 @@
# Helm Hub

The Helm Hub repository contains the documentation and some configuration for the
distributed public repository search hosted by Helm that can be found at https://hub.helm.sh
The Helm Hub repository contained the documentation and some configuration for the
distributed public repository search hosted by Helm that used to be found at https://hub.helm.sh

## Distributed Search
## ⚠️ NOTICE: Redirect To Artifact Hub

Helm was designed with many distributed repositories in mind. This is why the Helm
CLI has commands to manage adding, updating, listing, and removing them. Repositories
are hosted by many people and organizations. Sometimes these are private and sometimes
they are public with a goal of distributing applications.
The [Artifact Hub](https://artifacthub.io/) is a CNCF project to make discovering
distributed cloud native artifacts easy. This includes Helm charts. The Helm Hub,
including the search in the Helm Client, now redirect to the Artifact Hub. It
provides a better experience to that of the Helm Hub.

Discovering the charts hosted by the Helm project via the [stable and incubator](https://github.com/helm/charts)
repositories has been relatively easy. We want to go further and make it possible
to discover the charts and repositories being hosted by others.
## Claiming Your Repo In The Artifact Hub

The Hub provides a means to more easily find charts that are hosted outside the Helm
project. This has implications for those who build and distribute charts including:
If you had a repository in the Helm Hub but had not already listed it in the Artifact
Hub, it was automatically listed. Everything that as in the Helm Hub should be
discoverable in the Artifact Hub.

- They can manage the workflow around releases themselves
- They can track metrics around the use of their charts
There are two ways to claim your listing so that you can manage it on the Artifact
Hub:

## Artifact Hub Migration
1. If you create an account on the Artifact Hub there is a method to
[claim your repository](https://github.com/artifacthub/hub/blob/master/docs/repositories.md#ownership-claim).
In the repository settings you will find a button to start the
process. Note, the Artifact Hub has both user and organizational accounts.
If you have an organization, consider linking the repository to the organization
instead of an individual user.
2. You can file an issue on this repository and we can perform a manual handoff.

The Helm Hub is migrating to the [Artifact Hub](https://artifacthub.io/) ([issue here](https://github.com/helm/hub/issues/439)). This means a few changes are coming:
The first method is preferred as it requires fewer people in the loop and should
be faster and less work for all parties.

- When the migration is complete, the Helm Hub will redirect to the Artifact Hub
- The Helm Client will search the Artifact Hub instead of the Helm Hub
## Artifact Hub Migration Details

The Helm Hub has to the [Artifact Hub](https://artifacthub.io/) ([issue here](https://github.com/helm/hub/issues/439)).
This means:

- The Helm Hub redirects to the Artifact Hub
- The Helm Client searches the Artifact Hub instead of the Helm Hub
- Charts will be listed in the Artifact Hub instead of the Helm Hub

Chart repositories listed in the Helm Hub have been migrated to the Artifact Hub
if they were not already listed there. They are managed by the Helm Organization.
If you own one of the repositories and want to claim it there are two methods
you can use.

1. Once you have an account (or organization) setup you can claim ownership. This
happens via the "Claim Ownership" button in the Repositories settings. This
will walk you through a process where you prove ownership to claim it.
2. Contact one of the Helm chart maintainers and work through a manual handoff.

You are encouraged to take over ownership of your repositories in the Artifact Hub.
The first method is the preferred method as a repository owner can accomplish this
at their own pace.

## How To Add Your Helm Charts

The process to add a repository and all of its charts is documented in the
[Repositories.md](Repositories.md) file. This includes the guidelines that need
to be followed to be listed along with the functional parts of the process.

## Contributions

This project is in its early stages with plenty of room for improvement including
UX improvements, the back-end application, and the process used to manage the
Hub itself.

Contributions to the process happen in this repository while the software powering
the Hub is [Monocular](https://github.com/helm/monocular), a Helm project.
You can follow the process above to obtain ownership of your Helm repositories.

## Happy helming in China

If you are in China, you will experience problems with some Helm repositories and the images they use not being accessible (e.g., gcr.io). You can use a mirror hub at https://developer.aliyun.com/hub which will automatically sync & replace unavailable images & repository URLs in every Chart with locations accessible in China.
If you are in China, you will experience problems with some Helm repositories and the images they use not being accessible (e.g., gcr.io). You can use a mirror hub at https://developer.aliyun.com/hub which will automatically sync & replace unavailable images & repository URLs in every Chart with locations accessible in China.

## License

Expand Down