Elasticsearch

Templates de Índice

Os templates de índices são elementos onde é possível especificar configurações que serão aplicadas a índices quando criados. Para mais informações sobre seu funcionamento no Elasticsearch, consulte o manual do Elasticsearch.

O LumisXP cria no Elasticsearch templates de índices que servem para aplicar as configurações padrões usadas por ele nos índices que ele cria. Para customizar ou incluir configurações para serem aplicadas nos índices quando criados deve-se usar a funcionalidade de templates de índices. Abaixo é explicado os elementos que o LumisXP cria que as principais formas de incluir configurações customizadas nelas.

O LumisXP vai criar o componente de template:

Para cada idioma (em sua instalação inicial o LumisXP vem com os idiomas pt_BR e en_US) e para idioma neutro (representado por null), o LumisXP vai criar os seguintes componentes de template:

Para cada idioma e para idioma neutro, o LumisXP vai criar o seguinte template de índice:

Há duas formas de incluir configurações no template que será utilizado para configurar os índices criados pelo LumisXP. A mais simples é cadastrando os componentes de templates -custom citados acima. A forma mais complexa mas mais flexível é cadastrando outros templates de índice que serão utilizado no lugar do que o LumisXP cria.

Customizando componente de template custom

Basta utilizar a API de criar ou atualizar componente de template para criar ou atualizar os componentes de templates *-custom citados acima com as configurações desejadas.

No caso de uma nova instalação do LumisXP, pode-se criar esses componentes antes de iniciar o LumisXP pela primeira vez, para que possam ser aplicado desde os primeiros índices que ele criar. Caso já exista índice do LumisXP criado, eles precisarão ser ajustados manualmente, pois o template só é aplicado no momento da criação do índice.

Por exemplo, se for desejado que o template configure novos índices do LumisXP para não terem replicas, assumindo configurações padrões, poderia cria o componente de template com nome lumisportal-custom com a seguinte definição:

{
  "template" : {
    "settings" : {
      "number_of_replicas": 0
    }
  }
}

Se fosse desejado alguma configuração que varia com o idioma, poderia usar os componentes de template específicos de idioma, como lumisportal-pt_br-custom ou lumisportal-en_us-custom.

Customizando um template de índice

Nesta outra forma, cria-se outros templates de índice que serão utilizados no lugar dos templates de índice criados pelo LumisXP. Para isso basta os templates de índice criados terem priority acima de zero e terem o padrão apropriado para serem utilizados nos índices criados pelo LumisXP. Esses templates de índice também podem aproveitar o componente de template *-default, que possui as configurações padrões necessárias padra os índices do LumisXP, mas para isso o LumisXP terá que ter iniciado antes para chegar a ter criado o componente. Nesse caso ele provavelmente chegará a ter criado índices que precisarão ser ajustados manualmente, já que as configurações dos templates só são aplicadas no momento criação de índice. Para a criação do template de índice customizado pode-se utilizar a API de criação ou atualização de template de índice.

Por exemplo, usando esta abordagem para trocar o template utilizado para índices do idioma pt_br, em uma instalação do LumisXP com as configurações padrões, por um template de índice customizado que utiliza os componentes de template criados pelo LumisXP e inclui configuração para não ter réplicas, poderia criar um novo template de índice com a seguinte definição:

{
  "index_patterns" : [
    "lumisportal-pt_br-*"
  ],
  "priority" : 1,
  "composed_of": ["lumisportal-pt_br-default","lumisportal-custom","lumisportal-pt_br-custom"],
  "template" : {
    "settings" : {
      "number_of_replicas": 0
    }
  }
}