Helmアーティファクトのデプロイ

Helmは、Kubernetes用に構築されたソフトウェアの共有、パッケージ化およびデプロイ機能を提供するオープン・ソースのKubernetesパッケージ・マネージャです。Oracle Cloud Infrastructure (OCI) DevOpsサービスは、Container Engine for Kubernetes (OKE)クラスタへのHelmチャートのデプロイメントをサポートします。インライン・アーティファクトとして指定され、デプロイメント用のHelmステージに追加されたHelmコマンドを実行することもできます。

Helmチャートのデプロイメントが発生するのは、Helmチャートが初めてデプロイされた場合、またはアーティファクトまたはHelmステージ・パラメータで更新が検出された場合のみです。これは、デプロイメントを実行する前に自動的に検証されます。ただし、アーティファクトまたは他のHelmステージ・パラメータへの更新に関係なくHelmチャートをデプロイするには、デプロイメントの実行中にENFORCE_HELM_DEPLOYMENTパラメータをtrueに設定する必要があります。このパラメータは、ステージ・レベルとパイプライン・レベルの両方で動作します。パラメータが特定のステージに設定されている場合は、そのステージにのみ適用されます。パラメータがパイプラインまたはデプロイメント引数に設定されている場合は、パイプライン内のすべてのステージに適用されます。ただし、パイプラインまたはデプロイメント引数とステージ・オーバーライド引数にパラメータが設定されている場合は、パイプライン・パラメータまたはデプロイメント引数がステージ・オーバーライド引数より優先されます。このパラメータは、パイプライン内のすべてのステージに適用されます。

特定のHelmデプロイメント・ステージでは、OCI_DEVOPS_DEPLOY_USE_CREATE_NAMESPACE_FLAGをステージ・パラメータ・オーバーライドとして使用できます。このパラメータをtrueまたはfalseに設定して、Helmチャートのデプロイにhelm upgradeコマンドを使用するときに--create-namespaceフラグを制御できます。このパラメータはステージ・レベルで動作し、デプロイメント構成の粒度が向上します。詳細は、パラメータの構成を参照してください。

開始する前に、デプロイメント・パイプラインを作成してContainer Engine for Kubernetesクラスタを作成する必要があります。パブリックとプライベートの両方のOKEクラスタにデプロイできます。

デプロイメント・パイプラインの動的グループおよびポリシーの作成については、デプロイメント・パイプライン・ポリシーを参照してください。詳細は、DevOps IAMポリシーを参照してください。

Helmチャートは、デプロイメント用にOCIコンテナ・レジストリ・リポジトリに配置する必要があります。Helmチャートの追加を参照してください。Helmコマンドを実行するには、Helmコマンドをインライン・アーティファクトとして指定する必要があります。Helmコマンド仕様を参照してください。

Helmチャートには、Kubernetes YAMLマニフェスト・ファイルのテンプレートと、デフォルトのテンプレート値を指定するためのvalues.yamlファイルが含まれています。values.yamlは、OCIアーティファクト・レジストリにある汎用ファイルです。このファイルへの参照を作成する必要があります。アーティファクト・レジストリ・アーティファクトの追加を参照してください。

ノート

デプロイメントでは、Helmチャートtarballのパラメータ置換はサポートされていません。ただし、values.yamlファイルでサポートされています。

Oracle Cloudコンソール、REST APIおよびCLIを使用したDevOpsへのアクセスについては、DevOpsへのアクセスを参照してください。

ナビゲーション・メニューを開き、「開発者サービス」をクリックします。「DevOps」で、「プロジェクト」をクリックします。

プロジェクトおよびデプロイメント・パイプラインを選択します。

パイプラインにステージを追加するには、「+」アイコンをクリックし、「ステージの追加」を選択します。

ステージ・タイプとして「KubernetesクラスタへのHelmチャートのインストール」または「KubernetesクラスタでのHelmコマンドの実行」を選択し、「次へ」をクリックします。

ステージの名前と説明を入力します。説明の追加はオプションです。

「環境」で、既存のクラスタ環境を選択します。

Helmステージを作成する目的を選択します。オプションは次のとおりです:

KubernetesクラスタでのHelmチャートのインストールまたはアップグレード

KubernetesクラスタでのHelmコマンドの実行

Helmコマンドを実行するオプションを選択した場合は、Helmコマンド仕様アーティファクトを選択し、ステージを追加します。詳細は、Helmコマンド仕様を参照してください。

Helmチャートをインストールまたはアップグレードするオプションを選択した場合は、リリース名を入力します。例: helm-release。
リリースとは、特定の構成を持つHelmチャートの実行中のインスタンスを指します。1つのチャートを同じクラスタに何度もインストールして、異なるリリースを作成できます。

このステージがパイプラインから削除されたときにOKEクラスタからHelmリリースをアンインストールするには、「ステージ削除時にHelmリリースをアンインストールします」チェック・ボックスを選択します。

「アーティファクトの選択」をクリックして、デプロイメント用のHelmチャートを選択します。

(オプション)「アーティファクトの選択」をクリックして、ヘルム・チャートに渡される値を含むvalues.yamlファイルを選択します。このファイルには、オーバーライド可能なデフォルト・パラメータが含まれています。

(オプション)デフォルトの環境ネームスペースをオーバーライドするには、「Kubernetesネームスペースのオーバーライド」に値を入力します。

(オプション)デプロイメントのタイムアウト値を秒単位で入力します。

(オプション) Helmアップグレード・オプションを指定して、Helmチャート・バージョンをアップグレードするか、Helmリリースの構成を変更します。Helmアップグレードを参照してください。
Helmチャートのデプロイメント中に、Helmコマンドの値および文字列値を設定できます。
デプロイメント当たりのアップグレードの最大数を指定します。デフォルトでは、この値は10に設定されます。アップグレードの制限を設定しない場合は、ゼロを入力します。

検証が失敗した場合に、最後に成功したリリース・バージョンに自動的にロールバックするには、「はい」を選択します。詳細は、デプロイメントのロールバックを参照してください。

(オプション)パイプラインにタグを追加するには、「タグ付けオプションの表示」をクリックします。タグ付けとは、テナンシ内のリソースを整理およびトラッキングできるメタデータ・システムです。
リソースを作成する権限がある場合、それにフリーフォーム・タグを追加する権限もあります。
定義済タグを追加するには、タグ・ネームスペースを使用する権限が必要です。
詳細は、リソース・タグを参照してください。

ステージをパイプラインに追加するには、「追加」をクリックします。
ステージの削除中にhelmリリースをアンインストールするチェック・ボックスを選択した場合は、「Helmリリース警告のアンインストール」ダイアログ・ボックスで「確認」をクリックします。Helmリリースがアンインストールされると、リリースをアンインストールする作業リクエストが作成され、そのステータスは「デプロイメント・パイプライン」ページの「デプロイメント」セクションで追跡されます。
ステージ・プレビューによって、構成のスナップショットが提供されます。
必要に応じて、パイプラインに順次またはパラレルにステージを追加します。ターゲット環境にビルド出力をデプロイするには、デプロイメント・パイプラインを実行します。
デプロイメント中に、前の状態にロールバックされるこのステージのデプロイメントを取り消すことができます。Helmリリース・アップグレードの進行中にデプロイメントを取り消すと、アップグレードは取り消され、リリースは前の状態にロールバックされます。
ビルド・パイプラインからデプロイメントを自動的にトリガーするには、ビルド・パイプラインに「デプロイメントのトリガー」ステージを追加します。
パイプラインにOKE Helmステージを作成するには、create-OKE-helm-chart-stageコマンドを実行します:
```
oci devops deploy-stage create-oke-helm-chart-stage
```
必須パラメータ:
- --helm-chart-artifact-id
- --oke-cluster-environment-id
- --pipeline-id
- --stage-predecessor-collection
- --release-name
「目的」フィールドをHelmステージに追加するには、update-oke-helm-chart-stageコマンドを実行します:
```
oci devops deploy-stage update-oke-helm-chart-stage --helm-command-artifact-ids --purpose
```
Helmステージをアンインストールするには、create-oke-helm-chart-stageコマンドを実行します:
```
oci devops deploy-stage create-oke-helm-chart-stage --is-uninstall-on-stage-delete
```
deploy-stageのすべてのコマンドを取得するには:
```
oci devops deploy-stage -h
```
create-oke-helm-chart-stageコマンドのヘルプを取得するには:
```
oci devops deploy-stage create-oke-helm-chart-stage -h
```
Kubernetesクラスタ・ステージをパイプラインに作成するには、CreateDeployStage操作を使用します。deployStageType属性には、値としてOKE_HELM_CHART_DEPLOYMENTを指定します。

Oracle Cloud Infrastructureドキュメント

Helmアーティファクトのデプロイ