Разверните локальный хост-коннектор

Prev Next

Ознакомьтесь с техническими инструкциями по развертыванию, настройке и обслуживанию локальных хостов-коннекторов (OPCH) для интеграции с Tulip.

Данная статья представляет собой техническое справочное руководство для специалистов, ответственных за физическое развертывание и управление жизненным циклом OPCH. Хост-коннектор — это служба, используемая для облегчения подключения

к внешним веб-сервисам, базам данных и серверам OPC UA. Все экземпляры Tulip по умолчанию имеют хост Cloud Connector.

При определении того, подходит ли локальный хост-коннектор для данной архитектуры, необходимо учитывать несколько моментов.

Необходимые условия

Прежде чем продолжить, убедитесь, что вы ознакомились с основами работы хостов соединителей Tulip:* Хосты соединителей* Локальные хосты соединителей

Сеть

Наиболее распространённой причиной развёртывания локального хоста-коннектора являются преимущества, которые он предоставляет при подключении к системам, размещённым в локальной сети. При использовании локального решения все соединения из Tulip с внешними системами инициируются изнутри вашей локальной сети. Все соединения из вашей сети являются исходящими и устанавливаются с Tulip через безопасный WebSocket.

Это контрастирует с облачными хостами-коннекторами, которые требуют входящего доступа к сервисам. Как правило, это решение принимается ИТ-отделом, который разрешает входящие безопасные соединения WebSocket из облака Tulip к сервису, часто с использованием правил перенаправления портов на маршрутизаторе/брандмауэре WAN.

Развертывание локального хоста-коннектора

Update to Support and Troubleshooting

Starting with LTS16+, OPCH includes two environment variables to help with troubleshooting and support: TULIP_LOGGING_TO_TULIP (logging) and TULIP_TELEMETRY_TO_TULIP (metric reporting). To explicitly opt out, you can comment out the above environment variables.

Технические стандарты

OPCH performance

The amount of resources needed to run OPCH will increase as its usage increases. If you consistently use it beyond 250Hz of throughput, we strongly advise allocating more resources to your virtual machines to ensure optimal performance.

Если принято решение о развертывании локального решения, Tulip рекомендует использовать самообслуживание с помощью распределенного образа Docker. Самый простой способ сделать это — использовать виртуальную машину с дистрибутивом Linux.

Tulip также рекомендует размещать только один хост локального коннектора на одной виртуальной машине, чтобы избежать появления единичной точки отказа для сайтов.

Требования к виртуальной машине:

  • Оперативная память — 4 ГБ
  • Объем диска — 8–16 ГБ
  • Процессор — 2 ядра
  • Версия Docker — 20.10+

Что касается сетевых требований, хост локального коннектора должен иметь следующее:

  • IP-адрес
  • Разрешение DNS на
  • Выходной доступ по порту 443 к Tulip (список IP-адресов приведен здесь)
  • Исходящий доступ к репозиторию Docker, указанному здесь
  • Исходящий доступ ко всем соответствующим внешним системам через порты

Ознакомьтесь с полным списком сетевых требований здесь

Развертывание

В следующем разделе описано, как развернуть локальный хост-коннектор в различных средах. AWS и Azure предлагают контейнерные сервисы, способные запускать образ Docker.

AWS

Воспользуйтесь веб-интерфейсом и этим набором инструкций: https://aws.amazon.com/getting-started/hands-on/deploy-docker-containers/

Azure (Bash): LTS16+ OPCH

az container create `-g <НАЗВАНИЕ ГРУППЫ РЕСУРСОВ В AZURE> `--name <НАЗВАНИЕ КОНТЕЙНЕРА> `--cpu 2 `--memory 3 `--restart-policy Always `--public.ecr.aws/tulip/connector-host:<TAG>--os-type Linux `-e TULIP_UUID='<UUID>' `TULIP_FACTORY='https://<ВАШ САЙТ>.tulip.co' `TULIP_MACHINE_SECRET='<СЕКРЕТ>' `TULIP_DEVICE_TYPE='onprem' `TULIP_LOGGING_TO_TULIP=true`TULIP_TELEMETRY_TO_TULIP=true`TULIP_CONNECTORS_HTTP_PROXY='' `TULIP_CONNECTORS_HTTPS_PROXY=''

Azure (Bash): OPCH до версии LTS16

az container create `-g <НАЗВАНИЕ ГРУППЫ РЕСУРСОВ В AZURE> `--name <НАЗВАНИЕ КОНТЕЙНЕРА> `--cpu 2 `--memory 3 `--restart-policy Always `--public.ecr.aws/tulip/connector-host:<TAG> `--os-type Linux `-e TULIP_UUID='<UUID>' `TULIP_FACTORY='https://<ВАШ САЙТ>.tulip.co' `TULIP_MACHINE_SECRET='<СЕКРЕТ>' `TULIP_DEVICE_TYPE='onprem' `CONNECTORS_HTTP_PROXY='' `CONNECTORS_HTTPS_PROXY=''

Виртуальная машина Linux: LTS16+ OPCH

docker run -d \ --name tulip-connector-host \ -e TULIP_FACTORY='https://<FACTORY>.tulip.co' \ -e TULIP_UUID='<UUID>' \ -e TULIP_MACHINE_SECRET='<SECRET>' \ -e TULIP_DEVICE_TYPE='onprem' \ -e TULIP_LOGGING_TO_TULIP=true \ -e TULIP_TELEMETRY_TO_TULIP=true \ -e TULIP_CONNECTORS_HTTP_PROXY='' \ -e TULIP_CONNECTORS_HTTPS_PROXY='' \ --restart=always \ --net=host \ public.ecr.aws/tulip/connector-host:<TAG>

Виртуальная машина Linux: версия OPCH до LTS16

 --name tulip-connector-host \  
 -e TULIP\_FACTORY='https://.tulip.co' \  
 -e TULIP\_UUID='' \  
 -e TULIP\_MACHINE\_SECRET='' \  
 -e TULIP\_DEVICE\_TYPE='onprem' \  
 -e CONNECTORS\_HTTP\_PROXY='' \  
 -e CONNECTORS\_HTTPS\_PROXY='' \  
 -e EXIT\_ON\_DISCONNECT=true \ --restart=always \  
 --net=host \  
 --mount type=volume,source=tuliplog,target=/log \  
 public.ecr.aws/tulip/connector-host:

Windows (PowerShell): LTS16+ OPCH

docker run -d --name tulip-connector-host -e TULIP_FACTORY='https://<FACTORY>.tulip.co' -e TULIP_UUID='<UUID>' -e TULIP_MACHINE_SECRET='<SECRET>' -e TULIP_DEVICE_TYPE='onprem' -e TULIP_LOGGING_TO_TULIP=true -e TULIP_TELEMETRY_TO_TULIP=true -e TULIP_CONNECTORS_HTTP_PROXY='' -e TULIP_CONNECTORS_HTTPS_PROXY='' --restart=always --net=host public.ecr.aws/tulip/connector-host:<TAG>

Windows (PowerShell): версии OPCH до LTS16

docker run -d --name tulip-connector-host -e TULIP_FACTORY='https://<FACTORY>.tulip.co' -e TULIP_UUID='<UUID>' -e TULIP_MACHINE_SECRET='<SECRET>' -e TULIP_DEVICE_TYPE='onprem' -e HTTP_PROXY='' -e HTTPS_PROXY='' -e EXIT_ON_DISCONNECT=true --restart=always --net=host --mount type=volume,source=tuliplog,target=/log public.ecr.aws/tulip/connector-host:<TAG>

Устранение ошибок, связанных с сертификатами

Если OPCH не запускается с ошибками «самоподписанный сертификат в цепочке сертификатов», основной причиной может быть то, что корпоративный прокси-сервер или брандмауэр с настраиваемыми сертификатами препятствует установлению безопасных соединений с Tulip Cloud.

Симптомы: OPCH отображает статус «Never seen»; процесс завершается во время запуска; в журналах фиксируются ошибки цепочки SSL-сертификатов

Чтобы решить эту проблему, при запуске OPCH можно указать дополнительные центры сертификации с помощью следующей переменной среды, как показано ниже. Обратите внимание: файл должен находиться в контейнере Docker.

Для OPCH версий до LTS16: -e CONNECTORS_EXTRA_TRUSTED_CAS_FROM_FILES='["/etc/tulipCa/ca.pem"]'

Для OPCH версий LTS16 и выше: -e TULIP_CONNECTORS_EXTRA_TRUSTED_CAS_FROM_FILES='["/etc/tulipCa/ca.pem"]'


Обновление хоста локального коннектора

Version compatibility

OPCH must be kept up-to-date with the Tulip product. Learn more about [connector](/r230/docs/on-prem-<span translate=)-host-version-support">OPCH version support.

Recommended upgrade procedure for OPCH

Tulip recommends proactively confirming the upgrade by successfully running a test OPCH connection to the development environment and/or development instance. Once this verification is complete, the production environment can be confidently upgraded. Details on how can be found below.

:::(Предупреждение) (Возможно, потребуется также обновить ваше устройство Edge IO)
OPCH может работать на устройствах Edge IO. Если на вашем устройстве не включена функция автоматического обновления, его необходимо обновить вручную.

Если этот предупреждающий баннер по-прежнему отображается после завершения всех обновлений OPCH, убедитесь, что ваше устройство Edge IO также было обновлено.
:::

Tulip выпускает обновления для On-Premise Connector Host в соответствии с нашим графиком выпусков с долгосрочной поддержкой (LTS). Чтобы обновить службу, следуйте приведенным ниже инструкциям:

Процесс обновления OPCH приведёт к простою, поскольку под будет остановлен и запущен заново.

  1. Получите последнюю версию образа Docker для On-Premise Connector Host.

    docker pull public.ecr.aws/tulip/connector-host:<TAG>2. Выполните приведенную ниже команду, чтобы получить ID контейнера Docker.

    docker ps3. Если у вас есть доступ к TULIP_FACTORY, TULIP_UUID и TULIP_MACHINE_SECRET, перейдите к шагу 4. Если нет, выполните следующую команду и сохраните её вывод в безопасном месте.

    docker exec <идентификатор-контейнера> env4. Остановите существующий контейнер Docker.

    docker stop <идентификатор-контейнера>5. Удалите существующий контейнер Docker.

    docker rm <идентификатор-контейнера>6. Запустите стандартную команду Docker run, используя сохраненные учетные данные.

Для OPCH версии LTS16 и выше: docker run -d \ --name tulip-connector-host \ -e TULIP_FACTORY='https://<FACTORY>.tulip.co' \ -e TULIP_UUID='<UUID>' \ -e TULIP_MACHINE_SECRET='<SECRET>' \ -e TULIP_DEVICE_TYPE='onprem' \ -e TULIP_LOGGING_TO_TULIP=true \ -e TULIP_TELEMETRY_TO_TULIP=true \ -e TULIP_CONNECTORS_HTTP_PROXY='' \ -e TULIP_CONNECTORS_HTTPS_PROXY='' \ --restart=always \ --net=host \ public.ecr.aws/tulip/connector-host:<TAG>Для OPCH версий до LTS16: docker run -d \ --name tulip-connector-host \ -e TULIP_FACTORY='https://<FACTORY>.tulip.co' \ -e TULIP_UUID='<UUID>' \ -e TULIP_MACHINE_SECRET='<SECRET>' \ -e TULIP_DEVICE_TYPE='onprem' \ -e CONNECTORS_HTTP_PROXY='' \ -e CONNECTORS_HTTPS_PROXY='' \ -e EXIT_ON_DISCONNECT=true \ --restart=always \ --net=host \ --mount type=volume,source=tuliplog,target=/log \ public.ecr.aws/tulip/connector-host:<TAG>

  1. Убедитесь, что новый контейнер Docker активен.

    docker ps

Используйте среды коннекторов для тестирования обновления

Каждый коннектор имеет три различных среды (производственная, предпроизводственная и разработка), и каждая из этих сред может иметь свой собственный хост коннектора, причем они могут быть разных версий. В зависимости от состояния приложения (версия в разработке, ожидает утверждения, опубликована) можно использовать разную среду.Ожидаемый процесс проверки хоста коннектора должен выглядеть следующим образом: 1. Обновите OPCH в среде разработки. 2. Обновите хост коннектора для проверки (в данном случае предпроизводственная среда указывает на среду разработки). 1. Протестируйте коннектор на странице коннекторов или в режиме разработки вашего приложения. 3. По завершении тестирования обновите хост коннектора в производственной среде.

Дополнительную информацию см. в разделе «Среды коннекторов ».

В качестве альтернативы вы можете обновить OPCH на экземпляре разработки, а затем без опасений обновить производственную среду.

Перенаправление журналов в сторонние инструменты управления журналами

Availability

This capability is available for LTS15+ OPCH.

Вы можете перенаправлять журналы хоста локального коннектора (OPCH) в сторонние инструменты для централизованного мониторинга и устранения неполадок. OPCH поддерживает Datadog, Grafana Loki и Splunk через переменные среды. Доступные типы журналов связаны с работоспособностью вашего OPCH (особенно в части его подключения к Factory), выполнением вызовов коннекторов и журналами подписок. В рамках процесса запуска OPCH пользователи могут указать настройки внешнего инструмента ведения журналов, куда следует направлять журналы. Если добавлены учетные данные для нескольких сервисов, журналы отправляются во все сервисы

  1. Выберите место назначения
  2. Datadog: глобальный конечный пункт; требуется только ключ API.
  3. Grafana Loki: Loki, размещённый у клиента; URL может включать базовую аутентификацию.
  4. Splunk (HEC): многоинстансная среда; требуются как URL, так и токен.
  5. Добавьте переменные среды. Добавьте приведенные ниже переменные в среду хоста коннектора. Используйте только те, которые относятся к выбранному вами пункту назначения.

Datadog

  • TULIP_LOGGING_DATADOG_API_KEY=<ваш_ключ_API_Datadog>

Grafana Loki

  • TULIP_LOGGING_LOKI_URL=https://<user>:<password>@loki.your-domain.com/loki/api/v1/push
    (Поддерживается базовая аутентификация путем вставки user:password в URL — необязательно.)

Splunk (HEC)

  • TULIP_LOGGING_SPLUNK_URL=https://splunk.your-domain.com:8088/services/collector
  • TULIP_LOGGING_SPLUNK_TOKEN=<your_splunk_hec_token>
  1. Перезапустите хост коннектора

Перезапустите службу, чтобы новые переменные среды вступили в силу.

  1. Проверьте доставку

Создайте активность (например, запустите функцию коннектора) и убедитесь, что логи появляются в месте назначения:

  • Datadog: Проверьте последние журналы на наличие имени вашего хоста/службы.
  • Loki: выполните запрос по метке хоста или известной подстроке сообщения в Grafana Explore.
  • Splunk: выполните поиск по недавним событиям с вашего хоста (например, index=<your_index> source="tulip-connector-host").
  • Изменение или отключение ведения журнала
  • Чтобы сменить место назначения, обновите переменные, указав нового поставщика (и удалите старые).
  • Чтобы отключить ведение журнала, удалите переменные ведения журнала и перезапустите службу.

Дополнительная информация

Реализация на основе экспортеров Grafana Alloy:

Экспортер Datadog:https://grafana.com/docs/alloy/next/reference/components/otelcol/otelcol.exporter.datadog/

Экспортер Splunk HEC: https://grafana.com/docs/alloy/next/reference/components/otelcol/otelcol.exporter.splunkhec/

Нагрузка входящих и исходящих вызовов

В этом разделе объясняется, сколько HTTP-запросов OPCH отправляет в Tulip Cloud. Эти запросы можно разделить на запросы с фиксированной частотой (всегда выполняются) и запросы с переменной частотой (зависят от вашей конфигурации и активности).

Запросы с фиксированной частотой

Эти запросы поступают с постоянной, предсказуемой частотой:

Тип Частота Описание
Пульс 6 запросов/минуту Подтверждает, что OPCH находится в сети и подключен.
Опрос источника данных 20 запросов в минуту Регулярно
проверяет наличие обновлений в настроенных источниках данных.

Запросы с переменной частотой

Эти запросы зависят от вашей конфигурации и активности.
Чем больше происходит изменений или событий, тем выше частота запросов.

Тип Типичная частота
Изменения статуса онлайн-доступа к источнику данных машины 1 запрос на каждое изменение (до 60 запросов в минуту)
Вызовы коннекторов 1 исходящий запрос на каждый вызов HTTP-коннектора

Пример расчёта

Рассмотрим конфигурацию со следующими параметрами: - 1 источник данных оборудования - 500 атрибутов оборудования, каждый из которых передает данные с частотой 1 Гц (один раз в секунду)

Частота запросов в худшем случае:`Частота (в худшем случае) = (6 + 1 + 20) + 40 + 60 + 240 = 367 запросов/минуту

Note

The configurations and online statuses typically change rarely. Also, the OPCH optimizes the number of HTTP requests to the Tulip cloud by batching multiple requests together when needed. As a result, the average rate for the above setup will likely be around 200-270 requests/minute.

Дополнительные ссылки

Включение ротации журналов для Docker

Для существующих локальных инсталляций « Connector Hosts », в которых не используется ротация журналов Docker, следуйте инструкциям, приведенным здесь, чтобы обеспечить правильное управление дисковым пространством.

Проверка работоспособности OPCH

Для интеграции OPCH с вашим оркестратором служб на базе Azure или Kubernetes можно использовать следующую конфигурацию:

Для OPCH версии LTS16 и выше:

Для интеграции OPCH с вашим оркестратором сервисов на базе Azure или Kubernetes вы можете использовать следующую конфигурацию: Конечная точка проверки работоспособности случайным образом назначается на порту и доступна по корневому пути /health-check. При желании назначенный порт можно переопределить, установив для переменной TULIP_HEALTH_HTTP_PORT значение указанного порта. Например: TULIP_HEALTH_HTTP_PORT = 80. Успешный ответ будет содержать HTTP-код состояния 204, указывающий, что служба OPCH исправна и работает.

Для OPCH версий, предшествующих LTS16:

Чтобы интегрировать OPCH с вашим оркестратором служб на базе Azure или Kubernetes, можно использовать следующую конфигурацию: конечную точку проверки работоспособности необходимо включить, установив значение переменной среды CONNECTORS_HEALTHZ_SERVER_ENABLED равным true.Конечная точка доступна на порту 9223 и открыта по корневому пути /. При желании порт по умолчанию 9223 можно переопределить, установив для переменной CONNECTORS_PORT значение указанного порта. Например: CONNECTORS_PORT = 80

Успешный ответ будет возвращать HTTP-код состояния 200 (OK), указывающий, что служба OPCH исправна и работает.
При желании порт по умолчанию 9223 можно переопределить, установив для параметра CONNECTORS_PORT значение указанного порта. Например: CONNECTORS_PORT = 80

Успешный ответ будет сопровождаться кодом состояния HTTP 200 (OK), указывающим, что служба OPCH исправна и работает.

{{snippet.Нашли ли вы то, что искали?}}