Liveness Probe と Readiness Probe のプロパティー

以下の表に、アプリの liveness プローブと readiness プローブで使用されるプロパティーを要約します。

コンソールからのプローブの構成

Code Engine アプリケーションによって参照されるコード・イメージにプローブを実装した後、コンソールから liveness プローブと readiness プローブを構成して、アプリケーションのヘルス・チェックを実行できます。

開始前に

• コードにプローブを実装します。 (* Code Engine*)

• プロジェクトの作成. (Code Engine から)

1. Code EngineからProjectsページから、プロジェクトに移動します。
2. アプリケーションを作成します。 例えば、icr.io/codeengine/helloworldイメージを使用するmyappというアプリケーションを作成します。 このイメージは、 Samples for IBM Cloud Code Engine GitHub repoから入手できます。 アプリケーションの作成時に、liveness プローブと readiness プローブを構成できます。 あるいは、アプリケーション・ページの 「構成」 > 「イメージ開始オプション」 タブからアプリケーションを更新するときに、活性プローブおよび作動可能プローブの設定を表示および更新することができます。
3. アプリケーションの構成済みプローブとそのプロパティーを表示するには、アプリケーション・ページの 「構成」 > 「イメージ開始オプション」 タブに移動します。
4. 「イメージ開始オプション」 タブで、Liveness プローブと Readiness プローブの設定を編集します。 プローブを変更すると、新しいアプリケーション・リビジョンが作成されます。 例えば、デフォルトの Readiness Probe を編集して接続タイプを TCP から HTTP に変更し、Readiness Probe のパスを /readinessprobe に設定します。 プローブ・プロパティーについて詳しくは、 プロパティー を参照してください。 完了したら Done をクリックする。
5. 「デプロイ」 をクリックして変更を保存し、プローブ設定が構成されたアプリ・リビジョンをデプロイします。

「インスタンス」 タブのビューを使用して、アプリケーション・インスタンスを確認します。

CLI を使用したプローブの構成

Code Engine CLI で liveness プローブと readiness プローブを操作できます。 ibmcloud ce app create または ibmcloud ce app update コマンドで --probe-live または --probe-ready オプションを指定して、必要なプローブを構成します。

readiness プローブまたは liveness プローブで構成できるプロパティーについて詳しくは、 Liveness プローブと readiness プローブのプロパティー を参照してください。

開始前に

• コードにプローブを実装します。 コード (* Code Engine*) にプローブを実装した後、そのプローブで動作するように Code Engine アプリケーションを構成できます。

• Code Engineから、以下のようにします。

  • Code Engine の CLI 環境をセットアップします。
  • プロジェクトを作成します。

1. ibmcloud ce application create コマンドを使用してアプリケーションを作成します。 以下の例では、アプリケーションの名前としてmyappを使用し、参照するイメージとしてicr.io/codeengine/helloworldを指定します。

   ibmcloud ce application create --name myapp --image icr.io/codeengine/helloworld
   

2. application get コマンドを実行して、アプリケーションに関する詳細を表示します。 Readiness プローブはデフォルトで構成されていることに注意してください。

   ibmcloud ce application get --name myapp
   

   出力例

   [...]
   OK
   
   Name:               myapp
   ID:                 abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
   Project Name:       myproject
   [...]
   Readiness Probe:    
       Type:              tcpsocket  
       Port:              0  
   [...]
   

3. ibmcloud ce application update コマンドを使用して myapp アプリケーションを更新し、liveness プローブを構成します。 例えば、接続でポート 8080 を使用するようにタイプ HTTP の Liveness プローブを構成するには、 --probe-live オプションを指定します。参照されるコード・イメージのホーム・ディレクトリーへのパス * * は / です。

   application create または application update コマンドで readiness プローブまたは liveness プローブのプロパティーを構成する場合は、設定する各プロパティーの前にオプション --probe-live または --probe-ready を指定する必要があります。

   ibmcloud ce application update --name myapp --probe-live type=http --probe-live path=/ --probe-live port=8080
   

4. application get コマンドを実行して、更新された myapp アプリケーションに関する詳細を表示します。 詳細には、構成済みの活性プローブに関する情報が含まれます。

   ibmcloud ce application get --name myapp
   

   出力例

   [...]
   OK
   
   Name:               myapp
   ID:                 abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
   Project Name:       myproject
   [...]
   Liveness Probe:     
       Type:              httpget  
       Path:              /  
       Port:              8080  
       Interval:          10  
       Timeout:           1  
       FailureThreshold:  1  
   
   Readiness Probe:    
       Type:              tcpsocket  
       Port:              0  
   [...]
   

myapp アプリケーションに対して liveness プローブと readiness プローブの両方を構成したので、システムは常に両方のプローブをその構成に従って実行します。

コンソールからのプローブ設定の表示

構成済みの liveness プローブと readiness プローブの詳細をコンソールで表示するには、アプリケーション・ページの 「構成」 > 「イメージ開始オプション」 タブに移動します。

CLI でのプローブ設定の表示

構成済みの liveness プローブと readiness プローブに関する情報など、CLI を使用してアプリケーションに関する詳細を表示するには、 application get コマンドを実行します。

ibmcloud ce application get --name myapp

出力例

[...]
OK

Name:               myapp
ID:                 abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Project Name:       myproject
[...]
Liveness Probe:     
    Type:              httpget  
    Path:              /  
    Port:              8080  
    Interval:          10  
    Timeout:           1  
    FailureThreshold:  1  

Readiness Probe:    
    Type:              tcpsocket  
    Port:              0  
[...]

コンソールからのプローブ更新

アプリケーション・ページの 「構成」 > 「イメージ開始オプション」 タブから、コンソールで readiness プローブまたは liveness プローブを変更または編集できます。

1. 申し込みページにアクセスする。 アプリケーション・ページにナビゲートする方法の 1 つは、以下のとおりです。
   • Code Engine プロジェクト・ページを見つけます。
   • プロジェクト名をクリックすると、概要ページが開きます。
   • **「アプリケーション」**をクリックして、アプリケーションのリストを開きます。 アプリケーションの名前をクリックして、そのアプリケーション・ページを開きます。
2. アプリケーション・ページから、アプリケーション・ページの 「構成」 > 「イメージ開始オプション」 タブをクリックします。
3. 「イメージ開始オプション」 タブで、Liveness プローブと Readiness プローブの設定を編集します。 プローブを変更すると、新しいアプリケーション・リビジョンが作成されます。 「編集」 をクリックして、変更する readiness プローブまたは liveness プローブを変更します。
4. 「Readiness Probe」 ページまたは 「Liveness Probe」 ページで、プローブの プロパティー を更新します。 完了したら Done をクリックする。
5. 「デプロイ」 をクリックして変更を保存し、プローブ設定が構成されたアプリ・リビジョンをデプロイします。

「インスタンス」 タブのビューを使用して、アプリケーション・インスタンスを確認します。

CLIによるプローブの更新

接続タイプが HTTP で障害しきい値が 3 で、プローブ要求間の間隔が 5 秒になるように、 myapp の活性プローブを更新するとします。

1. ibmcloud ce application update コマンドを使用して myapp アプリケーションを更新し、接続タイプが HTTP、障害しきい値が 3、プローブ要求間の間隔が 5 秒になるように活性プローブを更新します。

   application create または application update コマンドで readiness プローブまたは liveness プローブのプロパティーを構成する場合は、設定する各プロパティーの前にオプション --probe-live または --probe-ready を指定する必要があります。

   ibmcloud ce application update --name myapp --probe-live type=http --probe-live interval=5 --probe-live failure-threshold=3
   

2. application get コマンドを実行して、更新された myapp アプリケーションに関する詳細を表示します。 詳細には、活性プローブの現在の構成に関する情報が含まれます。

   ibmcloud ce application get --name myapp
   

   出力例

   [...]
   OK
   
   Name:               myapp
   ID:                 abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
   Project Name:       myproject
   [...]
   Liveness Probe:     
       Type:              httpget  
       Path:              /  
       Port:              8080  
       Interval:          5  
       Timeout:           1  
       FailureThreshold:  3  
   
   Readiness Probe:    
       Type:              tcpsocket  
       Port:              0  
   [...]
   

3. ibmcloud ce application update コマンドを使用して myapp アプリケーションを更新し、接続タイプが HTTP、ポートが 8080、障害しきい値が 3、プローブ要求間の間隔が 5 秒になるように作動可能プローブを更新します。

   application create または application update コマンドで readiness プローブまたは liveness プローブのプロパティーを構成する場合は、設定する各プロパティーの前にオプション --probe-live または --probe-ready を指定する必要があります。

   ibmcloud ce application update --name myapp --probe-ready type=http --probe-ready port=8080 --probe-ready interval=5 --probe-ready failure-threshold=3
   

4. application get コマンドを実行して、更新された myapp アプリケーションに関する詳細を表示します。 詳細には、readiness プローブの更新された設定に関する情報が含まれます。

   ibmcloud ce application get --name myapp
   

   出力例

   [...]
   OK
   
   Name:               myapp
   ID:                 abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
   Project Name:       myproject
   [...]
   Liveness Probe:     
       Type:              httpget  
       Path:              /  
       Port:              8080  
       Interval:          5  
       Timeout:           1  
       FailureThreshold:  3  
   
   Readiness Probe:    
       Type:              httpget  
       Path:              /  
       Port:              8080  
       Interval:          5  
       Timeout:           1  
       FailureThreshold:  3  
   [...]
   

コンソールからのプローブの削除

コンソールで、アプリケーション・ページの 「構成」 > 「イメージ開始オプション」 タブから Liveness Probe を削除できます。

1. 申し込みページにアクセスする。 アプリケーション・ページにナビゲートする方法の 1 つは、以下のとおりです。
   • Code Engine プロジェクト・ページを見つけます。
   • プロジェクト名をクリックすると、概要ページが開きます。
   • **「アプリケーション」**をクリックして、アプリケーションのリストを開きます。 アプリケーションの名前をクリックして、そのアプリケーション・ページを開きます。
2. アプリケーション・ページで、 「構成」 タブをクリックしてから、アプリケーション・ページの 「イメージ開始オプション」 タブをクリックします。
3. Liveness Probe を削除するには、新しいアプリケーション・リビジョンを作成する必要があります。
   1. Liveness プローブを削除するには、 「削除」 をクリックします。
   2. Deploy をクリックして変更を保存し、アプリのリビジョンをデプロイします。

Readiness プローブを削除することはできませんが、 更新 することはできます。

CLI を使用したプローブの削除

1. liveness プローブを削除するには、 --probe-live-clear オプションを指定した ibmcloud ce application update コマンドを使用して myapp アプリケーションを更新します。

   ibmcloud ce application update --name myapp --probe-live-clear
   

2. application get コマンドを実行して、更新された myapp アプリケーションに関する詳細を表示します。 活性プローブが削除されます。

   ibmcloud ce application get --name myapp
   

   出力例

   [...]
   OK
   
   Name:               myapp
   ID:                 abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
   Project Name:       myproject
   [...]
   Readiness Probe:    
       Type:              httpget  
       Path:              /  
       Port:              8080  
       Interval:          5  
       Timeout:           1  
       FailureThreshold:  3   
   [...]
   

3. 作動可能プローブをデフォルト構成にリセットするには、 --probe-ready-reset オプションを指定した ibmcloud ce application update コマンドを使用して myapp アプリケーションを更新します。

   ibmcloud ce application update --name myapp --probe-ready-reset
   

4. application get コマンドを実行して、更新された myapp アプリケーションに関する詳細を表示します。 readiness プローブはデフォルト構成にリセットされます。

   ibmcloud ce application get --name myapp
   

   出力例

   [...]
   OK
   
   Name:               myapp
   ID:                 abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
   Project Name:       myproject
   [...]
   Readiness Probe:    
       Type:              tcpsocket  
       Port:              0  
   [...]