Gerenciando índices de pesquisa para sua instância

GitHub Enterprise Server usa o Elasticsearch para potencializar os recursos de pesquisa e fornece ferramentas para gerenciar o comportamento de pesquisa e índice.

Quem pode usar esse recurso?

Enterprise owners can manage search indices for a GitHub Enterprise Server instance.

Neste artigo

Sobre a pesquisa de GitHub Enterprise Server

Os usuários podem pesquisar sua instância para procurar, navegar e entender problemas, pull requests, código e outros conteúdos em GitHub Enterprise Server. O Elasticsearch potencializa a funcionalidade de pesquisa em sua instância. Você pode exibir o status atual do Elasticsearch e controlar o comportamento da pesquisa e do índice.

Para saber mais sobre a pesquisa de GitHub Enterprise Server, confira Pesquisa na documentação do GitHub. Para obter informações sobre o Elasticsearch, visite o site do Elasticsearch.

Sobre o gerenciamento de índices

GitHub Enterprise Server reconcilia o estado do índice de pesquisa com os dados na instância de maneira automática e regular, incluindo:

  • Problemas, solicitações de pull, repositórios e usuários no banco de dados
  • Repositórios Git (código-fonte) no disco

Em uso normal, os proprietários da empresa não precisam criar índices ou agendar trabalhos de reparo. Para solução de problemas ou outras finalidades de suporte, o Suporte do GitHub pode instruir você a executar um trabalho de reparo.

Exibindo índices de pesquisa

  1. No canto superior direito de qualquer página, clique em .
  2. Na barra lateral esquerda, clique em Índices de pesquisa.
  3. Em "Gerenciamento de índice", clique no índice de pesquisa que você deseja exibir.

Criando um novo índice de pesquisa

  1. No canto superior direito de qualquer página, clique em .

  2. Na barra lateral esquerda, clique em Índices de pesquisa.

  3. Ao lado de "Gerenciamento de índice", clique em Criar novo índice.

  4. Selecione a lista suspensa Selecione o índice a ser criado e clique no índice de pesquisa que deseja criar.

  5. Se quiser que o índice seja pesquisável, marque a caixa de seleção Tornar este índice pesquisável.

  6. Se quiser que o índice seja gravável, marque a caixa de seleção Tornar este índice gravável.

  7. Clique em Criar índice.

  8. Se a sua instância usar uma configuração de cluster ou de alta disponibilidade, você precisará executar um script para garantir que o número de índices de pesquisa esteja configurado corretamente na instância.

    Acesse o shell administrativo do seu dispositivo principal via SSH e execute um dos comandos a seguir.

    Para configurações de alta disponibilidade:

    Shell
    /usr/local/share/enterprise/ghe-es-auto-expand -v 0-all

    Para configurações de cluster:

    Shell
    /usr/local/share/enterprise/ghe-es-auto-expand -v 0-1

    Confira Acesar o shell administrativo (SSH).

Gerenciando índices de pesquisa

Ao exibir um índice de pesquisa existente no painel de administração do site, você pode executar as seguintes ações:

  • Torne o índice pesquisável.
  • Torne o índice gravável.
  • Atualize o índice.
  • Excluir o índice.
  • Redefina o estado de reparo do índice.
  • Inicie um novo trabalho de reparo de índice.
  • Habilite ou desabilite trabalhos de reparo de índice.

Você pode habilitar ou desabilitar as operações de pesquisa e índice do código-fonte. Para obter mais informações sobre a pesquisa de código, confira Pesquisar o código.

  1. No canto superior direito de qualquer página, clique em .
  2. Na barra lateral esquerda, clique em Índices de pesquisa.
  3. Na seção "Pesquisa de código", ao lado de "Pesquisa" ou "Indexação", clique em Habilitar ou Desabilitar.

Reparando índices de pesquisa

Sua instância usa trabalhos de reparo para reconciliar os dados e agenda um trabalho de reparo em segundo plano quando ocorrem os eventos a seguir:

  • Um índice de pesquisa é criado.
  • Dados ausentes precisam ser provisionados.
  • Dados antigos de pesquisa precisam ser atualizados.

Na seção "Reparar" do índice de pesquisa, uma barra de progresso mostra o status atual de um trabalho de reparo em todos os trabalhadores em segundo plano. Você pode ignorar o valor mostrado na barra de progresso após a conclusão de um trabalho de reparo. A barra de progresso mostra a diferença entre o deslocamento de reparo e a ID de registro mais alta no banco de dados, e diminuirá à medida que mais repositórios forem adicionados ao sua instância do GitHub Enterprise Server, mesmo que esses repositórios estejam realmente indexados.

Para minimizar os efeitos no desempenho de E/S e reduzir as chances de exceder o tempo limite das operações, execute o trabalho de reparo fora dos horários de pico. À medida que o trabalho reconciliar o índice de pesquisa com os dados de banco de dados e repositório Git, uma CPU será usada. Monitore as médias de carga do sistema e o uso da CPU com um utilitário como top. Se você não observar nenhum aumento significativo no consumo de recursos, também deverá ser seguro executar um trabalho de reparo de índice durante o horário de pico.

Os trabalhos de reparo usam um "deslocamento de reparo" a fim de alcançar a paralelização. Trata-se de uma compensação na tabela do banco de dados para o registro a ser reconciliado. Vários trabalhos em segundo plano podem sincronizar tarefas com base nessa compensação.