関数

手順

1. 関数のプロジェクトフォルダーに移動します。

2. Maven テストを実行します。

   $ ./mvnw test

手順

1. /health/liveness パスと /health/readiness パスを独自の値でオーバーライドします。これを行うには、関数ソースのプロパティーを変更するか、func.yaml ファイルで QUARKUS_SMALLRYE_HEALTH_LIVENESS_PATH および QUARKUS_SMALLRYE_HEALTH_READINESS_PATH 環境変数を設定します。

   1. 関数ソースを使用してパスを上書きするには、src/main/resources/application.properties ファイルの path プロパティーを更新します。

      quarkus.smallrye-health.root-path=/health 1
      quarkus.smallrye-health.liveness-path=alive 2
      quarkus.smallrye-health.readiness-path=ready 3

      1

      liveness パスと readiness パスの先頭に自動的に追加されるルートパス。

      2

      liveness パス。ここでは /health/alive に設定されます。

      3

      readiness パス。ここでは /health/ready に設定されます。

   2. 環境変数を使用してパスを上書きするには、func.yaml ファイルの build ブロックにパス変数を定義します。

      build:
        builder: s2i
        buildEnvs:
        - name: QUARKUS_SMALLRYE_HEALTH_LIVENESS_PATH
          value: alive 1
        - name: QUARKUS_SMALLRYE_HEALTH_READINESS_PATH
          value: ready 2

      1

      liveness パス。ここでは /health/alive に設定されます。

      2

      readiness パス。ここでは /health/ready に設定されます。

2. 新しいエンドポイントを func.yaml ファイルに追加して、Knative サービスのコンテナーに適切にバインドされるようにします。

   deploy:
     healthEndpoints:
       liveness: /health/alive
       readiness: /health/ready

手順

1. 関数の test フォルダーに移動します。

2. テストを実行します。

   $ npm test

手順

1. 関数コードで、次のインターフェイスを実装する Function オブジェクトを作成します。

   export interface Function {
     init?: () => any; 1
   
     shutdown?: () => any; 2
   
     liveness?: HealthCheck; 3
   
     readiness?: HealthCheck; 4
   
     logLevel?: LogLevel;
   
     handle: CloudEventFunction | HTTPFunction; 5
   }

   1

   サーバーの起動前に呼び出される初期化関数。この関数はオプションであり、同期する必要があります。

   2

   サーバーの停止後に呼び出される shutdown 関数。この関数はオプションであり、同期する必要があります。

   3

   liveness 関数。サーバーが生きているかどうかを確認するために呼び出されます。この関数はオプションであり、サーバーが稼動している場合は 200/OK を返す必要があります。

   4

   readiness 関数。サーバーがリクエストを受け入れる準備ができているかどうかを確認するために呼び出されます。この関数はオプションであり、サーバーが準備できている場合は 200/OK を返すはずです。

   5

   HTTP リクエストを処理する関数。

   たとえば、以下のコードを index.js ファイルに追加します。

   const Function = {
   
     handle: (context, body) => {
       // The function logic goes here
       return 'function called'
     },
   
     liveness: () => {
       process.stdout.write('In liveness\n');
       return 'ok, alive';
     }, 1
   
     readiness: () => {
       process.stdout.write('In readiness\n');
       return 'ok, ready';
     } 2
   };
   
   Function.liveness.path = '/alive'; 3
   Function.readiness.path = '/ready'; 4
   
   module.exports = Function;

   1

   カスタム liveness 関数。

   2

   カスタム readiness 関数。

   3

   カスタム liveness エンドポイント。

   4

   カスタム readiness エンドポイント。

   Function.liveness.path および Function.readiness.path の代わりに、LIVENESS_URL および READINESS_URL 環境変数を使用してカスタムエンドポイントを指定できます。

   run:
     envs:
     - name: LIVENESS_URL
       value: /alive 1
     - name: READINESS_URL
       value: /ready 2

   1

   liveness パス。ここで /alive に設定されます。

   2

   readiness パス。ここで /ready に設定されます｡

2. 新しいエンドポイントを func.yaml ファイルに追加して、Knative サービスのコンテナーに適切にバインドされるようにします。

   deploy:
     healthEndpoints:
       liveness: /alive
       readiness: /ready

手順

1. テストを実行していない場合は、最初に依存関係をインストールします。

   $ npm install

2. 関数の test フォルダーに移動します。

3. テストを実行します。

   $ npm test

手順

1. 関数コードで、次のインターフェイスを実装する Function オブジェクトを作成します。

   export interface Function {
     init?: () => any; 1
   
     shutdown?: () => any; 2
   
     liveness?: HealthCheck; 3
   
     readiness?: HealthCheck; 4
   
     logLevel?: LogLevel;
   
     handle: CloudEventFunction | HTTPFunction; 5
   }

   1

   サーバーの起動前に呼び出される初期化関数。この関数はオプションであり、同期する必要があります。

   2

   サーバーの停止後に呼び出される shutdown 関数。この関数はオプションであり、同期する必要があります。

   3

   liveness 関数。サーバーが生きているかどうかを確認するために呼び出されます。この関数はオプションであり、サーバーが稼動している場合は 200/OK を返す必要があります。

   4

   readiness 関数。サーバーがリクエストを受け入れる準備ができているかどうかを確認するために呼び出されます。この関数はオプションであり、サーバーが準備できている場合は 200/OK を返すはずです。

   5

   HTTP リクエストを処理する関数。

   たとえば、以下のコードを index.js ファイルに追加します。

   const Function = {
   
     handle: (context, body) => {
       // The function logic goes here
       return 'function called'
     },
   
     liveness: () => {
       process.stdout.write('In liveness\n');
       return 'ok, alive';
     }, 1
   
     readiness: () => {
       process.stdout.write('In readiness\n');
       return 'ok, ready';
     } 2
   };
   
   Function.liveness.path = '/alive'; 3
   Function.readiness.path = '/ready'; 4
   
   module.exports = Function;

   1

   カスタム liveness 関数。

   2

   カスタム readiness 関数。

   3

   カスタム liveness エンドポイント。

   4

   カスタム readiness エンドポイント。

   Function.liveness.path および Function.readiness.path の代わりに、LIVENESS_URL および READINESS_URL 環境変数を使用してカスタムエンドポイントを指定できます。

   run:
     envs:
     - name: LIVENESS_URL
       value: /alive 1
     - name: READINESS_URL
       value: /ready 2

   1

   liveness パス。ここで /alive に設定されます。

   2

   readiness パス。ここで /ready に設定されます｡

2. 新しいエンドポイントを func.yaml ファイルに追加して、Knative サービスのコンテナーに適切にバインドされるようにします。

   deploy:
     healthEndpoints:
       liveness: /alive
       readiness: /ready

手順

1. test_func.py ファイルが含まれる関数のフォルダーに移動します。

2. テストを実行します。

   $ python3 test_func.py

手順

1. 関数プロジェクトディレクトリーで以下のコマンドを実行します。

   $ kn func config

   あるいは、--path または -p オプションを使用して、関数プロジェクトディレクトリーを指定できます。

2. 対話型インターフェイスを使用して必要な操作を実行します。たとえば、ユーティリティーを使用して設定したボリュームのリストを表示すると、以下のような出力が生成されます。

   $ kn func config
   ? What do you want to configure? Volumes
   ? What operation do you want to perform? List
   Configured Volumes mounts:
   - Secret "mysecret" mounted at path: "/workspace/secret"
   - Secret "mysecret2" mounted at path: "/workspace/secret2"

   このスキームは、対話型ユーティリティーで利用可能なすべての操作と、それらに移動する方法を示しています。

   kn func config
      ├─> Environment variables
      │               ├─> Add
      │               │    ├─> ConfigMap: Add all key-value pairs from a config map
      │               │    ├─> ConfigMap: Add value from a key in a config map
      │               │    ├─> Secret: Add all key-value pairs from a secret
      │               │    └─> Secret: Add value from a key in a secret
      │               ├─> List: List all configured environment variables
      │               └─> Remove: Remove a configured environment variable
      └─> Volumes
              ├─> Add
              │    ├─> ConfigMap: Mount a config map as a volume
              │    └─> Secret: Mount a secret as a volume
              ├─> List: List all configured volumes
              └─> Remove: Remove a configured volume

3. オプション: 変更を反映させるため、関数をデプロイします。

   $ kn func deploy -p test

手順

1. 関数の func.yaml ファイルを開きます。

2. 追加するすべてのアノテーションについて、以下の YAML を annotations セクションに追加します。

   name: test
   namespace: ""
   runtime: go
   ...
   annotations:
     <annotation_name>: "<annotation_value>" 1

   1

   <annotation_name>: "<annotation_value>" をお使いのアノテーションに置き換えます。

   たとえば、関数が Alice によって作成者されたことを示すには、以下のアノテーションを含めることができます。

   name: test
   namespace: ""
   runtime: go
   ...
   annotations:
     author: "alice@example.com"

3. 設定を保存します。