Helm API

Helm の API ドキュメントです。

caution
この API は Helm 関連パッケージのクライアントであるHelmや helm-pushなどの Helm 関連のパッケージクライアントで使用するもので、 一般に手動で使用するものではありません。

GitLab パッケージレジストリから Helm パッケージをアップロードしてインストールする方法については、Helm レジストリのドキュメントを参照ください。

note
これらのエンドポイントは、標準の API 認証方式には対応していません。サポートしているヘッダやトークンの型についての詳細はHelm レジストリのドキュメントを参照ください。文書化されていない認証方式は、将来的に削除される可能性があります。

チャートインデックスのダウンロード

GitLab 14.1 で導入されました。

Chartインデックスをダウンロード：

GET projects/:id/packages/helm/:channel/index.yaml
属性種類必須説明
id文字列です。yesプロジェクトのIDまたはフルパス。
channel文字列です。yesHelmリポジトリチャンネル。
curl --user <username>:<personal_access_token> \
     "https://gitlab.example.com/api/v4/projects/1/packages/helm/stable/index.yaml"

出力をファイルに書き出します：

curl --user <username>:<personal_access_token> \
     "https://gitlab.example.com/api/v4/projects/1/packages/helm/stable/index.yaml" \
     --remote-name

Chartのダウンロード

GitLab 14.0 で導入されました。

Chartをダウンロードしてください：

GET projects/:id/packages/helm/:channel/charts/:file_name.tgz
属性種類必須説明
id文字列です。yesプロジェクトのIDまたはフルパス。
channel文字列です。yesHelmリポジトリチャンネル。
file_name文字列です。yesChartファイル名。
curl --user <username>:<personal_access_token> \
     "https://gitlab.example.com/api/v4/projects/1/packages/helm/stable/charts/mychart.tgz" \
     --remote-name

Chartのアップロード

GitLab 14.1 で導入されました。

Chartをアップロードしてください：

POST projects/:id/packages/helm/api/:channel/charts
属性種類必須説明
id文字列です。yesプロジェクトのIDまたはフルパス。
channel文字列です。yesHelmリポジトリチャンネル。
chartファイルyesChart (asmultipart/form-data).
curl --request POST \
     --form 'chart=@mychart.tgz' \
     --user <username>:<personal_access_token> \
     "https://gitlab.example.com/api/v4/projects/1/packages/helm/api/stable/charts"