Konfigurera Qlik Data Gateway – direktåtkomst i en behållare

Senast uppdaterad: 2026-09-30

Det här avsnittet beskriver hur du konfigurerar containerbaserad Gateway med direktåtkomst. Den innehåller förutsättningar och installationsinstruktioner, och beskriver de begränsningar och överväganden du bör känna till när du arbetar med containerbaserad Gateway med direktåtkomst.

Stöds från och med Gateway med direktåtkomst 1.8.0.

Vad är containeriserad Gateway med direktåtkomst?

Du kan distribuera Gateway med direktåtkomst i en Docker-behållare. Denna typ av distribution kallas containeriserad Gateway med direktåtkomst. Containerbaserade driftsättningar av Gateway med direktåtkomst stöds för Linux, macOS och Windows.

Containeriserad Gateway med direktåtkomst ger portabilitet till din Gateway med direktåtkomst-miljö.

Bästa praxis vid användning av Qlik Data Gateway – direktåtkomst

För att Qlik Data Gateway – direktåtkomst ska fungera utan problem rekommenderar vi att du följer de här metodtipsen:

Använd inte samma Gateway med direktåtkomst för utveckling, testning av användaracceptans och produktion, eftersom det ökar risken för överbelastning av tillgängliga resurser och påverkar systemstabiliteten. Från ett affärsperspektiv kan kombinationen av otillräckliga resurser och minskad stabilitet leda till försenade uppdateringar av produktionsprogramdata.
För optimala prestanda ska du installera Gateway med direktåtkomst i en miljö som är så nära datakällan som möjligt.

Systemförutsättningar

I det här delavsnittet beskrivs kraven för att använda containeriserad Gateway med direktåtkomst.

Programvarukrav

Docker Engine version 20.9+ och Docker Compose-pluginet (docker compose, v2-syntax) installerade på värddatorn.

Nödvändiga portar och protokoll

För nödvändiga portar och protokoll, se Portar och protokoll som krävs.

Rekommenderad maskinvara

Värd: 8 kärnor, 32 GB minne, 5 GB lagringsutrymme tillgängligt för Docker

Valfritt: Ange matchande gränser för behållaren i compose-filen så att gatewayen får dedikerad kapacitet i stället för att konkurrera med andra behållare eller processer på värden:

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

Lägsta hårdvarukrav

Den minsta hårdvaran är endast lämplig för specifika scenarier som använder mindre, dedikerade distributioner (utveckling, test eller produktion), med kontinuerligt låga datavolymer och ett begränsat antal samtidiga ominläsningar.

Värd: 4 kärnor, 8 GB minne, 5 GB lagringsutrymme tillgängligt för Docker

Valfritt: Ange matchande gränser för behållaren i compose-filen så att gatewayen får dedikerad kapacitet i stället för att konkurrera med andra behållare eller processer på värden:

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

Installera Qlik Data Gateway – direktåtkomst

Installation av en Direct Access gateway kräver åtgärder både i aktivitetscentret för Administration och på Direct Access gateway-servern.

Datagatewayprocedurer som måste utföras i aktivitetscentret för Administration kräver administrationsbehörighet för klientorganisationen.

Steg ett: hämta Qlik Data Gateway – direktåtkomst

Välj Datagateways i aktivitetscentret för Administration.

Alla befintliga datagatewayer kommer att anges i en tabell som visar grundläggande information om varje gateway.
Klicka på Driftsättning-knappen i verktygsfältet.

Driftsätt datagateway-dialogen öppnas.
Välj Datagateway - direkt åtkomst - Containerized Direct Access Gateway, godkänn Qlik kundavtal och klicka på Ladda ned. Installationsfilen för Direct Access gateway (docker-compose.qlik-data-gateway-direct-access.yml) kommer att laddas ned till din dator.

Steg två: Starta distributionen genom att köra Docker Compose-filen

För att starta distributionen av Gateway med direktåtkomst, kör följande kommando:

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

Steg tre: Konfigurera Gateway med direktåtkomst

För detaljerade installationsinstruktioner, se Steg tre: Konfigurera Gateway med direktåtkomst.

Fas fyra: Registrera datagatewayen

Nästa steg är att registrera datagatewayen. Detta kan göras antingen via aktivitetscentret Administration eller på kommandoraden.

Du kan registrera gatewayen med hjälp av aktivitetscentret Administration. Se Alternativ 1: Via aktivitetscentret Administration.

Du kan också registrera Gateway med direktåtkomst automatiskt från kommandoraden, utan att använda aktivitetscentret Administration. Denna metod använder en kortlivad sessionstoken som genererats från en OAuth-klient.

Automatisk registrering stöds endast via kommandoraden. Ett REST API för automatisk gatewayregistrering är för närvarande inte tillgängligt.

Förutsättningar

En API-nyckel med administratörsbehörighet för klientorganisationen för att skapa och hantera OAuth-klienter.

Registrera gatewayen med automatisk registrering

Först behöver du konfigurera en Python-miljö för att generera ett OAuth-klient-ID, samt en assertion-nyckel (kortlivad token) i direct-access-agent-behållaren. Kör följande kommandon separat, i den här ordningen:
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>
För det sista kommandot i listan ovan ska du följa de interaktiva anvisningarna och kopiera client_id (OAuth-klient-ID) och assertion när de tillhandahålls. Spara dessa uppgifter på papper eller i en tillfällig textfil så länge—de krävs för senare steg i processen.
När du har skrivit ned client_id och assertion, rensa Python-miljön med följande kommando:

deactivate
Ställ in OAuth-klientens samtyckesmetod på betrodd.

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"}]'
Begär en åtkomsttoken. Detta utlöser även automatiskt skapande av det botanvändarkonto som används av gatewayen.

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"

Anteckning om information
Om assertionen har löpt ut, kör om skriptet från den virtuella miljön.
Sök upp den automatiskt skapade botanvändaren.

curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <API-key>'
Kopiera ID:t för my-bot-client.
Skapa en "DAG Registration"-roll.

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"]}'
Tilldela roller på klientorganisationsnivå till botanvändaren.

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" } ] } ]'
Hämta utrymmet för Gateway med direktåtkomst.

curl "https://<tenant-url>/api/v1/spaces" -H 'authorization: Bearer <API-key>'
Kopiera utrymmes-ID:t för Direct Access Gateway.
Lägg till botanvändaren i ytan med behörigheten Kan redigera.

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"}'
Om den befintliga assertionen har löpt ut, generera en ny. Kör följande kommando:

python3 generate_gateway_assertion.py --tenant-url <tenant-url>
Följ de nödvändiga stegen i kommandotolken. Eftersom OAuth-klienten redan har skapats finns det ett behov av att uppdatera JWK med hjälp av detta API-anrop:

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>"}]'
Registrera gatewayen:

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>

Ta bort en automatiskt registrerad gateway

Använd följande steg för att avregistrera en gateway som registrerades med den automatiska, sessionstokenbaserade metoden som beskrivs ovan. Dessa steg tar även bort OAuth-klienten, bot-användaren och rollen som skapades för den.

Generera en assertion, enligt beskrivningen i delavsnittet ovan.
Ta bort gatewayen:

dotnet ConnectorAgent.dll qcs delete_gateway --tenant_url <tenant-url> --gateway_name <gateway-name> --client-id <client-ID> --assertion <assertion>
Leta upp botanvändarkontot som skapades för gatewayen.

curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <api-key>'
Kopiera bot-ID:t.
Ta bort detta botanvändarkonto.

curl -X DELETE "https://<tenant-url>/api/v1/users/<bot-user-ID>" -H "Authorization: Bearer <api-key>"
Leta upp rollen ”DAG Registration” som skapades för gatewayen.

curl "https://<tenant-url>/api/v1/roles?limit=1&filter=(name%20eq%20%22DAG%20Registration%22)" -H "Authorization: Bearer <api-key>"
Kopiera roll-ID:t.
Ta bort den här rollen.

curl -X DELETE "https://<tenant-url>/api/v1/roles/<role-ID> -H "Authorization: Bearer <api-key>"
Ta bort OAuth-klienten.

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>

Steg fem: starta Qlik Data Gateway – direktåtkomst-tjänsten på Direct Access gateway-servern

För att starta tjänsten Qlik Data Gateway – direktåtkomst, starta containrarna dcaas-dg och direct-access-agent.

Steg sex: lägg till en koppling till datakällan

Se Steg sex: lägg till en koppling till datakällan.

Miljöinställningar

Det här delavsnittet listar specifika miljövariabler från filen docker-compose.qlik-data-gateway-direct-access.yml som du kan behöva konfigurera för att ansluta dina datakällor korrekt via gatewayen.

ALLOW_SOURCES: En kommaseparerad tillåtelselista över värdnamn och IP-adresser. När gateway-agenten behöver ansluta till något på din egen server eller en annan värd i det lokala eller privata nätverket (till exempel en databas på localhost, ett Docker-tjänstnamn eller en värd med privat IP-adress), lägger du till den adressen i ALLOW_SOURCES — annars nekas kopplingsförsöket.

Datakällor som stöds

Följande ODBC-anslutningar stöds för containerbaserade installationer:
- PostgreSQL
- SQL Server
- Oracle
Mer information om ODBC-kopplingar finns i ODBC-databaser – Qlik Cloud (endast på engelska).
REST koppling (REST via Direct Access gateway). För mer information om REST-datakällor, se REST-källor ‒ Qlik Cloud (endast på engelska).

Mer information

Var den här sidan till hjälp för dig?

Om du stöter på några problem med den här sidan eller innehållet på den, t.ex. ett stavfel, ett saknat steg eller ett tekniskt fel – meddela oss!

Lämna din feedback här