クイックスタートガイド

このガイドでは、Helmをすぐに使い始める方法について説明します。

前提条件

Helmを正しく安全に使用するには、次の前提条件が必要です。

  1. Kubernetesクラスタ
  2. インストールに適用するセキュリティ設定(ある場合)を決定する
  3. Helmのインストールと設定。

Kubernetesをインストールするか、クラスタにアクセスできる必要があります

  • Kubernetesがインストールされている必要があります。Helmの最新リリースには、Kubernetesの最新の安定版リリース(ほとんどの場合、2番目に新しいマイナーリリース)をお勧めします。
  • また、ローカルに設定された `kubectl` のコピーが必要です。

HelmとKubernetesの間でサポートされている最大バージョン差については、Helmバージョンサポートポリシーを参照してください。

Helmのインストール

Helmクライアントのバイナリリリースをダウンロードします。 `homebrew` などのツールを使用するか、公式リリースページを参照してください。

詳細またはその他のオプションについては、インストールガイドを参照してください。

Helmチャートリポジトリの初期化

Helmの準備ができたら、チャートリポジトリを追加できます。利用可能なHelmチャートリポジトリについては、Artifact Hubを確認してください。

$ helm repo add bitnami https://charts.bitnami.com/bitnami

これがインストールされると、インストールできるチャートを一覧表示できるようになります

$ helm search repo bitnami
NAME                             	CHART VERSION	APP VERSION  	DESCRIPTION
bitnami/bitnami-common           	0.0.9        	0.0.9        	DEPRECATED Chart with custom templates used in ...
bitnami/airflow                  	8.0.2        	2.0.0        	Apache Airflow is a platform to programmaticall...
bitnami/apache                   	8.2.3        	2.4.46       	Chart for Apache HTTP Server
bitnami/aspnet-core              	1.2.3        	3.1.9        	ASP.NET Core is an open-source framework create...
# ... and many more

サンプルチャートのインストール

チャートをインストールするには、 `helm install` コマンドを実行します。Helmにはチャートを見つけてインストールする方法はいくつかありますが、最も簡単な方法は `bitnami` チャートを使用することです。

$ helm repo update              # Make sure we get the latest list of charts
$ helm install bitnami/mysql --generate-name
NAME: mysql-1612624192
LAST DEPLOYED: Sat Feb  6 16:09:56 2021
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES: ...

上記の例では、 `bitnami/mysql` チャートがリリースされ、新しいリリースの名前は `mysql-1612624192` です。

`helm show chart bitnami/mysql` を実行すると、このMySQLチャートの機能の概要がわかります。または、 `helm show all bitnami/mysql` を実行して、チャートに関するすべての情報を取得することもできます。

チャートをインストールするたびに、新しいリリースが作成されます。そのため、1つのチャートを同じクラスタに複数回インストールできます。そして、それぞれを個別に管理およびアップグレードできます。

`helm install` コマンドは、多くの機能を備えた非常に強力なコマンドです。詳細については、Helmの使用ガイドをご覧ください。

リリースについて学ぶ

Helmを使用して何がリリースされたかを確認するのは簡単です

$ helm list
NAME            	NAMESPACE	REVISION	UPDATED                             	STATUS  	CHART      	APP VERSION
mysql-1612624192	default  	1       	2021-02-06 16:09:56.283059 +0100 CET	deployed	mysql-8.3.0	8.0.23

`helm list` (または `helm ls` )関数は、デプロイされたすべてのリリースのリストを表示します。

リリースのアンインストール

リリースをアンインストールするには、 `helm uninstall` コマンドを使用します

$ helm uninstall mysql-1612624192
release "mysql-1612624192" uninstalled

これにより、 `mysql-1612624192` がKubernetesからアンインストールされ、リリースに関連付けられているすべてのリソースとリリース履歴が削除されます。

フラグ `--keep-history` が指定されている場合、リリース履歴は保持されます。そのリリースに関する情報をリクエストできます

$ helm status mysql-1612624192
Status: UNINSTALLED
...

Helmは、アンインストールした後でもリリースを追跡するため、クラスタの履歴を監査し、リリースを削除解除することさえできます( `helm rollback` を使用)。

ヘルプテキストを読む

使用可能なHelmコマンドの詳細については、 `helm help` を使用するか、コマンドの後に `-h` フラグを入力します

$ helm get -h