Instalar a UI da Web

Selecione uma versão da documentação:

Nesta página, mostramos como instalar a interface do usuário da Web do AlloyDB Omni para monitorar a integridade e a configuração dos seus clusters de banco de dados autogerenciados. A UI da Web oferece os seguintes recursos:

Recurso Descrição Contêineres (independentes) Kubernetes RPM (Linux) Orquestrador de RPM
Seleção de cluster Uma tela de conectividade que permite estabelecer, registrar e salvar credenciais de conexão para acessar clusters de destino. Com suporte Compatível Compatível Com suporte
Visão geral do cluster Painel de observação que mostra todas as instâncias de cluster ativas e gráficos de telemetria. Suporte parcial. Não há suporte para gráficos de telemetria. Com suporte Compatível Com suporte
Bancos de dados Página de visão geral que mostra as tabelas de catálogo e os tamanhos dos bancos de dados no cluster. Com suporte Compatível Compatível Com suporte
Mecanismo colunar Definições de configuração e estatísticas de execução de verificação para consultas analíticas. Com suporte Compatível Compatível Com suporte
Flags de banco de dados Painel de observação que mostra as sinalizações ativas e as configurações que se desviam das configurações padrão. Com suporte Compatível Compatível Com suporte
Query Insights Painéis de telemetria e desempenho de consultas que mostram histogramas estruturais e listas de consultas lentas. Com suporte Compatível Compatível Com suporte
Insights do sistema Gráficos de telemetria que mostram o consumo de CPU, o consumo de memória e a E/S de disco. Sem suporte Compatível Compatível Com suporte

Antes de começar

Antes de instalar a UI da Web, conclua os seguintes pré-requisitos:

  1. Consiga as imagens para sua implantação e faça o download e a instalação do AlloyDB Omni para usar a UI da Web: Instalar o AlloyDB Omni usando contêineres.

  2. Configure o usuário do banco de dados.

    A UI da Web depende de uma conta de usuário limitada, que tem o papel pg_monitor para acessar o banco de dados. Configure esse usuário em cada cluster executando os seguintes comandos em uma sessão psql:

    CREATE ROLE alloydbui WITH LOGIN PASSWORD 'PASSWORD';
GRANT pg_monitor TO alloydbui WITH INHERIT TRUE;

    Substitua PASSWORD por uma senha para o papel de banco de dados alloydbui.

  3. Configurar o Prometheus.

    Para conferir os dados do gráfico nas páginas Visão geral e Insights do sistema, incluindo o uso da CPU, instale e configure o Prometheus. Observação: um agente de monitoramento conteinerizado não está disponível quando você implanta o AlloyDB Omni como um contêiner independente. As métricas do gráfico do Prometheus nas páginas Visão geral e Insights do sistema não são compatíveis quando você se conecta a implantações de contêineres independentes.

Etapas opcionais

Para ativar outros recursos da UI da Web, conclua as seguintes configurações opcionais:

  • Configuração do Query Insights

    Para usar o recurso de Query Insights, ative a extensão pg_stat_statements. Em uma sessão do psql, execute os seguintes comandos para configurar as bibliotecas:

    ALTER SYSTEM SET shared_preload_libraries=google_columnar_engine,google_job_scheduler,google_storage,google_db_advisor,pg_stat_statements;
ALTER SYSTEM SET pg_stat_statements.max = 10000;
ALTER SYSTEM SET pg_stat_statements.track_utility = on;
ALTER SYSTEM SET track_io_timing = on;

    Em seguida, execute o seguinte comando em cada banco de dados individualmente para criar a extensão:

    CREATE EXTENSION IF NOT EXISTS pg_stat_statements;

    Reinicie o banco de dados para que essas mudanças entrem em vigor. Se você planeja ativar o mecanismo colunar, aguarde para reiniciar até que a configuração seja concluída.

  • Configuração do mecanismo colunar

    Para acessar os dados do mecanismo colunar na UI da Web, configure o mecanismo conforme descrito em Visão geral do mecanismo colunar.

  • Configuração da IA do AlloyDB

    Para usar os recursos de IA do AlloyDB na UI da Web, conceda as seguintes permissões:

    • Para preencher índices de vetor, conceda ao usuário alloydbui a permissão SELECT em pg_stat_ann_indexes.
    • Para exibir colunas de vetor, conceda ao usuário alloydbui a permissão SELECT em uma tabela.
Para mais informações, consulte Criar aplicativos de IA generativa usando a IA do AlloyDB.

Instalar a UI da Web

É possível instalar e executar a UI da Web em qualquer nó. A UI da Web não requer um nó dedicado. A instalação completa requer aproximadamente 250 MB de espaço em disco. Depois de receber as imagens para sua implantação e fazer o download do AlloyDB Omni, instale e execute a UI da Web.

Instalar usando a imagem do Docker ou do Podman

Ao executar o AlloyDB Omni usando contêineres, extraia a imagem do Docker ou do Podman:

Docker 

docker pull ALLOYDB_OMNI_UI_IMAGE_TAG

Podman 

podman pull ALLOYDB_OMNI_UI_IMAGE_TAG

Substitua ALLOYDB_OMNI_UI_IMAGE_TAG pela tag da imagem do contêiner da UI da Web.

Iniciar a UI da Web

A UI da Web usa um keystore Java para proteger a chave AES de 256 bits usada para criptografar dados de conexão. Ao iniciar a UI da Web, especifique uma variável de ambiente que contenha a senha.

Iniciar a UI da Web em contêineres

Execute o comando a seguir para iniciar o contêiner da UI da Web. Inclua a flag --add-host=host.docker.internal:host-gateway se você se conectar a uma instalação do AlloyDB Omni na mesma máquina host:

Docker 

docker run --name alloydb-omni-ui \
  --add-host=host.docker.internal:host-gateway \
  -e ALLOYDB_OMNI_UI_KEYSTORE="PASSWORD" \
  -p 9080:9080 \
  ALLOYDB_OMNI_UI_IMAGE_TAG

Podman 

podman run --name alloydb-omni-ui \
  --add-host=host.docker.internal:host-gateway \
  -e ALLOYDB_OMNI_UI_KEYSTORE="PASSWORD" \
  -p 9080:9080 \
  ALLOYDB_OMNI_UI_IMAGE_TAG

Substitua:

  • PASSWORD: a senha do keystore para ALLOYDB_OMNI_UI_KEYSTORE.

  • ALLOYDB_OMNI_UI_IMAGE_TAG: a tag da imagem do contêiner da UI da Web.

Abrir a UI da Web

Para acessar a UI da Web, abra um navegador em http://HOST:9080.

Substitua HOST pelo nome do host ou endereço IP do nó em que a UI da Web está instalada.

  • Se você configurou um caminho base personalizado usando a variável de ambiente opcional ALLOYDB_OMNI_BASE_PATH, como ao hospedar atrás de um proxy reverso, anexe o caminho ao URL: http://HOST:9080/BASE_PATH.

    Substitua BASE_PATH pelo caminho de base personalizado.

  • É possível configurar o caminho base sem uma barra inicial, por exemplo, ALLOYDB_OMNI_BASE_PATH=BASE_PATH. Todas as opções a seguir são alternativas válidas:

    • /test/
    • test/
    • test
    • /test

Limitações

A UI da Web tem as seguintes limitações:

  • Os gráficos de visão geral e os insights do sistema não estão disponíveis ao se conectar a implantações de contêineres independentes do AlloyDB Omni porque um agente de monitoramento em contêiner não está disponível para implantações de contêineres independentes. Todos os outros recursos e métricas que não são de gráfico continuam totalmente funcionais.

  • Para visualizar os dados do mecanismo colunar de uma determinada tabela, o usuário alloydbui precisa de pelo menos uma permissão nessa tabela, por exemplo, SELECT.

  • Para ver os dados do índice vetorial, o usuário alloydbui precisa da permissão SELECT em pg_stat_ann_indexes.

  • Para ver os dados da coluna de vetor de uma determinada tabela, o usuário alloydbui precisa da permissão SELECT nessa tabela.

Práticas recomendadas e advertências

Siga estas práticas recomendadas e advertências ao instalar e configurar a UI da Web:

  • Proteção por senha do keystore: a UI da Web gera um keystore Java para proteger a chave de criptografia do banco de dados AES de 256 bits. Use uma senha longa forte para ALLOYDB_OMNI_UI_KEYSTORE. Os erros de descriptografia ocorrem se você transferir os arquivos de configuração e se conectar com uma senha de keystore incorreta.
  • Coleta de métricas do Prometheus: configure os coletores para consultar instâncias de destino em intervalos padrão (15s a 30s) para consultar estatísticas sem sobrecarregar os nós do banco de dados.

    A seguir