VPC環境で利用できます。
Add-onのインストールと管理
Add-onをインストールして、設定とバージョンを変更し、削除する方法を説明します。Canaryアップグレードをサポートする Add-onのマイナーバージョンへのアップグレードは、Canaryアップグレードをご参照ください。
クラスタ作成時に一緒にインストール
クラスタを作成する時、Add-onタブメニューでインストールする Add-onを一緒に指定します。指定した Add-onは、クラスタが作成される間にインストールされます。クラスタ作成の全手順は、Ncloud Kubernetes Service を開始するをご参照ください。
指定する項目は次の通りです。
- Add-on選択: インストールする Add-onのチェックボックスをクリックして選択します。複数の Add-onを一度に指定できます。
- バージョン選択: Add-onのバージョン選択ボックスからインストールするバージョンを選択します。
- 設定値入力: [詳細設定] ボタンをクリックし、Add-on追加のポップアップで設定値を入力した後、 [保存] ボタンをクリックします。入力しないとデフォルト値でインストールされます。
運用中 Add-onのインストール
運用中のクラスタにインストールされていない Add-onを追加します。既にインストールされた Add-onはインストール完了と表示され、選択できません。
運用中のクラスタに Add-onをインストールする方法は、次の通りです。
- クラスタ詳細の [Add-on] タブメニューをクリックします。
- [Add-onのインポート] ボタンをクリックします。
- Add-onのインポートのポップアップが表示されたら、インストールする Add-onのチェックボックスをクリックして選択します。
- バージョン選択ボックスからインストールするバージョンをクリックして選択します。
- 設定値を入力するには、 [詳細設定] ボタンをクリックし、Add-on追加のポップアップで入力した後、 [保存] ボタンをクリックします。入力しないとデフォルト値でインストールされます。
- [インポート] ボタンをクリックします。インストールが開始されます。
設定変更とバージョンアップグレード
インストールされた Add-onのバージョンと設定値を変更します。Add-on変更のポップアップは、現在の設定値が入力された状態で表示されます。
Canaryアップグレードをサポートする Add-onでは、この手順で同じマイナーバージョン内のパッチバージョンのみ変更できます。マイナーバージョンをアップグレードするには、Canaryアップグレードを使用します。Canaryアップグレードの進行中は、変更や削除はできません。
インストールされた Add-onを変更する方法は、次の通りです。
- クラスタ詳細の [Add-on] タブメニューをクリックします。
- 変更する Add-onを選択し、 [変更] ボタンをクリックします。Add-on変更のポップアップが表示されます。
- 必要に応じてバージョンを変更します。バージョンはクラスタと互換性のある範囲内でクリックして選択できます。
- 必要に応じて設定値を変更します。
- **競合管理(競合解決)** から方法をクリックして選択します。詳細は、競合管理をご参照ください。
- [保存] ボタンをクリックします。変更が適用されます。
変更事項が拒否されたり検証に失敗する場合、直前の正常ステータス(バージョンと設定値)に自動復元を試行します。ただし、適用は完了したものの、その後ランタイムが異常な状態になった場合(例: コンテナが繰り返し再起動)は、自動復元の対象ではありません。
競合管理
Add-onはデフォルト設定値にユーザーが入力した設定値を反映して最終構成を作成し、これをクラスタに適用します。入力しなかった項目はデフォルト設定値を使用します。設定値を入力して構成を変えることは競合ではなく、競合は
ユーザーがクラスタ上で直接(例: kubectl edit)変更したフィールドにのみ発生します。直接変更したフィールドがない場合、どの方式を選択しても結果は同じです。
Add-on変更のポップアップの競合管理(競合解決) で選択できる方法は、次の通りです。
| 方式 | 説明 |
|---|---|
| Overwrite(上書き) | 基本的な方法でユーザーが直接変更したフィールドがあっても、最終構成値に上書きされる。競合でタスクが失敗しない |
| Preserve(既存設定を維持) | ユーザーが直接変更したフィールドはそのままにし、その他を最終構成値に更新。直接変更した値がこの値と競合する場合、タスクが失敗することがある |
Add-on削除
インストールされた Add-onをクラスタから削除します。インストールされた Add-onを削除する方法は、次の通りです。
- クラスタ詳細の [Add-on] タブメニューをクリックします。
- 削除する Add-onを選択し、 [削除] ボタンをクリックします。
- Add-on削除のポップアップの内容を確認し、削除する Add-onの名前を入力した後、 [削除] ボタンをクリックします。削除を開始します。
削除すると、Add-onを通じてインストールされたリソースが削除されます。削除前に Add-onリソースに依存するワークロードがクラスタに残ってないか確認します。ただし、ユーザーデータが残っているリソース(例: 使用中のボリュームスナップショット)は、保護のために保存されることがあります。また、保存されたリソースは必要な場合に直接クリーンアップします。
Canaryアップグレード
Canaryアップグレードは Add-onの新しいマイナーバージョンを既存バージョンと並行してインストールし、ワークロードを段階的に切り替えて検証した後、新しいバージョンへの移行を確定するアップグレード方式です。問題が見つかった場合は、新しいバージョンを削除して既存バージョンに戻すことができます。以下の3つのステップで行います。
- 開始: 新しいバージョンを既存バージョンと並行してインストールします。既存バージョンはそのまま運用されます。
- 検証: ワークロードを新しいバージョンに段階的に切り替えて正常動作を確認します。
- 確定またはキャンセル: 確定すると、新しいバージョンが運用バージョンとなり、既存バージョンが削除されます。キャンセルすると、新しいバージョンが削除され、既存バージョンが維持されます。
Canaryアップグレードをサポートする Add-onは、Add-onリストでご確認ください。[Canaryアップグレード] ボタンは、Canaryアップグレードをサポートする Add-onを選択した場合のみ有効になり、Add-onが有効でない場合やアップグレード可能なバージョンがない場合は無効になります。
Canaryアップグレードをサポートする Add-onは、インストールされているバージョン系列ごとに Revisionの識別子を持ちます。Revisionはバージョンのメジャーバージョンとマイナーバージョンから派生します(例: バージョン 1.30.3の Revisionは 1-30)。検証段階では2つの Revisionがクラスタに同時に存在し、コンソールのタスク結果詳細表で各 Revisionを確認できます。
開始前の確認事項
Canaryアップグレードを開始する前に、以下の事項をご確認ください。
- アップグレード可能なバージョンは、Canary開始ポップアップの対象バージョン選択ボックスに表示されます。現行バージョンの次のマイナーバージョンが提供されます。
- 開始時には、新しいバージョンに適用する設定値を指定できます。指定しない場合は現在の設定値がそのまま使用され、指定する場合は現在の設定値が指定した値に置き換わります。
- Canaryアップグレードの実行中は、以下のタスクを実行できません。確定またはキャンセルで終了した後に実行してください。
- 当該 Add-onの変更と削除
- クラスタの Kubernetesバージョンアップグレード
- 同じ Add-onの新しい Canaryアップグレード
Canaryステータス確認
Canaryアップグレード中の Add-onは、既存のステータスとは別に Canaryのステータスも持ちます。Add-onの [タスク結果の詳細を見る] ボタンをクリックすると、運用中のバージョンと Canaryバージョンが Revision、ステータスとともに表示されます。Canaryステータスは次の通りです。
| ステータス | 意味 | 可能なタスク |
|---|---|---|
| Canaryインストール中 | 新しいバージョンをインストール中 | 完了待ち |
| Canary実行中 | 2つのバージョンが同時に動作する検証段階 | 確定、キャンセル |
| Canaryインストール失敗 | 新しいバージョンインストール失敗 | 開始の再試行、キャンセル |
| Canary完了中 | 確定タスク進行中 | 完了待ち |
| Canary完了失敗 | 確定タスク失敗 | 確定再試行 |
| Canaryキャンセル中 | キャンセルタスク進行中 | 完了待ち |
| Canaryキャンセル失敗 | キャンセルタスク失敗 | キャンセル再試行 |
Canaryアップグレード開始
Add-onの新しいバージョンを既存バージョンと並行してインストールします。
- クラスタ詳細の [Add-on] タブメニューをクリックします。
- 対象 Add-onを選択し、 [Canaryアップグレード] ボタンをクリックします。
- Canary開始のポップアップが表示されたら、対象バージョン選択ボックスでアップグレードするバージョンをクリックして選択します。
- 必要に応じて新しいバージョンに適用する設定値を入力します。
- 案内内容を確認した後、 [開始] ボタンをクリックします。新しいバージョンのインストールが始まります。
インストールが完了すると、Canaryステータスが Canary実行中に変わり、検証段階が始まります。
ワークロードの切り替え
検証段階では、ワークロードは引き続き既存 Revisionを使用します。ユーザーがクラスタ上でワークロードを直接新しい Revisionに切り替えて確認し、影響範囲の小さいネームスペースから順次行うことをお勧めします。切り替え方法は Add-onごとに異なります。Add-onリストで当該 Add-onの Canaryアップグレード項目をご参照ください。
確定とキャンセル
検証が完了したら、確定またはキャンセルして終了します。対象 Add-onの [タスク結果の詳細を見る] ボタンをクリックすると、Canaryステータスに応じて実行可能なタスクのボタンが有効になります。
- 確定: [確定] ボタンをクリックします。Canary完了のポップアップで変更内容を確認し、復元できないことに同意するチェックボックスをクリックして選択した後、 [確定] ボタンをクリックします。新しいバージョンが運用バージョンとなり、既存 Revisionが削除されます。確定後は復元できません。
- キャンセル: [キャンセル] ボタンをクリックします。Canaryキャンセルポップアップの内容を確認した後、 [キャンセル実行] ボタンをクリックします。新しい Revisionが削除され、既存バージョンが維持されます。
確定またはキャンセルを行っても、削除される Revisionを使用しているワークロードは自動的に切り替わりません。確定前はすべてのワークロードが新しい Revisionに切り替わっていること、キャンセル前は新しい Revisionに切り替えたワークロードを既存 Revisionに戻していることか確認します。
Canaryタスク失敗時に確認
タスクが失敗すると、Canaryステータスが Canaryインストール失敗、Canary完了失敗、Canaryキャンセル失敗のいずれかで表示され、失敗の理由は [タスク結果の詳細を見る] ボタンをクリックし、ステータスログメッセージで確認できます。開始に失敗しても、既存バージョンは引き続き運用されます。確定またはキャンセルに失敗した場合、削除タスクが一部だけ完了している可能性があるため、メッセージを確認してから同じタスクを再試行して完了します。
開始の再試行は [Canaryアップグレード] ボタンで同じバージョンに対してのみ可能です。設定値は再試行時に変更できます。別のバージョンで進める場合は、キャンセルしてから新たに開始します。
Canaryアップグレードの開始、確定、キャンセルは、Cluster Add-on Canaryアップグレード APIでも実行できます。
タスク失敗時に確認
タスクに失敗すると、Add-onステータスがインストール失敗、アップデート失敗、削除失敗のいずれかで表示され、 [タスク結果の詳細を見る] ボタンをクリックし、ステータスログメッセージに原因が表示されます。メッセージを確認して設定値、バージョン、競合管理方式を調整してから、再試行してください。