Renomeação do Amazon OpenSearch Service: resumo das alterações

Em 8 de setembro de 2021, nosso pacote de pesquisas e análise mudou de nome para Amazon OpenSearch Service. O OpenSearch Service oferece suporte ao OpenSearch, bem como ao antigo Elasticsearch OSS. As seções a seguir descrevem as diferentes partes do serviço que foram alteradas com a renomeação do serviço e quais ações você precisa adotar para garantir que seus domínios continuem a funcionar corretamente.

Algumas dessas alterações só se aplicam quando você atualiza seus domínios do Elasticsearch para o OpenSearch. Em outros casos, como no console de Billing and Cost Management, a experiência muda imediatamente.

Essa lista não é exaustiva. Ao mesmo tempo que outras partes do produto também mudaram, essas atualizações são as mais relevantes.

Nova versão de API

A nova versão da API de configuração do OpenSearch Service (2021-01-01) funciona com o OpenSearch, bem como com o antigo Elasticsearch OSS. 21 operações de API foram substituídas por nomes mais concisos e independentes do mecanismo (por exemplo, CreateElasticsearchDomain alterado para CreateDomain), mas o OpenSearch Service continua a oferecer suporte a ambas as versões da API.

Recomendamos utilizar as novas operações de API para criar e gerenciar domínios no futuro. Observe que, ao usar as novas operações de API para criar um domínio, você precisará especificar o parâmetro EngineVersion no formato Elasticsearch_X.Y ou OpenSearch_X.Y, em vez de apenas o número da versão. Se você não especificar uma versão, ela assumirá por padrão a versão mais recente do OpenSearch.

Atualize seu AWS CLI para a versão 1.20.40 ou posterior para usar o aws opensearch ... para criar e gerenciar seus domínios. Para obter o novo formato de CLI, consulte a Referência da CLI do OpenSearch.

Tipos de instâncias renomeados

Os tipos de instâncias no Amazon OpenSearch Service agora estão no formato <type>.<size>.search, por exemplo, m6g.large.searchem vez de m6g.large.elasticsearch. Medida a ser tomada Os domínios existentes começarão a se referir automaticamente aos novos tipos de instâncias dentro da API e no console do Billing and Cost Management.

Se você tiver instâncias reservadas, seu contrato não será afetado pela alteração. A versão antiga da API de configuração ainda é compatível com o formato de nomenclatura antigo, mas se desejar usar a nova versão da API, você precisará usar o novo formato.

Alterações na política de acesso

As seções a seguir descrevem quais ações você precisará executar para atualizar suas políticas de acesso.

Políticas do IAM

Recomendamos atualizar suas políticas do IAM para usar as operações de API renomeadas. No entanto, o OpenSearch Service continuará a respeitar as políticas existentes replicando internamente as permissões de API antigas. Por exemplo, se você tiver permissão para executar a operação CreateElasticsearchDomain, agora você poderá fazer chamadas tanto para CreateElasticsearchDomain (operação da API antiga) quanto CreateDomain (operação da API nova). O mesmo se aplica às negações explícitas. Para obter uma lista das operações de API atualizadas, consulte a referência de elementos das políticas.

Políticas de SCP

As políticas de controle de serviço (SCPs) introduzem uma camada adicional de complexidade em comparação com o IAM padrão. Para evitar que suas políticas de SCP falhem, você deverá adicionar as operações de API antigas e novas a cada uma de suas políticas de SCP. Por exemplo, se um usuário tem permissões para CreateElasticsearchDomain, você também precisa conceder a eles permissões para CreateDomain para que eles possam manter a capacidade de criar domínios. O mesmo se aplica às negações explícitas.

Por exemplo:

"Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "es:CreateElasticsearchDomain",
        "es:CreateDomain"
         ...
      ],
    },
      "Effect": "Deny",
      "Action:" [
        "es:DeleteElasticsearchDomain",
        "es:DeleteDomain"
         ...

Novos tipos de recursos

O OpenSearch Service apresenta os seguintes novos tipos de recursos:

Recurso	Descrição
AWS::OpenSearchService::Domain	Representa um domínio do Amazon OpenSearch Service. Esse recurso existe no nível de serviço e não é específico do software em execução no domínio. Aplica-se a serviços como AWS CloudFormation e AWSResource Groups (Grupos de recursos) nos quais você cria e gerencia recursos para o serviço como um todo. Para obter instruções sobre como atualizar domínios definidos no CloudFormation do Elasticsearch para o OpenSearch, consulte as Observações no Guia do usuário do CloudFormation.
AWS::OpenSearch::Domain	Representa o software OpenSearch/ElasticSearch em execução em um domínio. Este recurso aplica-se a serviços como AWS CloudTrail e AWS Config, os quais fazem referência ao software em execução no domínio, em vez do OpenSearch Service como um todo. Esses serviços agora contêm tipos de recursos separados para domínios que executam o Elasticsearch (AWS::Elasticsearch::Domain) versus domínios que executam o OpenSearch (AWS::OpenSearch::Domain).

nota

No AWS Config, você continuará a ver seus dados sob o tipo de recurso AWS::Elasticsearch::Domain por várias semanas, mesmo se você atualizar um ou mais domínios para o OpenSearch.

Kibana renomeado para OpenSearch Dashboards

O OpenSearch Dashboards, a alternativa do AWS ao Kibana, é uma ferramenta de visualização de código aberto projetada para funcionar com o OpenSearch. Depois de atualizar um domínio do Elasticsearch para o OpenSearch, o endpoint /_plugin/kibana muda para /_dashboards. O OpenSearch Service redirecionará todas as solicitações para o novo endpoint, mas se você usar o endpoint do Kibana em qualquer uma das suas políticas do IAM, atualize essas políticas para incluir o novo endpoint /_dashboards também.

Se estiver usando Autenticação SAML para painéis OpenSearch , antes de atualizar seu domínio para o OpenSearch, você precisa alterar todos os URLs do Kibana configurados no seu provedor de identidade (IdP) de /_plugin/kibana para /_dashboards. Os URLs mais comuns são URLs de serviço de consumidor de asserção (ACS) e URLs de destinatário.

A função kibana_read_only padrão para o OpenSearch Dashboards foi renomeada para opensearch_dashboards_read_only, e a função kibana_user foi renomeada para opensearch_dashboards_user. A alteração se aplica a todos os domínios recém-criados do OpenSearch 1.x que executam o software de serviço R20211203 ou superior. Se você atualizar um domínio existente para o software de serviço R20211203, os nomes de funções permanecem os mesmos.

Métricas do CloudWatch renomeadas

Várias métricas do CloudWatch mudam para domínios que executam o OpenSearch. Quando você atualiza um domínio para o OpenSearch, as métricas mudam automaticamente e seus alarmes atuais do CloudWatch são interrompidos. Antes de atualizar seu cluster de uma versão do Elasticsearch para uma versão do OpenSearch, certifique-se de atualizar seus alarmes do CloudWatch para usar as novas métricas.

As seguintes métricas foram alteradas:

Nome da métrica original	Novo nome
KibanaHealthyNodes	OpenSearchDashboardsHealthyNodes
KibanaConcurrentConnections	OpenSearchDashboardsConcurrentConnections
KibanaHeapTotal	OpenSearchDashboardsHeapTotal
KibanaHeapUsed	OpenSearchDashboardsHeapUsed
KibanaHeapUtilization	OpenSearchDashboardsHeapUtilization
KibanaOS1MinuteLoad	OpenSearchDashboardsOS1MinuteLoad
KibanaRequestTotal	OpenSearchDashboardsRequestTotal
KibanaResponseTimesMaxInMillis	OpenSearchDashboardsResponseTimesMaxInMillis
ESReportingFailedRequestSysErrCount	KibanaReportingFailedRequestSysErrCount
ESReportingRequestCount	KibanaReportingRequestCount
ESReportingFailedRequestUserErrCount	KibanaReportingFailedRequestUserErrCount
ESReportingSuccessCount	KibanaReportingSuccessCount
ElasticsearchRequests	OpenSearchRequests

Para obter uma lista completa das métricas que o OpenSearch Service envia para o Amazon CloudWatch, consulte Monitorar métricas de cluster do OpenSearch com o Amazon CloudWatch.

Abra o console do Billing and Cost Management.

Os dados históricos presentes no console do Billing and Cost Management e do Cost and Usage Reports continuarão a usar o nome do serviço antigo. Por isso, você precisará começar a usar filtros tanto para o Amazon OpenSearch Service, quanto para o Elasticsearch legado ao procurar dados. Se você já tiver relatórios salvos, atualize os filtros para garantir que eles também incluam o OpenSearch Service. Inicialmente, você poderá receber um alerta quando seu uso diminuir para o Elasticsearch e aumentar para o OpenSearch, mas ele desaparecerá após alguns dias.

Além do nome do serviço, os campos a seguir serão alterados para todos os relatórios, listas e operações de API de lista de preços:

Campo	Formato antigo	Formato de linha
Tipo de instância	m5.large.elasticsearch	m5.large.search
Família de produtos	Instância do Elasticsearch Volume do Elasticsearch	Instância do Amazon OpenSearch Service Volume do Amazon OpenSearch Service
Descrição dos preços	5,098 USD por hora de instância c5.18xlarge.elasticsearch (ou hora parcial), UE	5,098 USD por hora de instância c5.18xlarge.search (ou hora parcial), UE
Família de instâncias	ultrawarm.elasticsearch	ultrawarm.search

Novo formato dos eventos

O formato dos eventos que o OpenSearch Service envia para o Amazon EventBridge e o Amazon CloudWatch mudou, especificamente o campo detail-type. O campo de origem (aws.es) permanece o mesmo. Para obter o formato completo de cada tipo de evento, consulte Eventos do OpenSearch Serviço de Monitoramento com a Amazon EventBridge. Se você tiver regras de evento existentes que dependem do formato antigo, atualize-as para que estejam em conformidade com o novo formato.

O que não mudou?

Os seguintes recursos e funcionalidades, entre outros não listados, permanecerão os mesmos:

• Entidade principal do serviço (es.amazonaws.com)

• Código do fornecedor

• ARNs de domínio

• Endpoints de domínio

Comece a usar: atualize os seus domínios para a versão 1.x do OpenSearch

A versão 1.x do OpenSearch é compatível com atualizações das versões 6.8 e 7.x do Elasticsearch. Para obter instruções sobre como atualizar seu domínio, consulte Iniciar uma atualização (console). Se você estiver usando a AWS CLI ou a API de configuração para atualizar seu domínio, você precisará especificar o TargetVersion como OpenSearch_1.x.

A versão 1.x do OpenSearch introduz uma configuração de domínio adicional chamada Enable compatibility mode (Habilitar modo de compatibilidade). Como alguns clientes e plugins do Elasticsearch OSS verificam a versão do cluster antes de se conectarem, o modo de compatibilidade define o OpenSearch para relatar sua versão como 7.10 para que esses clientes continuem a funcionar.

Você pode habilitar o modo de compatibilidade ao criar domínios do OpenSearch pela primeira vez ou ao atualizar para o OpenSearch a partir de uma versão do Elasticsearch. Se não estiver definido, o parâmetro assumirá como padrão o valor false quando você criar um domínio e true quando você atualizar um domínio.

Para habilitar o modo de compatibilidade usando a API de configuração, defina override_main_response_version como true:

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/upgradeDomain
{
  "DomainName": "domain-name",
  "TargetVersion": "OpenSearch_1.0",
  "AdvancedOptions": {
    "override_main_response_version": "true"
   }
}

Para habilitar ou desabilitar o modo de compatibilidade em domínios do OpenSearch existentes, é necessário usar a operação _cluster/settings da API do OpenSearch:

PUT /_cluster/settings
{
  "persistent" : {
    "compatibility.override_main_response_version" : true
  }
}