[OCI]Oracle Functions: Autonomous Databaseとの対話をより簡単にする方法 (2019/08/06)

Oracle Functions: Autonomous Databaseとの対話をより簡単にする方法 (2019/08/06)

https://blogs.oracle.com/developers/oracle-functions-an-easier-way-to-talk-to-your-autonomous-database
投稿者：Todd Sharp

先週、Oracle FunctionsをAutonomous DBインスタンスに接続してデータをクエリし、永続化する方法について投稿しました。
この記事では、カスタムDockerfileを作成し、サーバーレスファンクションのデプロイと呼び出しに使用するDockerイメージにATPウォレットが含まれていることを確認します。

Autonomous DBに初めて触れる方は、私の「Complete Guide To Getting Up And Running With Autonomous DB In The Cloud」をご覧ください。

この方法では、Oracle REST Data Services (ORDS)を利用して、ATPインスタンスのシンプルなユーザーテーブルからデータを取得します。
ORDSについてはマイクロサービスシリーズで詳しく説明しましたが、もし見逃してしまった場合は、ORDSを有効にして、
ORDSを呼び出してデータを取得するためのシンプルなサーバーレスファンクションを作成する方法をもう一度見てみましょう。

ORDSの有効化


最初のステップは、これから扱うスキーマをRESTで有効にすることです。
これは以下のクエリで実現できるので、お気に入りのクエリエディタやCLIツール、SQL Developer Webを開いて以下のように実行します。

BEGIN
/* enable ORDS for schema */
ORDS.ENABLE_SCHEMA(p_enabled => TRUE,
p_schema => 'USERSVC',
p_url_mapping_type => 'BASE_PATH',
p_url_mapping_pattern => 'usersvc',
p_auto_rest_auth => TRUE);
COMMIT;
END;


注意：引数p_auto_rest_authをTRUEに設定すると、/metadata-catalogエンドポイントが公開されないように保護されます。

呼び出しのための認証トークンを生成できるように、必要な権限を作成してみましょう。

DECLARE
l_roles OWA.VC_ARR;
l_modules OWA.VC_ARR;
l_patterns OWA.VC_ARR;
BEGIN
l_roles(1) := 'SQL Developer';
l_patterns(1) := '/users/*';
ORDS.DEFINE_PRIVILEGE(
p_privilege_name => 'rest_privilege',
p_roles => l_roles,
p_patterns => l_patterns,
p_modules => l_modules,
p_label => '',
p_description => '',
p_comments => NULL);
COMMIT;

END;


特権に関連付けられた OAUTH クライアントを作成します。

BEGIN
OAUTH.create_client(
p_name => '[Descriptive Name For Client]',
p_grant_type => 'client_credentials',
p_owner => '[Owner Name]',
p_description => '[Client Description]',
p_support_email => '[Email Address]',
p_privilege_names => 'rest_privilege'
);

COMMIT;
END;


クライアントアプリケーションにSQL Developerのロールを付与します。

BEGIN
OAUTH.grant_client_role(
p_client_name => 'Rest Client',
p_role_name => 'SQL Developer'
);
COMMIT;
END;


これで client_id と client_secret を取得できるようになりました。

SELECT id, name, client_id, client_secret
FROM user_ords_clients;


client_id と client_secret を使用して、REST 呼び出し用の認証トークンを生成することができます (これについては後ほど説明します)。
この時点では、スキーマはRESTが有効になっており、呼び出しを認証するための設定はすべて完了していますが、実際にはまだテーブルを公開していません。
テーブル全体をAuto-RESTで有効にすると、テーブル上のCRUD用のRESTエンドポイントのフルセットが得られます。

BEGIN
ORDS.enable_object(
p_enabled => TRUE,
p_schema => 'USERSVC',
p_object => 'USERS',
p_object_type => 'TABLE',
p_object_alias => 'users',
p_auto_rest_auth => FALSE);
COMMIT;
END;


この例では、ユーザー名ごとに単一のユーザーを取得するエンドポイントを作成してみましょう。

BEGIN
ORDS.define_service(
p_module_name => 'users',
p_base_path => 'users/',
p_pattern => 'user/:username',
p_method => 'GET',
p_source_type => ORDS.source_type_collection_item,
p_source => 'SELECT id, first_name, last_name, created_on FROM users WHERE username = :username OFFSET 0 ROWS FETCH NEXT 1 ROWS ONLY');
COMMIT;
END;


これで、このRESTエンドポイントにヒットしてユーザーを取得するためのOracle Functionを設定できました。
ORDSベースのURLが必要なので、Oracle Cloudダッシュボードにログインして、ATPインスタンスの詳細を表示します。
詳細ページで「Service Console」をクリックします。



Service Consoleで「開発」をクリックし、「SQL Developer Web」をクリックします。



SQL DeveloperのWeb urlは以下のようになっているはずです。

https://[random chars]-demodb.adb.us-phoenix-1.oraclecloudapps.com/ords/admin/_sdw/?nav=worksheet

ここからはORDSのベースURLを取得できるので、/adminの前にすべてコピーします。

https://[random chars]-demodb.adb.us-phoenix-1.oraclecloudapps.com/ords/

これは、ORDSサービスのベースURLです。

サーバーレスファンクションの作成


Oracle Functionsに慣れている場合は、このステップをスキップしてください。
Oracle Functionsに慣れていない場合は、まず最初に行う必要があるのは、ファンクションを格納する「アプリケーション」を作成することです。

fn create app
\--annotation oracle.com/oci/subnetIds='["ocid1.subnet.oc1.phx..."]'
\ords-demo

有効なサブネットIDを渡す必要があります。
私は通常、すべてのサーバーレスファンクション用にVCNを作成し、そのVCN内のサブネットの1つを選択します。
必要に応じて、Oracle Cloud InfrastructureでVCNを作成する方法についてのドキュメントを確認してください。

ボーナス・ヒント
papertrailapp.comにアカウントを登録して、ログの保存先を設定します。
次に、ファンクションを fn update app ords-demo -syslog-url tcp://logs3.papertrailapp.com:53136 でアップデートして、
ファンクションのコンソール出力をpapertrailのイベントビューアにログを記録できるようにします。

ファンクションに client_id と client_secret を取得するために、ファンクションにいくつかの設定変数を設定する必要があります。
fn config app [app name] [config key] [config value]で設定できます。



注意: 機密情報を含む設定変数は、常に暗号化する必要があります。その方法については、OCIでのKey Managementの使い方のガイドを参照してください。

では、ファンクションを作成します。

fn init --runtime java ords-demo-fn

生成されたプロジェクトをお気に入りのIDEで開き、HelloFunction.javaクラスを見てみましょう。
ベースURLを設定し、認証トークンを取得するためのプライベートファンクションを作成しましょう。
ここでは、アプリケーションの設定変数が環境プロパティとして利用可能であることに注意してください。

public class HelloFunction {

private final String ordsBaseUrl = "https://hvg9nd7xibsaegv-demodb.adb.us-phoenix-1.oraclecloudapps.com/ords/usersvc"; 
private final HttpClient httpClient = HttpClient.newHttpClient();

public String handleRequest(String input) {
String name = (input == null || input.isEmpty()) ? "world" : input;
return "Hello, " + name + "!";
}

private String getAuthToken() {
String authToken = "";
try {
Map<String, String> env = System.getenv();
for (String envName : env.keySet()) {
System.out.format("%s=%s%n", envName, env.get(envName));
}
String clientId = System.getenv().get("clientId");
String clientSecret = System.getenv().get("clientSecret");
String authString = clientId + ":" + clientSecret;
String authEncoded = "Basic " + Base64.getEncoder().encodeToString(authString.getBytes());
HttpRequest request = HttpRequest.newBuilder(new URI(this.ordsBaseUrl + "/oauth/token"))
.header("Authorization", authEncoded)
.header("Content-Type", "application/x-www-form-urlencoded")
.POST(HttpRequest.BodyPublishers.ofString("grant_type=client_credentials"))
.build();
HttpResponse<String> response = this.httpClient.send(request, HttpResponse.BodyHandlers.ofString());
String responseBody = response.body();
ObjectMapper mapper = new ObjectMapper();
TypeReference<HashMap<String, String>> typeRef = new TypeReference<HashMap<String, String>>() {};
HashMap<String, String> result = mapper.readValue(responseBody, typeRef);
authToken = result.get("access_token");
}
catch (URISyntaxException | IOException | InterruptedException e) {
e.printStackTrace();
}
return authToken;
}
}


ここでは、HttpClientをセットアップし、ORDSのベースURLを含む変数を設定し、認証トークンを生成するために使用できるファンクションを作成しました。
ここで、ユーザを表す静的な内部クラスを追加してみましょう。

public class HelloFunction {

private final String ordsBaseUrl = "https://hvg9nd7xibsaegv-demodb.adb.us-phoenix-1.oraclecloudapps.com/ords/usersvc";
 private final HttpClient httpClient = HttpClient.newHttpClient();

public static class User {
public String id;
public String username;
@JsonAlias("first_name")
public String firstName;
@JsonAlias("last_name")
public String lastName;
@JsonAlias("created_on")
public Date createdOn;
@JsonIgnore
public List links;
}

/* removed other functions for brevity */
}


Oracle Functions Java FDK には Jackson が含まれているので、User クラスに @JsonAlias をアノテーションして、
ORDS JSON レスポンス内の特定の要素をレスポンスオブジェクト内のプロパティにマッピングしたり、
@JsonIgnore を使用して特定のプロパティがレスポンスに含まれないようにしたりすることができます。
この依存関係を pom.xml に含めてください。

<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.9</version>
<scope>compile</scope>
</dependency>


最後に、handleRequestメソッドを実装し、ORDSを呼び出してユーザ名でユーザを取得し、レスポンスをUserオブジェクトとしてシリアライズして返すことができます。
クラス全体を完全に実装すると、以下のようになります。

package com.example.fn;

import com.fasterxml.jackson.annotation.JsonAlias;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.*;

public class HelloFunction {

private final String ordsBaseUrl = "https://hvg9nd7xibsaegv-demodb.adb.us-phoenix-1.oraclecloudapps.com/ords/usersvc";
 private final HttpClient httpClient = HttpClient.newHttpClient();

public static class User {
public String id;
public String username;
@JsonAlias("first_name")
public String firstName;
@JsonAlias("last_name")
public String lastName;
@JsonAlias("created_on")
public Date createdOn;
@JsonIgnore
public List links;
}

public User handleRequest(String username) {
User user = null;
try {
HttpRequest request = HttpRequest.newBuilder( new URI( this.ordsBaseUrl + "/users/user/" + username ) )
.header("Authorization", "Bearer " + getAuthToken())
.GET()
.build();
HttpResponse<String> response = this.httpClient.send(request, HttpResponse.BodyHandlers.ofString());
if( response.statusCode() == HttpURLConnection.HTTP_NOT_FOUND ) {
System.out.println("User with username " + username + " not found!");
}
else {
user = new ObjectMapper().readValue(response.body(), User.class);
}
}
catch (URISyntaxException | IOException | InterruptedException e) {
e.printStackTrace();
}
return user;
}

private String getAuthToken() {
String authToken = "";
try {
Map<String, String> env = System.getenv();
for (String envName : env.keySet()) {
System.out.format("%s=%s%n", envName, env.get(envName));
}
String clientId = System.getenv().get("clientId");
String clientSecret = System.getenv().get("clientSecret");
String authString = clientId + ":" + clientSecret;
String authEncoded = "Basic " + Base64.getEncoder().encodeToString(authString.getBytes());
HttpRequest request = HttpRequest.newBuilder(new URI(this.ordsBaseUrl + "/oauth/token"))
.header("Authorization", authEncoded)
.header("Content-Type", "application/x-www-form-urlencoded")
.POST(HttpRequest.BodyPublishers.ofString("grant_type=client_credentials"))
.build();
HttpResponse<String> response = this.httpClient.send(request, HttpResponse.BodyHandlers.ofString());
String responseBody = response.body();
ObjectMapper mapper = new ObjectMapper();
TypeReference<HashMap<String, String>> typeRef = new TypeReference<HashMap<String, String>>() {};
HashMap<String, String> result = mapper.readValue(responseBody, typeRef);
authToken = result.get("access_token");
}
catch (URISyntaxException | IOException | InterruptedException e) {
e.printStackTrace();
}
return authToken;
}
}


ファンクションのテスト


ファンクションが期待通りに動作することを確認するために、簡単なテストを書いてみましょう。
ここでは期待される JSON レスポンスをハードコードしていますが、あなたの場合は異なるでしょう。
テストを実行する前にシェルで clientId と clientSecretas の環境変数を設定しておく必要があります。

package com.example.fn;

import com.fnproject.fn.testing.FnResult;
import com.fnproject.fn.testing.FnTestingRule;
import org.junit.Rule;
import org.junit.Test;

import static org.junit.Assert.assertEquals;

public class HelloFunctionTest {

@Rule
public final FnTestingRule testing = FnTestingRule.createDefault();

@Test
public void shouldReturnUser() {
testing.givenEvent().withBody("tsharp").enqueue();
testing.thenRun(HelloFunction.class, "handleRequest");

FnResult result = testing.getOnlyResult();
assertEquals("{\"id\":\"8C561D58E856DD25E0532010000AF462\",\"username\":\"tsharp\",\"firstName\":\"todd\",\"lastName\":\"sharp\",\"createdOn\":1561649500385}", result.getBodyAsString());
}

}


ファンクションのデプロイ


Fn CLIを使ってファンクションをクラウドにデプロイすると、ビルドプロセスの一部としてユニットテストが実行されます。
手動でテストを実行して合格を確認し、テストを実行するために環境に設定されている設定変数に依存しているので、
ビルドプロセスの一部としてテストの実行をスキップする独自のDockerfileをプロジェクトのルートにドロップする予定です
（余談：将来的にこのプロセスをより簡単にするために、PMやエンジニアと協力しています）。

FROM fnproject/fn-java-fdk-build:jdk11-1.0.98 as build-stage
WORKDIR /function
ENV MAVEN_OPTS -Dhttp.proxyHost= -Dhttp.proxyPort= -Dhttps.proxyHost= -Dhttps.proxyPort= -Dhttp.nonProxyHosts= -Dmaven.repo.local=/usr/share/maven/ref/repository

ADD pom.xml /function/pom.xml
RUN ["mvn", "package", "dependency:copy-dependencies", "-DincludeScope=runtime", "-DskipTests=true", "-Dmdep.prependGroupId=true", "-DoutputDirectory=target", "--fail-never"]

ADD src /function/src

RUN ["mvn", "package", "-DskipTests=true"]
FROM fnproject/fn-java-fdk:jre11-1.0.98
WORKDIR /function
COPY --from=build-stage /function/target/*.jar /function/app/

CMD ["com.example.fn.HelloFunction::handleRequest"]


このファンクションで使用する標準のDockerfileに変更があるのは、最終ビルドのRUNコマンドに-DskipTests=trueを追加したことだけです。
これで、ファンクションをクラウドにデプロイするには fn deploy --app ords-demo を実行します。

ファンクションの呼び出し


この時点では，ファンクションは fn invoke ords-demo ords-demo-fn を実行することで呼び出すことができますが、
ユーザ名をファンクションに渡したいので， echo "tsharp" | fn invoke ords-demo ords-demo-fn を実行して，ユーザのレスポンスを受け取ります。



まとめ

この記事では、Autonomous DBインスタンスのスキーマに対してORDSを有効にし、ORDSを特権で保護し、
RESTエンドポイントへのHTTP呼び出しを認証するために使用できる認証クライアントとクレデンシャルを作成する方法を見てきました。
私たちは、サーバーレスファンクションからカスタム ORDS エンドポイントへの HTTP 呼び出しを行うためにこれらの資格情報を使用し、
その結果を Java POJO としてシリアライズし、ファンクション呼び出しからその結果を返しました。

Photo by Spring Fed Images on Unsplash

コメント

コメントを投稿

このブログの人気の投稿

Oracle RACによるメンテナンスのためのドレインとアプリケーション・コンティニュイティの仕組み (2023/11/01)

イメージ
Oracle RACによるメンテナンスのためのドレインとアプリケーション・コンティニュイティの仕組み (2023/11/01) https://database-heartbeat.com/2023/11/01/draining-ac-rac/ はじめに Oracle RACは、Oracle Databaseのスケーラビリティと高可用性を提供します。1つのサーバー(RACノード)に障害が発生した場合、またはメンテナンスのためにオフラインになった場合でも、追加のノードを介してデータベースにアクセスできます。ただし、メンテナンスの開始時に、データの読取りまたは変更に関係なく、一部の作業を実行しているクライアント・セッションはどうなりますか。この作業は中断され、ドレインを実装してアプリケーション・コンティニュイティまたは透過的アプリケーション・コンティニュイティを有効にしないかぎり、エンドユーザーまたはアプリケーションによって再度実行する必要があります。 環境 2ノードのOracle RACを例に挙げて、高速アプリケーション通知(FAN)、ドレインおよびアプリケーション・コンティニュイティによってメンテナンス・イベントがエンドユーザーに透過的になる方法を理解しましょう。アプリケーションは、30個のセッションを保持するように構成された接続プールを使用しています。 通常の操作 通常の操作中は、両方のRACノードが起動し、アプリケーションを実行しています。ロード・バランシング戦略によっては、セッションの数が両方のノード間で異なるか、均等に分散される場合があります。次の図をよりよく視覚化するために、ノード2のノード1および20のセッションに10のセッションがあるとします。 セッションは、アイドル状態(接続されているが何もしていない)またはアクティブ状態(リクエストの途中)にできます。リクエストは、データの読取り(SELECT)または操作(INSERT、DELETE、UPDATE)が可能です。 ドレインによるサービスの停止 ある時点で、システムのメンテナンスが必要になります。2ノードRACがあるため、メンテナンスはローリング方式で、1つのノードを順番に(ほとんどの場合)実行できます。メンテナンスは、たとえば、オペレーティング・システム、Grid Infrastructureまたはデ
続きを読む

Oracle Cloud Infrastructure Secure Desktopsを発表: デスクトップ仮想化のためのOracleのクラウドネイティブ・サービス (2023/06/28)

イメージ
Oracle Cloud Infrastructure Secure Desktopsを発表: デスクトップ仮想化のためのOracleのクラウドネイティブ・サービス (2023/06/28) https://blogs.oracle.com/cloud-infrastructure/post/secure-desktops-cloud-native-virtualization 投稿者： Joost Pronk Van Hoogeveen Jan Hendrik Mangold | Principal Product Manager Oracleは、Oracle Cloud Infrastructure(OCI)Secure Desktopsという新しいクラウド・ネイティブ・サービスをリリースしています。このエキサイティングな開発により、顧客はOCIテナンシから簡単にすばやく仮想デスクトップ・インフラストラクチャ(VDI)をデプロイできます。 OCIの使用状況は大幅に拡大しています。組織は、OCI内でデータを安全に保つことの価値を実現しています。ゼロトラストなセキュリティ優先アーキテクチャを実装することで、OCI Compute、Storage、およびNetworkingサービスは、グローバル・アクセスのためのエンタープライズ・アプリケーションを導入するための信頼できるプラットフォームを提供します。 データ・セキュリティとVDIがどのように役立つか 業界のアナリストによると 、ラップトップは53秒ごとに盗まれています。その事実と現実を結び付けると、会社のデータは、公共の場所を経由したり、従業員の自宅に座ったりするラップトップやデスクトップへと移行します。ローカル・ディスクの暗号化、データ・アクセス権限の強制、VPNアクセスの保護によってデータを保護するためにテクノロジが使用されていますが、いずれも許容可能なセキュリティ・レベルが適用されるため、リスクは依然として高くなる可能性があります。盗難または準拠していないいくつかのマシンでは、企業データ、さらには顧客データのデータ侵害が発生する可能性があります。 VDIテクノロジは長年にわたって存在してきましたが、従業員はローカル・マシンを使用して、会社のデータ・センター内の仮想マシンで実行されているデスクトップ・アプリケー
続きを読む

新しいOracle Container Engine for Kubernetesの機能強化により、大規模なKubernetesがさらに簡単になりました (2023/03/20)

イメージ
新しいOracle Container Engine for Kubernetesの機能強化により、大規模なKubernetesがさらに簡単になりました (2023/03/20) https://blogs.oracle.com/cloud-infrastructure/post/oracle-container-engine-kubernetes-enhancements 投稿者： Mickey Boxell | Product Management Linux以降、 Kubernetes はオープンソースソフトウェアの歴史上最も急速に成長しているプロジェクトです。10年も経たないうちに、 Kubernetesは主流 になり、特に過去2年間で導入がかつてないほど大きくなりました。 Oracle Cloud Infrastructure(OCI) は、この勢いも見ています。あらゆる業界の何千ものエンタープライズ顧客が、クラウドネイティブアプリケーション開発のメリットを経験しており、その導入を迅速化し、Kubernetesの使用を拡大しています。 Oracle Container Engine for Kubernetes (OKE)で実行されている抽出、変換、ロード(ETL)ジョブ、パイプライン、ハイパフォーマンスコンピューティング(HPC)ワークロード、さらにはデータベースなどにKubernetesを使用するために、顧客はKubernetesで標準化されており、コンテナ化されたアプリケーションを実行するのみでなく拡張されています。  「私たちは、Kubernetes インフラストラクチャと OKE、GPU、HPC、およびストリーミング、OpenSearch などの最新の開発者サービスを組み合わせて使用​​して、OCI で数十億の音声 AI クエリを実行しています。私たちは、次世代のトレーニングと配信に最適なクラウドとして OCI を選択しました。 AI アプリケーション – Mercedes Benz、Toast、VIZIO、Hyundai などのグローバル ブランドに最速かつ最も正確な音声エクスペリエンスを提供するのに役立ちます.OCI を使用することで、以前のクラウドと比較してパフォーマンスが 50 ～ 60% 向上しました。 2 倍のコスト削減 – 使用量
続きを読む