ローカル・ホストでのファンクションのクイックスタート
このOCI Functions QuickStartを使用して、ローカル・ホストで迅速に設定および実行する方法をご覧ください。
A.テナンシを設定します
適切なユーザーおよびグループが存在しない場合:
- テナンシ管理者としてコンソールにサインインします。
- ナビゲーション・メニューを開き、「アイデンティティとセキュリティ」を選択します。「アイデンティティ」で、「ドメイン」を選択します。
- 「グループ」、「グループの作成」の順にクリックして、新しいグループを作成します。
- 「ユーザー」、「ユーザーの作成」の順にクリックして、新しいユーザーを作成します。
- 「グループ」、グループの名前、「ユーザーをグループに追加」の順にクリックして、ユーザーをグループに追加します。
詳細は、構成ノートを参照してください。
ネットワーク・リソースおよびOCI Functionsリソースを作成する適切なコンパートメントがまだ存在しない場合:
- テナンシ管理者としてコンソールにサインインします。
- ナビゲーション・メニューを開き、「アイデンティティとセキュリティ」を選択します。「アイデンティティ」で、「コンパートメント」を選択します。
- 「コンパートメントの作成」をクリックします。
詳細は、構成ノートを参照してください。
ネットワーク・リソースを作成する適切なVCNがまだ存在しない場合:
- テナンシ管理者としてコンソールにサインインします。
- ナビゲーション・メニューを開き、「ネットワーキング」、「仮想クラウド・ネットワーク」の順に選択します。
- VCNウィザードの起動をクリックして、新しいVCNを作成します。
- 「VCNウィザードの起動」ダイアログ・ボックスで、「インターネット接続性を持つVCN」を選択し、「VCNウィザードの起動」をクリックします。
- 新しいVCNの名前を入力し、「次へ」をクリックし、「作成」をクリックして、関連するネットワーク・リソースとともにVCNを作成します。
詳細は、構成ノートを参照してください。
1人以上のOCI Functionsユーザーがテナンシ管理者でない場合:
- テナンシ管理者としてコンソールにサインインします。
- ナビゲーション・メニューを開き、「アイデンティティとセキュリティ」を選択します。「アイデンティティ」で、「ポリシー」を選択します。
-
「ポリシーの作成」をクリックし、新しいポリシーの名前と説明を指定して、テナンシのルート・コンパートメントを選択します。
-
ポリシー・ビルダーを使用してポリシーを作成します。「ポリシー・ユース・ケース」のリストから「ファンクション」を選択し、ポリシー・テンプレートの「ユーザーによるファンクションおよびアプリケーションの作成、デプロイおよび管理」に基づいてポリシーを設定します。
このポリシー・テンプレートには、次のポリシー・ステートメントが含まれます:
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アプリケーションの作成
- ファンクション開発者としてコンソールにサインインします。
- ナビゲーション・メニューを開き、「開発者サービス」を選択します。「ファンクション」で、「アプリケーション」を選択します。
- OCI Functionsで使用しているリージョンを選択します。
- 「アプリケーションの作成」をクリックします。
- 次を指定します:
- 新規アプリケーションの名前としてhelloworld-app。このアプリケーションに最初のファンクションをデプロイし、ファンクションの起動時にこのアプリケーションを指定します。
- ファンクションを実行するVCNおよびサブネット。パブリック・サブネットにはVCN内のインターネット・ゲートウェイが必要で、プライベート・サブネットにはVCN内のサービス・ゲートウェイが必要です。
- 「作成」をクリックします。
詳細は、詳細な手順を参照してください。
C.ローカルホスト開発環境を設定する
開発環境のターミナル・ウィンドウ:
- 次のように入力して、Dockerがインストールされていることを確認します:
docker version
Dockerがインストールされていないことを示すエラー・メッセージが表示された場合は、続行する前にDockerをインストールする必要があります。ご使用のプラットフォームのDockerドキュメントを参照してください(Oracle Linuxについては、こちらを参照してください)。
Dockerがインストールされている場合、GitHubのFn Projectホームページの「前提条件」セクションに移動し、インストールされているDockerのバージョンが少なくともそこで指定されている最小バージョンであることを確認します。そうでない場合は、続行する前にDockerを再インストールしてください。
- 次のように入力して、標準のhello-world Dockerイメージをコンテナとして起動し、Dockerが実行されていることを確認します:
docker run hello-world
Dockerが実行されていないことを示すエラー・メッセージが表示された場合は、続行する前にDockerデーモンを起動する必要があります。Dockerドキュメントを参照してください。
詳細は、構成ノートを参照してください。
- ファンクション開発者としてコンソールにサインインします。
- 「プロファイル」メニューを開き、「ユーザー設定」(または「マイ・プロファイル」またはアカウント名)をクリックします。
- 「リソース」で、「APIキー」をクリックし、「APIキーの追加」をクリックします。
- 「APIキーの追加」ダイアログで、「APIキー・ペアの生成」を選択します。
- 「秘密キーのダウンロード」をクリックし、
~/.oci
ディレクトリに秘密キー・ファイルを(.pemファイルとして)保存します。(~/.oci
ディレクトリがまだ存在しない場合は作成します)。 - 「追加」をクリックして、新しいAPI署名キーをユーザー設定に追加します。
「構成ファイルのプレビュー」ダイアログが表示され、
DEFAULT
という名前のプロファイル(先ほど作成したAPI署名キーのフィンガープリントを含む)の基本認証情報を含む構成ファイル・スニペットが含まれています。 - テキスト・ボックスに表示されている構成ファイル・スニペットをコピーし、「構成ファイルのプレビュー」ダイアログを閉じます。
- テキスト・エディタで、
~/.oci/config
ファイルを開き、ファイルにスニペットを貼り付けます。(~/.oci/config
ファイルがまだ存在しない場合は、ここで作成します)。 - テキスト・エディタで、貼り付けたスニペットのプロファイルを次のように変更します。
- プロファイル名を
[DEFAULT]
から選択した名前([functions-developer-profile]
など)に変更します。~/.oci/config
ファイルには、同じ名前のプロファイルを2つ含めることはできません。 - プロファイルの
key_file
パラメータの値を変更して、以前にダウンロードした秘密キー・ファイル(.pemファイル)のパスを指定します。
- プロファイル名を
- テキスト・エディタで、
~/.oci/config
ファイルに加えた変更を保存し、テキスト・エディタを閉じます。 - ターミナル・ウィンドウで、次のように入力して、秘密キー・ファイル(.pemファイル)の権限を変更し、ユーザーのみが読み取れるようにします:
chmod go-rwx ~/.oci/<private-key-file-name>.pem
API署名キーの設定およびプロファイルの作成の詳細は、構成ノートを参照してください。
開発環境のターミナル・ウィンドウ:
- ご使用の環境にあわせて、次の適切な手順を使用してFn ProjectのCLIをインストールします。
- LinuxまたはMacOS: 次のように入力します。
curl -LSs https://raw.githubusercontent.com/fnproject/cli/master/install | sh
- Homebrewを使用したMacOS: Enter:
brew update && brew install fn
- Windows: GitHubへのFnクライアントのインストール手順に従います。
- Linux、MacOSまたはWindows: 「Fn Project Releases」ページ(GitHub)からバイナリをダウンロードして実行します。
- LinuxまたはMacOS: 次のように入力します。
- 次のように入力して、Fn ProjectのCLIがインストールされていることを確認します:
fn version
詳細は、構成ノートを参照してください。
開発環境のターミナル・ウィンドウ:
- 次を入力して、新しいFn ProjectのCLIコンテキストを作成します:
fn create context <my-context> --provider oracle
--provider oracle
を指定すると、Oracle Cloud Infrastructureリクエスト署名、秘密キー、ユーザー・グループ、およびこれらのユーザー・グループに権限を付与するポリシーを使用して、認証および認可が有効になります。 - 次を入力して、Fn ProjectのCLIが新しいコンテキストを使用するように指定します:
fn use context <my-context>
- 次のように入力して、OCI関数で使用するために作成したOCIプロファイルの名前で新しいFn Project CLIコンテキストを構成します(たとえば、
[functions-developer-profile]
)。fn update context oracle.profile <profile-name>
詳細は、構成ノートを参照してください。
開発環境のターミナル・ウィンドウ:
- デプロイされたファンクションを所有するコンパートメントのOCIDを使用して、新しいFn ProjectのCLIコンテキストを構成します
fn update context oracle.compartment-id <compartment-ocid>
- 次を入力して、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
-
OCIファンクションで使用する現在のリージョンおよびテナンシの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
-
次のように入力して、OCIファンクションがファンクション・イメージをプッシュおよびプルするリポジトリのコンパートメントの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関数はルート・コンパートメント内のリポジトリに対してイメージをプッシュおよびプルします。
詳細は、構成ノートを参照してください。
- ファンクション開発者としてコンソールにサインインします。
- 「プロファイル」メニューを開き、「ユーザー設定」(または「マイ・プロファイル」またはアカウント名)をクリックします。「認証トークン」ページで、「トークンの生成」をクリックします。
- 「トークンの生成」ダイアログに認証トークンの意味のある説明を入力し、「トークンの生成」をクリックします。新しい認証トークンが表示されます。
- 認証トークンを、後で取得できる保護された場所にただちにコピーします。これは、コンソールに認証トークンが再度表示されないようにするためです。
- 「トークンの生成」ダイアログを閉じます。
詳細は、構成ノートを参照してください。
コンソールの「Getting Started」ページで、次の手順を実行します。
-
次のコマンドをコピーします。
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
- ターミナル・ウィンドウで、コピーしたコマンドを貼り付けて実行します。
-
パスワードの入力を求められたら、前に作成してコピーしたOracle Cloud Infrastructure認証トークンを入力します。たとえば、
6aN...6MqX
です。これで、ファンクションの作成、デプロイおよび起動を開始する準備ができました。
詳細は、構成ノートを参照してください。
D.ファンクションの作成、デプロイおよび呼出し
ターミナル・ウィンドウで:
-
次のように入力してhelloworld java関数を作成します。
fn init --runtime java hello-java
hello-javaというディレクトリが作成され、次のものが含まれます。
- func.yamlという関数定義ファイル
- helloworldファンクションのソース・ファイルとディレクトリを含む/srcディレクトリ
- pom.xmlというMaven構成ファイル。ファンクションのコンパイルに必要な依存性を指定します。
Javaは、サポートされている複数の言語の1つにすぎません。
詳細は、詳細な手順を参照してください。
ターミナル・ウィンドウで:
- 前のステップで作成したhello-javaディレクトリに移動します。
cd hello-java
- 次の単一のFn Projectコマンドを入力して、ファンクションとその依存関係をhello-javaというDockerイメージとして作成し、そのイメージを指定したDockerレジストリにプッシュし、前に作成したhelloworld-appアプリケーションでそのファンクションをOCIファンクションにデプロイします。
fn -v deploy --app helloworld-app
- (オプション)「ファンクション」(helloworld-appアプリケーションの詳細ページの「リソース」の下)をクリックし、hello-javaファンクションが表示されるようになったことを通知して、ファンクションがOCIファンクションにデプロイされていることを確認します。
詳細は、詳細な手順を参照してください。
ターミナル・ウィンドウで:
-
次のように入力してhello-java関数を起動します。
fn invoke helloworld-app hello-java
「Hello world!」メッセージが表示されます。
-
次のように入力して、パラメータ
'John'
を使用してhello-java関数を起動します。echo -n 'John' | fn invoke helloworld-app hello-java
「Hello John!」メッセージが表示されます。
完了しました。OCI Functionsを使用して最初のファンクションを作成、デプロイおよび起動しました。
詳細は、詳細な手順を参照してください。
ファンクションを作成、デプロイおよび起動したので、次のことを学習します。
- Oracle Cloud Infrastructure Loggingサービスでのファンクション・ログの表示、またはsyslog URLの構成によるファンクション・ログの表示(ファンクション・ログの格納および表示を参照)
- GitHubのサンプルを使用したOCI関数の確認(Oracle Functionsのサンプルを参照)
- SDKを使用してファンクションを呼び出します(「SDKを使用したファンクションの呼出し」を参照)
これで完了です。