デプロイメントの使用

3 デプロイメントの使用

Service Managerインスタンスにログインしたら、デプロイメントの作成または既存のデプロイメントの編集を行うことができます。1つのService Managerインスタンスで複数のデプロイメントを扱うことができます。

Oracle GoldenGate Microservicesのインストールを完了した後、Oracle GoldenGate Configuration Assistant (OGGCA)を使用して、デプロイメント(セキュアまたは非セキュア)を作成する必要があります。このウィザードを使用すると1つのService Managerに複数のデプロイメントを追加できます。

Oracle GoldenGate Microservices内でセキュアな構成を使用することをお薦めします。セキュアなMicroservicesデプロイメントの設定には、次の2つのオプションがあります。

Microservicesをループバック・アドレスで実行し、HTTPSリバース・プロキシ(nginx)を前に置きます。リバース・プロキシ・サポートを参照してください。
- Oracle GoldenGate ClassicとOracle GoldenGate Microservicesの間の相互運用性は、SOCKSPROXYでOracle GoldenGate Classicからのデータ・ポンプExtractを使用してoggプロトコルを介して構成されます。
すべてのサービスでTLSバージョン1.2が有効になっているOracle GoldenGate Microservicesを実行します。

内容は次のとおりです。

Service Managerに接続する方法

Service Managerは、ホスト・マシンで実行されているデプロイメントおよび関連付けられたサービスを制御できるようにする、Oracle GoldenGate Microservices内の主要なウォッチドッグ・サービスです。

ServiceManagerは、次の3つの異なるモードで構成できます。

手動
デーモンとして
XAGエージェントと統合

ノート:

Service Managerがシステム・デーモンとして登録されている場合、Service Manager、Administration Server (AS)、Distribution Server (DS)、Receiver Server (RS)およびPerformance Metrics Serverはホストの起動(再起動)時に自動的に起動されます。

Service Managerへのログイン

Oracle GoldenGate Microservicesデプロイメントの使用を開始するには、Service Managerに接続する必要があります。

ノート:

Service Managerに初めてログインする場合は、パスワードを変更することをお薦めします。

Webブラウザを開いて、Oracle GoldenGate Configuration Assistantで作成したService Managerに接続します。URLはhttp://localhost:9001のようになります。9001はService Managerインスタンスをデプロイしたポートです。セキュアなデプロイメントの場合、URLはhttps://localhost:9001のようになります。
デプロイメント時に作成したユーザー名とパスワードを入力してサインインします。

Service Managerでは、Service Managerとその他すべてのサーバーが稼働中かどうかを確認できます。リンクを使用して、それぞれのインタフェースに接続し、詳細を確認し、デプロイメントを管理します。

Service Managerをデーモン・サーバーとして設定する方法の詳細は、「セキュアなデプロイメントとセキュアでないデプロイメントを作成する方法」を参照してください。

Service Managerのクイック・ツアー

Oracle GoldenGate Microservicesのインストールが完了すると、指定したURLでService Managerが開きます。このページは、デプロイメントの実行や、Administration Server、Distribution Server、Receiver Server、Performance Metrics ServerおよびAdmin Clientの構成のためのアクセス・ポイントとして機能します。

Service Managerのホームページは、デプロイされたサービスを表示したり、デプロイメントに関連するインベントリや構成の情報にアクセスしたりできるダッシュボードです。デプロイメントのステータスの確認や、サービスの起動と停止を行うこともできます。

Service Managerの概要が把握できたところで、ここではService Managerホームページを使用して実行できる操作の一部について説明します。

操作	タスク
サービスのステータスを表示	ステータス変更の確認
デプロイメントを起動および停止	「デプロイメントとサーバーを起動および停止する方法」
様々なサーバーにアクセス	それぞれのリンクをクリックしてアクセスできます。 Administration Server: ExtractとReplicatの追加、変更および削除を行います。 Distribution Server: パスの追加、変更および削除を行います Performance Metrics Server: メッセージを確認し、ステータスの変更を確認します Receiver Server: パスのネットワーク統計とファイルI/O統計などパスの詳細を表示します。
Administration Server、Distribution Server、Performance Metrics ServerおよびReceiver Serverの詳細にアクセス	詳細を確認する必要があるサーバーの「Details」をクリックします。「サービス構成の表示および編集」を参照してください。
「Application Navigation」ペイン	アイコンをクリックして開き、Service ManagerまたはDiagnosisのホームページにアクセスします。

Service Managerを起動および停止する方法

Oracle GoldenGate Microservices内のService Managerの起動および停止プロセスは、環境内でService Managerがどのように構成されているかによって異なります。

次に、Service Managerの起動および停止プロセスを実行する方法について説明します。

Service Managerが手動モードで構成されている場合、Service Managerを起動または停止するために実行できるスクリプトが$DEPLOYMENT_BASE/ServiceManager/binディレクトリにあります。
スクリプトを実行して、次の場所からService Managerを起動または停止します。
- Service Managerを起動する場合: OGG_Deployment_Home/bin/startSM.sh
- Service Managerを停止する場合: OGG_Deployment_Home/bin/stopSM.sh
Service Managerがデーモンとして構成される場合、手動の相互作用の起動または停止に必要なスクリプトは作成されません。Service Managerの起動または停止は、オペレーティング・システムが行います。

OEL 6の場合:

stop/start/status for Service Manager

/etc/init.d/OracleGoldenGate start

/etc/init.d/OracleGoldenGate stop

/etc/init.d/OracleGoldenGate status

OEL 7の場合:

systemctl start OracleGoldenGate

systemctl status OracleGoldenGate

systemctl stop OracleGoldenGate
Service Managerが、Oracle Cluster Ready Service (CRS)内のXAGエージェントとともに実行するように構成される場合、起動および停止プロセスはCRSスタックによって処理されます。

デプロイメントの詳細および構成の変更方法

選択したサービス(サーバー)の構成を確認および変更できます。

「Details」タブ

選択したデプロイメント構成を確認する場合に使用します。Configuration Assistantでサービスを構成したデプロイメント・ディレクトリがすべて表示されます。Oracleデータベースの場合、編集できるディレクトリは、Oracle GoldenGateホーム(OGG_HOME)のみです。これにより、最初に構成したものとは異なるインストールを使用できます。

「Configuration」タブ

選択したデプロイメント環境変数を確認して変更する場合に使用します。デプロイメント用に構成した環境変数が表示されます。新しい変数の追加、既存の変数の変更および選択した変数の削除を実行できます。

OracleデータベースRU11以上で動作するAIXでOracle GoldenGate Microservicesを使用する場合、 AIXTHREAD_STK値を1048576 (1MB)以上に設定する必要があります。次のように、このタブからAIXTHREAD_STK値を設定できます。

デプロイメントのAIXTHREAD_STKの環境変数を追加します。

デプロイメントを再起動します。

これらの更新をExtractレポート・ファイルで確認します。

ExtractスレッドIXAsyncTransは、最小サイズ2Mに設定されています。

AIXのデフォルトのスタック・サイズは、64ビット・アプリケーションでは196,608バイトです。

Certificates

このタブを使用して、クライアント証明書およびCA証明書を管理します。

ログ情報を解釈する方法

Service Managerについてロギングされたすべてのメッセージをこのページで確認できます。

表の使用

ExtractおよびReplicatサーバー・メッセージの更新されたログが表示されます。このリストは、日付または重大度でソートできます(それぞれの横にある下矢印をクリックします)。また、このログをリフレッシュして、表示するページ数を選択することもできます。

検索する場合は、「Date」、「Severity」または「Message」を選択してから、適切なオプションを選択して検索を構成します。

ページの下部にある「Notifications」タブに注目してください。ここには、トランザクション・エラーのためにログでは更新されないサーバー・メッセージが表示されます。たとえば、データベース資格証明を使用したデータベースへのログインに失敗した場合などです。

デバッグ・ロギングを有効にして使用する方法

このページから、デバッグ・ロギングを有効にし、デバッグ・ログ・ファイルをダウンロードできます。

デバッグ・ロギングの有効化:

デバッグ・ロギングを有効にするには、次の手順を実行します。

「Service Manager」ページの「Navigation」ペインで「Debug Log」オプションをクリックします。
「Enable Debug Log」オプションをクリックして、デバッグ情報のロギングを開始します。

デバッグ・ログの使用

このページからアクセスおよびデバッグ・ログ・ファイルを使用できます。

「Download Log File」オプションをクリックして、デバッグ・ログのローカル・コピーを保存します
「Load Debug Log File」オプションをクリックして、このページにデバッグ・ログを表示します。
必要に応じて、「Search By」ボックスを使用して、デバッグ・ログの特定のエントリを検索します。自動的にリフレッシュされない場合は、「Refresh」をクリックして最新のログ情報を取得できます。

Service Managerとデプロイメントを起動および停止する方法

Service Managerは、Administration Server、Distribution Server、Performance Metrics Server、Receiver Serverなど、デプロイメントやその他のマイクロサービスを起動および停止できる中央ハブです。

サーバーを起動および停止するには、セキュリティ管理権限が必要です。受信証跡ソースのみを使用することを選択して、Distribution Serverを停止または無効にすることを選択する場合があります。DMZ設定では、Administation Serverを無効化するよう選択できます。

Service Managerを使用したデプロイメントの開始または停止

ノート:

Oracle GoldenGate Service Managerがシステム・デーモンとして登録されている場合、Service Managerおよび他のサーバーはホストの起動(再起動)時に自動的に起動されます。

スクリプトを使用したデプロイメントの開始および停止

Service Managerデプロイメントには、コマンドラインからデプロイメントをローカルに起動および停止するための起動および停止スクリプト(startSM.shおよびstopSM.sh)が含まれています。

スクリプトにアクセスして実行するステップは次のとおりです。

環境変数(主にETC_HOMEおよびVAR_HOME)が正しく設定されていることを確認します。環境変数設定については、セキュアなデプロイメントまたはセキュアでないデプロイメントの追加方法を参照してください。
Service ManagerのDEPLOYMENT_HOME/binディレクトリに移動します。

ノート:
Service Managerをシステム・デーモンとして実行することを選択した場合、これらのスクリプト・ファイルはこの場所に存在しません。かわりに、binディレクトリには、Service Managerをデーモンとして登録するために使用されるoggInst.locファイルが含まれます。
次のコマンドを実行して、Service Managerを停止します:
```
./stopSM.sh
```
次のコマンドを実行して、Service Managerを起動または再起動します:
```
./startSM.sh
```

デプロイメントを削除する方法

OGGCAを使用して、またはサイレント・モードで、デプロイメントを削除できます。

内容は次のとおりです。

デプロイメントを削除する方法: GUI

Oracle GoldenGate Configuration Assistantウィザードを使用してデプロイメントを削除できます。

デプロイメントを削除するには、次の手順を実行します。

ノート:

デプロイメントを削除しても、Oracle GoldenGate Microservicesをアンインストールしても、システムによって自動的にプロセスが停止されることはありません。この結果、場合によっては、デプロイメントに関連付けられたプロセスを停止する必要があります。また、ファイルを手動で消去する必要があります。

Oracle GoldenGate Configuration Assistantウィザードを実行します。

$OGG_HOME/bin
「Select Service Manager Options」画面で「Existing Service Manager」を選択します。「Next」をクリックします
「Configuration Options」画面で「Remove Existing Oracle GoldenGate Deployment」を選択します。
削除する必要があるデプロイメントを「Deployment Name」リスト・ボックスで選択します。すべてのデプロイメント・ファイル(構成ファイルを含む)をホストから削除する場合は、「Delete Deployment Files from Disk」チェック・ボックスも選択します。
管理アカウントのユーザー名とパスワードを入力して、「Next」をクリックします。
デプロイメントと一緒に削除される設定のリストを確認して、「Finish」をクリックします。

Service Managerを削除するには次の手順を実行します。

Oracle GoldenGate Configuration Assistantウィザードを実行します。

$OGG_HOME/bin
「Select Service Manager Options」画面で「Existing Service Manager」を選択します。「Next」をクリックします。
削除する他のデプロイメントがない場合は、ドロップダウンからService Managerを削除するオプションを選択できます。「Configuration Options」画面で「Remove Service Manager Deployment」を選択します。
「Finish」をクリックします。

デプロイメントの削除後に手動で削除するファイル

一部のファイルを手動で削除する必要があるのは、Service Managerが登録されていたが、登録解除して新たに登録する必要がある場合のみです。ファイルを手動で削除するには、root権限またはsudo権限が必要です。削除するファイルを次に示します。

オペレーティング・システム	既存のService Managerを登録解除するために手動で削除するファイル
Linux 6	`/etc/init.d/OracleGoldenGate` `/etc/rc.d/OracleGoldenGate` `/etc/rc.d/*OracleGoldenGate` `/etc/oggInst.loc`
Linux 7	`/etc/systemd/system/OracleGoldenGate.service`

Service Managerを停止するには、次のコマンドを実行します。

systemctl stop OracleGoldenGate 
systemctl disable OracleGoldenGate *

ノート:

Service Managerが(XAGとの統合ありまたはなしで)サービスとして登録されていない場合、OGGCAはService Managerデプロイメントを停止します。そうでない場合はunregisterServiceManagerというスクリプトが作成され、ユーザーが実行するとsystemctlコマンドが実行され、指定されたファイルが削除されます。

デプロイメントを削除する方法: サイレント・モード

Oracle GoldenGateホームのbinディレクトリから、Oracle GoldenGate Configuration Assistant (oggca)を使用して、デプロイメントをサイレントで削除できます。

デプロイメントを削除することで、そのデプロイメントの様々なコンポーネント(Extract、Replicat、パス、構成ファイルなど)を削除できます。ただし、Service Managerは削除されません。

デプロイメントをサイレントで削除するには、次の手順を実行します。

デプロイメント・レスポンス・ファイルがあることを確認します。デプロイメント・レスポンス・ファイルを取得するには、OGGCAを実行してレスポンス・ファイルを保存します。

デプロイメント・レスポンス・ファイル内で次の行を更新します。

CONFIGURATION_OPTION=REMOVE
ADMINISTRATOR_PASSWORD=********
CREATE_NEW_SERVICEMANAGER=false

-silent および-responseFileオプションを使用して、次の場所からOGGCAプログラムを実行します。デプロイメント・レスポンスへの正確なパスを指定する必要があります。
```
$OGG_HOME/bin/oggca.sh -silent -responseFile
path_to_response_file/response_file.rsp
```
例:
```
$OGG_HOME/bin/oggca.sh -silent -responseFile
        /home/oracle/software/ogg_deployment.rsp 
```

サービス構成の表示および編集

Administration Server、Distribution Server、Performance Metrics ServerおよびReceiver Serverのサービス構成と再起動オプションは、Services Managerで表示および編集できます。

各サーバーのサービス構成にはService Managerのホームページからアクセスできます。サービス構成を確認する必要があるサーバーの「Details」ボタンをクリックします。Service Configurationページが表示されます。このページで、対応するサーバーのサービス構成と再起動オプションを表示および編集できます。すべてのサーバーの構成と再起動オプションは同一です。

次の表で、Services Configurationページのサービス構成と再起動のオプションについて説明します。

サービス構成のオプション

説明

Port

対応するサーバーのポート番号

Enable Legacy Protocol

互換性のあるサービスで従来の通信を有効にします。

Enabled Async Operation

非同期RESTful APIメソッドの実行を有効にします

Default Sync Wait

サービスが非同期REST APIレスポンスに応答するまでに待機するデフォルトの時間

Enabled Task Manager

提供するサービスのタスク管理を有効にします。

U-Mask

ファイル・モード作成マスク

Quiet

サービスを非出力モードで起動します。

Enabled

サービスがService Managerによって管理されることを示します。

Status

サービスが実行していることを示します。

再起動のオプション

説明

Enabled

trueに設定すると、タスクが中止された場合に再起動します。

On Success

falseに設定すると、タスクは失敗した場合のみ再起動します。

Delay

異常終了したプロセスの検出からプロセスの再起動までの待機時間(分)。

Retries

再起動を試行する最大回数。これを超えると再試行を中止します。

Window

再試行回数がカウントされる時間枠。デフォルトは120分です。

Disable on Failure

trueに設定すると、実行ウィンドウですべての実行試行が失敗した場合にタスクが無効になります。