Se uma instância do Looker hospedada pelo cliente não conseguir se comunicar com o hub de ações hospedado pelo Looker, os administradores do Looker não poderão ativar ações que ofereçam suporte a resultados transmitidos em streaming ou que usem OAuth. Além disso, os usuários do Looker podem ter consultas pendentes ao enviar ou programar dados para ações que aceitam resultados transmitidos e podem não conseguir configurar ações OAuth.
Para usar as integrações do Looker, o hub de ações e a instância do Looker precisam se comunicar entre si. Os administradores de instâncias hospedadas pelo cliente que tiverem interesse em ler sobre soluções adequadas para a arquitetura da instância podem consultar as recomendações descritas na seção Considerações sobre instâncias hospedadas pelo cliente da página de documentação Compartilhamento de dados por meio de um hub de ações.
Se a instância usar um certificado SSL emitido por uma autoridade certificadora (AC) que não está na lista de certificados raiz, as ações de OAuth e streaming podem não ser usadas em uma instância do Looker hospedada pelo cliente.
Para conferir as ações configuradas para oferecer suporte a resultados transmitidos ou OAuth, consulte a lista de serviços integrados do Looker na página de documentação Configurações de administrador: ações.
Esta página descreve como iniciar um servidor local do hub de ações para usar ações do Looker que oferecem suporte a resultados transmitidos em streaming ou que usam o Google OAuth. É possível configurar seu próprio servidor de hub de ações local criando um contêiner ou uma máquina virtual (VM) que hospeda uma cópia clonada do código do repositório do Hub de Ações do Looker e seguindo estas etapas, conforme descrito em mais detalhes nas seções a seguir:
- Crie uma configuração de contêiner ou máquina virtual (VM) para o servidor do hub de ações.
- Configure as credenciais do OAuth do Google.
- Configure a tela de consentimento do Google OAuth.
- Configure as variáveis de ambiente.
- Gerar uma chave de API.
- Inicie o novo hub de ações.
- Adicione o novo hub de ações à sua instância do Looker.
Criar uma configuração de contêiner ou máquina virtual (VM) para o servidor do hub de ações
A VM ou o contêiner precisa atender aos seguintes requisitos e dependências de alocação e rede:
Alocação de memória recomendada
O Looker recomenda a alocação de duas linhas de execução de CPU/vCPU e pelo menos 2 GB de memória para esse contêiner ou VM. Se você espera um uso intenso das ações, aumente a memória para mais de 2 GB.
Requisitos de rede
Seu hub de ações precisa ter um endereço IP estático ou um endereço que possa ser resolvido por um Sistema de Nomes de Domínio (DNS) interno.
Sua rede precisa oferecer suporte aos seguintes requisitos de comunicação:
- A instância do Looker precisa ser capaz de se comunicar com o hub de ações.
- O Google Auth precisa ser capaz de se comunicar com o hub de ações.
- Um navegador conectado internamente precisa conseguir acessar o hub de ações.
- O Action Hub precisa acessar os servidores do Google Drive.
Dependências necessárias
Ao clonar o repositório de ações do Looker na VM ou no contêiner recém-criado:
- Verifique se o Node 12.13 está instalado.
- Execute
yarn installpara instalar os pacotes necessários.
Depois de configurar o ambiente, você vai precisar criar credenciais do Google OAuth para o servidor do hub de ações no Console da API do Google Cloud.
Configurar as credenciais do OAuth do Google
Para configurar as credenciais do Google OAuth para suas ações, você precisa fazer o seguinte:
Criar as credenciais do OAuth do Google
Para criar o ID e a chave secreta do cliente OAuth do Google:
- Acesse a página Gerenciar recursos do Google Cloud e clique em Criar projeto para criar um novo projeto.
Para mais informações sobre como criar um projeto, consulte o guia Como criar e gerenciar projetos.
- Depois que o novo projeto for criado, selecione-o.
- Na barra lateral esquerda do console, acesse a página APIs e serviços > Credenciais.
- Clique em Criar credenciais.
- No menu suspenso, clique em ID do cliente OAuth.
- Talvez seja necessário configurar uma tela de consentimento do OAuth. Se sim, siga as instruções na seção Como configurar a tela de consentimento do OAuth mais adiante nesta página e prossiga para a etapa 7.
- Em Tipo de aplicativo, selecione Aplicativo da Web.
- Informe o nome do aplicativo no campo Nome.
- Na seção Origens JavaScript autorizadas, adicione o endereço raiz do aplicativo Looker que você usa internamente.
- Defina os URIs de redirecionamento autorizados para os consoles do Google Drive e das Planilhas Google, em que
ACTION_HUB_BASE_URLé o endereço do seu hub de ações:https://<ACTION_HUB_BASE_URL>/actions/google_sheets/oauth_redirect https://<ACTION_HUB_BASE_URL>/actions/google_drive/oauth_redirect - Clique no botão Criar para gerar o ID e a chave secreta do cliente OAuth. Você vai precisar deles mais tarde.
Configurar a tela de consentimento OAuth
Nessa página do Console de APIs do Google, você pode configurar uma tela de consentimento para todos os aplicativos do seu projeto. Assim, os usuários podem conceder acesso aos dados e receber um link para qualquer documentação legal ou de privacidade. Se você já concluiu essa etapa ou não precisa configurar uma tela de consentimento, pule esta seção e volte à janela do terminal para definir as variáveis de ambiente, conforme descrito em Como definir as variáveis de ambiente mais adiante nesta página.
Para configurar a tela de consentimento:
- Clique em CONFIGURAR TELA DE PERMISSÃO.
- Selecione se é um aplicativo interno ou externo e clique em CRIAR.
- Digite o nome do aplicativo no campo Nome do app.
- Em E-mail de suporte ao usuário, insira um endereço de e-mail para mostrar na Tela de consentimento do OAuth para suporte ao usuário.
- Opcionalmente, para o logotipo do app, faça upload de um arquivo de imagem para usar na tela de consentimento do OAuth.
- Opcionalmente, insira o link da página inicial do aplicativo, que precisa ser hospedado no mesmo domínio raiz que o hub de ações.
- Opcionalmente, insira um link para a Política de Privacidade do app no campo Link da Política de Privacidade do aplicativo. O link precisa estar hospedado no mesmo domínio raiz que o hub de ações.
- Opcionalmente, insira um link para os Termos de Serviço do seu app no campo Link dos Termos de Serviço do aplicativo. O link precisa estar hospedado no mesmo domínio raiz que o hub de ações.
- Na seção Domínios autorizados, clique em ADICIONAR DOMÍNIO e insira o domínio raiz que o hub de ações está usando.
- No campo Dados de contato do desenvolvedor, insira um e-mail para que o Google possa entrar em contato com você.
- Clique em SALVAR E CONTINUAR.
- Na seção Escopos, adicione os tipos de dados do usuário que o app precisa acessar. Isso inclui e-mail, perfil, OpenID e
https://mail.google.com. Como essa lista inclui informações sensíveis do usuário, o Google vai precisar verificar sua tela de consentimento do OAuth antes de publicar. - Clique em SALVAR E CONTINUAR.
- Opcionalmente, na seção Usuários de teste, adicione os usuários que vão ter acesso ao hub de ações antes da verificação.
- Clique em SALVAR E CONTINUAR.
- Clique em VOLTAR AO PAINEL.
- Na barra lateral esquerda, clique em Credenciais para voltar à configuração das credenciais do OAuth.
Depois de configurar a tela de consentimento do OAuth, se você estava no processo de configurar credenciais do Google Oauth, volte para a etapa 7 desse procedimento e termine de configurar as credenciais. Caso contrário, volte à janela do terminal para definir as variáveis de ambiente.
Como definir as variáveis de ambiente
No ambiente de contêiner ou VM, defina estas variáveis de ambiente:
ACTION_HUB_LABEL=<your action hub label name>
ACTION_HUB_SECRET=<some secret>
ACTION_HUB_BASE_URL=<your action hub base address>
# For example https://actions.company.com
# DO NOT INCLUDE A TRAILING SLASH
GOOGLE_SHEET_CLIENT_ID=<OAuth client ID>
GOOGLE_SHEET_CLIENT_SECRET=<OAuth client secret>
GOOGLE_DRIVE_CLIENT_ID=<OAuth client ID>
GOOGLE_DRIVE_CLIENT_SECRET=<OAuth client secret>
É possível usar o mesmo OAuth client ID e OAuth client secret para o Google Drive e as Planilhas Google. No entanto, é melhor definir os dois conjuntos de tokens da API do Google.
Também defina a chave de criptografia:
CIPHER_MASTER="<hex aes-256 key>"
Essa chave não é usada para criptografia de longo prazo. Ela é usada apenas para criptografar state durante um fluxo OAuth. Confira abaixo um exemplo de chave AES-256 hexadecimal:
C4EFBBE2C364248419776459A00F2F4017CE77E29D9E8F64940687EA440A0CC9
Como gerar uma chave de API
Para acessar a chave de API, execute este comando:
y
arn generate-api-key
Mantenha a chave gerada para uso posterior na configuração. Essa chave é gerada com base no ACTION_HUB_SECRET.
Como iniciar o servidor local do hub de ações
Para iniciar o hub de ações, execute este comando:
yarn start
Como adicionar o hub de ações à sua instância do Looker
Para adicionar o hub de ações à instância do Looker:
- No Looker, acesse a página Ações em Plataforma no painel Administrador.
- Role até a parte de baixo da página e clique no botão Adicionar hub de ações.
- Insira seu
ACTION_HUB_BASE_URLe clique em Adicionar hub de ações. O hub de ações vai aparecer em um novo título com o nome eACTION_HUB_BASE_URL. Suas ações do Google Drive e das Planilhas Google vão aparecer abaixo desse título. - Se a conexão falhar, insira o
api-keyque você gerou anteriormente no campo Authorization Token e clique no link Refresh na parte de cima do cabeçalho do hub de ações. - Ative as ações do Google Drive e do Planilhas e verifique se elas estão configuradas corretamente no hub de ações.
Próxima etapa
A próxima etapa é publicar o aplicativo criado no Console de APIs do Google. Para publicar, acesse a página Tela de consentimento do OAuth e clique no botão Enviar para verificação. O processo de publicação do aplicativo pode levar algum tempo e exigir algumas etapas de verificação com o Google.