Configurando Qlik Data Gateway - Acesso direto em um contêiner

Última atualização: 30/09/2026

Este tópico descreve como configurar o Direct Access gateway conteinerizado. Ele fornece pré-requisitos e instruções de instalação e descreve as limitações e considerações das quais você deve estar ciente ao trabalhar com Direct Access gateway conteinerizado.

Suportado a partir de Direct Access gateway 1.8.0.

O que é Direct Access gateway conteinerizado?

Você pode implementar Direct Access gateway em um contêiner Docker. Este tipo de implementação é chamado de Direct Access gateway conteinerizado. As implantações conteinerizadas do Direct Access gateway são suportadas para Linux, macOS e WindowsLocale.

O Direct Access gateway conteinerizado oferece portabilidade para o seu ambiente Direct Access gateway.

Melhores práticas ao usar o Qlik Data Gateway - Acesso direto

Para uma experiência bem-sucedida ao usar o Qlik Data Gateway - Acesso direto, é altamente recomendável seguir estas práticas recomendadas:

Não use o mesmo Direct Access gateway para desenvolvimento, testes de aceitação do usuário e produção, pois isso aumentará o risco de sobrecarregar os recursos disponíveis e impactar a estabilidade do sistema. Do ponto de vista comercial, a combinação de recursos insuficientes e diminuição da estabilidade pode resultar em atrasos nas atualizações dos dados do aplicativo de produção.
Para um desempenho ideal, instale o Direct Access gateway em um ambiente o mais próximo possível da sua fonte de dados.

Pré-requisitos do sistema

Esta seção descreve os requisitos para usar o Direct Access gateway conteinerizado.

Requisitos de software

Docker Engine versão 20.9+ e o plugin do Docker Compose (docker compose, sintaxe v2) instalados no host.

Portas e protocolos necessários

Para portas e protocolos necessários, consulte Portas e protocolos necessários.

Hardware recomendado

Host: 8 núcleos, 32 GB de memória, 5 GB de armazenamento disponível para o Docker

Opcional: defina limites correspondentes no contêiner no arquivo compose para que o gateway tenha capacidade dedicada, em vez de competir com outros contêineres ou processos no host:

direct-access-agent:
    image: ...
    deploy:
      resources:
        limits:
          cpus: "6"
          memory: 24G
...
dcaas:
    image: ...
    deploy:
      resources:
        limits:
          cpus: "2"

Hardware mínimo

O hardware mínimo é adequado apenas para cenários específicos que usam implementações dedicadas menores (desenvolvimento, teste ou produção), com volumes de dados continuamente baixos e um número limitado de recargas simultâneas.

Host: 4 núcleos, 8 GB de memória, 5 GB de armazenamento disponíveis para o Docker

Opcional: defina limites correspondentes no contêiner no arquivo compose para que o gateway tenha capacidade dedicada, em vez de competir com outros contêineres ou processos no host:

direct-access-agent:
    image: ...
    deploy:
      resources:
        limits:
          cpus: "2"
          memory: 4G
...
dcaas:
    image: ...
    deploy:
      resources:
        limits:
          cpus: "2"

Instalando o Qlik Data Gateway - Acesso direto

A configuração do Direct Access gateway envolve procedimentos que precisam ser executados no centro de atividades de Administração e no servidor do Direct Access gateway.

Os procedimentos de gateway de dados que precisam ser executados no centro de atividades de Administração exigem permissão do administrador de locatários.

Estágio um: baixe o Qlik Data Gateway - Acesso direto

No centro de atividades de Administração, selecione Gateways de dados.

Todos os gateways de dados existentes serão listados em uma tabela mostrando informações básicas sobre cada gateway.
Clique no botão Implementar da barra de ferramentas.

O diálogo Implementar gateway de dados é aberto.
Selecione Gateway de dados - Acesso direto - Containerized Direct Access Gateway, aceite o Qlik Contrato do Cliente e clique em Baixar. O arquivo de instalação do Direct Access gateway (docker-compose.qlik-data-gateway-direct-access.yml) será baixado em sua máquina.

Etapa dois: Inicie a implementação executando o arquivo do Docker Compose

Para iniciar a implementação do Direct Access gateway, execute o seguinte comando:

docker compose -f docker-compose.qlik-data-gateway-direct-access.yml up

Etapa três: Configuração de Direct Access gateway

Para obter instruções detalhadas de configuração, consulte Etapa três: Configurar Direct Access gateway.

Etapa quatro: Registrar o gateway de dados

A próxima etapa é registrar o gateway de dados. Isso pode ser feito por meio da central de atividades Administração ou na linha de comando.

Você pode registrar o gateway usando a central de atividades Administração. Consulte Opção 1: Pela central de atividades Administração.

Você também pode registrar Direct Access gateway automaticamente a partir da linha de comando, sem usar a central de atividades Administração." Este método utiliza um token de sessão de curta duração gerado a partir de um cliente OAuth.

O registro automático é suportado apenas por meio da linha de comando. Uma API REST para registro automático de gateway não está disponível no momento.

Pré-requisitos

Uma chave de API com permissão de administrador do locatário para criar e gerenciar clientes OAuth.

Registrar o gateway com registro automático

Primeiro, você precisa configurar um ambiente Python para gerar um ID de cliente OAuth, bem como uma chave de asserção (token de curta duração) no contêiner direct-access-agent. Execute os seguintes comandos separadamente, nesta ordem:
1. docker exec -it --user root direct-access-agent-1 bash
2. apt-get update && apt-get install -y python3 python3-pip
3. apt install python3.11-venv
4. python3 -m venv .venv
5. source .venv/bin/activate
6. pip install cryptography pyjwt
7. python3 generate_gateway_assertion.py --tenant-url <tenant-url>
Para o último comando na lista acima, seguir os prompts interativos e copiar o client_id (ID do cliente OAuth) e o assertion quando fornecidos. Guarde esses detalhes em papel ou em um arquivo de texto temporário por enquanto — eles serão necessários para etapas posteriores do processo.
Quando você tiver anotado o client_id e o assertion, limpe o ambiente Python com o seguinte comando:

deactivate
Defina o método de consentimento do cliente OAuth como confiável.

curl "https://<tenant-url>/api/v1/oauth-clients/<client-id>/connection-configs/me" -X PATCH -H 'accept: application/json' -H 'content-type: application/json' -H 'authorization: Bearer <api-key>' -d '[{"op":"replace","path":"/consentMethod","value":"trusted"}]'
Solicite um token de acesso. Isso também aciona a criação automática da conta de usuário do bot usada pelo gateway.

curl "https://<tenant-url>/oauth/token" -X POST -H 'content-type: application/x-www-form-urlencoded' -d "grant_type=client_credentials" -d "client_id=<client-id>" -d "client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer" -d "client_assertion=<assertion>" -d "scope=admin.direct-access-gateways:register_gateway admin.direct-access-gateways:delete_gateway"

Nota informativa
Se a asserção tiver expirado, execute novamente o script a partir do ambiente virtual.
Localize o usuário de bot criado automaticamente.

curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <API-key>'
Copie o ID de my-bot-client.
Crie uma função "DAG Registration".

curl "https://<tenant-url>/api/v1/roles" -X POST -H 'accept: application/json' -H 'content-type: application/json' -H 'authorization: Bearer <API-key>' -d '{"name":"DAG Registration","description":"Role for registering a gateway","assignedScopes":["admin.direct-access-gateways:register_gateway", "admin.direct-access-gateways:delete_gateway"]}'
Atribua funções no nível do locatário ao usuário do bot.

curl "https://<tenant-url>/api/v1/users/<bot-user-ID>" -X PATCH -H 'accept: application/json' -H 'content-type: application/json' -H 'authorization: Bearer <API-key>' -d ' [ { "op": "replace", "path": "/assignedRoles", "value": [ { "name": "DAG Registration" } ] } ]'
Obter o espaço do Direct Access Gateway.

curl "https://<tenant-url>/api/v1/spaces" -H 'authorization: Bearer <API-key>'
Copie o ID do espaço do Direct Access Gateway.
Adicione o usuário bot ao espaço com a permissão Pode editar.

curl "https://<tenant-url>/api/v1/spaces/<DAG-space-ID>/assignments" -X POST -H 'accept: application/json' -H 'content-type: application/json' -H 'authorization: Bearer <API-key>' -d '{"assigneeId": "<bot-user-ID>","roles": ["consumer","dataconsumer","producer"], "type": "user"}'
Caso a asserção existente tenha expirado, gere uma nova. Execute o seguinte comando:

python3 generate_gateway_assertion.py --tenant-url <tenant-url>
Siga as etapas necessárias no prompt de comando. Como o cliente OAuth já foi criado, é necessário atualizar o JWK usando esta chamada de API:

curl "https://<tenant-url>/api/v1/oauth-clients/<client-ID>" -X PATCH -H 'accept: application/json' -H 'content-type: application/json' -H 'authorization: Bearer <API-key>' -d '[{"op":"replace","path":"/publicKeys/0/y","value":"<Y-value-from-JWK>"},{"op":"replace","path":"/publicKeys/0/x","value":"<X-value-from-JWK>"},{"op":"remove","path":"/publicKeys/0/use"},{"op":"replace","path":"/publicKeys/0/kid","value":"<kid-value-from-JWK>"}]'
Registre o gateway:

dotnet ConnectorAgent.dll qcs register_gateway --tenant_url <tenant-url> --gateway_name <DAG-name> --gateway_description <DAG-description> --space_name <space-name> --client-id <client-ID> --assertion <assertion>

Remover um gateway registrado automaticamente

Use as etapas a seguir para cancelar o registro de um gateway que foi registrado usando o método automático baseado em token de sessão descrito acima. Essas etapas também removem o cliente OAuth, o usuário do bot e a função que foram criados para ele.

Gere uma asserção, conforme descrito na seção acima.
Exclua o gateway:

dotnet ConnectorAgent.dll qcs delete_gateway --tenant_url <tenant-url> --gateway_name <gateway-name> --client-id <client-ID> --assertion <assertion>
Localize a conta de usuário do bot que foi criada para o gateway.

curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <api-key>'
Copie o ID do bot.
Exclua esta conta de usuário do bot.

curl -X DELETE "https://<tenant-url>/api/v1/users/<bot-user-ID>" -H "Authorization: Bearer <api-key>"
Localize a função “DAG Registration” que foi criada para o gateway.

curl "https://<tenant-url>/api/v1/roles?limit=1&filter=(name%20eq%20%22DAG%20Registration%22)" -H "Authorization: Bearer <api-key>"
Copie o ID da função.
Exclua esta função.

curl -X DELETE "https://<tenant-url>/api/v1/roles/<role-ID> -H "Authorization: Bearer <api-key>"
Exclua o cliente OAuth.

curl -X DELETE https://<tenant-url>/api/v1/oauth-clients/<OAuth-client-ID> -H "qlik-confirm-delete: <OAuth-client-ID>" -H "Authorization: Bearer <api-key>

Estágio cinco: inicie o serviço Qlik Data Gateway - Acesso direto no servidor do Direct Access gateway

Para iniciar o serviço Qlik Data Gateway - Acesso direto, inicie os contêineres dcaas-dg e direct-access-agent.

Estágio seis: adicione uma conexão à sua fonte de dados

Consulte Estágio seis: adicione uma conexão à sua fonte de dados.

Configurações do ambiente

Esta seção lista variáveis de ambiente específicas do arquivo docker-compose.qlik-data-gateway-direct-access.yml que você pode precisar configurar para conectar adequadamente suas fontes de dados por meio do gateway.

ALLOW_SOURCES: Uma lista de permissões separada por vírgulas de nomes de host e IPs. Quando o agente do gateway precisa se conectar a algo no seu próprio servidor ou em outro host na rede local ou privada (por exemplo, um banco de dados em localhost, um nome de serviço do Docker ou um host de IP privado), você adiciona esse endereço a ALLOW_SOURCES — caso contrário, a tentativa de conexão é recusada.

Fontes de dados com suporte

Os seguintes conectores ODBC são suportados para instalações conteinerizadas:
- PostgreSQL
- SQL Server
- Oracle
Para obter mais informações sobre conectores ODBC, consulte Bancos de dados ODBC - Qlik Cloud (somente em inglês).
REST conector (REST via Direct Access gateway). Para obter mais informações sobre fontes de dados REST, consulte Fontes REST ‒ Qlik Cloud (somente em inglês).

Saiba mais

Esta página ajudou?

Se você encontrar algum problema com esta página ou seu conteúdo – um erro de digitação, uma etapa ausente ou um erro técnico – avise-nos!

Deixe seu feedback aqui