コンテナ内で Qlik Data Gateway - 直接アクセスを設定する

最終更新日時: 2026/09/30

このトピックでは、コンテナ化された Direct Access gateway の設定方法について説明します。前提条件とインストール手順を提供し、コンテナ化された Direct Access gateway を使用する際に注意が必要な制限事項と考慮事項について説明します。

Direct Access gateway 1.8.0 以降でサポートされています。

コンテナ化された Direct Access gateway とは何ですか?

Direct Access gateway を Docker コンテナに展開できます。このタイプの展開は、コンテナ化された Direct Access gateway と呼ばれます。コンテナ化された Direct Access gateway の展開は、Linux、macOS、Windows でサポートされています。

コンテナ化された Direct Access gateway は、Direct Access gateway 環境にポータビリティを提供します。

Qlik Data Gateway - 直接アクセスを使用するときのベストプラクティス

Qlik Data Gateway - 直接アクセスを適切に使用するには、次のベストプラクティスに従うことを強くお勧めします。

開発、ユーザー受け入れテスト、実稼働に同じ Direct Access gateway を使用しないでください。使用可能なリソースが過負荷になり、システムの安定性に影響を与えるリスクが高まります。ビジネスの観点から見ると、リソース不足と安定性の低下が組み合わさり、実稼働アプリケーションデータの更新が遅れる可能性があります。
最適なパフォーマンスを得るには、データソースにできるだけ近い環境に Direct Access gateway をインストールしてください。

システム前提条件

このセクションでは、コンテナ化された Direct Access gateway を使用するための要件について説明します。

ソフトウェア要件

Docker Engine バージョン 20.9 以降および Docker Compose プラグイン (docker compose、v2 構文) がホストにインストールされていること。

必要なポートとプロトコル

必要なポートとプロトコルについては、必要なポートとプロトコル を参照してください。

推奨ハードウェア

ホスト: 8 コア、32 GB メモリ、Docker で利用可能な 5 GB のストレージ
オプション: ゲートウェイがホスト上の他のコンテナやプロセスと競合することなく専用のキャパシティを確保できるように、compose ファイル内のコンテナに対応する制限を設定します:
```
direct-access-agent:
    image: ...
    deploy:
      resources:
        limits:
          cpus: "6"
          memory: 24G
...
dcaas:
    image: ...
    deploy:
      resources:
        limits:
          cpus: "2"
```

最小ハードウェア

最小ハードウェアは、小規模な専用展開 (開発、テスト、または運用) を使用し、継続的にデータ量が少なく、同時リロードの数が制限されている特定のシナリオにのみ適しています。

ホスト: 4 コア、8 GB のメモリ、Docker で利用可能な 5 GB のストレージ
オプション: ゲートウェイがホスト上の他のコンテナやプロセスと競合することなく専用のキャパシティを確保できるように、compose ファイル内のコンテナに対応する制限を設定します:
```
direct-access-agent:
    image: ...
    deploy:
      resources:
        limits:
          cpus: "2"
          memory: 4G
...
dcaas:
    image: ...
    deploy:
      resources:
        limits:
          cpus: "2"
```

Qlik Data Gateway - 直接アクセスのインストール

Direct Access gateway のセットアップには、管理アクティビティセンターおよび Direct Access gateway サーバーの両方で実行が必要な手順が含まれます。

管理アクティビティセンターで実行が必要なデータゲートウェイ手順には、テナント管理者の権限が必要です。

ステージ 1: Qlik Data Gateway - 直接アクセスをダウンロードする

管理アクティビティセンターで、データゲートウェイを選択します。

既存のデータゲートウェイがある場合、各ゲートウェイに関する基本情報を表示するテーブルにリストされます。
[展開] ツールバーボタンをクリックします。

[データゲートウェイの展開] ダイアログが開きます。
データゲートウェイ - 直接アクセス - コンテナ化された Direct Access Gatewayを選択し、Qlik 顧客契約に同意して、 [ダウンロード] をクリックします。Direct Access gateway 設定ファイル (docker-compose.qlik-data-gateway-direct-access.yml) がマシンにダウンロードされます。

ステージ 2: Docker Compose ファイルを実行して展開を開始する

Direct Access gateway の展開を開始するには、次のコマンドを実行します。

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

ステージ 3: Direct Access gateway を設定する

詳細な設定手順については、「ステージ 3: Direct Access gateway のセットアップ」を参照してください。

ステージ 4: データゲートウェイを登録する

次のステップでは、データゲートウェイを登録します。これは、管理アクティビティセンターから、またはコマンドラインで実行できます。

管理アクティビティセンターを使用して、ゲートウェイを登録できます。「オプション 1: 管理アクティビティセンター経由」を参照してください。

管理アクティビティセンターを使用せずに、コマンドラインから Direct Access gateway を自動的に登録することもできます。このメソッドは、OAuth クライアントから生成された有効期間の短いセッショントークンを使用します。

自動登録はコマンドラインからのみサポートされています。ゲートウェイの自動登録用の REST API は、現在利用できません。

前提条件

OAuth クライアントを作成および管理するためのテナント管理者権限を持つ API キー。

自動登録によるゲートウェイの登録

まず、direct-access-agent コンテナ内で OAuth クライアント ID およびアサーションキー (有効期間の短いトークン) を生成するために、Python 環境を設定する必要があります。次のコマンドをこの順序で個別に実行します。
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>
上記のリストの最後のコマンドについては、対話型プロンプトに従い、表示された client_id (OAuth クライアント ID) と assertion をコピーします。これらの詳細は、プロセスの後の手順で必要になるため、現時点では紙に書き留めるか、一時的なテキストファイルに保存しておいてください。
client_id と assertion を書き留めたら、次のコマンドで Python 環境をクリーンアップします。

deactivate
OAuth クライアントの同意方法を信頼済みに設定します。

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"}]'
アクセストークンをリクエストします。これにより、ゲートウェイで使用されるボットユーザーアカウントの自動作成もトリガーされます。

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"

情報メモ
アサーションの有効期限が切れている場合は、仮想環境からスクリプトを再実行してください。
自動作成されたボットユーザーを検索します。

curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <API-key>'
my-bot-client の ID をコピーします。
「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"]}'
ボットユーザーにテナントレベルのロールを割り当てます。

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" } ] } ]'
Direct Access Gateway のスペースを取得します。

curl "https://<tenant-url>/api/v1/spaces" -H 'authorization: Bearer <API-key>'
Direct Access Gateway のスペース ID をコピーします。
ボットユーザーを [編集可能] 権限でスペースに追加します。

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"}'
既存のアサーションの有効期限が切れている場合は、新しいアサーションを生成してください。次のコマンドを実行します:

python3 generate_gateway_assertion.py --tenant-url <tenant-url>
コマンドプロンプトで、必要なステップに従います。OAuth クライアントはすでに作成されているため、この API 呼び出しを使用して JWK を更新する必要があります。

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>"}]'
ゲートウェイを登録します。

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>

自動登録されたゲートウェイの削除

上記で説明したセッショントークンベースの自動方式を使用して登録されたゲートウェイの登録を解除するには、次のステップを実行します。これらのステップを実行すると、作成された OAuth クライアント、ボットユーザー、ロールも削除されます。

上記のセクションで説明されているように、アサーションを生成します。
ゲートウェイを削除します:

dotnet ConnectorAgent.dll qcs delete_gateway --tenant_url <tenant-url> --gateway_name <gateway-name> --client-id <client-ID> --assertion <assertion>
ゲートウェイ用に作成されたボットユーザーアカウントを検索します。

curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <api-key>'
ボット ID をコピーします。
このボットユーザーアカウントを削除します。

curl -X DELETE "https://<tenant-url>/api/v1/users/<bot-user-ID>" -H "Authorization: Bearer <api-key>"
ゲートウェイ用に作成された「DAG Registration」ロールを検索します。

curl "https://<tenant-url>/api/v1/roles?limit=1&filter=(name%20eq%20%22DAG%20Registration%22)" -H "Authorization: Bearer <api-key>"
ロール ID をコピーします。
このロールを削除します。

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

ステージ 5: Direct Access gateway サーバーで Qlik Data Gateway - 直接アクセスサービスを起動する

Qlik Data Gateway - 直接アクセスサービスを起動するには、dcaas-dg および direct-access-agent コンテナを起動します。

ステージ 6: データソースに接続を追加する

「ステージ 6: データソースに接続を追加する」を参照してください。

環境設定

このセクションでは、ゲートウェイ経由でデータソースを適切に接続するために設定が必要になる可能性がある、docker-compose.qlik-data-gateway-direct-access.yml ファイルの特定の環境変数を一覧表示します。

ALLOW_SOURCES: カンマ区切りのホスト名と IP の許可リスト。ゲートウェイエージェントが、ユーザーのサーバー上、またはローカルネットワークやプライベートネットワーク内の別のホスト (例: localhost 上のデータベース、Docker サービス名、プライベート IP ホストなど) に接続する必要がある場合は、そのアドレスを ALLOW_SOURCES に追加します。追加しない場合、接続試行は拒否されます。

サポートされているデータソース

コンテナ化されたインストールでは、次の ODBC コネクタがサポートされています。
- PostgreSQL
- SQL Server
- Oracle
ODBC コネクタの詳細については、「ODBC データベース - Qlik Cloud (英語のみ)」を参照してください。
REST コネクタ (REST Direct Access gateway 経由)。REST データソースの詳細については、「REST ソース ‒ Qlik Cloud (英語のみ)」を参照してください。

詳細を見る

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。

こちらにフィードバックをお寄せください

コンテナ内で Qlik Data Gateway - 直接アクセス を設定する