Github + Artifacthub で helm chart を公開する手順まとめ

• 概要
• 環境
• ポイント
• 事前準備
• Github pages の設定
• helm repo index
• helm package
  • git push
• ArtifactHub でリポジトリの作成
• 動作確認
• おまけ: README やロゴを設定する方法
• 参考サイト

概要

自作の helm chart を Github で公開する大まかな流れを紹介します

環境

• helm 3.5.2

ポイント

• tgz を作成して http or https で公開すれば OK
• tgz の作成は helm コマンドを使ってできる

事前準備

すでに helm create test-package で chart は作成している想定です

Github pages の設定

• main に /docs ディレクトリを作成する
• Github の設定から Pages を有効にする
  • Settings -> Options -> GitHub Pages

helm repo index

index.yaml を作成します
変更したい箇所があれば手動で変更します

• helm repo index ../docs --url http://your-name.github.io/test-package

helm package

これで tgz ファイルが作成できます
これを Github Pages で公開します

• helm package ./test-package

git push

作成された tgz を /docs に移動して Github に push します
これで Github Pages で tgz が公開された状態になります

ArtifactHub でリポジトリの作成

https://artifacthub.io/ にログインしてリポジトリを作成します
URL は Github Pages の URL を記載します

動作確認

• helm repo add test-package http://your-name.github.io/test-package/
• helm repo update
• helm install test-package test-package/test-package

おまけ: README やロゴを設定する方法

• README.md を tgz ファイルに含めることで自動で展開してくれます
• ロゴは artifacthub-pkg.yml の logoURL or logoPath を指定すれば自動で設定されます
• アカウントのロゴは ArtifactHub のプロフィール設定から行えます

参考サイト

• https://helm.sh/docs/topics/chart_repository/