GitHub Pages のホスティングによる ArtifactHub での Helm Chart の公開

Built for Speed: ~10ms Latency, Even Under Load
Blazingly fast way to build, track and deploy your models!
- Handles 350+ RPS on just 1 vCPU — no tuning needed
- Production-ready with full enterprise support
Helm Chart を GitHub Pages でホストし、ArtifactHub 上で他のユーザーが利用できるようにする方法について説明します。プロセスを理解する前に、まずこれらの用語を最も単純な形式で理解していきましょう。
Helm Chart とは
Helm Chart は、デプロイしたい Kubernetes リソースをテンプレート化する方法です。複数のクラスタ(あるいは同じクラスタ内)で異なる値を使用して Kubernetes リソースを作成したい場合、リソースのテンプレートを作成してパッケージ化します。このパッケージは Helm Chart として知られています。
GitHub Pages
GitHub Pages は、GitHub のサーバー上でホストされるウェブサイトまたはウェブページを作成できる GitHub の機能です。シンプルな index.html ファイルがある場合、一般的に username.github.io の形式になる GitHub 提供のドメイン名を使用してこの HTML ファイルをホストできます。これは、別のウェブホスティングサービスを必要とせずに、オンラインで自身の作業を共有したりプロジェクトを披露したりする方法です。今回のケースでは、Helm Chart を GitHub Pages 上でホストします。
ArtifactHub
ArtifactHub は、Helm Chart や OPA などのさまざまなソフトウェアディストリビューションの中央リポジトリとして機能するウェブベースのプラットフォームです。Helm Chart を作成し、GitHub Pages でホストしたら、ArtifactHub に掲載してコミュニティから発見できるようにします。
ArtifactHub 自体は Helm Chart をホストせず、Helm Chart リポジトリのレジストリとして機能します。開発者は Helm Chart を GitHub、GitLab、Bitbucket などの好みのリポジトリに公開し、そのリポジトリを ArtifactHub に登録できます。
GitHub Pages を介した Helm Chart のホスティング
それでは、GitHub の Pages 機能を活用してアプリケーションの Helm Chart をホストする方法を見ていきます。この例ではサンプル Helm Chart を使用しますが、同様の方法で独自のカスタマイズされた Helm Chart を使用することもできます。
ステップ 1: サンプル Helm Chart の作成
まず、サンプル Helm Chart の作成から始めます。
helm create sample-nginx
ステップ 2: GitHub リポジトリの作成
チャートをホストする公開 GitHub リポジトリを作成します。
- GitHub リポジトリを作成します
- 公開(Public)に設定されていることを確認します
- Helm Chart を含む
chartsという名前のディレクトリを作成します chartsディレクトリがリポジトリのルートレベルにあることを確認します- リポジトリの
mainブランチにチャートをプッシュします
$ tree .
.
├── README.md
└── charts
└── sample-nginx
├── Chart.yaml
├── charts
├── templates
│ ├── NOTES.txt
│ ├── _helpers.tpl
│ ├── deployment.yaml
│ ├── hpa.yaml
│ ├── ingress.yaml
│ ├── service.yaml
│ ├── serviceaccount.yaml
│ └── tests
│ └── test-connection.yaml
└── values.yaml
リポジトリを作成しました。以下でホストされています:
ステップ 3: GitHub アクセストークンの作成
チャートが main ブランチに入ったら、GitHub Release を作成できるパイプラインを作成する必要があります。この GitHub Release が、見返りとしてチャートを公開します。これを行うには、特定セットの権限を設定したトークンを作成する必要があり、これがパイプラインでチャートをリリースする際に使用されます。
- 右上隅の GitHub プロフィールをクリックします
- Settings に移動します。
- 左側パネルの一番下にある Developer Settings に移動します。
- Personal Access tokens に移動し、Fine-grained tokens を選択します。
- Generate new token をクリックします

- トークン名を入力し、有効期限を選択します。ここでは、期限が切れるとトークンが無効になる 7 日間に設定しています。
- Repository Access で「Only select repositories」を選択し、作業中の GitHub リポジトリを選択します

- Permissions セクションでは、Repository permissions のみを使用する必要があります。
- この選択で、
Contentsに対してRead and writeが必要です

- 概要として、これらの権限のみが設定されている必要があります
- トークンが生成されたら、次のステップのために大切に保管してください。
ステップ 4: GitHub Pages の設定
GitHub Pages を使用して、ウェブサイトを GitHub 上で直接(静的に)ホストできます。
- リポジトリ内に
gh-pagesという名前の別のブランチを作成します。ブランチ名は必ずgh-pagesとしてください。 - このブランチ内のすべてのファイルを削除し、ホスティングをテストするためのシンプルなファイル
index.htmlのみを作成します。変更を GitHub にプッシュします。
<!DOCTYPE html>
<html>
<head>
<title>Sample charts</title>
<style>
.chart {
width: 400px;
height: 300px;
margin: 20px;
border: 1px solid #ccc;
box-shadow: 2px 2px 5px #ccc;
display: inline-block;
vertical-align: top;
padding: 10px;
box-sizing: border-box;
font-size: 14px;
line-height: 1.5;
}
.chart h3 {
margin-top: 0;
font-size: 18px;
font-weight: bold;
}
.chart p {
margin: 0;
}
</style>
</head>
<body>
<h1>Sample charts</h1>
<div class="chart">
<h3>Chart 1</h3>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer euismod diam et purus hendrerit mollis.</p>
<!-- add your chart code here -->
</div>
<div class="chart">
<h3>Chart 2</h3>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer euismod diam et purus hendrerit mollis.</p>
<!-- add your chart code here -->
</div>
<div class="chart">
<h3>Chart 3</h3>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer euismod diam et purus hendrerit mollis.</p>
<!-- add your chart code here -->
</div>
</body>
</html>
- リポジトリ名の下にある Settings に移動し、左側パネルの Pages をクリックします。

- Build and deployment セクションで Branch
gh-pagesを選択し、GitHub が処理するまで少し待ちます。完了すると、同じウィンドウに URL が表示されます。それをクリックすると、作成したindex.htmlが表示されます。 - こちらをクリックして index.html を確認します — https://dunefro.github.io/sample-charts/
- これで、この HTML ファイルをホストする代わりに、Helm Chart をホストできるようになります。
ステップ 5: GitHub Actions でのパイプライン作成
前のステップでは、アクセストークンを使用して GitHub Release を作成するパイプラインについて説明しました。このタスクを実行するために好みのツールを選択できますが、ここでは GitHub Actions を選択します。GitHub Actions は、CI/CD タスクを実行するために GitHub でネイティブにサポートされているもう 1 つのツールです。
パイプラインを作成する前に、前のタスクで作成したトークンを渡すためのシークレット変数を解釈・作成します。
- リポジトリに移動し、リポジトリ名の下にある Settings をクリックします

- 左側パネルの Secrets and Variables に移動し、Actions をクリックします
- New Repository Secret をクリックしてトークンを貼り付けます

これで、このトークンをパイプライン内で使用してリリースをプッシュできるようになります。
次に、GitHub Actions パイプラインを作成します
mainブランチのリポジトリルートレベルに.github/workflowsディレクトリを作成します。- このディレクトリは、GitHub Actions が実行するすべての CI/CD パイプラインを保持するデフォルトのディレクトリです。
- 上記ディレクトリ内に
release.yamlという名前のファイルを作成します。 - 以下のコンテンツを貼り付けます
name: Release Charts
on:
push:
branches:
- main
jobs:
release:
permissions:
contents: write # to push chart release and create a release (helm/chart-releaser-action)
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Configure Git
run: |
git config user.name "$GITHUB_ACTOR"
git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
- name: Set up Helm
uses: azure/setup-helm@v3.5
with:
version: v3.9.2
- name: Run chart-releaser
uses: helm/chart-releaser-action@v1.5.0
env:
CR_TOKEN: "${{ secrets.HELM_RELEASE_TOKEN }}"
このパイプラインは非常にシンプルです。すばやく理解していきましょう
name— パイプラインの名前on— パイプラインを実行する条件。ここではmainブランチへの各プッシュで実行するように指定しています。jobs— パイプラインコードを含む実際のジョブ。設定済みの contents におけるwriteの権限を確認しますstepsパイプラインのステップを定義します。最初のステップはactions/checkout@v3を使用することです。通常、パイプラインを作成する場合は、まずコードをチェックアウトします。コードをチェックアウトする処理を書く代わりに、GitHub はコードを書かずに直接使用できるactionを提供しています。- 2 番目のステップでは、git を構成するコマンドを実行します。同様に、3 番目のステップでは
azure/setup-helmアクションを使用して Helm を設定します。 - 最後のステップでは、
helm/chart-releaser-actionを使用して Helm Chart をリリースします。リリースにはシークレットトークンが必要ですが、これは作成済みで、トークン名HELM_RELEASE_TOKENを介してパイプラインに渡されています。このアクションはgh-pagesブランチにindex.yamlも作成し、GitHub Page が Helm Chart の静的レジストリとして機能するようにします。
ステップ 6: パイプラインを実行し、リリースが作成されたか確認する
これで、main ブランチにあるリポジトリの README.md ファイルに非常に小さな変更を加え、パイプラインをトリガーさせます。変更をプッシュすると、小さなオレンジ色のドットが表示され、パイプラインが実行中であることが確認できます

- リポジトリ名の下にある Actions に移動し、実行中のパイプラインを確認します。
- パイプラインが終了したら、
gh-pagesブランチに移動してindex.yamlが作成されているか確認できます。 index.yamlは、Helm が静的にホストされたウェブサイトを Helm レジストリとして認識できるようにする方法です。- パイプラインが終了すると、
pages build and deploymentという名前の別のパイプラインが自動的にトリガーされます。これは、gh-pages branchで行われた変更をホストしてindex.yamlをパブリックに利用可能にするために GitHub によって自動生成されます。 — https://dunefro.github.io/sample-charts/index.yaml - GitHub の Releases ページに移動してリリースを確認し、Helm Chart が Releases ページにリリースされていることを確認できます。 — https://github.com/dunefro/sample-charts/releases
ステップ 7: minikube クラスタにデプロイしてリリースを確認する
Helm レジストリが正常に作成されたかどうかをテストするには
minikubeクラスタを作成します- 以下のコマンドを実行します
# add the repo
helm repo add sample-charts https://dunefro.github.io/sample-charts/
helm repo update
# install the charts
helm upgrade --install test-nginx sample-charts/sample-nginx
# check pods
$ kubectl get pods
NAME READY STATUS RESTARTS AGE
test-nginx-sample-nginx-b95bb4f46-tbppn 1/1 Running 0 30s
チャートは正常に機能しています。
ArtifactHub のセットアップ
次に、Helm Chart をコミュニティに披露できるように、ArtifactHub でアカウントをセットアップする方法を見ていきます。以下のような他のコミュニティチャートも見つかるでしょう
ステップ 1: ArtifactHub でアカウントを作成しリポジトリを作成する
チャートがホストされました。他の開発者が ArtifactHub 経由でこれらを使用できるように確認する必要があります。
- https://artifcathub.io にアクセスしてサインアップします。
- この後、左上隅のアイコンからプロフィールをクリックし、Control panel をクリックします。
- + Add Repository をクリックし、リポジトリの詳細を追加します。GitHub Pages でチャートがホストされている URL を必ず使用してください。

- あとはリラックスして待ちます。ArtifactHub は Pages でホストされている
index.yamlを使用して自動的に詳細を取得します
ステップ 2: リポジトリの検証
リポジトリが作成されていることが確認でき、ArtifactHub がデータを取得できるようになると、検索にも反映され始めます。次に、以下のような検証済みパブリッシャータグを適用します

これを行うには、メタデータファイルとして gh-pages ブランチに artifacthub-repo.yml ファイルを追加する必要があります。これが ArtifactHub によって読み取られ、レジストリの所有者であることが確認されます。
- 作成したリポジトリから ID をコピーします。
gh-pagesブランチに以下の内容でartifacthub-repo.ymlという名前のファイルを作成します
repositoryID: 67d52f16-b102-4661-bfa5-9e6694587e24
owners: # (optional, used to claim repository ownership)
- name: Vedant Pareek
email: dunefro@gmail.com
- ArtifactHub と GitHub Actions が検出できるように、チャートの **version を更新します。
- ArtifactHub がレジストリのチェックを実行するまで少し待ちます。
これは、Truefoundry でパブリック Helm Chart をホストするために使用したのと同じ方法です。TrueFoundry は、機械学習モデルの開発から本番環境への移行に至るライフサイクルジャーニー全体を簡素化する MLOps、LLMOps プラットフォームです。モデル構築中の容易さと快適さをもたらすために、機械学習ライフサイクルの全過程におけるすべての問題点を考慮に入れています。
TrueFoundry AI Gateway delivers ~3–4 ms latency, handles 350+ RPS on 1 vCPU, scales horizontally with ease, and is production-ready, while LiteLLM suffers from high latency, struggles beyond moderate RPS, lacks built-in scaling, and is best for light or prototype workloads.


















.webp)





.webp)
.webp)
.png)

.png)
.png)
.png)
.png)
.png)
.webp)
.webp)






