A デプロイヤ・コマンドライン・リファレンス
Oracle Stream Analyticsアプリケーションのデプロイに使用できる、Oracle Stream Analyticsのデプロイヤ
・ユーティリティへの参照を提供します。
この付録の内容は次のとおりです。
A.1 デプロイヤ・ユーティリティの使用方法の概要
Deployer
ユーティリティは、管理者や開発者がOracle Stream Analyticsアプリケーションのデプロイ操作をコマンドラインで実行するためのJavaベースのデプロイメント・ユーティリティです。
Oracle Stream Analyticsデプロイメントのコンテキストでは、アプリケーションは次のアーティファクトを含むOSGiバンドルJARファイルとしてhttp://www.osgi.org/で定義されます。
-
アダプタ、アダプタ・ファクトリ、ビジネス・ロジックを格納したPOJOなど、アプリケーションのいくつかのコンポーネントを実装するコンパイル済Javaクラス・ファイル。
-
プロセッサ、アダプタ、ストリームなど、アプリケーションのコンポーネントを構成する1つまたは複数のOracle Stream Analytics構成XMLファイル。
構成ファイルは、OSGiバンドルJARファイルの
META-INF/wlevs
ディレクトリにある必要があります。 -
アプリケーションのすべてのコンポーネントと、各コンポーネントが相互にどのように接続されているかを記述したEPNアセンブリ・ファイル。EPNアセンブリ・ファイルは標準のSpringコンテキスト・ファイルを拡張します。
EPNアセンブリ・ファイルは、OSGiバンドルJARファイルの
META-INF/spring
ディレクトリにある必要があります。 -
JARファイルのコンテンツを記述する
MANIFEST.MF
ファイル。
デプロイヤ・ユーティリティはHTTPを使用してOracle Stream Analyticsに接続し、アプリケーションのデプロイ先となるサーバー・インスタンスに応じてJettyを構成する必要があります。
Oracle Stream Analyticsは、deployments.xml
ファイルを使用して、デプロイ済アプリケーションのOSGiバンドルのリストを内部的に維持します。このファイルはDOMAIN_DIR/servername
ディレクトリにあります。DOMAIN_DIR
はメイン・ドメイン・ディレクトリであり、アプリケーションのデプロイ先となるサーバー・インスタンスに対応します。servername
はサーバー・インスタンス自体です。
注意:
deployments.
xmlファイルのXSDは、情報のみの目的で提供されます。deployments.xml
ファイルを手動で更新することはお薦めしません。
A.2 デプロイヤ・ユーティリティ環境の構成
デプロイヤ・ユーティリティを使用する前に、環境を適切に構成する必要があります。
デプロイヤ・ユーティリティ環境の構成:
デプロイヤ・ユーティリティ環境を構成するには、次の手順を実行します。
- Oracle Stream Analyticsソフトウェアをインストールおよび構成します。
CLASSPATH
変数を更新して、/Oracle/Middleware/my_oep/oep/bin
ディレクトリにあるwlevsdeploy.jar JAR
ファイルを含めます。
A.3 リモートでのデプロイヤ・ユーティリティの実行
Oracle Stream Analyticsをインストールして実行しているコンピュータとは別のコンピュータでDeployer
ユーティリティを実行すると便利な場合があります。
リモートでのデプロイヤ・ユーティリティの実行:
A.4 デプロイヤ・ユーティリティを起動するための構文
この項では、デプロイヤ・ユーティリティの構文を示します。
java -jar wlevsdeploy.jar [Connection Arguments] [User Credential Arguments] [Deployment Commands]
次の項では、デプロイヤ・ユーティリティで使用できる様々な引数およびコマンドについて説明します。このユーティリティの具体的な使用方法の例については、「デプロイヤ・ユーティリティの例」を参照してください。
A.4.1 接続引数
表A-1は、デプロイヤ・ユーティリティで指定できる接続引数を示しています。
表A-1 接続引数
引数 | 説明 |
---|---|
-url url |
OSGIバンドルのデプロイ先となるOracle Stream Analyticsインスタンスのデプロイヤ・ユーティリティのURLを指定します。 URLは次の形式にします。 http://host:port/wlevsdeployer 説明:
たとえば、Oracle Stream Analyticsがホスト http://ariel:9002/wlevsdeployer |
A.4.2 ユーザー資格証明の引数
表A-2は、デプロイヤ・ユーティリティで指定できるユーザー資格証明の引数を示しています。
表A-2 ユーザー資格証明の引数
引数 | 説明 |
---|---|
-user username |
Oracle Stream Analytics管理者のユーザー名。
|
-password password |
Oracle Stream Analytics管理者のパスワード。 注意: この引数は非推奨で、後続のリリースで削除される可能性もあります。この引数を使用しないことをお薦めします。 |
A.4.3 デプロイメント・コマンド
表A-3は、デプロイヤ・ユーティリティで使用できるデプロイメント・コマンドを示しています。
表A-3 デプロイメント・コマンド
コマンド | 説明 |
---|---|
-encrypt |
ユーザー名とパスワードを暗号化し、出力ファイルに書き込みます。 |
-encryptoutfile encryptoutfile |
encryptoutfileを使用して、暗号化されたユーザー名とパスワードを書き込むことを指定します。 |
-group groupname |
デプロイ・コマンド(install、uninstall、update、suspendまたはresume)をターゲット・グループ(具体的には、そのグループ内の一連の実行中サーバー)に適用することを指定します。 ドメイン・グループを指定するには、次のようにキーワード -group all カスタム・グループを指定するには、単純にグループの名前を指定します: -group my_group 注意: サーバーがマルチサーバー・ドメインの一部である場合(つまり、クラスタリングが有効な場合)、グループに対してのみデプロイできます。サーバーがスタンドアロン・サーバー・ドメインの一部の場合(つまり、クラスタリングが無効の場合)は、グループにはデプロイできません。詳細は、「マルチサーバー・ドメインについて」を参照してください。 |
-help |
コマンド構文および引数について説明するメッセージを出力します。 |
-install bundle |
指定したOracle Stream Analyticsインスタンスに、指定したOSGiバンドルをインストールします。
バンドルが置かれている場所が、デプロイヤ・ユーティリティを実行しているディレクトリに対して相対的なディレクトリではない場合、バンドルのフル・パス名を必ず指定してください。 特に、Oracle Stream Analyticsでは次の処理が行われます。
|
-resume name |
指定したOracle Stream Analyticsインスタンス上で一時停止されたOSGIバンドルを再開し、構成されたアダプタが再びただちに着信データを受信し始めます。
Bundle-SymbolicName: myApp |
-status name |
現在のインストール済OSGiバンドルに関するステータス情報を返します。
Bundle-SymbolicName: myApp |
-suspend name |
指定したOracle Stream Analyticsインスタンスにインストール済で現在実行中のOSGIバンドルを一時停止します。
Bundle-SymbolicName: myApp |
-uninstall name |
指定したOracle Stream Analyticsインスタンスから既存のバンドルを削除します。
Bundle-SymbolicName: myApp 特に、Oracle Stream Analyticsでは次の処理が行われます。
|
-update bundle |
既存のOSGiバンドルを新しいアプリケーション・コードで更新します。
バンドルが置かれている場所が、デプロイヤ・ユーティリティを実行しているディレクトリに対して相対的なディレクトリではない場合、バンドルのフル・パス名を必ず指定してください。 特に、Oracle Stream Analyticsでは次の処理が行われます。
|
-userconfigfile userconfigfile |
userconfigfile (security-config.xml)を使用して、暗号化されたユーザー名とパスワードをファイルから取得することを指定します。 |
-userkeyfile userkeyfile |
userkeyfile (.msainternal.dat)を使用して、ユーザー |
A.5 デプロイヤ・ユーティリティの例
次の例は、デプロイヤ・ユーティリティの使用方法を示しています。
すべての例で、Oracle Stream Analyticsはホストariel
で実行されていて、リスニング・ポートは9002
であり、また、サーバー管理者のユーザー名/パスワードはそれぞれoepadmin/welcome1
です。わかりやすくするために、例は複数行に分けて示していますが、コマンドを実行するときは、すべての引数とコマンドを1行に入力します。
java -jar wlevsdeploy.jar -url http://ariel:9002/wlevsdeployer -user wlevs -password wlevs -install /application/bundles/com.my.exampleApp_1.0.0.0.jar
上の例は、/application/bundles
ディレクトリにあるcom.my.exampleApp_1.0.0.0.jar
というOSGiバンドルをインストールする方法を示しています。
次のコマンドは、このアプリケーションを一時停止後に再開する方法を示しています。
java com.bea.wlevs.deployment.Deployer -url http://ariel:9002/wlevsdeployer -user wlevs -password wlevs -resume exampleApp
次の例は、このアプリケーションのアンインストール方法を示しています。アンインストールを実行すると、アプリケーションのすべてのトレース情報がドメイン・ディレクトリから削除されます。
java com.bea.wlevs.deployment.Deployer -url http://ariel:9002/wlevsdeployer -user wlevs -password wlevs -uninstall exampleApp
次の例は、strategies_1.0.jar
というアプリケーションをstrategygroup
にインストールする方法を示しています。また、java
ユーティリティの-jar
コマンドの使用方法も示しています。
java -jar wlevsdeploy.jar -url http://ariel:9002/wlevsdeployer -install strategies_1.0.jar -group strategygroup