自己管理型MongoDBの外部設定値

__rest展開ディレクティブを使用する

__rest展開ディレクティブは、 RESTエンドポイントから構成ファイル値をロードします。 __restは、構成ファイル内の特定の値の読み込みまたは構成ファイル全体の読み込みをサポートしています。

storage:  dbPath: "/var/lib/mongo"systemLog:  destination: file  path: "/var/log/mongodb/mongod.log"net:  bindIp: 192.51.100.24,127.0.0.1  tls:    mode: requireTLS    certificateKeyFile: "/etc/tls/mongod.pem"    certificateKeyFilePassword:      __rest: "https://myrestserver.example.net/api/config/myCertKeyFilePassword"      type: "string"

__rest: "https://myrestserver.example.net/api/config/fullConfig"type: "yaml"

__exec展開ディレクティブを使用する

__exec展開ディレクティブは、shell またはターミナルコマンドから構成ファイル値をロードします。 __execは、構成ファイル内の特定の値の読み込みまたは構成ファイル全体の読み込みをサポートしています。

storage:  dbPath: "/var/lib/mongo"systemLog:  destination: file  path: "/var/log/mongodb/mongod.log"net:  bindIp: 192.51.100.24,127.0.0.1  tls:    mode: requireTLS    certificateKeyFile: "/etc/tls/mongod.pem"    certificateKeyFilePassword:      __exec: "python /home/myUserName/getPEMPassword.py"      type: "string"

__exec: "python /home/myUserName/getFullConfig.py"type: "yaml"

展開ディレクティブに関する参考資料

__rest

__rest展開ディレクティブは、 RESTエンドポイントから構成ファイル値をロードします。 __restは、構成ファイル内の特定の値の読み込みまたは構成ファイル全体の読み込みをサポートしています。 その後、 mongod / mongosは、構成の一部として外部ソースの値の使用を開始します。

__rest展開ディレクティブの構文は次のとおりです。

• 特定の構成ファイル設定に対してRESTエンドポイントを指定するには、次のようにします。

  <some configuration file setting>:  __rest: "<string>"  type: "string"  trim: "none|whitespace"  digest: "<string>"  digest_key: "<string>"

• 構成ファイル全体にRESTエンドポイントを指定するには

  __rest: "<string>"type: "yaml"trim: "none|whitespace"

  RESTエンドポイント経由で構成ファイル全体を指定する場合、展開ディレクティブとそのオプションは構成ファイルで指定される値のみである必要があります。

__rest は、次のフィールドがあります。

フィールド	タイプ	説明
__rest	string	必須。 mongod / mongosが外部ソースの値を取得するためのGETリクエストを発行する URL 。 非ローカルホストRESTエンドポイント（たとえば、リモート サーバーでホストされているRESTエンドポイント）の場合、 __restにはホストマシンとリモート サーバーの両方が TLS 1.1以降をサポートしている暗号化された（ https:// ） URL が必要です。 RESTURLで指定された エンドポイントに認証が必要な場合は、標準の RFC3986 ユーザー情報形式を使用してURLに認証情報をエンコードします。 ローカルホストRESTエンドポイント（ホスト マシンでリッスンするRESTエンドポイントなど）の場合、 __restは暗号化されていない（ http:// ）URL を許可します。 重要: 指定されたREST エンドポイントによって返される値には、追加の展開ディレクティブを含めることはできません。mongod/ は返されたデータに対して追加の処理を実行せず、返されたデータに追加の展開ディレクティブが含まれている場合はエラーmongos コードで終了します。
type	string	任意__restが指定された URL から返された値を解析する方法を制御します。 可能な値は次のとおりです。 string （デフォルト） 返されたデータをリテラル string として解析するように__restに指示します。 stringを指定する場合、 __restブロック全体とサポート オプションは、外部ソース値をロードするフィールドの下にネストする必要があります。 yaml 返されたデータをyaml形式のファイルとして解析するように__restに指示します。 yamlを指定する場合、 __restブロックは構成ファイル内の 唯一 のコンテンツである必要があります。 mongod / mongosは、構成ファイルの内容を REST リソースから取得されたyamlに置き換えます。
trim	string	任意whitespaceを指定すると、 __restは先頭または末尾の空白、具体的には" " 、 "\r" 、 "\n" 、 "\t" 、 "\v" 、 "\f"の発生を削除します。 デフォルトはnone 、または削除なし。
ダイジェスト	string	任意.展開結果の HMAC-SHA256 出力は、HMAC-SHA256(digest_key, message) として計算されます。ここで message は検索する構成設定の値です。 指定する場合は、 Digest_key も指定する必要があります。
Digest_key	string	任意.展開結果の HMAC-SHA256 ダイジェスト の計算に使用される 32 バイトキーの 64 文字の 16進数文字列表現。 指定する場合は、ダイジェストも指定する必要があります。 例えば、certificateKeyFilePassword が "superSecret123" であると仮定します。REST リクエストまたは exec サービス呼び出しを使用してこのパスワードを検索するには、ダイジェスト キーを生成し、それを使用してパスワードのダイジェストを計算する必要があります。 ターミナルで次のコードを実行します。これにより、32 バイトのダイジェストキーが生成されます。 openssl rand -hex 32 出力を表示 ダイジェスト キーを生成した後、これを使用してパスワードのダイジェストを計算できます。 echo -ne "superSecret123" | openssl dgst -sha256 -mac hmac -macopt hexkey:f38d0d5adfcf1a0575f9fa9051c70a2f88b1bb7562513c9efd7686e9c21ad304 出力を表示

注意

• 構成ファイルに__rest展開が含まれている場合、Linux/macOS では、構成ファイルへの読み取りアクセスは、 mongod / mongosプロセスを実行しているユーザーのみに制限する必要があります。

• __rest展開ディレクティブの解析を有効にするには、 オプションを使用してmongod /mongos --configExpand "rest"を起動します。

例については、「 __rest展開ディレクティブの使用 」を参照してください。

__exec

__exec展開ディレクティブは、shell またはターミナルコマンドの出力から構成ファイル値をロードします。 __execは、構成ファイル内の特定の値の読み込みまたは構成ファイル全体の読み込みをサポートしています。 その後、 mongod / mongosは、構成の一部として外部ソースの値の使用を開始します。

__exec展開ディレクティブの構文は次のとおりです。

• 特定の構成ファイル設定に対して shell またはターミナルコマンドを指定するには、次のようにします。

  <some configuration file setting>:  __exec: "<string>"  type: "string"  trim: "none|whitespace"

• 構成ファイル全体に対して shell またはターミナルコマンドを指定するには:

  __exec: "<string>"type: "yaml"trim: "none|whitespace"

  ターミナルコマンドまたは shell コマンドを使用して構成ファイル全体を指定する場合、展開ディレクティブとそのオプションは、構成ファイルで指定される値のみである必要があります。

__exec は、次のフィールドがあります。

フィールド	タイプ	説明
__exec	string	必須 stringmongodmongos外部ソースの値を取得するためにターミナルまたは shell 実行shell する 。 Linux および OSX ホストでは、実行は POSIX popen()によって処理されます。 Windows ホストでは、実行は プロセス制御 API 経由で処理されます。 __execは、 mongodまたはmongosを開始したのと同じユーザーとして読み取り専用パイプを開きます。 重要: 指定されたコマンドを実行して返されるデータには、追加の展開ディレクティブを含めることはできません。mongod/ は返されたデータに対して追加の処理を実行せず、返されたデータに追加の展開ディレクティブが含まれている場合はエラーmongos コードで終了します。
type	string	任意コマンドの実行時に返される値を__execが解析する方法を制御します。 可能な値は次のとおりです。 string （デフォルト） 返されたデータをリテラル string として解析するように__execに指示します。 stringを指定する場合、 __execブロック全体とサポート オプションは、外部ソース値をロードするフィールドの下にネストする必要があります。 yaml 返されたデータをyaml形式のファイルとして解析するように__execに指示します。 yamlを指定する場合、 __execブロックは構成ファイル内の 唯一 のコンテンツである必要があります。 mongod / mongosは、構成ファイルの内容を実行された コマンドから検索されたyamlに置き換えます。
trim	string	任意whitespaceを指定すると、 __execは先頭または末尾の空白、具体的には" " 、 "\r" 、 "\n" 、 "\t" 、 "\v" 、 "\f"の発生を削除します。 デフォルトはnone 、または削除なし。
ダイジェスト	string	任意.展開結果の HMAC-SHA256 出力は、HMAC-SHA256(digest_key, message) として計算されます。ここで message は検索する構成設定の値です。 指定する場合は、 Digest_keyも指定する必要があります
Digest_key	string	任意.展開結果の HMAC-SHA256 ダイジェスト の計算に使用される 32 バイトキーの 64 文字の 16進数文字列表現。 指定する場合は、ダイジェストも指定する必要があります 例えば、certificateKeyFilePassword が "superSecret123" であると仮定します。REST リクエストまたは exec サービス呼び出しを使用してこのパスワードを検索するには、ダイジェスト キーを生成し、それを使用してパスワードのダイジェストを計算する必要があります。 ターミナルで次のコードを実行します。これにより、32 バイトのダイジェストキーが生成されます。 openssl rand -hex 32 出力を表示 ダイジェスト キーを生成した後、これを使用してパスワードのダイジェストを計算できます。 echo -ne "superSecret123" | openssl dgst -sha256 -mac hmac -macopt hexkey:f38d0d5adfcf1a0575f9fa9051c70a2f88b1bb7562513c9efd7686e9c21ad304 出力を表示

注意

• 構成ファイルに__exec展開が含まれている場合、Linux/macOS では、構成ファイルへの書込み (write) アクセスは、 mongod / mongosプロセスを実行しているユーザーのみに制限する必要があります。

• __exec展開ディレクティブの解析を有効にするには、 mongod / mongosを--configExpand "exec"オプションとともに起動します。

例については、「 __exec展開ディレクティブの使用 」を参照してください。

解決された展開ディレクティブ値を含む構成ファイルを出力する

1 つ以上の展開ディレクティブを指定する構成ファイルの最終出力をテストするには、 mongod / mongosを--outputConfigオプションとともに起動します。 mongodで開始されたmongos /--outputConfig は、解決された YAML 構成ドキュメントをstdout に出力し、停止します。構成ファイルで指定された展開ディレクティブのいずれかが追加の展開ディレクティブを返す場合、 mongod / mongosはエラーをスローして終了します。

たとえば、次の構成ファイルmongod.confには__rest展開ディレクティブが含まれています。

storage:  dbPath: "/var/lib/mongo"systemLog:  destination: file  path: "/var/log/mongodb/mongod.log"net:  port:    __rest: "https://mongoconf.example.net:8080/record/1"    type: string

指定された URL で記録された string は、 20128

構成ファイルに__rest展開が含まれている場合、Linux/macOS では、構成ファイルへの読み取りアクセスは、 mongod / mongosプロセスを実行しているユーザーのみに制限する必要があります。

}mongod --configExpand "rest"オプションと--outputConfig オプションを使用して を起動します。

mongod -f mongod.conf --configExpand rest --outputConfig

mongodは終了前に以下をstdoutに出力します。

config: mongod.confstorage:  dbPath: "/var/lib/mongo"systemLog:  destination: file  path: "/var/log/mongodb/mongod.log"net:  port: 20128outputConfig: true