クロスプラットフォーム版
Version 23.4.8843
Version 23.4.8843
クロスプラットフォーム版
CData Sync のクロスプラットフォーム版には組み込みEclipse Jetty Web サーバーが含まれ、外部サーバー構成なしでSync を実行できます。さらに、インストールにはApache Tomcat、Eclipse Jetty、またはIBM WebSphere などのJava サーブレットコンテナにデプロイ可能なWAR ファイルが含まれています。
組み込みJetty サーバーの使用には、JDK 11 またはそれ以上のバージョンがマシンにインストールされている必要があります。外部Java サーブレットコンテナへのデプロイにはサーブレット3.0(Jetty 8+、Tomcat 7+、WebSphere 8+、など)が必要です。
Windows
Windows の場合、CData Sync はサービスとしてデフォルトでインストールされます。アプリケーションにアクセスするには、まず、サービスが起動していることを確認する必要があります。サービスが起動したら、Web ブラウザを開いてURL にhttp://localhost:8181/ を入力すると、CData Sync 管理コンソールにアクセスできます。
また、サービスを使用せずにjava
コマンドを介してアプリケーションを実行することもできます。CData はサービスの利用を推奨していますが、特定の構成ではこちらの方法が有効です。
サービスの起動と停止
サービスの開始と停止は、次のいずれかの方法で行います。
-
スタートメニューのショートカット(推奨)
-
コマンドプロンプトコマンド
スタートメニューのショートカット
CData Sync インストーラーは、アプリケーションを簡単に使用できるスタートメニューのショートカットを作成します。これらのショートカットにアクセスするには、スタートメニューを開いてCData Sync 2023
フォルダを展開します。以下のショートカットが利用可能です。
-
Start CData Sync:CData Sync サービスを開始します。デフォルトでは、このサービスはWindows 起動時に実行されます。そのため、アプリケーションを実行するたびにこのコマンドを実行する必要はありません。
-
Stop CData Sync:CData Sync サービスを停止します。このアクションは、Sync のアップグレード時に必要です。
-
Launch CData Sync Admin Console:デフォルトのWeb ブラウザでWeb ブラウザウィンドウを開き、管理コンソールURL http://localhost:8181/ にアクセスします。サービスが起動していない場合、Web ブラウザはエラーを返します。
サービス管理コンソール
サービス管理コンソールを開くには、スタートメニューを開きサービスと入力します。表示されたサービスアプリケーションを選択します。
CData Sync というサービスが表示されるまでスクロールダウンします。サービスが起動している場合は、状態カラムに実行中と表示されます。サービスを右クリックすると、開始、停止、および再起動のオプションを利用できます。
コマンドプロンプト
高度なユーザーは、Windows のコマンドプロンプトを使用して、サービスに対して手動でコマンドを発行することができます。コマンドプロンプトを開き、ディレクトリをインストールフォルダに変更します(デフォルトはC:\Program Files\CData\CData Sync
です)。
Note:Microsoft PowerShell ウィンドウを使用してこれらのコマンドを発行することもできますが、構文が若干異なります。PowerShell を使用する際は、コマンドを適宜修正してください。
CData Sync サービスを開始するには、次のコマンドを実行します。
sync.exe -start
以下のコマンドで、サービスを再起動または停止できます。
sync.exe --restart --ServiceName "CData Sync"
sync.exe --stop --ServiceName "CData Sync"
サービスを使わずに起動
サービスを開始せずにCData Sync を実行するには、インストールフォルダでコマンドプロンプトを開きます。アプリケーションを開始するには、次のコマンドを実行します。
java -jar sync.jar
Linux
CData Sync を任意の場所にインストールしたら、CData Sync をサービスとして実行するか、アプリケーションを手動で実行することができます。CData は、重要なアプリケーションにSync を使用する場合は、サービスの使用をお勧めします。
Sync をサービスとして実行
CData Sync をサービスとして実行すると、アプリケーションをユーザープロセスから独立して実行し、再起動時に自動的に再起動することができます。この方法は、クリティカルな用途に適しています。
CData では、Linux 上でCData Sync アプリケーションを管理するデーモンの作成を推奨しています。インストールパッケージに含まれるスクリプトで、これを自動的に行うことができます。必要に応じて、手動でデーモンを作成することも可能です。
システムが systemd デーモンマネージャーを使用している場合に、CData Sync デーモンを設定する最も安全な方法は、インストールパッケージに含まれているスクリプトを実行することです。
bash ./service
このスクリプトは、cdata-sync.service
という名前のデーモンを作成します。その後、systemctl
を使用してデーモンを管理できます。
systemctl enable cdata-sync
systemctl start cdata-sync
スタンドアロンアプリケーションの実行
サービスを作成せずにCData Sync を開始するには、ターミナルでインストールディレクトリの >sync.jar ファイルを開き、次のように設定ファイルを引数として指定します。
java -jar sync.jar
組み込みJetty サーバーの構成
CData Sync は、あらゆる環境ですぐに動作するようあらかじめ設定されています。ただし、CData Sync インストールディレクトリにsync.properties ファイルを生成することで、Sync で公開されているデータへのアクセス方法をカスタマイズできます(Windows の場合、インストールディレクトリのデフォルトはC:\Program Files\CData\CData Sync
です)。
sync.properties ファイルの生成
組み込みJetty サーバーをカスタマイズする前に、sync.properties ファイルを作成する必要があります。これを行うには、sync.jar ファイルがあるインストールディレクトリ(InstallationDirectory
)で以下のコマンドを実行します。
java -jar sync.jar -GenerateProperties
Note:sync.properties ファイルを生成すると、Syncをアップグレードしてもこのファイルは上書きされません。
sync.properties ファイルには、次のセクションで説明するように、ポートを変更したりTLS / SSL を有効にするために変更できるパラメータが含まれています。
ポートの変更
組み込みサーバーがリッスンするポートを設定するには、
-
InstallationDirectory
にあるsync.properties ファイルを見つけ、テキストエディタで開きます。 -
ポートが設定されている次の行を探します。
cdata.http.port=8181
-
この値を、希望するポート番号に変更します。
SSL / TLS の有効化
SSL / TLS 接続(HTTPS)を有効化する場合にも、以下のように、 InstallationDirectory
のsync.properties ファイルを修正します。
-
cdata.tls.keyStoreType
設定を、使用するキーストアのタイプに設定します。有効な値には、jks、pkcs12、およびjceks が含まれます。 -
cdata.tls.keyStorePath
設定を、使用するキーストアのパスに設定します。${cdata.home} は、InstallationDirectory
を参照するために使用される場合があることに注意してください。 -
cdata.tls.keyStorePassword
設定を、キーストアのパスワードに設定します。 -
cdata.tls.port
設定を、サーバーをホストするために使用するポートに設定します。 -
(オプション)
cdata.http.port
設定を、プレーンテキスト接続を無効にするために空の文字列に設定します。
最終的にはこのようになります。
;; HTTP
cdata.http.port=
;; TLS
cdata.tls.port=8443
cdata.tls.keyStoreType=PKCS12
cdata.tls.keyStorePath=${cdata.home}/mycertificate.pfx
cdata.tls.keyStorePassword=mypassword
Note:Sync で設定するために外部秘密鍵を取得する場合は、必ず証明書の所有者をSync (cdatasync:cdatasync) をホストするために使用されるサービスアカウントに変更してください。
Tomcat での設定
WAR ファイルの配布
Tomcat にWAR ファイルを配布するには2つのオプションがあります。
-
webapps
フォルダにWAR ファイルをコピーする。 -
Tomcat の管理コンソール内でWAR ファイルの配布を行う。Apache Tomcat のドキュメントには、この方法のさらに詳しい説明があります。お使いのTomcat のバージョンのドキュメントを参照してください。
WAR ファイルがTomcat のファイルアップロードに許可されているデフォルトの最大サイズを超える可能性があります。デプロイメント中のエラーを解決するために、Manager アプリケーションのweb.xml ファイルを変更して、より大きなファイルを許可することができます。Tomcat の設定に応じて、このファイルは/usr/share/tomcat7-admin/manager/WEB-INF
、または別の類似ディレクトリにある可能性があります。このファイルでは、許容される最大ファイルサイズ(バイト単位)を変更できます。例えば、200-MB のWAR ファイルのデプロイメントを許容するには、次の値を変更して許容される最大ファイルサイズを変更します。
<multipart-config>
<!-- 200-MB max -->
<max-file-size>209715200</max-file-size>
<max-request-size>209715200</max-request-size>
<file-size-threshold>0</file-size-threshold>
</multipart-config>
Java 認証・承認サービス(JAAS)の設定
Sync がアプリケーション内で動的にユーザーを管理できるようにするには、次のサブセクションで説明するようにJAAS を設定する必要があります。
ログインモジュールの作成
$CATALINA_BASE/conf/
フォルダに、jaas.config という名前のJAAS コンフィギュレーションファイルを作成します。
標準認証を使用するには、jaas.config に次の内容を含めます。
Sync {
sync.LoginModule required;
};
LDAP またはWindows Active Directory を使用してユーザーを認証する場合は、代わりに以下の内容を追加します。
Sync {
com.sun.security.auth.module.LdapLoginModule REQUIRED
userProvider="ldaps://ab1cdef234.wfsaas.net:636/CN=Users,DC=example,DC=com"
authIdentity="{USERNAME}@example.com"
userFilter="(&(|(samAccountName={USERNAME})(userPrincipalName={USERNAME})(cn={USERNAME}))(objectClass=user))"
useSSL=false;
sync.LoginModule optional;
};
この例では、userProvider
、authIdentity
、およびuserFilter
属性の値を環境に合わせて変更する必要があります。
JAASRealm モジュールの作成(または変更)
以下にあるコンフィギュレーションXML ファイルを作成(既存の場合は変更)して、Sync のコンテキストを作成します。
$CATALINA_BASE/conf/Catalina/localhost/sync.xml
Note:Tomcat の構成によっては、このパスが若干異なる場合があります。この例では、Catalina
はエンジン名、localhost
はserver.xml で定義されたホスト名を示します。
以下で示すように、<Context> ブロックを定義して<Realm> 要素を追加します。
<Context>
<Realm className="org.apache.catalina.realm.JAASRealm" appName="Sync"
userClassNames="sync.SimplePrincipal"
roleClassNames="sync.GroupPrincipal" />
</Context>
次に、Tomcat サーバーのコンフィギュレーションファイルserver.xml の<Host> 要素を、以下のようにcopyXML 属性をtrue に設定して更新します。
<Host name="localhost" appBase="webapps" unpackWARS="true" autoDeploy="true" copyXML="true">
...
</Host>
ログインモジュールの表示
コンフィギュレーションを表示するには、Java 仮想マシン(JVM)がログインモジュール(jaas.config)に誘導される必要があります。JVM のjava.security.auth.login.config
システムプロパティをjaas.config ファイルのパスに設定します。これを行うには、次の行を$CATALINA_BASE/conf/catalina.properties
ファイルに追加します。
java.security.auth.login.config=${catalina.base}/conf/jaas.config
データディレクトリ権限の設定
Java サーブレットコンテナを実行するプロセスのユーザーに、以下のように、適切な場所にあるデータディレクトリへの読み / 書きのアクセス権限を許可します。
-
Windows:
C:\ProgramData\CData\Sync\
-
Linux:
~/cdata/sync
Tomcat サーバーを再起動して、変更を反映します。これでアプリケーションにログインすることができます。
WebSphere での設定
WebSphere クラスローダーの設定
WebSphere がアプリケーションリソースを正しくロードするためには、以下の手順に従ってください。
-
WebSphere で、アプリケーション -> アプリケーション・タイプ -> WebSphere エンタープライズ・アプリケーションに移動します。
-
Sync を選択します。
-
クラス・ロードおよび更新の検出を選択します。
-
最初にローカル・クラス・ローダーをロードしたクラス(親が最後)を選択します。
-
アプリケーションの単一クラス・ローダーを選択します。
-
OK をクリックします。その後保存をクリックします。
Java 認証・承認サービス(JAAS)の設定
次の手順でJAAS を設定し、Sync がWebSphere Application Server 内で動的にユーザーを管理できるようにします。
-
Sync をデプロイします。
-
アプリケーションセキュリティを有効化します(セキュリティー -> グローバル・セキュリティー -> アプリケーション・セキュリティーを使用可能にする)。
-
次のように、システムログインにカスタムログインモジュールを追加します。
-
セキュリティー -> グローバル・セキュリティー -> Java 認証・承認サービス -> システム・ログイン -> WEB_INBOUND に移動します。新規をクリックしてsync.LoginModule という名前の新しいエントリを追加します。sync.LoginModule はcom.ibm.ws.security.server.lm.ltpaLoginModule の前にある必要があることに注意してください。
-
ログイン・モジュール・プロキシーの使用チェックボックスを選択します。
-
認証ストラテジーのOPTIONAL を選択します。
-
カスタム・プロパティーのisWebSphere を追加してtrue に設定します。
-
-
-
グループを作成します。
-
ユーザーおよびグループ -> グループの管理 -> 作成に移動します。
-
cdata_admin、cdata_standard、およびcdata_support グループを作成します。
-
-
グループをロールにマップします。
-
アプリケーション -> アプリケーション・タイプ -> WebSphere エンタープライズ・アプリケーション -> sync_war -> ユーザー / グループへのセキュリティー・ロールのマッピングに移動します。
-
cdata_admin グループをcdata_admin ロールにマップします。
-
cdata_standard グループをcdata_standard ロールにマップします。
-
cdata_support グループをcdata_support ロールにマップします。
-
アプリケーションのレルム内で認証済みすべてをcdata_user ロールにマップします。
-
-
com.ibm.ws.webcontainer.AllowQueryParamWithNoEqual プロパティをtrue に設定します。
-
サーバー -> サーバー・タイプ -> Web Sphere Application Server に移動し、Sync がホストされているサーバーを選択します。
-
コンテナー設定 -> Web コンテナー設定 -> Web コンテナーを選択します。
-
追加プロパティー -> カスタム・プロパティーを選択します。
-
新規プロパティ:com.ibm.ws.webcontainer.AllowQueryParamWithNoEqual を追加します。
-
値をtrue に設定します。
-
-
WebSphere を再起動します。
データディレクトリ権限の設定
Java サーブレットコンテナを実行するプロセスのユーザーに、データディレクトリへの読み / 書きのアクセス権限を許可します。
-
Windows:
C:\ProgramData\CData\Sync\
-
Linux:
~/cdata/sync
WebSphere サーバーを再起動して、変更を反映します。これでアプリケーションにログインすることができます。
Jetty での設定
Sync にはJetty Web サーバーが組み込まれていますが、アプリケーションを外部のJetty 設定で使用することもできます。
WAR ファイルの配布
WAR ファイルをJetty のwebapps
フォルダにコピーします。
Java 認証・承認サービス(JAAS)の設定
JAAS を設定してSync がアプリケーションのユーザーを管理できるようにするには、次のサブセクションで説明する手順を実行する必要があります。
JAAS モジュールの追加
JAAS モジュールをインストールするには、次のコマンドを送信します。
java -jar {JETTY_HOME}/start.jar --add-to-start=jaas
ログインモジュールの作成
{JETTY_BASE}/etc/login.conf
フォルダに、login.config という名前のログインコンフィギュレーションファイルを作成します。
login.config ファイルに以下の内容を記述します。
Sync {
sync.LoginModule required debug=true;
};
セキュリティハンドラの更新
セキュリティハンドラの設定は、sync.xml 設定ファイルにあります。securityHandler ブロックを以下のように変更します。
<Set name="securityHandler">
<New class="org.eclipse.jetty.security.ConstraintSecurityHandler">
<Set name="loginService">
<New class="org.eclipse.jetty.jaas.JAASLoginService">
<!-- This name is the same as **login-config > realm-name** in web.xml. -->
<Set name="name">SyncRealm</Set>
<!-- LoginModuleName must match the name of your LoginModule, as declared in your login-module configuration file. -->
<Set name="loginModuleName">Sync</Set>
<!-- Set the principal class name for the custom role. -->
<Set name="roleClassNames">
<Array type="java.lang.String">
<Item>sync.GroupPrincipal</Item>
</Array>
</Set>
</New>
</Set>
</New>
</Set>
データディレクトリ権限の設定
Java サーブレットコンテナを実行するプロセスのユーザーに、データディレクトリへの読み / 書きのアクセス権限を許可します。
-
Windows:
C:\ProgramData\CData\Sync\
-
Linux:
~/cdata/sync
Jetty サーバーを再起動して、変更を反映します。これでアプリケーションにログインすることができます。
ユーザー管理
初めて起動する際、Sync はユーザー名とパスワードの資格情報を持つユーザーの作成を要求します。最初のユーザーを作成後、アプリケーションの設定ページのユーザータブで、ユーザーの追加、削除、および管理を行うことができます。
Sync を外部のJava サーブレットにデプロイする場合(つまり、アプリケーション付属の組み込みサーバーを使用しない場合)、Sync によるユーザーの管理を可能にするためJAAS の設定が必要です。前のセクションで、特定の外部サーブレットごとにJAAS を設定するプロセスを詳しく説明しています。
アプリケーションディレクトリの検索と設定
Sync ApplicationDirectory
フォルダには、アプリケーションで使用されるすべてのデータ(設定データ、アプリケーションデータ、ログデータ、証明書など)が格納されます。ApplicationDirectory
のデフォルトの場所は、Sync が組み込みWeb サーバー経由でホストされているか、外部のJava サーブレットコンテナ経由でホストされているかによって異なります。
組み込みWeb サーバーの場合、 ApplicationDirectory
は InstallationDirectory
と同じです。デフォルトの場所は次のとおりです。
/opt/sync
Sync が外部のJava サーブレットコンテナにホストされている場合、 ApplicationDirectory
はサーバーを実行しているユーザーのホームディレクトリからの相対パスです。
~/sync
このパスでは、’~’ はアプリケーションをホストするサーバーを実行しているユーザーのホームディレクトリに解決します。
ApplicationDirectory
フォルダを構成でき、これはさまざまなシナリオで役立ちます。
-
Sync の複数インスタンスのクラスタリング
-
アプリケーションデータ用の共有ネットワークドライブの使用
-
同じフォルダにアクセスする他のシステム内へのSync の組み込み
ApplicationDirectory
を変更すると、アプリケーションのデータファイルが移動します。ただし、EXE ファイルやJAR ファイルなどの他のアプリケーションリソースは移動しません。これらのリソースは InstallationDirectory
フォルダに格納されます。このフォルダは ApplicationDirectory
と同じ場合がありますが、 ApplicationDirectory
を変更しても、これらのリソースの場所は変わりません。
組み込みJava サーバー
クロスプラットフォーム版を組み込みJetty サーバーで使用する場合、 ApplicationDirectory
は InstallationDirectory
にあるsync.properties ファイルに設定されます。このサーバー設定ファイル内で、cdata.app.directory の設定に希望するディレクトリのパスを設定する必要があります。次の例は、マウントされたドライブ上の共有フォルダにデータディレクトリを設定した場合を示しています。
cdata.app.directory=/mnt/shared/sync
Sync がcdata.app.directory のパスを見つけることができ、そのパスで読み取りと書き込みができる適切なアクセス許可を持つ場合、指定したディレクトリ内にデータフォルダを作成します。
外部Java サーバー
クロスプラットフォーム版を外部のJava サーブレット(アプリケーションに含まれるJetty サーバー以外のサーバー)で使用する場合、アプリケーションのデータディレクトリの設定の詳細は使用する特定のサーブレットに依存します。特定のサーブレットに適した構文を使用するAppDirectory 環境変数を必要なディレクトリのパスに設定する必要があります。
Sync がAppDirectory のパスを見つけることができ、そのパスで読み取りと書き込みができる適切なアクセス許可を持つ場合、指定したディレクトリ内にデータフォルダを作成します。
アプリケーションデータベースの設定
Sync のアプリケーションデータベースは、以下のようなアプリケーションデータの複数のテーブルを保存します。
-
ジョブ
-
タスク
-
接続
-
履歴(ジョブとタスク両方)
-
アプリケーションログ(アプリケーションレベルのエラーとイベント)
-
監査ログ(ユーザーによるSync の設定変更)
デフォルトでSync は ApplicationDirectory
に存在するDerby データベースをアプリケーションデータベースとして使用します。ただし、SQL Server、PostgreSQL、MySQL などのエンタープライズデータベースを使用するようにアプリケーションを設定できます。
組み込みJava サーバー
クロスプラットフォーム版を組み込みJetty サーバーで使用する場合、アプリケーションデータベースは InstallationDirectory
にあるsync.properties ファイルに設定されます。このサーバー設定ファイル内で、cdata.app.db の設定に、希望するデータベースの適切な接続パラメータを含むJava Database Connectivity (JDBC) 接続文字列を設定する必要があります。次の例は、この設定をMySQL、PostgreSQL、およびSQL データベースについて示しています。
MySQL
cdata.app.db=jdbc:cdata:mysql:server=localhost;port=3306;database=mysql;user=MyUserName;password=MyPassword
PostgreSQL
cdata.app.db=jdbc:cdata:postgresql:server=localhost;port=5432;database=postgresql;user=MyUserName;password=MyPassword
SQL Server
cdata.app.db=jdbc:cdata:sql:server=localhost;database=sqlserver;user=MyUserName;password=MyPassword
Sync がcdata.app.db 接続文字列で正常に接続を確立できる場合、そのデータベースをアプリケーションデータベースとして使用します。
外部Java サーバー
クロスプラットフォーム版を外部のJava サーブレット(アプリケーションに含まれるJetty サーバー以外のサーバー)で使用する場合、アプリケーションのデータベースの設定の詳細は使用する特定のサーブレットに依存します。特定のサーブレットに適した構文を使用する、サーバーを設定する際のアプローチを次のいずれかから選択します。
-
ターゲットデータベースの接続プロパティを含むJNDI データソースを定義。
-
APP_DB 環境変数をJDBC 接続文字列に設定。
Sync がJDNI データソースまたはAPP_DB 接続文字列を使用してデータベースに同期できる場合、そのデータベースをアプリケーションデータベースとして使用します。
ログインのロックアウト
Sync は、ブルートフォースアタックを防ぐために、不正なパスワードを何度も入力するユーザーを自動的にロックアウトします。デフォルトでは、5分以内に6回不正なパスワードを入力したユーザーは30分間ロックアウトされます。
Web サーバーの動作を規定するXML 設定ファイルを編集することで、ロックアウトの設定を変更できます。この3つの設定はロックアウトに関係します。
-
LockoutFailedAttempts - ロックアウトのトリガーとなる不正なパスワードの数。ロックアウトを無効にするには、LockoutFailedAttempts を0に設定します。
-
LockoutMinutes - ロックアウトする時間。デフォルトは30分です。
-
LockoutTimeCheckPeriod - 失敗した試行回数を0にリセットするまでの時間。デフォルトは5分です。
組み込みJetty サーバー
sync.properties ファイル内のロックアウト設定を変更するには、以下のように、name:value ペアのカンマ区切りのリストをinitParameters
に追加します。
cdata.initParameters=LockoutFailedAttempts:0
Tomcat
Tomcat sync.xml ファイルのロックアウト設定を編集するための構文は以下のとおりです。
<Context>
<Parameter name="LockoutFailedAttempts" value="0" />
</Context>
一般的な課題と解決方法
このセクションでは、Java 環境にSync をデプロイする際に遭遇する可能性がある一般的な課題をリストアップします。それぞれの課題について推奨ソリューションを記載します。その他のヘルプについては、CData テクニカルサポート:[email protected] にお問い合わせください。
課題
Sync が起動しない、または期待されるものとは異なるAppDirectory を使用して起動する
このエラーは、Sync が ApplicationDirectory
にアクセスするために必要な権限を持っていない可能性があります( ApplicationDirectory
は、ジョブ、接続、変換などの設定に関する重要な情報を保存するフォルダです)。このエラーの原因として考えられるのは、サービスをセットアップする前にローカルユーザーとしてSync を実行している場合です。この場合、アプリケーションで作成される特定のリソースが、ローカルユーザーの下に作成されている可能性があります。結果として、Sync をサービスとして実行する場合にこれらのリソースを利用できません。
推奨ソリューション
Linux オペレーティング環境で、サービスアカウント(またはSync を実行させるための他のアカウント)が ApplicationDirectory
にアクセスできることを確認する最も簡単な方法は、chown
コマンドを使用することです。例えば、 ApplicationDirectory
がLinux のデフォルトの場所にあってSync がサービスアカウントで実行されるべき場合、以下のコマンドでエラーが解決されるはずです。
sudo chown -R cdatasync:cdatasync /opt/sync