Настройка Шлюз данных Qlik — прямой доступ в контейнере

Вы также можете автоматически зарегистрировать Direct Access Gateway из командной строки, не используя центр действий Администрирование status. Этот метод использует краткосрочный сессионный токен, сгенерированный клиентом OAuth.

Предварительные требования

Ключ API с разрешением администратора клиента на создание клиентов OAuth и управление ими.

Регистрация шлюза с помощью автоматической регистрации

1. Сначала необходимо настроить среду Python для генерации идентификатора клиента OAuth, а также ключа утверждения (кратковременного токена) в контейнере direct-access-agent. Выполните следующие команды по отдельности в указанном порядке:

   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>

2. Для последней команды в приведенном выше списке следите за интерактивными подсказками и скопируйте client_id (идентификатор клиента OAuth) и assertion, когда они будут предоставлены. Пока сохраните эти данные на бумаге или во временном текстовом файле — они понадобятся на последующих этапах процесса.

3. Когда вы запишете client_id и assertion, очистите среду Python с помощью следующей команды:

   deactivate

4. Установите для метода согласия OAuth-клиента значение trusted.

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

5. Запросите токен доступа. Это также запускает автоматическое создание учетной записи бота, используемой шлюзом.

   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"

   Примечание к информации

   Если срок действия утверждения истек, повторно запустите скрипт из виртуальной среды.

6. Найдите автоматически созданного пользователя-бота.

   curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <API-key>'

7. Скопируйте идентификатор my-bot-client.

8. Создайте роль "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"]}'

9. Назначьте роли уровня клиента пользователю-боту.

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

10. Получить пространство Шлюза прямого доступа.

    curl "https://<tenant-url>/api/v1/spaces" -H  'authorization: Bearer <API-key>'

11. Скопируйте идентификатор пространства Direct Access Gateway.

12. Добавьте пользователя-бота в пространство с разрешением Может редактировать.

    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"}'

13. Если срок действия существующего утверждения истек, сгенерируйте новое. Выполните следующую команду:

    python3 generate_gateway_assertion.py --tenant-url <tenant-url>

14. Выполните необходимые шаги в командной строке. Поскольку клиент OAuth уже создан, необходимо обновить JWK с помощью этого вызова 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>"}]'

15. Зарегистрируйте шлюз:

    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, пользователя-бота и роль, созданные для него.

1. Сгенерируйте утверждение, как описано в разделе выше.

2. Удалите шлюз:

   dotnet ConnectorAgent.dll qcs delete_gateway --tenant_url <tenant-url> --gateway_name <gateway-name> --client-id <client-ID> --assertion <assertion>

3. Найдите учетную запись пользователя-бота, созданную для шлюза.

   curl "https://<tenant-url>/api/v1/users" -H 'accept: application/json' -H 'authorization: Bearer <api-key>'

4. Скопируйте идентификатор бота.

5. Удалить эту учетную запись пользователя-бота.

   curl -X DELETE "https://<tenant-url>/api/v1/users/<bot-user-ID>" -H "Authorization: Bearer <api-key>"

6. Найдите роль «DAG Registration», созданную для шлюза.

   curl "https://<tenant-url>/api/v1/roles?limit=1&filter=(name%20eq%20%22DAG%20Registration%22)"  -H "Authorization: Bearer <api-key>"

7. Скопируйте идентификатор роли.

8. Удалите эту роль.

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

9. Удалите клиент 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>