Oracle Cloud Infrastructureドキュメント

ファンクションへのカスタム構成パラメータの受渡し

Oracle Functionsにデプロイするファンクションのコードには、通常、異なるパラメータの値が必要です。 一部の事前定義済パラメータは、環境変数として使用できます。 しかし、多くの場合、独自に定義したパラメータをファンクションで使用する必要があります。 たとえば、データベースから読み取ってデータベースに書き込むファンクションを作成できます。 このファンクションには、ユーザー名、パスワードおよびホスト名で構成されるデータベース接続文字列が必要です。 起動時にファンクションに渡されるパラメータとして、ユーザー名、パスワードおよびホスト名を定義することが必要になる場合があります。

Oracle Functionsにデプロイされたファンクションにユーザー定義パラメータを渡すには、カスタム構成パラメータと呼ばれるキーと値のペアを作成します。 次のカスタム構成パラメータを作成できます:

  • アプリケーション全体。つまり、アプリケーション内のすべてのファンクションに渡されます。
  • ファンクション固有。定義されている特定のファンクションに渡されます(ファンクション固有のパラメータは、同じ名前のアプリケーション全体のパラメータをオーバーライドします)。

カスタム構成パラメータを作成するには、次を使用できます:

  • ファンクションのfunc.yamlファイルのconfig:セクションで、ファンクション固有のカスタム構成パラメータを定義
  • コンソールおよびFn Project CLIを使用して、アプリケーション全体およびファンクション固有のカスタム構成パラメータの両方を定義

Oracle Functionsでは、アプリケーション内のすべてのカスタム構成パラメータ(アプリケーション全体とファンクション固有の両方)が、最大許容サイズの4Kbで、シリアルにエンコードされた単一の構成オブジェクトに結合されます。

コンソールの使用

コンソールを使用してファンクションに渡すカスタム構成パラメータを指定するには:

  1. ファンクション開発者としてコンソールにログインします。
  2. コンソールで、「ナビゲーション・メニュー」を開きます。 ソリューションおよびプラットフォームの下で、開発者サービスに移動して「ファンクション」をクリックします。
  3. Oracle Functionsで使用するリージョンを選択します。 Oracleは、Fn Project CLIコンテキストで指定されたDockerレジストリと同じリージョンを使用することをお薦めします(「6. Oracle Cloud Infrastructureに接続するFn Project CLIコンテキストの作成」を参照)。
  4. Fn Project CLIコンテキストで指定されたコンパートメントを選択します(「6. Oracle Cloud Infrastructureに接続するFn Project CLIコンテキストの作成」を参照)。

    「アプリケーション」ページには、コンパートメントで定義されたアプリケーションが表示されます。

  5. カスタム構成パラメータを渡すファンクションを含むアプリケーションの名前をクリックします:

    • アプリケーション内のすべてのファンクションに1つ以上のカスタム構成パラメータを渡すには、「構成」をクリックして、アプリケーションの「構成」セクションを表示します。

    • 1つ以上のカスタム構成パラメータを特定のファンクションに渡すには、ファンクション名をクリックしてそのファンクションの「構成」セクションを表示します。

  6. 「構成」セクションで、最初のカスタム構成パラメータの詳細を指定します:

    • キー: カスタム構成パラメータの名前。 名前に使用できるのは、英数字とアンダースコアのみで、1文字目は数字にできません。 たとえば、username
    • 値: カスタム構成パラメータの値。 値には印刷可能なunicode文字のみを含める必要があります。 たとえば、jdoe などです
  7. プラス・ボタンをクリックして、新しいカスタム構成パラメータを保存します。

    Oracle Functionsでは、アプリケーション内のすべてのカスタム構成パラメータ(アプリケーション全体とファンクション固有の両方)のキーと値のペアが、最大許容サイズの4Kbで、シリアルにエンコードされた単一の構成オブジェクトに結合されます。 シリアルにエンコードされた構成オブジェクトのサイズが4Kbよりも大きい場合、新しいカスタム構成パラメータを保存することはできません。

  8. (オプション)必要に応じて、追加のカスタム構成パラメータを入力します。

Fn Project CLIコマンドの使用方法

Fn Project CLIを使用して、ファンクションに渡すカスタム構成パラメータを指定するには:

  1. ファンクション開発者として開発環境にログインして、ターミナル・ウィンドウを開きます。

  2. 既存のアプリケーションのすべてのファンクションに渡す1つ以上のカスタム構成パラメータを指定するには、次のように入力します:

    $ fn config app <app-name> <key> <value>

    説明:

    • <app-name>は、カスタム構成パラメータを渡すファンクションを含むアプリケーションの名前です。
    • <key>は、カスタム構成パラメータの名前です。 名前に使用できるのは、英数字とアンダースコアのみで、1文字目は数字にできません。
    • <value>は、カスタム構成パラメータに指定する値です。 値には印刷可能なunicode文字のみを含める必要があります。

    例えば:

    $ fn config app acmeapp username jdoe

    次の点に注意してください。

    • fn create appコマンドを使用して新しいアプリケーションを作成するときに、アプリケーション全体のカスタム構成パラメータを定義することもできます。
    • Oracle Functionsでは、アプリケーション内のすべてのカスタム構成パラメータ(アプリケーション全体とファンクション固有の両方)のキーと値のペアが、最大許容サイズの4Kbで、シリアルにエンコードされた単一の構成オブジェクトに結合されます。
  3. 特定のファンクションに渡す1つ以上のカスタム構成パラメータを指定するには、次のように入力します:

    $ fn config function <app-name> <function-name> <key> <value>

    説明:

    • <app-name>は、カスタム構成パラメータを渡すファンクションを含むアプリケーションの名前です。
    • <function-name>は、カスタム構成パラメータを渡すファンクションの名前です。
    • <key>は、カスタム構成パラメータの名前です。 名前に使用できるのは、英数字とアンダースコアのみで、1文字目は数字にできません。
    • <value>は、カスタム構成パラメータに指定する値です。 値には印刷可能なunicode文字のみを含める必要があります。

    例えば:

    $ fn config function acmeapp acme-func username jdoe

    次の点に注意してください。

    • fn create functionコマンドを使用してファンクションを新しく作成する場合、ファンクション固有のカスタム構成パラメータも定義できます。
    • Oracle Functionsでは、アプリケーション内のすべてのカスタム構成パラメータ(アプリケーション全体とファンクション固有の両方)のキーと値のペアが、最大許容サイズの4Kbで、シリアルにエンコードされた単一の構成オブジェクトに結合されます。

APIの使用

APIおよび署名リクエストの使用については、REST APIおよび「セキュリティ資格証明」を参照してください。 SDKの詳細は、「ソフトウェア開発キットとコマンドライン・インタフェース」を参照してください。

次のAPI操作を使用して、カスタム構成パラメータを定義します: