Microsoft SQL Server の設定
Microsoft SQL Server のサンプル Docker Compose ファイルは、PTC ソフトウェアダウンロードサイトの ThingWorx Platform の部分からダウンロードできる Dockerfile に含まれています。
 |
初期メモリは 2 GB に設定され、最大メモリは 4 GB に設定されています。ボリュームマウントは docker-compose ファイルが基準になります。この場所にログとコンフィギュレーションファイルが保管されてコンテナでの永続化が有効になります。
|
プラットフォームサービスの environment セクションに以下のオプションを追加することで、このインスタンスのコンフィギュレーションを制御できます。
|
変数名
|
値
|
デフォルト
|
コメント
|
||
|---|---|---|---|---|---|
|
DATABASE_HOST
|
文字列
|
mssql
|
SQL Server データベースホストのホスト名、サービス名、または IP アドレスを指定します。
|
||
|
DATABASE_PORT
|
数値
|
1433
|
SQL Server データベースのポート番号を指定します。
|
||
|
DATABASE_ADMIN_USERNAME
|
文字列
|
SA
|
SQL Server データベースの管理者ユーザー名を指定します。コンテナを正常に作成するには、指定されているデフォルト値を使用する必要があります。
|
||
|
DATABASE_ADMIN_PASSWORD
|
文字列
|
PASSWORD
|
SQL Server データベースの管理者パスワードを指定します。DATABASE_ADMIN_PASSWORD と SA_PASSWORD の値は同じでなければなりません。
|
||
|
DB_TYPE
|
文字列
|
mssql
|
デフォルトの永続化プロバイダの名前を指定します。注記: この変数は ThingWorx 9.3.0 以降のバージョンではサポートされていません。
|
||
|
SA_PASSWORD
|
文字列
|
PASSWORD
|
SA パスワードを指定します。DATABASE_ADMIN_PASSWORD と SA_PASSWORD の値は同じでなければなりません。
|
||
|
ENABLE_HTTP
|
true/false
|
true
|
Tomcat で HTTP コネクタを有効にすることで、コンテナへのトラフィックをセキュリティ保護しません
|
||
|
ENABLE_HTTPS
|
true/false
|
false
|
Tomcat で HTTPS コネクタを有効にすることで、コンテナへのトラフィックをセキュリティ保護します。キーストアも用意し、SSL_KEYSTORE_PASSWORD を設定しなければなりません。
|
||
|
SSL_KEYSTORE_PASSWORD
|
文字列
|
PASSWORD
|
Tomcat で SSL 通信に使用されるキーストアへのパスワードを指定します。
|
||
|
SSL_KEYSTORE_BASE_PATH
|
文字列
|
/ThingworxPlatform
|
Tomcat SSL キーストアへのパスを指定します。キーストアをデフォルトフォルダ以外のコンテナ内の場所に保管する場合、この変数を設定しなければなりません。
|
||
|
SSL_KEYSTORE_FILENAME
|
文字列
|
keystore.jks
|
Tomcat SSL キーストアのファイル名を指定します。キーストアにデフォルト以外のファイル名を付ける場合、この変数を設定しなければなりません。
|
||
|
TOMCAT_SSL_PROTOCOLS
|
文字列
|
TLSv1.2
|
Tomcat SSL プロトコルを指定します。Tomcat で使用されている SSL プロトコルをオーバーライドする場合にこれを設定します。
|
||
|
SERVER_HTTP_PORT
|
文字列
|
8080
|
Tomcat が HTTP 通信を監視するポートを指定します。このポートが変更された場合、公開されるポートを Compose ファイルで変更しなければなりません。
|
||
|
SERVER_HTTPS_PORT
|
文字列
|
8443
|
Tomcat が HTTPS 通信を監視するポートを指定します。このポートが変更された場合、公開されるポートを Compose ファイルで変更しなければなりません。
|
||
|
DOCKER_DEBUG
|
true/false
|
false
|
コンテナ起動時にデバッグ情報を記録するオプションを切り替えます。これには機密情報が含まれている可能性があることに注意してください。
|
||
|
TWX_DATABASE_USERNAME
|
文字列
|
""
|
データベース用に作成される ThingWorx ユーザーを指定します。この変数は ThingWorx Platform を起動する前に手動で設定しなければなりません。
|
||
|
TWX_DATABASE_PASSWORD
|
文字列
|
""
|
データベース用の ThingWorx ユーザーのパスワードを指定します。この変数は ThingWorx Platform を起動する前に手動で設定しなければなりません。
|
||
|
TWX_DATABASE_SCHEMA
|
文字列
|
""
|
ThingWorx インスタンスのスキーマ名を指定します。この変数は ThingWorx Platform を起動する前に手動で設定しなければなりません。
|
||
|
LS_USERNAME
|
文字列
|
""
|
ThingWorx ライセンスを取得する PTC ログインユーザー名を指定します。
|
||
|
LS_PASSWORD
|
文字列
|
""
|
ThingWorx ライセンスを取得する PTC ログインパスワードを指定します。
|
||
|
ENABLE_BACKUP
|
true/false
|
false
|
バックアップのオプションを切り替えます。
|
||
|
ENABLE_LOGGING
|
true/false
|
true
|
ログ作成のオプションを切り替えます。
|
||
|
ENCRYPT_CREDENTIALS
|
true/false
|
false
|
platform-settings.json ファイル内のデータベースとライセンスのパスワードを暗号化するオプションを切り替えます。
|
||
|
THINGWORX_INITIAL_ADMIN_PASSWORD
|
文字列
|
""
|
ThingWorx での管理者ユーザーの初期パスワードを設定します。この変数は ThingWorx Platform を起動する前に手動で設定しなければなりません。ThingWorx が正常に起動した後でこのパスワードを変更できます。
|
||
|
THINGWORX_INITIAL_METRICS_USER_PASSWORD
|
文字列
|
""
|
ThingWorx での MetricsUser の初期パスワードを設定します。これはオプションの変数です。ThingWorx Platform を起動する前に手動で設定します。ThingWorx が正常に起動した後でこのパスワードを変更できます。
|
||
|
EXTPKG_IMPORT_POLICY_ENABLED
|
true/false
|
false
|
拡張パッケージアップローダを介した拡張パッケージのインポートのグローバルな有効化/無効化を制御します。
|
||
|
EXTPKG_IMPORT_POLICY_ALLOW_JARRES
|
true/false
|
false
|
Jar (Java) リソースが含まれている拡張パッケージのインポートアクセス許可を制御します。false に設定され、拡張機能に jar ファイルが含まれている場合、インポートは失敗します。
|
||
|
EXTPKG_IMPORT_POLICY_ALLOW_JSRES
|
true/false
|
false
|
Javascript リソースが含まれている拡張パッケージのインポートアクセス許可を制御します。false に設定され、拡張機能に javascript ファイルが含まれている場合、インポートは失敗します。
|
||
|
EXTPKG_IMPORT_POLICY_ALLOW_CSSRES
|
true/false
|
false
|
CSS リソースが含まれている拡張パッケージのインポートアクセス許可を制御します。false に設定され、拡張機能に css ファイルが含まれている場合、インポートは失敗します。
|
||
|
EXTPKG_IMPORT_POLICY_ALLOW_JSONRES
|
true/false
|
false
|
JSON リソースが含まれている拡張パッケージのインポートアクセス許可を制御します。false に設定され、拡張機能に json ファイルが含まれている場合、インポートは失敗します。
|
||
|
EXTPKG_IMPORT_POLICY_ALLOW_WEBAPPRES
|
true/false
|
false
|
WebApps リソースが含まれている拡張パッケージのインポートアクセス許可を制御します。false に設定され、拡張機能に WebApp リソースファイルが含まれている場合、インポートは失敗します。
|
||
|
EXTPKG_IMPORT_POLICY_ALLOW_ENTITIES
|
true/false
|
false
|
拡張不可エンティティ定義が含まれている拡張パッケージのインポートアクセス許可を制御します。false に設定され、拡張機能に拡張パッケージエンティティ以外の拡張不可エンティティ定義が含まれている場合、インポートは失敗します。
|
||
|
EXTPKG_IMPORT_POLICY_ALLOW_EXTENTITIES
|
true/false
|
false
|
拡張可能エンティティ定義が含まれている拡張パッケージのインポートアクセス許可を制御します。false に設定され、拡張機能に拡張パッケージエンティティ以外の拡張可能エンティティ定義が含まれている場合、インポートは失敗します。
|
||
|
ENABLE_CONSOLE_OUTPUT
|
true/false
|
false
|
コンソールのログを有効にします。
|
||
|
ENABLE_CLUSTERED_MODE
|
true/false
|
false
|
クラスタモードを有効にするには true に設定します。
|
||
|
HTTP_PORT
|
数値
|
Null
|
HTTP 通信に使用するポート。SERVER_HTTP_PORT と一致する必要があります。サービス検出に使用されます。
|
||
|
HTTP_SERVICE_NAME
|
文字列
|
thingworx-http
|
ThingWorx Platform の HTTP サービス名。サービス検出に使用されます。
|
||
|
HTTPS_PORT
|
数値
|
Null
|
HTTPS 通信に使用するポート。SERVER_HTTPS_PORT と一致する必要があります。サービス検出に使用されます。
|
||
|
HTTPS_SERVICE_NAME
|
文字列
|
thingworx-https
|
ThingWorx Platform の HTTPS サービス名。サービス検出に使用されます。
|
||
|
TOMCAT_SSL_CIPHERS
|
文字列
|
""
|
コンマで区切られた暗号スイートのオプションのリスト。リストされているこれらの暗号のみに HTTPS 接続を制限します。設定されていない場合、デフォルトの JVM 暗号が使用されます。
|
||
|
TOMCAT_COMPRESSION
|
on/off/force
|
off
|
Tomcat の圧縮を有効または無効にします。コネクタで HTTP/1.1 GZIP 圧縮を使用してサーバーの帯域幅を節約できます。使用可能な値には off (圧縮を無効にする)、on (テキストデータの圧縮を許可する)、force (例外なく圧縮を強制する) があります。
|
||
|
TOMCAT_COMPRESSION_MIN_SIZE
|
数値
|
2048
|
TOMCAT_COMPRESSION が on である場合に出力を圧縮する前の最小データ量を指定します。
|
||
|
TOMCAT_USE_SEND_FILE
|
true/false
|
true
|
sendfile 機能を有効または無効にします。sendfile を使用すると、そうでない場合に Tomcat が応答に対して実行する圧縮が無効になります。
|
||
|
COORDINATOR_HOSTS
|
文字列
|
""
|
Zookeeper エンドポイントのコンマ区切りリスト。各エンドポイントは _host_:_port_ です。
|
||
|
IGNITE_ZK_CONNECTION
|
文字列
|
""
|
サービス検出に使用される Zookeeper のホストとポート
|
||
|
ZK_SSL_ENABLED
|
true/false
|
false
|
Zookeeper 用に SSL を有効にします。
|
||
|
ZK_SSL_KEYSTORE_LOCATION
|
文字列
|
/certs/zookeeper.p12
|
Zookeeper キーストアへのパス。
|
||
|
ZK_SSL_KEYSTORE_PASSWORD
|
文字列
|
""
|
Zookeeper キーストアのパスワード。
|
||
|
ZK_SSL_TRUSTSTORE_LOCATION
|
文字列
|
""
|
Zookeeper トラストストアへのパス。
|
||
|
ZK_SSL_TRUSTSTORE_PASSWORD
|
文字列
|
""
|
Zookeeper キーストアのパスワード。
|
||
|
CATALINA_OPTS
|
文字列
|
""
|
Tomcat に渡される Java ランタイムオプション。
|
||
|
DATABASE_ADMIN_SCHEMA
|
文字列
|
postgres
|
DB サーバー上のデフォルトスキーマの名前。
|
||
|
TWX_KEYSTORE_PASSWORD
|
文字列
|
""
|
ThingWorx キーストアパスワードの設定に使用するパスワード。設定されていない場合、ThingWorx は初回起動時にランダムなパスワードを作成します。
このパスワードを設定することで、HA の設定および古いデータ/ボリュームの復元にそのパスワードが使用されるようにします。
|
||
|
SECRET_CX_APP_KEY
|
文字列
|
""
|
接続サーバーが ThingWorx への接続に使用するアプリケーションキー
|
||
|
SECRET_PROVISIONING_APP_KEY
|
文字列
|
""
|
初回起動時に ThingWorx のプロビジョニングに使用されるアプリケーションキー。
|
||
|
EXTPKG_IMPORT_POLICY_HA_COMPATIBILITY_LEVEL
|
WARN/DENY
|
WARN
|
HA と互換性のある拡張機能を許可するか拒否するかを制御する拡張機能インポートポリシーコンフィギュレーション。オプションは WARN または DENY です。
WARN に設定した場合、HA に準拠していない拡張機能もインポートされますが、アプリケーションログに警告が書き込まれます。
DENY に設定した場合、HA に準拠する拡張機能のみをインポートできます。
|
||
|
ENABLE_PROPERTY_TRANSFORM
|
true/false
|
false
|
プロパティ変換を有効にするには true に設定します。
|
||
|
PROPERTY_TRANSFORM_RABBITMQ_HOST
|
""
|
localhost
|
プロパティ変換で使用する RabbitMQ ホスト。
|
||
|
PROPERTY_TRANSFORM_RABBITMQ_PORT
|
文字列
|
5672
|
プロパティ変換で使用する RabbitMQ ポート。
|
||
|
PROPERTY_TRANSFORM_RABBITMQ_USERNAME
|
文字列
|
admin
|
プロパティ変換で使用する RabbitMQ ユーザー名。
|
||
|
PROPERTY_TRANSFORM_RABBITMQ_PASSWORD
|
文字列
|
""
|
プロパティ変換で使用する RabbitMQ パスワード。
|
||
|
PROPERTY_TRANSFORM_RABBITMQ_VHOST
|
文字列
|
/
|
プロパティ変換で使用する RabbitMQ Vhost。
|
||
|
IGNITE_SSL_ACTIVE
|
true/false
|
false
|
Ignite 用に SSL を有効にします。
|
||
|
IGNITE_KEYSTORE_FILE_PATH
|
文字列
|
/certs/ignite.pfx
|
Ignite キーストアへのパス。
|
||
|
IGNITE_KEYSTORE_PASSWORD
|
文字列
|
""
|
Ignite キーストアのパスワード。
|
||
|
ZK_SASL_ENABLED
|
true/false
|
false
|
Zookeeper での SASL 認証を有効にします。
|
||
|
ZK_SASL_SECURITY_AUTH_LOGIN_CONFIG
|
文字列
|
/tmp1/jaas.conf
|
JAAS コンフィギュレーションファイルへのパス。
|
||
|
ZK_SASL_SECURITY_KRB5_CONF
|
文字列
|
/tmp1/krb5.conf
|
Kerberos コンフィギュレーションファイルへのパス。
|
||
|
AKKA_SSL_ENABLED
|
true/false
|
true
|
tls Akka 通信をオン/オフにします。
|
||
|
AKKA_KEYSTORE
|
文字列
|
/certs/keystore.jks
|
Akka キーストアへのパスは証明書ボリュームに保存できます。たとえば、/certs/keystore.jks などです。
|
||
|
AKKA_TRUSTSTORE
|
文字列
|
/certs/truststore.jks
|
Akka トラストストアへのパスは証明書ボリュームに保存できます。たとえば、/certs/truststore.jks などです。
|
||
|
AKKA_KEYSTORE_PASSWORD
|
文字列
|
デフォルト値は設定されていません
|
AKKA_KEYSTORE からのパスワード。
|
||
|
AKKA_TRUSTSTORE_PASSWORD
|
文字列
|
デフォルト値は設定されていません
|
AKKA_TRUSTSTORE からのパスワード。
|
自分のサイトに固有の場所にボリュームパスを変更することもできます。ボリュームパスでは以下の構文が使用されます。
"./<ローカルマウントへのパス>:/<コンテナマウントへのパス>"
例:
"/opt/ThingworxPlatform:/ThingworxPlatform"
|
|
ボリュームパスを更新する場合、内部コンテナのマウントポイントは変わらないので、ローカルマウントのみを変更します。
|
MS SQL Server Docker イメージはテストを簡単に行うために提供されています。提供されている MS SQL Server Docker を本番用には使用しないでください。最良事例としては、本番用に独自の MS SQL Server 環境を設定します。
Docker の外に存在する Microsoft SQL Server データベースに接続するには、mssql サービスを Compose ファイルから除去し、以下の変数を platform 環境変数に追加します。
• DATABASE_ADMIN_USERNAME
• DATABASE_ADMIN_PASSWORD
これらはユーザー、データベース、またはスキーマの作成が承認されている Microsoft SQL Server データベース上の管理者アカウントであり、ThingWorx コンテナは初回起動時にこれをロードします。外部の Microsoft SQL Server データベースを使用するためのプラットフォーム設定が含まれている Compose ファイルの例については、ThingWorx Docker での外部 Microsoft SQL Server データベースの使用を参照してください。
外部データベースを使用している場合、ThingWorx スキーマを手動でインストールでき、ThingWorx Docker コンテナ用の管理者資格証明は入力しません。これを行うには、変数 DATABASE_HOST、DATABASE_PORT、TWX_DATABASE_USERNAME、TWX_DATABASE_PASSWORD、および TWX_DATABASE_SCHEMA を適宜設定します。