翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon DocumentDB 移行ランブック

このランブックは、 AWS Database Migration Service (DMS) を使用して MongoDB データベースを Amazon DocumentDB に移行するための包括的なガイドを提供します。これは、最初の検出から移行後の検証まで、エンドツーエンドの移行ジャーニーを通じてデータベース管理者、クラウドエンジニア、開発者をサポートするように設計されています。

MongoDB と Amazon DocumentDB の間の実装とサポートされている機能の違いを考慮すると、このランブックは構造化された体系的なアプローチを強調しています。重要な移行前評価を概説し、互換性に関する考慮事項を強調し、最小限の中断で移行を成功させるために必要な主要なタスクについて詳しく説明します。

ランブックは、以下のトピックで構成されています。

このランブックのガイダンスに従うことで、チームはアプリケーションの機能を維持し、リスクを最小限に抑えながら、Amazon DocumentDB へのスムーズで安全かつ効率的な移行を確保できます。

互換性

MongoDB から Amazon DocumentDB に移行する場合、移行を成功させるには、徹底的な初期評価と機能の互換性チェックが不可欠です。このプロセスは、集約パイプライン演算子、クエリパターン、インデックス、データモデルなど、MongoDB 機能の包括的なインベントリから始まります。

Amazon DocumentDB は MongoDB 3.6、4.0、5.0、8.0 API と互換性があるため、新しい MongoDB 固有の機能を使用するアプリケーションではリファクタリングが必要になる場合があります。評価する重要な領域には、シャーディングメカニズム (Amazon DocumentDB は異なるアプローチを使用）、トランザクション実装、変更ストリームの機能、インデックスタイプ (特にスパースインデックスと部分インデックス) などがあります。

パフォーマンス特性も異なり、Amazon DocumentDB は予測可能なパフォーマンスを持つエンタープライズワークロード向けに最適化されています。テストでは、両方のシステムに対して代表的なワークロードを実行して、最適化が必要なクエリパターンを特定する必要があります。

評価フェーズでは、潜在的なパフォーマンスギャップを検出するための実行計画のモニタリングが重要です。これにより、明確な移行ロードマップを作成し、必要なアプリケーションの変更を特定し、スムーズな移行のための現実的なタイムラインを確立できます。

コア機能の互換性

包括的な機能サポート

拡張 AWS統合機能

最新のアーキテクチャの利点

Amazon DocumentDB の機能の包括的な概要については、「Amazon DocumentDB でサポートされている MongoDB API、オペレーション、およびデータ型」および「機能の違い: Amazon DocumentDB と MongoDB」を参照して、データベースの可能性を最大化してください。

Amazon DocumentDB は、MongoDB が提供するすべてのインデックスをサポートしているわけではありません。GitHub には、互換性を確認するための無料のインデックスツールが用意されています。インデックスツールを実行して非互換性を評価し、それに応じて回避策を計画します。

Amazon DocumentDB 互換性評価ツール

GitHub の Amazon DocumentDB Compatibility Tool はMongoDBワークロードを分析し、サポートされていない、または Amazon DocumentDB で変更が必要な演算子、コマンド、および機能をレポートします。3.6 から 8.0.1 (デフォルト: 8.0.1) までのターゲットバージョンをサポートしています。

推奨: URI モード (MongoDB 5.0 以降)

URI モードは MongoDB インスタンスに直接接続し、オペレーションをリアルタイムでサンプリングし、プロファイリングやログアクセスを必要としません。

代替方法

前提条件

使用状況の詳細と使用可能なすべてのオプションについては、GitHub の README を参照してください。

ワークロードの検出

MongoDB から Amazon DocumentDB に移行するには、既存のデータベースワークロードを完全に理解する必要があります。ワークロード検出は、データベースの使用パターン、データ構造、クエリパフォーマンス、運用上の依存関係を分析し、中断を最小限に抑えながらシームレスな移行を確保するプロセスです。このセクションでは、MongoDB から Amazon DocumentDB への効果的な移行を容易にするためのワークロード検出に関連する主要なステップを概説します。

既存の MongoDB デプロイの評価

移行前に、以下を含む現在の MongoDB 環境を評価することが重要です。

データモデルの違いを特定する

Amazon DocumentDB は MongoDB と互換性がありますが、サポートされている機能には次のような違いがあります。

クエリとパフォーマンスの分析

クエリの動作を理解することで、移行と移行後のパフォーマンスを最適化できます。分析すべき主な領域は次のとおりです。

セキュリティとアクセスコントロールの確認

認証と認可

暗号化

保管中および転送中の暗号化がコンプライアンス要件と一致していることを確認します。

ネットワーク設定

仮想プライベートクラウド (VPC) のセットアップとセキュリティグループルールを計画します。

運用とモニタリングに関する考慮事項

システムの信頼性を維持するために、ワークロード検出には以下も含める必要があります。

新しいターゲットクラスターを作成する

の手順に従って Amazon DocumentDB クラスターを作成しますAmazon DocumentDB クラスターの作成。クラスターを移行用に設定するときは、次の推奨事項を適用します。

インデックスの移行

MongoDB から Amazon DocumentDB に移行するには、データだけでなくインデックスも転送して、クエリパフォーマンスを維持し、データベースオペレーションを最適化する必要があります。このセクションでは、互換性と効率を確保しながら、MongoDB から Amazon DocumentDB にインデックスを移行するための詳細なステップ倍ステップのプロセスを概説します。

Amazon DocumentDB インデックスツールの使用

GitHub でインデックスツールのクローンを作成する

git clone https://github.com/awslabs/amazon-documentdb-tools.git
cd amazon-documentdb-tools/index-tool

pip install -r requirements.txt

MongoDB からインデックスをエクスポートする (MongoDB から移行する場合)

python3 migrationtools/documentdb_index_tool.py \
  --dump-indexes \
  --dir index_export \
  --uri 'mongodb://<username>:<password>@<source_endpoint>:27017'

インデックスを検証する

python3 migrationtools/documentdb_index_tool.py \
  --show-issues \
  --dir index_export

インデックスをインポートする

python3 migrationtools/documentdb_index_tool.py \
  --restore-indexes \
  --skip-incompatible \
  --dir index_export \
  --uri 'mongodb://<username>:<password>@<target_endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&retryWrites=false'

ユーザー移行

MongoDB から Amazon DocumentDB にユーザーを移行することは、アクセスコントロール、認証、データベースセキュリティを維持する上で不可欠です。このセクションでは、Amazon MongoDB ユーザーを、 Amazon DocumentDB エクスポートユーザーツールを使用して、彼らのロールとアクセス許可を保持しながら正常に移行する詳細な手順を概説します。

Amazon DocumentDB ユーザーエクスポートツールの使用

Export Users tool は、ユーザーとロールを MongoDB または Amazon DocumentDB から JavaScript ファイルにエクスポートし、それを別のクラスターで再作成するために使用できます。

前提条件

# Clone the repository
git clone https://github.com/awslabs/amazon-documentdb-tools.git
cd amazon-documentdb-tools/migration/export-users

# Install required dependencies
pip install pymongo

ステップ 1: ユーザーとロールをエクスポートする

# Export users and roles to JavaScript files
python3 docdbExportUsers.py \
  --users-file mongodb-users.js \
  --roles-file mongodb-roles.js \
  --uri "mongodb://<username>:<password>@<source_endpoint>:27017"

ステップ 2: ユーザーファイルを編集する

セキュリティ上の理由から、パスワードはエクスポートされません。mongodb-users.js ファイルを開き、各createUserステートメントのpwd値を置き換えて、各ユーザーのパスワードを追加します。

db.getSiblingDB("admin").createUser({
  user: "appuser",
  pwd: "REPLACE_THIS_PASS",
  roles: [
    { role: "readWrite", db: "mydb" }
  ]
})

ステップ 3: Amazon DocumentDB にカスタムロールを復元する

# Import roles first
mongosh \
  --tls \
  --host <target_endpoint>:27017 \
  --tlsCAFile global-bundle.pem \
  --username <username> \
  --password <password> \
  mongodb-roles.js

ステップ 4: Amazon DocumentDB にユーザーを復元する

# Import users after roles are created
mongosh \
  --tls \
  --host <target_endpoint>:27017 \
  --tlsCAFile global-bundle.pem \
  --username <username> \
  --password <password> \
  mongodb-users.js

重要な注意事項

この方法は、ユーザーとロールを MongoDB から Amazon DocumentDB に移行するための安全で柔軟なアプローチを提供し、移行プロセス中にパスワードをリセットできるようにします。

データ移行

オンライン移行

このセクションでは、最小限のダウンタイムと継続的なレプリケーションを可能にする AWS DMS ために、 を使用して MongoDB から Amazon DocumentDB へのオンライン移行を実行する詳細な手順について説明します。まず、Amazon DocumentDB クラスターをターゲットとしてセットアップし、MongoDB インスタンスがソースとして適切に設定されていることを確認します。通常、変更データキャプチャにはレプリカセットモードが必要です。次に、DMS レプリケーションインスタンスを作成し、必要な接続の詳細を使用してソースエンドポイントとターゲットエンドポイントを定義します。エンドポイントを検証したら、フルデータロード、継続的なレプリケーション、またはその両方を含む移行タスクを設定して開始します。

新しいターゲットクラスターを作成する

「新しいターゲットクラスターを作成する」を参照してください。

ソースを設定する

MongoDB と Amazon DocumentDB は、シナリオに応じて、どちらも移行ソースとして機能します。

移行を開始する前に、 AWS DMS アクセスを許可するようにソースを設定します。

適切なアクセス許可を持つ MongoDB ユーザーを作成します。

db.createUser({
  user: "dmsUser",
  pwd: "<password>",
  roles: [{ role: "readAnyDatabase", db: "admin" }]
})

ネットワークと認証を設定します。

MongoDB から DMS への移行用のネットワーク接続を設定する場合:

EC2 がホストする MongoDB ソース

オンプレミス MongoDB ソース

MongoDB Atlas ソース

Amazon DocumentDB ソース

DMS レプリケーションインスタンスのセキュリティグループからのインバウンドトラフィックを許可するように、ソース Amazon DocumentDB セキュリティグループを設定します。

DMS レプリケーションインスタンスを作成する

GitHub の DMS Buddy を使用して、最適な DMS 設定とインスタンスサイズで最適な移行インフラストラクチャを作成します。手動で設定する場合、次の手順に従います。

DMS エンドポイントを作成する

ソースエンドポイントを作成する

MongoDB ソースの場合

Amazon DocumentDB ソースの場合

ターゲットエンドポイント (Amazon DocumentDB) を作成する

レプリケーションタスクを作成する

オフライン移行

このセクションでは、mongodump および mongorestore のネイティブ MongoDB ツールを使用して、セルフマネージド MongoDB インスタンスから Amazon DocumentDB へのオフライン移行を実行するプロセスを概説します。

前提条件

ソース MongoDB の要件

ターゲット Amazon DocumentDB の要件

一般的な要件

Amazon DocumentDB クラスターを準備する

「新しいターゲットクラスターを作成する」を参照してください。

データダンプを実行する (mongodump)

ダンプファイルを作成するために、次のいずれかのオプションを選択します。

ダンプファイルを復元環境に転送する

ダンプサイズに基づいて適切な方法を選択します。

Amazon DocumentDB (mongorestore) にデータを復元する

復元プロセスを開始する前に、Amazon DocumentDB でインデックスを作成します。Amazon DocumentDB インデックスツール を使用して、インデックスをエクスポートおよびインポートできます。

データを復元するには、以下のいずれかのオプションを選択します。

モニタリング

このセクションでは、進行中の移行の進行状況、パフォーマンス、状態を追跡するための詳細なモニタリングプロセスについて説明します。

モニタリング手順は、移行方法 (AWS DMS、mongodump/mongorestore、またはその他のツール) に関係なく適用されます。

AWS DMS 移行モニタリング (該当する場合)

次の主要な CloudWatch メトリクスをモニタリングします。

フルロードフェーズのメトリクス

CDC フェーズメトリクス

リソースメトリクス

エラーメトリクス

移行パフォーマンスが低下した場合に通知を受け取るには、 CDCLatencyTarget や CPUUtilization などの重要なメトリクスの CloudWatch アラームを作成します。

DMS ログ (CloudWatch ログ)

DMS タスクのステータス (使用 AWS CLI)

aws dms describe-replication-tasks \
  --filters Name=replication-task-id,Values=<task_id> \
  --query "ReplicationTasks[0].Status"

予想されるステータスフロー:

作成中 → 準備完了 → 実行中 → 停止中 → 停止 (または失敗)

docdb-dashboarder の使用によるモニタリング

この docdb-dashboarder ツールは、重要なパフォーマンスメトリクスを含む CloudWatch ダッシュボードを自動的に生成することで、Amazon DocumentDB クラスターの包括的なモニタリングを提供します。これらのダッシュボードには、重要なクラスターレベルのメトリクス (レプリカラグ、オペレーションカウンター)、インスタンスレベルのメトリクス (CPU、メモリ、接続)、ストレージメトリクス (ボリューム使用量、バックアップストレージ) が表示されます。移行シナリオの場合、このツールは、CDC レプリケーションラグや運用率などのメトリクスを使用して移行の進行状況を追跡する特殊なダッシュボードを提供します。ダッシュボードでは、複数のクラスターを同時にモニタリングし、NVMe-backed インスタンスのサポートを含めることができます。これらのメトリクスを視覚化することで、チームはパフォーマンスのボトルネックをプロアクティブに特定し、リソース割り当てを最適化し、Amazon DocumentDB デプロイの円滑な運用を確保できます。このツールを使用すると、ダッシュボードを手動で作成する必要がなくなり、すべての環境で一貫したモニタリングが可能になります。セットアップ手順と高度な設定オプションについては、Amazon DocumentDB Dashboarder ツール GitHub リポジトリを参照してください。

検証

このセクションでは、移行後のデータの整合性、整合性、アプリケーションの互換性を確保するための詳細な検証プロセスについて説明します。

検証手順は、移行方法 (AWS DMS、mongodump/mongorestore、またはその他のツール) に関係なく適用されます。

検証チェックリスト

各コレクションのドキュメント数がソースとターゲットの間で一致することを検証します。

MongoDB ソース

mongosh \
  --host <source_endpoint> \
  --port 27017 \
  --username <user> \
  --password <password> \
  --eval "db.<collection>.countDocuments()"

Amazon DocumentDB ターゲット

mongosh \
  --host <target_endpoint> \
  --port 27017 \
  --username <user> \
  --password <password> \
  --tls \
  --tlsCAFile global-bundle.pem \
  --eval "db.<collection>.countDocuments()"

スキーマとインデックスの検証

以下を確認してください。

コレクションを確認する (ソースとターゲット)

mongosh --host <source_endpoint> \
  --port 27017 \
  --username <username> \
  --password <password> \
  --eval "db = db.getSiblingDB('<database>'); db.getCollectionNames();"

mongosh --host <target_endpoint> \
  --port 27017 \
  --username <username> \
  --password <password> \
  --tls --tlsCAFile global-bundle.pem \
  --eval "db = db.getSiblingDB('<database>'); db.getCollectionNames();"

インデックスを確認する (ソースとターゲット)

mongosh --host <source_endpoint> \
  --port 27017 \
  --username <username> \
  --password <password> \
  --eval "db.<collection>.getIndexes()"

mongosh --host <target_endpoint> \
  --port 27017 \
  --username <username> \
  --password <password> \
  --tls --tlsCAFile global-bundle.pem \
  --eval "db.<collection>.getIndexes()"

コレクションのリストを比較して、欠落しているコレクションや余分なコレクションがないことを確認します。

インデックス名、キー定義、一意の制約、TTL インデックス (存在する場合) を確認して、インデックスを検証します。

スキーマ検証ルールを確認する (MongoDB でスキーマ検証を使用する場合)

mongosh --host <source_endpoint> \
  --port 27017 \
  --username <username> \
  --password <password> \
  --eval "db.getCollectionInfos({name: '<collection>'})[0].options.validator"

mongosh --host <target_endpoint> \
  --port 27017 \
  --username <username> \
  --password <password> \
  --tls --tlsCAFile global-bundle.pem \
  --eval "db.getCollectionInfos({name: '<collection>'})[0].options.validator"

データサンプリングとフィールドレベルの検証

ドキュメントをランダムにサンプリングし、ソースとターゲットのフィールドを比較できます。

手動サンプリング

5 つのランダムドキュメント (ソース) を取得します。

mongosh --host <source_endpoint> \
  --port 27017 \
  --username <username> \
  --password <password> \
  --eval "db.<collection>.aggregate([{ \$sample: { size: 5 } }])"

同じドキュメント ID (ターゲット) を取得します。

mongosh --host <target_endpoint> \
  --port 27017 \
  --username <username> \
  --password <password> \
  --tls --tlsCAFile global-bundle.pem \
  --eval "db.<collection>.find({ _id: { \$in: [<list_of_ids>] } })"

自動サンプリング

import pymongo

# Connect to source and target
source_client = pymongo.MongoClient("<source_uri>")
target_client = pymongo.MongoClient("<target_uri>",
                                    tls=True,
                                    tlsCAFile='global-bundle.pem')
source_db = source_client["<db_name>"]
target_db = target_client["<db_name>"]

# Compare 100 random documents
for doc in source_db["<collection>"].aggregate([{"$sample": {"size": 100}}]):
    target_doc = target_db["<collection>"].find_one({"_id": doc["_id"]})
    if target_doc != doc:
        print(f"Mismatch in _id: {doc['_id']}")
    else:
        print(f"Match: {doc['_id']}")

DataDiffer ツールを使用した検証

GitHub の DataDiffer ツールは、ソースデータベースとターゲットデータベース間でデータを比較する信頼性の高い方法を提供します。

前提条件

DataDiffer ツールをインストールする前に、次の前提条件を満たす必要があります。

セットアップとインストール

リポジトリのクローンを作成し、DataDiffer ディレクトリに移動する

git clone https://github.com/awslabs/amazon-documentdb-tools.git
cd amazon-documentdb-tools/migration/data-differ

必要な依存関係をインストールする

pip install -r requirements.txt

データ検証の実行

接続の詳細を含む設定ファイル (config.json など) を作成する

{
  "source": {
    "uri": "mongodb://<username>:<password>@<source_endpoint>:27017/?replicaSet=rs0",
    "db": "your_database",
    "collection": "your_collection"
  },
  "target": {
    "uri": "mongodb://<username>:<password>@<target_endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&retryWrites=false",
    "db": "your_database",
    "collection": "your_collection"
  },
  "options": {
    "batch_size": 1000,
    "threads": 4,
    "sample_size": 0,
    "verbose": true
  }
}

DataDiffer ツールを実行する

python differ.py --config config.json

大規模なコレクションの場合、サンプリングを使用してデータのサブセットを検証する

python differ.py --config config.json --sample-size 10000

複数のコレクションを検証するには、個別の設定ファイルを作成するか、バッチモードを使用する

python differ.py --batch-config batch_config.json

結果の解釈

ツールの出力は次のとおりです。

ベストプラクティス

DataDiffer ツールを使用する際のベストプラクティスは次のとおりです。