メインコンテンツまでスキップ
IntroFundamentalsObservabilitySecurityNetworkingAutomationAI/MLTroubleshooting
Switch to Essentials →

Helm

始める前に

このセクション用に環境を準備してください：

~$prepare-environment introduction/helm


このワークショップでは主にKustomizeと対話しますが、EKSクラスターに特定のパッケージをインストールするためにHelmを使用する状況があります。このラボでは、Helmの簡単な紹介を行い、事前にパッケージ化されたアプリケーションをインストールする方法を示します。


備考
このラボでは、独自のワークロード用のHelmチャートの作成については説明しません。このトピックの詳細については、ガイドを参照してください。


HelmはKubernetes用のパッケージマネージャーであり、Kubernetesアプリケーションの定義、インストール、アップグレードを支援します。Helmはチャートと呼ばれるパッケージングフォーマットを使用し、アプリケーションの実行に必要なすべてのKubernetesリソース定義が含まれています。Helmを使用することで、Kubernetesクラスター上でのアプリケーションのデプロイと管理が簡素化されます。


Helm CLI​


helm CLIツールは通常、Kubernetesクラスターと組み合わせて使用され、アプリケーションのデプロイとライフサイクルを管理します。これにより、Kubernetes上でのアプリケーションデプロイの一貫性と再現性のあるパッケージ化、インストール、管理が容易になり、異なる環境間でのアプリケーションデプロイの自動化と標準化が容易になります。


CLIはすでに私たちのIDEにインストールされています：


~$helm version


Helmチャートのインストール​


サンプルアプリケーションのUIコンポーネントをKustomizeマニフェストではなく、Helmチャートを使用してインストールしてみましょう。Helmパッケージマネージャーを使用してチャートをインストールすると、そのチャートに対して新しいリリースが作成されます。各リリースはHelmによって追跡され、他のリリースとは独立してアップグレード、ロールバック、またはアンインストールすることができます。


まず既存のUIアプリケーションを削除しましょう：


~$kubectl delete namespace ui


次にチャートをインストールできます：


~$helm install ui \
  oci://public.ecr.aws/aws-containers/retail-store-sample-ui-chart \
  --version 1.2.1 \
  --create-namespace --namespace ui \
  --wait


このコマンドを次のように分解できます：


    

  • Helmにチャートのインストールを指示するinstallサブコマンドを使用
    • 

  • リリースにuiという名前を付ける
    • 

  • 特定のバージョンでECR Publicにホストされているチャートを使用
    • 

  • チャートをui名前空間にインストール
    • 

  • リリース内のPodが準備完了状態になるのを待機
    • 



チャートがインストールされたら、EKSクラスター内のリリースを一覧表示できます：


~$helm list -A
NAME   NAMESPACE  REVISION  UPDATED                                  STATUS    CHART                               APP VERSION
ui     ui         1         2024-06-11 03:58:39.862100855 +0000 UTC  deployed  retail-store-sample-ui-chart-X.X.X


また、指定した名前空間で実行されているアプリケーションを確認できます：


~$kubectl get pod -n ui
NAME                     READY   STATUS    RESTARTS   AGE
ui-55fbd7f494-zplwx      1/1     Running   0          119s


チャートオプションの設定​


上記の例では、チャートをデフォルト設定でインストールしました。多くの場合、コンポーネントの動作を変更するためにインストール時にチャートに設定値を提供する必要があります。


インストール時にチャートに値を提供する一般的な方法は2つあります：


    

  1. YAMLファイルを作成し、-fまたは--valuesフラグを使用してHelmに渡す
    2. 

  2. --setフラグに続けてkey=valueペアを使用して値を渡す
    3. 



これらの方法を組み合わせてUIリリースを更新してみましょう。次のvalues.yamlファイルを使用します：


~/environment/eks-workshop/modules/introduction/helm/values.yaml
podAnnotations:
  my-annotation: my-value

app:
  theme: orange


これにより、Podにいくつかのカスタムkubernetes注釈が追加され、UIテーマが上書きされます。


どの値を使用すればよいかわからない場合
多くのHelmチャートはレプリカ数やPod注釈などの一般的な側面を設定するための比較的一貫した値を持っていますが、各Helmチャートには独自の一意の設定セットがあります。特定のチャートをインストールおよび設定する際は、そのドキュメントで利用可能な設定値を確認する必要があります。


また、--setフラグを使用して追加のレプリカを追加します：


~$helm upgrade ui \
  oci://public.ecr.aws/aws-containers/retail-store-sample-ui-chart \
  --version 1.2.1 \
  --create-namespace --namespace ui \
  --set replicaCount=3 \
  --values ~/environment/eks-workshop/modules/introduction/helm/values.yaml \
  --wait


リリースを一覧表示します：


~$helm list -A
NAME   NAMESPACE  REVISION  UPDATED                                  STATUS    CHART                                APP VERSION
ui     ui         2         2024-06-11 04:13:53.862100855 +0000 UTC  deployed  retail-store-sample-ui-chart-X.X.X   X.X.X


revision列が2に更新されていることがわかります。これは、Helmが更新された設定を個別のリビジョンとして適用したためです。これにより、必要に応じて以前の設定にロールバックすることができます。


特定のリリースのリビジョン履歴は次のように表示できます：


~$helm history ui -n ui
REVISION  UPDATED                   STATUS      CHART                               APP VERSION  DESCRIPTION
1         Tue Jun 11 03:58:39 2024  superseded  retail-store-sample-ui-chart-X.X.X  X.X.X        Install complete
2         Tue Jun 11 04:13:53 2024  deployed    retail-store-sample-ui-chart-X.X.X  X.X.X        Upgrade complete


変更が反映されたことを確認するために、ui名前空間のPodを一覧表示します：


~$kubectl get pods -n ui
NAME                     READY   STATUS    RESTARTS   AGE
ui-55fbd7f494-4hz9b      1/1     Running   0          30s
ui-55fbd7f494-gkr2j      1/1     Running   0          30s
ui-55fbd7f494-zplwx      1/1     Running   0          5m


現在3つのレプリカが実行されていることがわかります。また、Deploymentを調査することで注釈が適用されたことを確認できます：


~$kubectl get -o yaml deployment ui -n ui | yq '.spec.template.metadata.annotations'
my-annotation: my-value
[...]


リリースの削除​


同様にCLIを使用してリリースをアンインストールすることもできます：


~$helm uninstall ui --namespace ui --wait


これにより、そのリリース用にチャートによって作成されたすべてのリソースがEKSクラスターから削除されます。


Helmを使用したアプリケーションのデプロイ​


それでは、Helmを使用してリテールストアアプリケーションをデプロイする方法を見てみましょう。ワークショップでは主にKustomizeを使用しますが、多くのサードパーティアプリケーションがHelmチャートとして配布されているため、Helmを理解することは価値があります。


Catalogサービス用のシンプルなチャートの作成​


Helmでアプリケーションをパッケージ化してデプロイする方法を理解するために、catalogサービス用の基本的なHelmチャートを作成してみましょう：


~$helm create retail-catalog


これにより、基本的なチャート構造が作成されます。作成されたものを見てみましょう：


~$ls -la retail-catalog/
total 8
drwxr-xr-x  4 user user  128 Nov 15 10:30 .
drwxr-xr-x  3 user user   96 Nov 15 10:30 ..
-rw-r--r--  1 user user 1141 Nov 15 10:30 Chart.yaml
drwxr-xr-x  2 user user   64 Nov 15 10:30 charts
drwxr-xr-x  3 user user   96 Nov 15 10:30 templates
-rw-r--r--  1 user user 1862 Nov 15 10:30 values.yaml


チャートのカスタマイズ​


catalogサービスをデプロイするためにデフォルトの値を変更しましょう。values.yamlファイルを更新します：


~$cat > retail-catalog/values.yaml <<EOF
replicaCount: 2
 
image:
  repository: public.ecr.aws/aws-containers/retail-store-sample-catalog
  tag: "0.4.0"
  pullPolicy: IfNotPresent
 
serviceAccount:
  create: true
 
service:
  type: ClusterIP
  port: 80
  targetPort: 8080
 
ingress:
  enabled: false
 
httpRoute:
  enabled: false
 
autoscaling:
  enabled: false
 
resources:
  requests:
    cpu: 128m
    memory: 512Mi
  limits:
    cpu: 256m
    memory: 512Mi
 
nameOverride: "catalog"
fullnameOverride: "catalog"
EOF


チャートのインストール​


まず、Kustomizeでインストールされた既存のcatalogデプロイを削除しましょう：


~$kubectl delete namespace catalog


それでは、Helmチャートを使用してcatalogサービスをインストールしましょう：


~$helm install catalog ./retail-catalog --namespace catalog --create-namespace


デプロイを確認します：


~$helm list -n catalog
NAME     NAMESPACE  REVISION  UPDATED                                  STATUS    CHART               APP VERSION
catalog  catalog    1         2024-11-15 10:35:42.123456789 +0000 UTC  deployed  retail-catalog-0.1.0  1.16.0


実行中のPodを確認します：


~$kubectl get pods -n catalog
NAME                       READY   STATUS    RESTARTS   AGE
catalog-7d4b8c9f8d-abc12   1/1     Running   0          2m
catalog-7d4b8c9f8d-def34   1/1     Running   0          2m


リリースのアップグレード​


Helmの強みの1つはアプリケーションのアップグレード管理です。レプリカ数を更新してアプリケーションをスケールしてみましょう：


~$helm upgrade catalog ./retail-catalog \
  --namespace catalog \
  --set replicaCount=3


ロールバック​


何か問題が発生した場合、Helmを使用すると簡単にロールバックできます：


~$helm rollback catalog 1 -n catalog


クリーンアップ​


Helmリリースを削除します：


~$helm uninstall catalog -n catalog


この例は、Helmがアプリケーションのデプロイに高レベルの抽象化を提供し、アップグレード、ロールバック、構成管理のサポートが組み込まれていることを示しています。


Helmの仕組みを理解したので、宣言的な構成管理について学ぶためにKustomizeに進むか、Fundamentalsモジュールに進むことができます。