ローカル・ホストでのファンクションのクイックスタート

このOCI Functions QuickStartを使用して、ローカル・ホストで迅速に設定および実行する方法を確認してください。

A.テナンシを設定します

1. グループとユーザーの作成

適切なユーザーおよびグループが存在しない場合:

  1. テナンシ管理者としてコンソールにサインインします。
  2. ナビゲーション・メニューを開き、「アイデンティティとセキュリティ」をクリックします。「アイデンティティ」で、「ドメイン」をクリックします。
  3. 「グループ」「グループの作成」の順にクリックして、新しいグループを作成します。
    この図は、「名前」および「説明」フィールドが空の「グループの作成」ダイアログを示しています。
  4. 「ユーザー」「ユーザーの作成」の順にクリックして、新しいユーザーを作成します。
    この図は、「名前」、「説明」、「電子メール」および「電子メールの確認」フィールドが空の「ユーザーの作成」ダイアログを示しています。
  5. 「グループ」、グループの名前、「ユーザーをグループに追加」の順にクリックして、ユーザーをグループに追加します。
    この図は、「ユーザー」フィールドが空の「ユーザーをグループに追加」ダイアログを示しています。

詳細は、構成ノートを参照してください。

2. コンパートメントの作成

ネットワーク・リソースおよびOCI Functionsリソースを作成する適切なコンパートメントがまだ存在しない場合:

  1. テナンシ管理者としてコンソールにサインインします。
  2. ナビゲーション・メニューを開き、「アイデンティティとセキュリティ」をクリックします。「アイデンティティ」で、「コンパートメント」をクリックします。
  3. 「コンパートメントの作成」をクリックします。
    この図は、「名前」および「説明」フィールドが空の「コンパートメントの作成」ダイアログを示しています。

詳細は、構成ノートを参照してください。

3.VCNとサブネットを作成します

ネットワーク・リソースを作成する適切なVCNがまだ存在しない場合:

  1. テナンシ管理者としてコンソールにサインインします。
  2. ナビゲーション・メニューを開き、「ネットワーキング」「仮想クラウド・ネットワーク」の順にクリックします。
  3. VCNウィザードの起動をクリックして、新しいVCNを作成します。
  4. 「VCNウィザードの起動」ダイアログ・ボックスで、「インターネット接続性を持つVCN」を選択し、「VCNウィザードの起動」をクリックします。
    この図は、「インターネット接続性を持つVCNの作成」オプションが選択された「VCNウィザードの起動」ダイアログを示しています。
  5. 新しいVCNの名前を入力し、「次へ」をクリックし、「作成」をクリックして、関連するネットワーク・リソースとともにVCNを作成します。

詳細は、構成ノートを参照してください。

4. グループとサービスのポリシーの作成

1つ以上のOCI Functionsユーザーがテナンシ管理者でない場合:

  1. テナンシ管理者としてコンソールにサインインします。
  2. ナビゲーション・メニューを開き、「アイデンティティとセキュリティ」をクリックします。「アイデンティティ」で、「ポリシー」をクリックします。
  3. 「ポリシーの作成」をクリックし、新しいポリシーの名前と説明を指定して、テナンシのルート・コンパートメントを選択します。

  4. ポリシー・ビルダーを使用してポリシーを作成します。「ポリシー・ユース・ケース」のリストから「ファンクション」を選択し、ポリシー・テンプレートの「ユーザーによるファンクションおよびアプリケーションの作成、デプロイおよび管理」に基づいてポリシーを設定します。

    この図は、「名前」、「説明」および「コンパートメント」フィールドが空の「ポリシーの作成」ダイアログを示しています。「ユーザーによるクラウド・シェルを使用したファンクションおよびアプリケーションの作成、デプロイおよび管理」テンプレートが「共通ポリシー・テンプレート」フィールドに表示されます。いくつかのポリシー・ステートメントが表示されます。

    このポリシー・テンプレートには、次のポリシー・ステートメントが含まれます:

    • Allow group <group-name> to use cloud-shell in tenancy
    • Allow group <group-name> to manage repos in tenancy
    • Allow group <group-name> to read objectstorage-namespaces in tenancy
    • Allow group <group-name> to manage logging-family in tenancy
    • Allow group <group-name> to read metrics in tenancy
    • Allow group <group-name> to manage functions-family in tenancy
    • Allow group <group-name> to use virtual-network-family in tenancy
    • Allow group <group-name> to use apm-domains in tenancy
    • Allow group <group-name> to read vaults in tenancy
    • Allow group <group-name> to use keys in tenancy
    • Allow service faas to use apm-domains in tenancy
    • Allow service faas to read repos in tenancy where request.operation='ListContainerImageSignatures'
    • Allow service faas to {KEY_READ} in tenancy where request.operation='GetKeyVersion'
    • Allow service faas to {KEY_VERIFY} in tenancy where request.operation='Verify'

    必要に応じて、これらのポリシー・ステートメントをコンパートメント別に制限できます。

詳細は、構成ノートを参照してください。

Bアプリケーションの作成

1. 最初のアプリケーションを作成します
  1. ファンクション開発者としてコンソールにサインインします。
  2. ナビゲーション・メニューを開き、「開発者サービス」をクリックします「ファンクション」で、「アプリケーション」をクリックします。
  3. OCI Functionsで使用しているリージョンを選択します。
  4. 「アプリケーションの作成」をクリックします。
    この図は、「名前」、「VCN」および「サブネット」フィールドが空の「新規アプリケーション」ダイアログを示しています。
  5. 次を指定します:
    • 新規アプリケーションの名前としてhelloworld-app。このアプリケーションに最初のファンクションをデプロイし、ファンクションの起動時にこのアプリケーションを指定します。
    • ファンクションを実行するVCNおよびサブネット。パブリック・サブネットにはVCN内のインターネット・ゲートウェイが必要で、プライベート・サブネットにはVCN内のサービス・ゲートウェイが必要です。
  6. 「作成」をクリックします。

詳細は、詳細な手順を参照してください。

C.ローカルホスト開発環境を設定する

1.Dockerのインストールと起動

開発環境のターミナル・ウィンドウ:

  1. 次のように入力して、Dockerがインストールされていることを確認します:
    docker version

    Dockerがインストールされていないことを示すエラー・メッセージが表示された場合は、続行する前にDockerをインストールする必要があります。ご使用のプラットフォームのDockerドキュメントを参照してください(Oracle Linuxについては、こちらを参照してください)。

    Dockerがインストールされている場合、GitHubのFn Projectホームページの「前提条件」セクションに移動し、インストールされているDockerのバージョンが少なくともそこで指定されている最小バージョンであることを確認します。そうでない場合は、続行する前にDockerを再インストールしてください。

  2. 次のように入力して、標準のhello-world Dockerイメージをコンテナとして起動し、Dockerが実行されていることを確認します:
    docker run hello-world

    Dockerが実行されていないことを示すエラー・メッセージが表示された場合は、続行する前にDockerデーモンを起動する必要があります。Dockerドキュメントを参照してください。

詳細は、構成ノートを参照してください。

2.API署名キーおよびOCIプロファイルの設定
  1. ファンクション開発者としてコンソールにサインインします。
  2. 「プロファイル」メニューを開き、「ユーザー設定」をクリックします。
  3. 「リソース」で、「APIキー」をクリックし、「APIキーの追加」をクリックします。
  4. 「APIキーの追加」ダイアログで、「APIキー・ペアの生成」を選択します。
    この図は、「APIキー・ペアの生成」オプションが選択された「APIキーの追加」ダイアログを示しています。
  5. 「秘密キーのダウンロード」をクリックし、~/.ociディレクトリに秘密キー・ファイルを(.pemファイルとして)保存します。(~/.ociディレクトリがまだ存在しない場合は作成します)。
  6. 「追加」をクリックして、新しいAPI署名キーをユーザー設定に追加します。

    「構成ファイルのプレビュー」ダイアログが表示され、DEFAULTという名前のプロファイル(先ほど作成したAPI署名キーのフィンガープリントを含む)の基本認証情報を含む構成ファイル・スニペットが含まれています。

    この画像は、「構成ファイルのプレビュー」ダイアログと、Defaultという名前のプロファイルの基本認証情報を示しています。

  7. テキスト・ボックスに表示されている構成ファイル・スニペットをコピーし、「構成ファイルのプレビュー」ダイアログを閉じます。
  8. テキスト・エディタで、~/.oci/configファイルを開き、ファイルにスニペットを貼り付けます。(~/.oci/configファイルがまだ存在しない場合は、ここで作成します)。
  9. テキスト・エディタで、貼り付けたスニペットのプロファイルを次のように変更します。
    • プロファイル名を[DEFAULT]から選択した名前([functions-developer-profile]など)に変更します。~/.oci/configファイルには、同じ名前のプロファイルを2つ含めることはできません。
    • プロファイルのkey_fileパラメータの値を変更して、以前にダウンロードした秘密キー・ファイル(.pemファイル)のパスを指定します。
  10. テキスト・エディタで、~/.oci/configファイルに加えた変更を保存し、テキスト・エディタを閉じます。
  11. ターミナル・ウィンドウで、次のように入力して、秘密キー・ファイル(.pemファイル)の権限を変更し、ユーザーのみが読み取れるようにします:
    chmod go-rwx ~/.oci/<private-key-file-name>.pem

API署名キーの設定およびプロファイルの作成の詳細は、構成ノートを参照してください。

3.Fn ProjectのCLIのインストール

開発環境のターミナル・ウィンドウ:

  1. ご使用の環境にあわせて、次の適切な手順を使用してFn ProjectのCLIをインストールします。
  2. 次のように入力して、Fn ProjectのCLIがインストールされていることを確認します:
    fn version

詳細は、構成ノートを参照してください。

4.Fn ProjectのCLIコンテキスト・プロバイダの設定--oracle

開発環境のターミナル・ウィンドウ:

  1. 次を入力して、新しいFn ProjectのCLIコンテキストを作成します:
    fn create context <my-context> --provider oracle

    --provider oracleを指定すると、Oracle Cloud Infrastructureリクエスト署名、秘密キー、ユーザー・グループ、およびこれらのユーザー・グループに権限を付与するポリシーを使用して、認証および認可が有効になります。

  2. 次を入力して、Fn ProjectのCLIが新しいコンテキストを使用するように指定します:
    fn use context <my-context>
  3. 次のように入力して、OCI Functionsで使用するために作成したOCIプロファイルの名前で新しいFn ProjectのCLIコンテキストを構成します(たとえば、[functions-developer-profile])。
    fn update context oracle.profile <profile-name>

詳細は、構成ノートを参照してください。

5.Fn ProjectのCLIコンテキスト構成の完了

開発環境のターミナル・ウィンドウ:

  1. デプロイされたファンクションを所有するコンパートメントのOCIDを使用して、新しいFn ProjectのCLIコンテキストを構成します
    fn update context oracle.compartment-id <compartment-ocid>
  2. 次を入力して、OCI APIのコール時に使用するAPI-urlエンドポイントで新しいコンテキストを構成します。
    fn update context api-url <api-endpoint>

    ここで、<api-endpoint>は、ファンクションAPIファンクション・エンドポイントのリストにあるエンドポイントの1つです。フォーマットはhttps://functions.<region-identifier>.oci.oraclecloud.comです。例:

    fn update context api-url https://functions.us-phoenix-1.oci.oraclecloud.com
  3. OCI Functionsで使用する現在のリージョンおよびテナンシのOracle Cloud Infrastructure Registryアドレスを使用して、Fn ProjectのCLIコンテキストを構成します:

    fn update context registry <region-key>.ocir.io/<tenancy-namespace>/<repo-name-prefix>

    <repo-name-prefix>は、ファンクションのイメージを格納するOracle Cloud Infrastructure Registryリポジトリに対して選択した接頭辞です。例:

    fn update context registry phx.ocir.io/ansh81vru1zp/acme-repo
  4. 次のように入力して、OCI Functionsでファンクション・イメージをプッシュおよびプルするリポジトリのコンパートメントのOCIDを使用して、Fn ProjectのCLIコンテキストを構成します:

    fn update context oracle.image-compartment-id <compartment-ocid>

    例:

    fn update context oracle.image-compartment-id ocid1.compartment.oc1..aaaaaaaaquqe______z2q

    oracle.image-compartment-idの値を指定しない場合、OCI Functionsはルート・コンパートメント内のリポジトリに対してイメージをプッシュおよびプルします。

詳細は、構成ノートを参照してください。

6. 認証トークンの生成
  1. ファンクション開発者としてコンソールにサインインします。
  2. 「ユーザー」メニューを開き、「ユーザー設定」に移動します。「認証トークン」ページで、「トークンの生成」をクリックします。
  3. 「トークンの生成」ダイアログに認証トークンの意味のある説明を入力し、「トークンの生成」をクリックします。新しい認証トークンが表示されます。
  4. 認証トークンを、後で取得できる保護された場所にただちにコピーします。これは、コンソールに認証トークンが再度表示されないようにするためです。
  5. 「トークンの生成」ダイアログを閉じます。

詳細は、構成ノートを参照してください。

7. レジストリにログイン

コンソール「スタート・ガイド」ページで、次の手順を実行します。

  1. 次のコマンドをコピーします。

    docker login -u '<tenancy-namespace>/<user-name>' <region-key>.ocir.io

    例:

    docker login -u 'ansh81vru1zp/jdoe@acme.com' phx.ocir.io

    テナンシがOracle Identity Cloud Serviceとフェデレートされている場合、形式は若干異なります。例:

    docker login -u 'ansh81vru1zp/oracleidentitycloudservice/jdoe@acme.com' phx.ocir.io
  2. ターミナル・ウィンドウで、コピーしたコマンドを貼り付けて実行します。
  3. パスワードの入力を求められたら、前に作成してコピーしたOracle Cloud Infrastructure認証トークンを入力します。たとえば、6aN...6MqXです。

    これで、ファンクションの作成、デプロイおよび起動を開始する準備ができました。

詳細は、構成ノートを参照してください。

D.ファンクションの作成、デプロイおよび呼出し

1. 最初の関数を作成

ターミナル・ウィンドウで:

  1. 次のように入力してhelloworld java関数を作成します。

    fn init --runtime java hello-java

    hello-javaというディレクトリが作成され、次のものが含まれます。

    • func.yamlという関数定義ファイル
    • helloworldファンクションのソース・ファイルとディレクトリを含む/srcディレクトリ
    • pom.xmlというMaven構成ファイル。ファンクションのコンパイルに必要な依存性を指定します。

    Javaは、サポートされている複数の言語の1つにすぎません。

    詳細は、詳細な手順を参照してください。

2. 最初の関数のデプロイ

ターミナル・ウィンドウで:

  1. 前のステップで作成したhello-javaディレクトリに移動します。
    cd hello-java
  2. 次の単一のFn Projectコマンドを入力して、ファンクションとその依存関係をhello-javaというDockerイメージとして構築し、そのイメージを指定したDockerレジストリにプッシュし、前に作成したhelloworld-appアプリケーションでファンクションをOCIファンクションにデプロイします:
    fn -v deploy --app helloworld-app
  3. (オプション)「ファンクション」(helloworld-appアプリケーションの詳細ページの「リソース」の下)をクリックし、hello-javaファンクションが表示されるようになったことを通知して、ファンクションがOCIファンクションにデプロイされていることを確認します。

詳細は、詳細な手順を参照してください。

3. 最初の関数を呼び出します

ターミナル・ウィンドウで:

  1. 次のように入力してhello-java関数を起動します。

    fn invoke helloworld-app hello-java

    「Hello world!」メッセージが表示されます。

  2. 次のように入力して、パラメータ'John'を使用してhello-java関数を起動します。

    echo -n 'John' | fn invoke helloworld-app hello-java

    「Hello John!」メッセージが表示されます。

完了しました。OCI Functionsを使用して最初のファンクションを作成、デプロイおよび起動しました。

詳細は、詳細な手順を参照してください。

4. 次のステップ

ファンクションを作成、デプロイおよび起動したので、次のことを学習します。

これで完了です。