メインコンテンツへ移動

MongoDB TLS 接続設定

HAP が MongoDB サーバーの CA 証明書を信頼し、TLS で暗号化接続を確立するための設定方法を説明します。

現在、HAP は MongoDB の片方向 TLS 認証に対応しています。mTLS(双方向 TLS 認証)には対応していません。

設定前に、MongoDB で TLS が有効になっていることを確認してください。

証明書の準備​

MongoDB サーバー証明書を発行した CA 証明書を PEM 形式で用意します。

ファイル説明
custom-ca.crtMongoDB サーバー証明書の検証に使用する CA 証明書

複数の CA 証明書は、同じ custom-ca.crt ファイルに続けて記載できます。

  • ファイルには CA の公開証明書のみを含め、秘密鍵を含めないでください。秘密鍵を含むファイルは全体がインポート拒否されます。
  • MongoDB の接続アドレスは、サーバー証明書内のドメイン名または IP アドレスと一致する必要があります。

証明書のマウント​

HAP v7.4.0 以降は、カスタム CA 証明書のインポートに対応しています。

CA 証明書をコンテナ内にマウントすると、コンテナの起動時に自動的にインポートされます。

  1. HAP サーバー上の /data/mingdao/script/volume/cafile/custom-ca.crt に CA 証明書を配置します。

  2. /data/mingdao/script/docker-compose.yaml の app サービスの volumes 設定を確認し、証明書をコンテナ内にマウントします。例:

    services:
    app:
    volumes:
    - ./volume/cafile/custom-ca.crt:/Housekeeper/cafile/custom-ca.crt:ro

該当するマウント設定がすでにある場合は、重複して追加する必要はありません。

接続の設定​

デプロイ方式に応じて、対象の設定ファイルを変更します。

/data/mingdao/script/docker-compose.yaml の app サービスで設定します。

ENV_MONGODB_OPTIONS に tls=true を追加します。既存のパラメーターは保持し、MongoDB のアドレス、ポート、アカウント情報を環境に合わせて変更します。

ENV_MONGODB_URI: 'mongodb://hap:YOUR_PASSWORD@192.0.2.10:27017,192.0.2.11:27017,192.0.2.12:27017'
ENV_MONGODB_OPTIONS: '?tls=true'

ENV_MONGODB_OPTIONS は ? で始まり、複数のパラメーターは & で区切ります。

設定後、シングルモードではインストールマネージャーのディレクトリで次のコマンドを実行し、app コンテナを再作成して Compose の設定を反映します。

docker compose -f docker-compose.yaml up -d --no-deps --force-recreate app

その後、HAP マイクロサービスを再起動します。クラスターモードでは設定を適用し、HAP マイクロサービスを再起動します。