OpenSearch Dashboards から OpenSearch UI への保存済みオブジェクトの移行

OpenSearch Dashboards に既存のダッシュボード、ビジュアライゼーション、インデックスパターン、およびその他の保存されたオブジェクトがある場合は、OpenSearch UI でそれらを移行して再利用できます。

OpenSearch UI に移行するメリット:

移行の概要

移行プロセスは、以下の大まかなステップで構成されます。

前提条件

移行する前に、次の前提条件を確認してください。

ステップ 1: OpenSearch Dashboards から保存されたオブジェクトをエクスポートする

管理 UI またはエクスポート API を使用して、保存されたオブジェクトを OpenSearch Dashboards からエクスポートします。エクスポートでは、選択したすべての保存済みオブジェクトタイプとその依存関係を含む改行区切りの JSON (NDJSON) ファイルが生成されます。

OpenSearch Dashboards で手動でエクスポートする

API を使用したエクスポート

OpenSearch Dashboards の保存済みオブジェクトのエクスポート API を使用して、保存済みオブジェクトをプログラムでエクスポートできます。これは、移行を自動化したり、エクスポートステップを CI/CD パイプラインに統合したりするのに役立ちます。

次の の例では、関連するオブジェクトを含むすべてのダッシュボードをエクスポートします。プレースホルダー値を、ユーザー自身の情報に置き換えます。

curl -X POST \
    "https://dashboards-endpoint/_dashboards/api/saved_objects/_export" \
    -u 'master-username:master-password' \
    -H "Content-Type: application/json" \
    -H "osd-xsrf: true" \
    -d '{
        "type": ["dashboard", "visualization", "index-pattern", "search"],
        "includeReferencesDeep": true,
        "excludeExportDetails": false
    }' \
    -o saved-objects-export.ndjson

ドメインできめ細かなアクセスコントロールが有効になっていない場合は、 -uフラグを省略できます。

特定の保存済みオブジェクトを ID でエクスポートするには、 の代わりに objectsパラメータを使用しますtype。

curl -X POST \
    "https://dashboards-endpoint/_dashboards/api/saved_objects/_export" \
    -u 'master-username:master-password' \
    -H "Content-Type: application/json" \
    -H "osd-xsrf: true" \
    -d '{
        "objects": [
            {"type": "dashboard", "id": "dashboard-id"},
            {"type": "visualization", "id": "visualization-id"}
        ],
        "includeReferencesDeep": true
    }' \
    -o saved-objects-export.ndjson

curl -X GET \
    "https://dashboards-endpoint/_dashboards/api/saved_objects/_find?type=dashboard" \
    -u 'master-username:master-password'

ステップ 2: 保存したオブジェクトを OpenSearch UI にインポートする

保存したオブジェクトをエクスポートした後、NDJSON ファイルを OpenSearch UI に手動でインポートするか、API 経由でインポートできます。

OpenSearch UI に手動でインポートする

API 経由でのインポート

AWS 署名バージョン 4 認証で API を使用して保存済みオブジェクトをインポートするには、まずデータソース ID を取得し、インポートリクエストで使用する必要があります。プレースホルダー値を、ユーザー自身の情報に置き換えます。

ステップ 1: ワークスペースのデータソース ID を取得する:

curl -X GET \
    "https://opensearch-ui-endpoint/w/workspace-id/api/saved_objects/_find?type=data-source" \
    --aws-sigv4 "aws:amz:region:opensearch" \
    --user "$AWS_ACCESS_KEY_ID:$AWS_SECRET_ACCESS_KEY" \
    -H "x-amz-security-token: $AWS_SESSION_TOKEN" \
    -H "osd-xsrf: true"

ステップ 2: ステップ 1 のデータソース ID を使用して保存されたオブジェクトをインポートします。

curl -X POST \
    "https://opensearch-ui-endpoint/w/workspace-id/api/saved_objects/_import?overwrite=true&dataSourceId=data-source-id" \
    --aws-sigv4 "aws:amz:region:opensearch" \
    --user "$AWS_ACCESS_KEY_ID:$AWS_SECRET_ACCESS_KEY" \
    -H "x-amz-security-token: $AWS_SESSION_TOKEN" \
    -H "osd-xsrf: true" \
    -F "file=@saved-objects-export.ndjson"