Edge Server の構成 - プレビュー

前提条件

各 Edge Server インスタンスは、Atlas プロジェクト内のサービスに接続します。 Edge Server インスタンスを使用する前に、関連するサービスを作成し、Edge Server インスタンスの認証プロバイダと権限を構成する必要があります。

詳細については、「 Edge Server 用サービスの作成 」を参照してください。

Edge Server ホストの要件

Edge Server インスタンスを実行するホストは、EC 2インスタンスやその他のクラウドサーバー、またはオンサイトでプロビジョニングするハードウェアです。

Edge Server インスタンスのインストールと構成

Edge Server Service または Device Sync Service を作成した後、Edge Server インスタンスを作成する必要があります。 各サービスには多くの Edge Server インスタンスがある場合があります。 Edge Server インスタンスを作成すると、Edge Server インスタンスedgectlをインストールおよび管理するためのツールをダウンロードするために使用できるインストール スクリプトが取得されます。 また、Edge Server インスタンスを登録するために使用できるトークンも取得します。 詳細については、 「 Edge Server インスタンスの作成 」を参照してください。

インストール スクリプトを使用して、ホスト上の Edge Server インスタンスをセットアップして実行します。

curl -s https://services.cloud.mongodb.com/edge/install.sh | bash

edgectl init --app-id="<INSERT-YOUR-APP-ID-HERE>" --platform=compose

edgectl config --insecure-disable-auth=true

Edge Server の起動と停止

Edge Server インスタンスを起動および停止するには、 edgectlを使用します。

すべての Edge Server インスタンス コンテナを起動するには、 startコマンドを使用します。

edgectl start

すべての Edge Server インスタンス コンテナを停止するには、 stopコマンドを使用します。

edgectl stop

Edge Server ステータスの確認

Edge Server インスタンスが実行されている場合は、次の方法でインスタンスのステータスが表示されます。

edgectl status

これにより、Edge Server コンテナの状態に関する情報と、重要な情報の内訳の Sync サーバーの詳細なステータスが提供されます。 次のようになります。

{
   "mongoContainerStatus": {
      "message": "running"
   },
   "mongoDBStatus": {
      "message": "ready"
   },
   "syncServerContainerStatus": {
      "message": "running"
   },
   "syncServerStatus": {
      "message": "ACTIVE"
   },
   "syncServerDetailedStatus": {
      "version": "v0.22.3",
      "status": "ACTIVE",
      "cloud_connected": true,
      "num_local_clients": 0,
      "query": {
         "Item": "truepredicate"
      }
   }
}

syncServerDetailedStatusには、Edge Server インスタンスの状態に関する情報が含まれています。 これには、次のような、Atlas への接続と、それに接続されたクライアントに関する詳細が含まれます。

Edge Server インスタンス構成を更新する

edgectlを使用して、既存の Edge Server インスタンスに変更を加えることができます。 構成を変更した後、インスタンスを再起動して更新を適用します。

edgectl config --YOUR-FLAG-HERE

edgectl stop

edgectl start

Edge Server バージョンのアップグレード

Edge Server が進化するにつれて、新しい機能を活用するために、Edge Server のバージョンをアップグレードすることが必要になる場合があります。 さらに、Edge Server インスタンスは、使用可能な最新バージョンより 1 段階のメジャー バージョン以下でなければなりません。そうしないと、 FAILED状態になり、Atlas に接続できなくなります。

edgectl update

edgectl config

edgectl start

edgectl clean

edgectl start

edgectl prune

Edge Server API キーのサイクル数

Edge Server API キーを繰り返し使用する方法は、次のとおりです。

edgectl config --update-registration-token=true

Edge Server のクエリを指定する

クエリを指定しない場合、Edge Server インスタンスはデフォルトで"*"のグローバル クエリになります。これにより、リンクされたデータソース内のすべてのコレクション内のすべてのデータが自動的に同期されます。

Edge Server インスタンス同期クエリを指定するには、 edgectl configコマンドでいくつかの引数を使用できます。

• 単純な string クエリを渡します。

  edgectl config --query="Store: store_id == 42"

• 複数のクエリ フラグを渡して、複数のコレクションのクエリを指定します。

  edgectl config --query="Person: age > 10" --query "Pet: type = 'cat'"

• より複雑なクエリをマッピングする JSON オブジェクトを含むファイルへのパスを渡します。

  edgectl config --query-file="/Users/my.user/edge-server/query.json"

• すべてのコレクションで同じクエリを使用するには、グローバル クエリを渡します。

  edgectl config --global-query="shouldSync == true"

グローバル クエリを使用していない限り、Edge Server クエリはYOUR-SCHEMA-TITLE: YOUR-QUERYの形式をとります。

• YOUR-SCHEMA-TITLE:スキーマのtitleフィールド。このフィールドは通常、データベース内のコレクションの名前と一致します。 異なるデータベースに同じ名前を持つ 2 つのコレクションがある場合は、コレクション名の前にデータベース名が付けられます。たとえば、 databaseName_collectionName 。

  リンクされた Atlas データソースには、それぞれ一致するスキーマを持つ多くのコレクションが含まれる場合があります。 デフォルトの Edge Server クエリ"*"またはすべてを同期するグローバル クエリを使用しない場合は、同期する各スキーマに独自のクエリが必要です。

  テンプレート アプリを使用している場合、これはItemコレクションです。

• YOUR-QUERY: Edge Server がコレクションと同期できるドキュメントを決定するクエリ。 RQLを使用してこのクエリを定義できますが、 Flexible Sync RQLの制限 に関する同じ警告メッセージが表示されます。

edgectl config --global-query="truepredicate"

edgectl config --global-query="store_id == 42"

edgectl config --query="Inventory: store_id == 42"

edgectl config --query="Project: facility_id == 42" --query "Item: priority >= 3"

edgectl config --query-file="/Users/my.user/edge-server/query.json"

{
  "Project": "facility_id == 42",
  "Item": "priority >= 3"
}

オフライン接続のシミュレート

Edge Server は、Atlas との接続を失った Edge Server インスタンスをシミュレートするために使用できるデモ モードを提供します。 Edge Server インスタンスがオフラインのデモ モードの間も、MongoDB ドライバーやツール、または Atlas Device SDK アプリケーションを使用して、 インスタンスで CRUD 操作を引き続き実行できます。

Edge Server インスタンスに接続されたクライアントを使用してローカルにデータの変更を確認できますが、Atlas に反映された変更は確認できません。 同様に、Edge Server インスタンスがオフラインになっているときに Atlas で行った変更は Edge Server に同期されず、ローカル クライアントに反映されます。

Edge Server インスタンスのオフライン デモ モードを終了すると、Atlas との同期が自動的に再開されます。 Edge Server インスタンスのデータが Atlas に反映され、Atlas で変更されたデータはインスタンスと接続されたクライアントに表示されます。

edgectl config --insecure-enable-offline-demo

edgectl offline-demo disable-connection

edgectl offline-demo enable-connection

ホスト上で複数の Edge Server インスタンスの実行

Edge Server アーキテクチャの開発中に、単一のホスト（たとえば、ローカルマシン）で複数の Edge Server インスタンスを実行する場合があります。 edgectlプロファイル機能を使用して、これを実現できます。

Edge Server インスタンスを作成すると、 edgectlによってデフォルトのプロファイルが自動的に作成されます。 プロファイルは、コマンドを特定の Edge Server インスタンスにマッピングします。

同じマシンに新しい Edge Server インスタンスを作成すると、 edgectlは新しいプロファイルをデフォルト プロファイルとして設定します。 デフォルト以外のプロファイルを使用するコマンドを発行するには、各コマンドに--profileフラグを追加します。

edgectl start --profile=YOUR-PROFILE-NAME

プロファイルとそれに関連する構成ファイルは、次の場所で表示できます。

~/.mongodb-edge/profiles/

edgectl init --app-id="YOUR-APP-ID" --platform=compose --profile=YOUR-PROFILE-NAME

edgectl profile list

edgectl profile inspect YOUR-PROFILE-NAME

{
  "appId" : "YOUR-APP-ID",
  "platform" : "compose"
}

edgectl profile set-default YOUR-PROFILE-NAME

edgectl profile delete YOUR-PROFILE-NAME