Configurar um centro de ações locais para ações que usam OAuth e streaming

Se uma instância do Looker alojada pelo cliente não conseguir comunicar com o centro de ações alojado pelo Looker, os administradores do Looker podem não conseguir ativar ações que suportem resultados transmitidos ou que usem o OAuth. Além disso, os utilizadores do Looker podem ter problemas com consultas pendentes ao enviar ou agendar dados para ações que suportam resultados transmitidos e podem não conseguir configurar ações OAuth.

Para usar as integrações do Looker, o Action Hub do Looker e a instância do Looker têm de conseguir comunicar entre si. Os administradores de instâncias alojadas pelo cliente que tenham interesse em ler sobre soluções adequadas para a arquitetura da respetiva instância podem consultar as recomendações descritas na secção Considerações para instâncias alojadas pelo cliente da página de documentação Partilhar dados através de um centro de ações.

Se a instância usar um certificado SSL emitido por uma autoridade de certificação (AC) que não esteja nesta lista de certificados de raiz, as ações de OAuth e streaming podem não ser utilizáveis numa instância do Looker alojada pelo cliente.

Para ver as ações configuradas para suportar resultados de streaming ou OAuth, consulte a lista de serviços integrados do Looker na página de documentação Definições de administração – Ações.

Esta página descreve como iniciar um servidor do hub de ações local para usar ações do Looker que suportam resultados transmitidos ou que usam o Google OAuth. Pode configurar o seu próprio servidor do hub de ações locais criando um contentor ou uma máquina virtual (VM) que aloja uma cópia clonada do código do repositório do hub de ações do Looker e, em seguida, seguindo estes passos, conforme descrito mais detalhadamente nas secções seguintes:

1. Crie uma configuração de contentor ou máquina virtual (VM) para o servidor do centro de ações.
2. Configure as credenciais do OAuth da Google.
3. Configure o ecrã de consentimento OAuth da Google.
4. Configure as variáveis de ambiente.
5. Gere uma chave da API.
6. Inicie o novo centro de ações.
7. Adicione o novo hub de ações à sua instância do Looker.

Nota: se tiver uma autorização que conceda acesso apenas a páginas selecionadas no painel de administração, como manage_schedules, manage_themes ou see_admin, mas não tiver a função de administrador, a página ou as páginas descritas aqui podem não estar visíveis para si no painel de administração.

Criar uma configuração de contentor ou máquina virtual (VM) para o servidor do centro de ações

A sua VM ou contentor deve cumprir os seguintes requisitos de atribuição e rede, bem como dependências:

• Atribuição de memória recomendada
• Requisitos de rede
• Dependências obrigatórias

Atribuição de memória recomendada

O Looker recomenda a atribuição de 2 threads de CPU/vCPU e, pelo menos, 2 GB de memória para este contentor ou VM. Se prevê uma utilização intensa das suas ações, considere aumentar a memória para além de 2 GB.

Requisitos de rede

O hub de ações tem de ter um endereço IP estático ou um endereço que possa ser resolvido através de um Sistema de Nomes de Domínio (DNS) interno.

A sua rede tem de suportar os seguintes requisitos de comunicação:

• A instância do Looker tem de conseguir comunicar com o centro de ações.
• A autenticação Google tem de conseguir comunicar com o centro de ações.
• Um navegador ligado internamente tem de conseguir aceder ao centro de ações.
• O centro de ações tem de conseguir aceder aos servidores do Google Drive.

Dependências obrigatórias

Quando clona o repositório de ações do Looker para a VM ou o contentor recém-criado:

• Certifique-se de que o Node 12.13 está instalado.
• Execute yarn install para instalar os pacotes necessários.

Depois de configurar o ambiente, tem de criar credenciais do Google OAuth para o servidor do centro de ações na Google Cloud API Console.

Configurar credenciais de OAuth da Google

Para configurar as credenciais do OAuth da Google para as suas ações, tem de:

• Crie credenciais do OAuth
• Configure um ecrã de consentimento OAuth

Criar as credenciais do OAuth da Google

Para criar o ID de cliente e o segredo do cliente do Google OAuth:

1. Aceda à página Gerir 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 Criar e gerir projetos.

2. Depois de criar o novo projeto, selecione-o.
3. Na barra lateral esquerda da consola, navegue para a página APIs e serviços > Credenciais.
4. Clique em Criar credenciais.
5. No menu pendente, clique em ID de cliente OAuth.
6. Pode ter de configurar um ecrã de consentimento OAuth. Se for o caso, siga as instruções na secção Configurar o ecrã de consentimento OAuth mais adiante nesta página e, em seguida, avance para o passo 7.
7. Para Tipo de aplicação, selecione Aplicação Web.
8. Indique o nome da sua aplicação no campo Nome.
9. Na secção Origens JavaScript autorizadas, adicione o endereço da aplicação Looker raiz que usa internamente.
10. Defina os URIs de redirecionamento autorizados para as consolas do Google Drive e do Google Sheets, em que ACTION_HUB_BASE_URL é o endereço do seu centro de ações:

                https://<ACTION_HUB_BASE_URL>/actions/google_sheets/oauth_redirect
                https://<ACTION_HUB_BASE_URL>/actions/google_drive/oauth_redirect
            

11. Clique no botão Criar para gerar o ID de cliente OAuth e o segredo do cliente OAuth. Vai precisar de ambos mais tarde.

Configurar o ecrã de consentimento OAuth

Esta página da Google API Console permite-lhe configurar um ecrã de consentimento para todas as aplicações no seu projeto, o que permite aos utilizadores conceder acesso aos respetivos dados, bem como dar-lhes um link para qualquer documentação legal ou de privacidade. Se já concluiu este passo ou não precisa de configurar um ecrã de consentimento, ignore esta secção e volte à janela do terminal para definir as variáveis de ambiente, conforme descrito em Definir as variáveis de ambiente mais adiante nesta página.

Para configurar o ecrã de consentimento:

1. Clique em CONFIGURAR ECRÃ DE CONSENTIMENTO.
2. Selecione se esta é uma aplicação interna ou externa e clique em CRIAR.
3. Introduza o nome da sua aplicação no campo Nome da app.
4. Para o Email de apoio técnico ao utilizador, introduza um endereço de email a apresentar no ecrã de consentimento OAuth para apoio técnico ao utilizador.
5. Opcionalmente, para o Logótipo da app, carregue um ficheiro de imagem para usar no ecrã de consentimento OAuth.
6. Opcionalmente, introduza o Link da página inicial da aplicação, que deve estar alojado no mesmo domínio raiz que o seu centro de ações.
7. Opcionalmente, introduza um link para a política de privacidade da sua aplicação no campo Link da política de privacidade da aplicação. O link tem de estar alojado no mesmo domínio raiz que o centro de ações.
8. Opcionalmente, introduza um link para os termos de utilização da sua aplicação no campo Link dos termos de utilização da aplicação. O link tem de estar alojado no mesmo domínio raiz que o centro de ações.
9. Na secção Domínios autorizados, clique em ADICIONAR DOMÍNIO e introduza o domínio raiz que o centro de ações está a usar.
10. No campo Informações de contacto do programador, introduza um email através do qual a Google possa entrar em contacto consigo.
11. Clique em GUARDAR E CONTINUAR.
12. Na secção Âmbitos, adicione os tipos de dados do utilizador aos quais a sua aplicação tem de aceder. Isto inclui email, perfil, OpenID e https://mail.google.com. Uma vez que esta lista inclui informações confidenciais do utilizador, a Google tem de validar o seu ecrã de consentimento do OAuth antes de poder ser publicada.
13. Clique em GUARDAR E CONTINUAR.
14. Opcionalmente, na secção Utilizadores de teste, adicione todos os utilizadores aos quais quer conceder acesso ao centro de ações antes da validação.
15. Clique em GUARDAR E CONTINUAR.
16. Clique em VOLTAR AO PAINEL DE CONTROLO.
17. Na barra lateral esquerda, clique em Credenciais para voltar a configurar as suas credenciais OAuth.

Depois de configurar o ecrã de consentimento OAuth, se estiver a configurar as credenciais do Google OAuth, regresse ao passo 7 desse procedimento e conclua a configuração das credenciais. Caso contrário, pode voltar à janela do terminal para definir as variáveis de ambiente.

Definir as variáveis de ambiente

No ambiente de VM ou contentor, 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>

Deve poder usar o mesmo OAuth client ID e OAuth client secret para o Google Drive e o Google Sheets. No entanto, é melhor ter ambos os conjuntos de tokens da API Google definidos.

Defina também a chave de encriptação:

    CIPHER_MASTER="<hex aes-256 key>"

Esta chave não é usada para encriptação a longo prazo. É usada apenas para encriptar state durante um fluxo OAuth. Segue-se um exemplo de uma chave AES-256 hexadecimal:

    C4EFBBE2C364248419776459A00F2F4017CE77E29D9E8F64940687EA440A0CC9

Gerar uma chave da API

Para obter a chave da API, execute este comando:

y arn generate-api-key

Retenha a chave gerada para utilização posterior na configuração. Esta chave é gerada com base no ACTION_HUB_SECRET.

Iniciar o servidor do centro de ações locais

Para iniciar o centro de ações, execute este comando:

yarn start

Adicionar o centro de ações à sua instância do Looker

Para adicionar o centro de ações à sua instância do Looker:

1. No Looker, navegue para a página Ações em Plataforma no painel Administração.
2. Desloque a página até à parte inferior e clique no botão Adicionar centro de ações.
3. Introduza o seu ACTION_HUB_BASE_URL e clique em Adicionar centro de ações. O centro de ações deve aparecer sob um novo cabeçalho com o respetivo nome e ACTION_HUB_BASE_URL. As suas ações do Google Drive e do Google Sheets devem aparecer sob este título.
4. Se a ligação falhar, introduza o api-key que gerou anteriormente no campo Token de autorização e clique no link Atualizar na parte superior do cabeçalho do centro de ações.
5. Ative as ações do Google Drive e do Google Sheets e verifique se estão configuradas corretamente no centro de ações.

Passo seguinte

O passo seguinte é publicar a aplicação que criou na Google API Console. Para publicar, aceda à página Ecrã de consentimento OAuth e clique no botão Enviar para validação. Tenha em atenção que o processo de publicação da aplicação pode demorar algum tempo e requer alguns passos de validação com a Google.