データベース管理

イントロダクション
バックアップ
リストア
データベースの承認
マルチサービス/マルチテナント・データベース分離
完全なデータベースの削除
インデックスの設定
データベース管理スクリプト
- 期限切れのドキュメントの削除
- 最新の更新ドキュメント
データベースによる Orion エラー

イントロダクション

システム管理者は MongoDB の知識を持っていると仮定します (MongoDB 教育サイトには非常に良いコースと無料のコースがあります)。それ以外の場合は、このセクションで説明する手順に非常に注意することをお勧めします。

バックアップ

MongoDB データベースの通常手順を使用します。

mongobackup コマンドを使用して、Orion Context Broker データベースのバックアップを取得します。バックアップを実行する前に broker を停止することを強くお勧めします。

mongodump --host <dbhost> --db <db>

これにより、 dump/ ディレクトリにバックアップが作成されます。

マルチテナント/マルチサービスを使用している場合は、各テナント/サービスのデータベースに手順を適用する必要があります。

トップ

リストア

MongoDB データベースの通常手順を使用します。

Orion Context Broker データベースの以前のバックアップをリストアするには、mongorestore コマンドを使用します。バックアップを実行する前に broker を停止し、broker が使用するデータベースを削除 (drop) することを強くお勧めします。

バックアップは dump/<db> ディレクトリ . にあると仮定しましょう。それをリストアするには :

mongorestore --host <dbhost> --db <db> dump/<db>

マルチテナント/マルチサービスを使用している場合は、各テナント/サービスのデータベースに手順を適用する必要があります。

トップ

データベースの認証

MongoDB の認証は -dbURI および -dbpwd オプションを使用して設定されます (コマンドライン・オプションのセクションを参照)。考慮すべきいくつかの異なるケースがあります:

MongoDB インスタンス/クラスタが認証を使用していない場合は、-dbpwd を使用せず、username:${PWD}@ のパートを省略した -dbURI を使用してください
authMechanism オプションを使用して、-dbURI 内で認証メカニズムを指定できます
MongoDB インスタンス/クラスタが認可を使用している場合は、次のようになります :
- -dbURI では、username:${PWD}@ のパートを使用する必要があります。${PWD} は dbpwd パラメータの値に置き換えられます
- Orion をシングルサービス/テナントモードで実行している場合 (つまり -multiservice でない場合)、1つのデータベース (-db オプションで指定されたもの) であり、認証は、-dbURI および -dbpwd で指定されたユーザ名を使用してそのデータベース内で行われます
- Orion をマルチサービス/テナントモードで実行している場合 (つまり -multiservice の場合)、認証は、admin データベースで -dbURI で指定されたユーザー名と -dbpwd を使用して行われます。このドキュメントの後半で説明するように、マルチサービス/テナントモードでは、Orion はいくつかのデータベース (潜在的にオンザフライで作成される可能性があります) を使用します。admin データベース上での認証は、それらの全てで許可します
- とにかく、上記のデフォルトを -dbURI の defaultauthdb でオーバーライドして、必要な認証 DB を指定できます

次の例を考えてみましょう。 MongoDB の構成がそうである場合、通常は以下を使用してアクセスします :

mongosh mongodb://orion@orionrules:example1.net:27017,example2.net:27017,example3.net:27017/admin?replicaSet=rs0&tls=true&tlsAllowInvalidCertificates=true

Context Broker CLI パラメーターの同等の接続は次のようになります :

-dbURI mongodb://orion@${PWD}:example1.net:27017,example2.net:27017,example3.net:27017/admin?replicaSet=rs0&tls=true&tlsAllowInvalidCertificates=true -dbpwd orionrules

トップ

マルチサービス/マルチテナント・データベース分離

通常、Orion Context Broker は MongoDB レベル (-db コマンドライン・オプションで指定されたもの、通常は "orion")で1つのデータベースのみを使用します。ただし、マルチテナント/マルチサービスを使用する場合は動作が異なり、次のデータベースが使用されます (<db> を -db コマンドライン・オプションの値にしてください) :

既定テナント用のデータベース <db> (通常は orion)
サービス/テナント用 <tenant> のデータベース <db>-<tenant> (テナントの名前が tenantA と付けられ、デフォルト -db が使用されている場合、データベースは orion-tenantA になります)

テナントデータを含む最初のリクエストが Orion によって処理されることで、サービスごと/テナントのデータベースは "オンザフライ" で作成されます。

最後に、サービス/テナントデータベースごとに、すべてのコレクションおよび管理手順 (バックアップ、リストアなど) が特定のサービス/テナントデータベースに関連付けられます。

トップ

データベースを完全に削除

この操作は、MongoDB シェルを使用して行われます :

mongo <host>/<db>
> db.dropDatabase()

トップ

インデックスの設定

パフォーマンス・チューニングのドキュメントのデータベース・インデックスのセクションを確認してください。

Top

データベース管理スクリプト

Orion Context Broker には、/usr/share/contextBroker ディレクトリ内にインストールされた、データベース内の参照および管理アクティビティに使用できるいくつかのスクリプトが付属しています。

これらのスクリプトを使用するには、pymongo ドライバ (バージョン 2.5 以上) をインストールする必要があります (通常は root として実行するか、sudo コマンドを使用します) :

pip-python install pymongo

トップ

期限切れのドキュメントの削除

NGSI は、レジストレーションとサブスクリプション (コンテキストとコンテキスト・アベイラビリティの両方のサブスクリプション) の有効期限を指定します。期限切れのレジストレーション/サブスクリプションはサブスクリプション更新リクエストを使用して "再アクティブ化" することができて、期間を変更するため、Orion Context Broker は期限切れのドキュメントを削除しません (無視されます)。

ただし、有効期限が切れたレジストレーション/サブスクリプションはデータベース内の領域を消費するため、時々 "パージ" することができます。その作業を手助けするために、garbage-collector.py script が Orion Context Broker と一緒に提供されています。

garbage-collector.py は、registrations, csubs コレクション内の期限切れのドキュメントを探し、次のフィールドでそれらを "マーク (marking)" します :

{
  ...,
  "expired": 1,
  ...
}

garbage-collector.py プログラムは、解析されるコレクションを引数として取ります。たとえば、csubs を分析するために実行します :

garbage-collector.py csubs

garbage-collector.py を実行した後は、mongo コンソールの次のコマンドを使用して、期限切れのドキュメントを簡単に削除できます :

mongo <host>/<db>
> db.registrations.remove({expired: 1})
> db.csubs.remove({expired: 1})

トップ

データベースによる Orion エラー

大きなオフセット値を使用してエンティティを取得し、このエラーが発生した場合 :

GET /v2/entities?offset=54882

{
    "description": "Sort operation used more than the maximum RAM. You should create an index. Check the Database Administration section in Orion documentation.",
    "error": "InternalServerError"
}

DB はリソースの不足によるソート動作の失敗に関連するエラーを発生させている。Orion ログ・ファイルに次のような ERROR トレースが含まれていることを確認できます :

Raising alarm DatabaseError: next(): { $err: "Executor error: OperationFailed Sort operation used more than the maximum 33554432 bytes of RAM. Add an index, or specify a smaller limit.", code: 17144 }

これに対する典型的な解決策は、ソートに使用されるフィールドにインデックスを作成することです。特に、(作成日に基づいて) デフォルトのエンティティの順序を使用している場合は、mongo シェルで次のコマンドを使用してインデックスを作成できます :

db.entities.createIndex({creDate: 1})

トップ