View a markdown version of this page

Migração de objetos salvos dos OpenSearch painéis para a interface do usuário OpenSearch - OpenSearch Serviço Amazon

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Migração de objetos salvos dos OpenSearch painéis para a interface do usuário OpenSearch

Se você tiver painéis, visualizações, padrões de índice e outros objetos salvos nos OpenSearch painéis, poderá migrá-los e reutilizá-los na interface do usuário. OpenSearch

Benefícios da migração para a OpenSearch interface do usuário:

  • Alta disponibilidade — A OpenSearch interface do usuário é hospedada no Nuvem AWS e permanece disponível durante as atualizações e a manutenção do domínio, enquanto os OpenSearch painéis são hospedados no domínio e ficarão temporariamente indisponíveis.

  • Várias fontes de dados — A OpenSearch interface de usuário pode fornecer um painel único consolidado em várias fontes de dados, incluindo OpenSearch domínios, coleções sem servidor e conexões de dados com o Amazon S3 e a Amazon CloudWatch; enquanto cada OpenSearch painel só pode funcionar com um domínio ou coleção.

  • Recursos adicionais, como AI Assistant e Workspaces, estão disponíveis na OpenSearch interface do usuário. Saiba mais:Usando a OpenSearch interface do usuário no Amazon OpenSearch Service.

Visão geral da migração

O processo de migração consiste nas seguintes etapas de alto nível:

  1. Exporte objetos salvos dos OpenSearch painéis — Use a interface de gerenciamento de objetos salvos do OpenSearch painel ou a API de exportação para baixar seus painéis, visualizações, padrões de índice e outros objetos como um arquivo JSON (NDJSON) delimitado por nova linha.

  2. Crie um aplicativo de OpenSearch interface de usuário e um espaço de trabalho — Se você ainda não tiver feito isso, crie um aplicativo de OpenSearch interface de usuário e um espaço de trabalho para receber os objetos importados.

  3. Registre a fonte de dados na OpenSearch interface do usuário — Associe seu OpenSearch domínio ao aplicativo de OpenSearch interface do usuário e registre-o como fonte de dados no espaço de trabalho. Os padrões de índice em seus objetos importados fazem referência a essa fonte de dados.

  4. Importar objetos salvos na OpenSearch interface do usuário — Use a OpenSearch interface de gerenciamento de objetos salvos na interface do usuário ou a API de importação para carregar o arquivo NDJSON no espaço de trabalho de destino.

  5. Valide os objetos importados — Abra seus painéis e visualizações na OpenSearch interface do usuário para verificar se eles são exibidos corretamente e se os dados estão fluindo do domínio ou da coleção associada.

Pré-requisitos

Antes da migração, verifique os seguintes pré-requisitos:

nota

OpenSearch A interface do usuário só oferece suporte à OpenSearch versão 1.3 e posterior. Verifique se seu OpenSearch domínio está executando a versão 1.3 ou superior antes de tentar migrar objetos salvos.

Etapa 1: Exportar objetos salvos dos OpenSearch painéis

Exporte seus objetos salvos dos OpenSearch painéis usando a interface de gerenciamento ou a API de exportação. A exportação produz um arquivo JSON (NDJSON) delimitado por nova linha que contém todos os tipos de objetos salvos selecionados e suas dependências.

Exportar manualmente em OpenSearch painéis

Para exportar objetos salvos usando a interface de gerenciamento de OpenSearch painéis
  1. Abra sua instância do OpenSearch Dashboards.

  2. No painel de navegação esquerdo, escolha Gerenciamento.

  3. Em Gerenciamento de painéis, escolha Objetos salvos.

  4. Selecione os objetos salvos que você deseja exportar. Para exportar todos os objetos de um tipo específico, filtre por tipo usando a barra de pesquisa. Para exportar todos os objetos, marque a caixa de seleção no cabeçalho da tabela.

  5. Escolha Exportar.

  6. Na caixa de diálogo Exportar objetos salvos, certifique-se de que a opção Incluir objetos relacionados esteja selecionada. Essa opção inclui todos os objetos dos quais os objetos salvos selecionados dependem, como padrões de índice referenciados por visualizações. Desmarque essa opção somente se você pretende gerenciar dependências manualmente.

  7. Escolha Exportar para baixar o .ndjson arquivo para sua máquina local.

dica

Quando você escolhe Incluir objetos relacionados, o arquivo NDJSON exportado contém todos os objetos salvos necessários para renderizar os painéis e visualizações selecionados, incluindo seus padrões de índice dependentes, visualizações e objetos de pesquisa. Isso simplifica a etapa de importação e evita a perda de erros de referência.

Exportação via API

Você pode usar a API de exportação de objetos salvos do OpenSearch Dashboards para exportar objetos salvos de forma programática. Isso é útil para automatizar migrações ou integrar a etapa de exportação em um pipeline. CI/CD

nota

Se o seu OpenSearch domínio tiver o controle de acesso refinado ativado, você deverá fornecer credenciais de autenticação com sua solicitação de exportação. Use a autenticação básica HTTP adicionando a -u bandeira com seu nome de usuário e senha. Para obter mais informações sobre as opções de autenticação, consulte Fine-grained controle de acesso no Amazon OpenSearch Service.

O exemplo a seguir exporta todos os painéis com seus objetos relacionados. Substitua placeholder values por suas próprias informações.

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

Se o seu domínio não tiver o controle de acesso detalhado ativado, você poderá omitir o sinalizador. -u

Para exportar objetos salvos específicos por ID, use o objects parâmetro em vez detype:

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
nota

Para encontrar IDs de objetos salvos, você pode usar a API Saved Objects para listar todos os objetos de um tipo específico. O exemplo a seguir lista todos os painéis:

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

A resposta inclui a ID de cada objeto salvo. Você também pode encontrar o ID na URL do navegador ao visualizar o objeto nos OpenSearch painéis.

Etapa 2: importar objetos salvos para a OpenSearch interface

Depois de exportar os objetos salvos, você pode importar o arquivo NDJSON para a OpenSearch interface do usuário manualmente ou via API.

Importar manualmente na OpenSearch interface

Para importar objetos salvos usando a OpenSearch interface de usuário de gerenciamento de interface
  1. Abra seu aplicativo de OpenSearch interface de usuário e navegue até o espaço de trabalho de destino.

  2. No espaço de trabalho, escolha Ativos na navegação superior ou vá até a página de ativos do espaço de trabalho.

  3. Escolha Importar para abrir a caixa de diálogo Importar ativos.

  4. Escolha Selecionar arquivo e selecione o .ndjson arquivo que você exportou dos OpenSearch Painéis.

  5. Para Gerenciamento de conflitos, escolha uma das seguintes opções:

    • Crie novos ativos com IDs exclusivos (padrão) — Gera novos IDs para todos os objetos importados, evitando conflitos com ativos existentes.

    • Verificar ativos existentes — Verifica se há conflitos com objetos existentes. Quando selecionada, escolha uma das seguintes subopções:

      • Substituir conflitos automaticamente — Os ativos existentes com a mesma ID são substituídos automaticamente.

      • Solicitar ação em caso de conflito — Você é solicitado a resolver cada conflito individualmente.

  6. Escolha Importar.

  7. Revise o resumo da importação.

Importar via API

Para importar objetos salvos usando a API com autenticação AWS Signature versão 4, você deve primeiro obter a ID da fonte de dados e usá-la na solicitação de importação. Substitua placeholder values por suas próprias informações.

Etapa 1: obtenha o ID da fonte de dados para seu espaço de trabalho:

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"
nota

A resposta inclui o ID da fonte de dados. Você também pode encontrar o ID da fonte de dados no URL do navegador ao visualizar a fonte de dados na OpenSearch interface do usuário.

Etapa 2: Importe os objetos salvos usando a ID da fonte de dados da Etapa 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"
nota

Esses exemplos usam a --aws-sigv4 opção embutida do curl (disponível no curl 7.75 ou posterior) para assinar as solicitações. Defina suas AWS credenciais como variáveis de ambiente antes de executar os comandos: AWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEY, e AWS_SESSION_TOKEN (se estiver usando credenciais temporárias).