From 2a23c1a83b2bfe6327375801ddbd4f6ba872fa71 Mon Sep 17 00:00:00 2001 From: Matt Farina Date: Wed, 7 Oct 2020 10:11:37 -0400 Subject: [PATCH] Next step in turning down the Helm Hub - The CircleCI config used to deploy the Helm Hub has been removed. If we need to undo this and restore the functionlaity, this file can be pulled from the git history. - The readme has been updated with the details of the move. Signed-off-by: Matt Farina --- .circleci/config.yml | 58 --------------------------------- README.md | 76 ++++++++++++++++++-------------------------- 2 files changed, 31 insertions(+), 103 deletions(-) delete mode 100644 .circleci/config.yml diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index 14dc3663..00000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,58 +0,0 @@ -version: 2.1 -jobs: - deploy: - docker: - # Upgrade the Dockerfile and push image when the hub az cluster tiller - # version upgrades. - - image: quay.io/helmpack/kubectl-helm-az:0.1.2 - # Don't automatically upgrade the Hub monocular chart version for each - # new helm/monocular release. Instead assume we'll need testing, and - # set the version manually here. - environment: - CHART_VERSION: 1.4.9 - steps: - - run: - name: Authenticate to cluster - shell: /bin/sh -eo pipefail - command: | - az login --service-principal -u $SERVICE_PRINCIPAL_ID -p $SERVICE_PRINCIPAL_PASS -t $SERVICE_TENANT_ID - az aks get-credentials -n $CLUSTER_NAME -g $RESOURCE_GROUP - - checkout - - run: - name: Install compare-url dependencies - command: apk add --no-cache curl git - - compare-url/reconstruct - - run: - name: Upgrade/install Monocular Helm chart with any Hub changed values - shell: /bin/sh -eo pipefail - command: | - CIRCLE_COMPARE_URL=$(cat CIRCLE_COMPARE_URL.txt) - COMMIT_RANGE=$(echo $CIRCLE_COMPARE_URL | sed 's:^.*/compare/::g') - echo "Commit range: $COMMIT_RANGE" - - for config in config/helm-hub-values.yaml config/repo-values.yaml repos.yaml; do - if git diff $COMMIT_RANGE --name-status | grep "$config" >/dev/null; then - echo "Config file changed: $config" - export CONFIG_UPDATED=true - fi - done - - if [ -n "$CONFIG_UPDATED" ]; then - export MONGODB_ROOT_PASSWORD=$(kubectl get secret --namespace helm-hub helm-hub-mongodb -o jsonpath="{.data.mongodb-root-password}" | base64 -d) - helm init --client-only - helm repo add monocular https://helm.github.io/monocular - helm repo update - helm upgrade --install helm-hub monocular/monocular --version $CHART_VERSION --namespace helm-hub --set mongodb.mongodbRootPassword=$MONGODB_ROOT_PASSWORD -f config/helm-hub-values.yaml -f config/repo-values.yaml - else - echo "No upgrade necessary. No config changes detected" - fi -orbs: - compare-url: iynere/compare-url@0.4.10 -workflows: - version: 2 - merge-master: - jobs: - - deploy: - filters: - branches: - only: master diff --git a/README.md b/README.md index d15e05a6..d4d8242f 100644 --- a/README.md +++ b/README.md @@ -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