Migration des objets enregistrés des OpenSearch tableaux de bord vers l'interface utilisateur OpenSearch

Si vous disposez de tableaux de bord, de visualisations, de modèles d'index et d'autres objets enregistrés dans OpenSearch Dashboards, vous pouvez les migrer et les réutiliser dans l'interface utilisateur. OpenSearch

Avantages de la migration vers l' OpenSearch interface utilisateur :

Présentation de la migration

Le processus de migration comprend les étapes de haut niveau suivantes :

Conditions préalables

Avant la migration, vérifiez les conditions préalables suivantes :

Étape 1 : Exporter les objets enregistrés depuis les OpenSearch tableaux de bord

Exportez vos objets enregistrés depuis les OpenSearch tableaux de bord à l'aide de l'interface utilisateur de gestion ou de l'API d'exportation. L'exportation produit un fichier JSON délimité par de nouvelles lignes (NDJSON) qui contient tous les types d'objets enregistrés sélectionnés et leurs dépendances.

Exporter manuellement sur les OpenSearch tableaux de bord

Exportation via API

Vous pouvez utiliser l'API d'exportation des objets enregistrés des OpenSearch tableaux de bord pour exporter des objets enregistrés par programmation. Cela est utile pour automatiser les migrations ou intégrer l'étape d'exportation dans un CI/CD pipeline.

L'exemple suivant exporte tous les tableaux de bord avec leurs objets associés. Remplacez les placeholder values par vos propres informations.

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

Si le contrôle d'accès détaillé n'est pas activé sur votre domaine, vous pouvez omettre le drapeau. -u

Pour exporter des objets enregistrés spécifiques par ID, utilisez le objects paramètre au lieu de 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'

Étape 2 : Importer des objets enregistrés dans l' OpenSearch interface utilisateur

Après avoir exporté les objets enregistrés, vous pouvez importer le fichier NDJSON dans l' OpenSearch interface utilisateur manuellement ou via l'API.

Importation manuelle sur l' OpenSearch interface utilisateur

Importation via API

Pour importer des objets enregistrés à l'aide de l'API avec authentification AWS Signature Version 4, vous devez d'abord obtenir l'ID de la source de données, puis l'utiliser dans la demande d'importation. Remplacez les placeholder values par vos propres informations.

Étape 1 : obtenir l'ID de source de données pour votre espace de travail :

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"

Étape 2 : Importez les objets enregistrés à l'aide de l'ID de source de données indiqué à l'étape 1 :

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"