Configuration de Passerelle de données Qlik - Accès direct dans un conteneur

Dernière mise à jour : 30/09/2026

Cette rubrique explique comment configurer une installation Direct Access gateway conteneurisée. Elle fournit les conditions préalables requises et les instructions d’installation et décrit les limitations et les considérations à prendre en compte lors de l’utilisation de Direct Access gateway dans un conteneur.

Supporté à partir de Direct Access gateway 1.8.0.

Qu’est-ce qu’une installation Direct Access gateway conteneurisée ?

Vous pouvez déployer Direct Access gateway dans un conteneur Docker. Ce type de déploiement est appelé un déploiement Direct Access gateway conteneurisé. Les déploiements Direct Access gateway conteneurisés sont supportés pour Linux, macOS et Windows.

Un déploiement Direct Access gateway conteneurisé fournit la portabilité à votre environnement Direct Access gateway.

Bonnes pratiques lors de l'utilisation de Passerelle de données Qlik - Accès direct

Pour une expérience concluante lors de l'utilisation de Passerelle de données Qlik - Accès direct, il est vivement recommandé de suivre les bonnes pratiques suivantes :

N'utilisez pas la même Direct Access gateway pour le développement, les tests d'acceptation utilisateur et la production, car cela augmenterait le risque de surcharge des ressources disponibles et aurait un impact sur la stabilité du système. D'un point de vue commercial, la combinaison de ressources insuffisantes et d'une stabilité réduite peut entraîner des retards de mise à jour des données des applications de production.
Pour des performances optimales, installez Direct Access gateway dans un environnement aussi proche que possible de votre source de données.

Conditions préalables requises du système

Cette section décrit les conditions requises relatives à l’utilisation d’un déploiement Direct Access gateway conteneurisé.

Conditions logicielles requises

Docker Engine version 20.9+ et le plug-in Docker Compose (Docker Compose, syntaxe v2) installés sur l’hôte.

Ports et protocoles requis

Pour les ports et protocoles requis, consultez Ports et protocoles requis.

Matériel recommandé

Hôte : 8 cœurs, 32 Go de mémoire, 5 Go de stockage disponible pour Docker
Facultatif : définissez des limites correspondantes pour le conteneur dans le fichier Compose afin que la passerelle dispose d’une capacité dédiée plutôt que d’entrer en concurrence avec d’autres conteneurs ou processus sur l’hôte :
```
direct-access-agent:
    image: ...
    deploy:
      resources:
        limits:
          cpus: "6"
          memory: 24G
...
dcaas:
    image: ...
    deploy:
      resources:
        limits:
          cpus: "2"
```

Configuration minimale requise

La configuration matérielle minimale requise ne convient qu’à des scénarios spécifiques qui utilisent des déploiements (développement, test ou production) dédiés de plus petite taille avec des volumes de données continuellement faibles et un nombre limité de chargements simultanés.

Hôte : 4 cœurs, 8 Go de mémoire, 5 Go de stockage disponible pour Docker
Facultatif : définissez des limites correspondantes pour le conteneur dans le fichier Compose afin que la passerelle dispose d’une capacité dédiée plutôt que d’entrer en concurrence avec d’autres conteneurs ou processus sur l’hôte :
```
direct-access-agent:
    image: ...
    deploy:
      resources:
        limits:
          cpus: "2"
          memory: 4G
...
dcaas:
    image: ...
    deploy:
      resources:
        limits:
          cpus: "2"
```

Installation de Passerelle de données Qlik - Accès direct

La configuration de Direct Access gateway implique des procédures à réaliser dans le centre d'activités Administration et sur le serveur Direct Access gateway.

Les procédures de la passerelle de données à effectuer dans le centre d'activités Administration nécessitent une autorisation d'administrateur de clients.

Étape un : téléchargez Passerelle de données Qlik - Accès direct

Dans le centre d'activités Administration, sélectionnez Passerelles de données.

Toutes les passerelles de données existantes seront répertoriées dans un tableau indiquant des informations de base sur chacune.
Cliquez sur le bouton de barre d'outils Déployer.

La boîte de dialogue Déployer la passerelle de données s'ouvre.
Sélectionnez Passerelle de données - Accès direct - Direct Access gateway conteneurisée, acceptez le Contrat client Qlik, puis cliquez sur Télécharger. Le fichier d’installation de Direct Access gateway (docker-compose.qlik-data-gateway-direct-access.yml) sera téléchargé sur votre poste.

Étape deux : Démarrer le déploiement en exécutant le fichier Docker Compose

Pour démarrer le déploiement de Direct Access gateway, exécutez la commande suivante :

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

Étape trois : Configuration de Direct Access gateway

Pour obtenir des instructions de configuration détaillées, consultez Étape trois : Configurer Direct Access gateway.

Étape quatre : Enregistrer la passerelle de données

L’étape suivante consiste à enregistrer la passerelle de données. Cela peut être fait soit via le centre d’activités Administration, soit via la ligne de commande.

Vous pouvez enregistrer la passerelle à l’aide du centre d’activités Administration. Consultez Option 1 : via le centre d’activités Administration.

Vous pouvez également enregistrer automatiquement Direct Access gateway depuis la ligne de commande sans utiliser le centre d’activités Administration. Cette méthode utilise un jeton de session de courte durée généré à partir d’un client OAuth.

L’enregistrement automatique est supporté uniquement via la ligne de commande. Il n’existe actuellement pas d’API REST pour l’enregistrement automatique de la passerelle.

Conditions préalables requises

Une clé API avec l’autorisation d’administrateur de clients pour créer et gérer des clients OAuth.

Enregistrement de la passerelle avec l’enregistrement automatique

Vous devez commencer par configurer un environnement Python pour générer un ID client OAuth, ainsi qu’une clé d’assertion (jeton de courte durée) dans le conteneur direct-access-agent. Exécutez les commandes suivantes séparément, dans cet ordre :
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>
Pour la dernière commande de la liste ci-dessus, suivez les invites interactives et copiez le client_id (ID client OAuth) et le assertion lorsqu’ils sont fournis. Conservez ces informations sur papier ou dans un fichier texte temporaire pour le moment — elles seront nécessaires pour les étapes ultérieures du processus.
Lorsque vous avez noté le client_id et le assertion, nettoyez l’environnement Python avec la commande suivante :

deactivate
Définissez la méthode de consentement du client OAuth sur approuvé.

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"}]'
Demandez un jeton d’accès. Cela déclenche également la création automatique du compte d’utilisateur bot utilisé par la passerelle.

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"

Note Informations
Si l’assertion a expiré, réexécutez le script depuis l’environnement virtuel.
Recherchez l’utilisateur bot automatiquement créé.

curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <API-key>'
Copiez l’ID de my-bot-client.
Créez un rôle « Enregistrement DAG ».

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"]}'
Affectez des rôles au niveau du client à l’utilisateur 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" } ] } ]'
Obtenez l’espace Direct Access gateway.

curl "https://<tenant-url>/api/v1/spaces" -H 'authorization: Bearer <API-key>'
Copiez l’ID d’espace Direct Access gateway.
Ajoutez l’utilisateur bot à l’espace avec l’autorisation Accès en écriture.

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"}'
Si l’assertion existante a expiré, générez-en une nouvelle. Exécutez la commande suivante :

python3 generate_gateway_assertion.py --tenant-url <tenant-url>
Suivez les étapes requises dans l’invite de commande. Puisque le client OAuth est déjà créé, il est nécessaire de mettre à jour le JWK à l’aide de cet appel d’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>"}]'
Enregistrez la passerelle :

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>

Suppression d’une passerelle automatiquement enregistrée

Suivez les étapes suivantes pour annuler l’enregistrement d’une passerelle qui a été enregistrée à l’aide de la méthode automatique basée sur un jeton de session décrite ci-dessus. Ces étapes suppriment également le client OAuth, l’utilisateur bot et le rôle qui ont été créés pour la passerelle.

Générez une assertion, comme décrit dans la section ci-dessus.
Supprimez la passerelle :

dotnet ConnectorAgent.dll qcs delete_gateway --tenant_url <tenant-url> --gateway_name <gateway-name> --client-id <client-ID> --assertion <assertion>
Recherchez le compte d’utilisateur bot créé pour la passerelle.

curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <api-key>'
Copiez l’ID de bot.
Supprimez ce compte d’utilisateur bot.

curl -X DELETE "https://<tenant-url>/api/v1/users/<bot-user-ID>" -H "Authorization: Bearer <api-key>"
Recherchez le rôle « Enregistrement DAG » qui a été créé pour la passerelle.

curl "https://<tenant-url>/api/v1/roles?limit=1&filter=(name%20eq%20%22DAG%20Registration%22)" -H "Authorization: Bearer <api-key>"
Copiez l’ID de rôle.
Supprimez ce rôle.

curl -X DELETE "https://<tenant-url>/api/v1/roles/<role-ID> -H "Authorization: Bearer <api-key>"
Supprimez le client 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>

Étape cinq : démarrez le service Passerelle de données Qlik - Accès direct sur le serveur Direct Access gateway

Pour démarrer le service Passerelle de données Qlik - Accès direct, démarrez les conteneurs dcaas-dg et direct-access-agent.

Étape six : ajoutez une connexion à votre source de données

Consultez Étape six : ajoutez une connexion à votre source de données.

Paramètres d’environnement

Cette section répertorie les variables d’environnement spécifiques du fichier docker-compose.qlik-data-gateway-direct-access.yml que vous devrez peut-être configurer pour connecter correctement vos sources de données via la passerelle.

ALLOW_SOURCES : liste d’autorisation de noms d’hôte et d’adresses IP séparés par des virgules. Lorsque l’agent de passerelle doit se connecter à un élément situé sur votre propre serveur ou sur un autre hôte du réseau local ou privé (par exemple, une base de données sur localhost, un nom de service Docker ou un hôte avec une adresse IP privée), vous ajoutez cette adresse à ALLOW_SOURCES — sinon, la tentative de connexion est refusée.

Sources de données supportées

Les connecteurs ODBC suivants sont supportés pour les installations conteneurisées :
- PostgreSQL
- SQL Server
- Oracle
Pour plus d’informations sur les connecteurs ODBC, consultez Bases de données ODBC ‒ Qlik Cloud (uniquement en anglais).
Connecteur REST (REST via Direct Access gateway). Pour plus d’informations sur les sources de données REST, consultez Sources REST ‒ Qlik Cloud (uniquement en anglais).

En savoir plus

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici