Poznaj techniczne kroki związane z wdrażaniem, konfiguracją i utrzymaniem lokalnych hostów łączników (OPCH) na potrzeby integracji z platformą Tulip.
Niniejszy artykuł stanowi techniczny przewodnik dla osób odpowiedzialnych za fizyczne wdrażanie i zarządzanie cyklem życia hostów OPCH. Host łącznika to usługa służąca do ułatwiania połączeń z
do zewnętrznych usług internetowych, baz danych i serwerów OPC UA. Wszystkie instancje Tulip mają domyślnie host Cloud Connector.
Przy podejmowaniu decyzji, czy lokalny host łącznika (OPCH) jest odpowiednim rozwiązaniem architektonicznym, należy wziąć pod uwagę kilka kwestii.
Wymagania wstępne
Zanim przejdziesz dalej, upewnij się, że zapoznałeś się z podstawowymi informacjami na temat hostów łączników Tulip:* Hosty łączników* Hosty łączników lokalnych
Sieć
Najczęstszym powodem wdrożenia lokalnego hosta łącznika są korzyści, jakie oferuje on podczas łączenia się z systemami hostowanymi w sieci lokalnej. W przypadku rozwiązania lokalnego wszystkie połączenia z Tulip do systemów zewnętrznych rozpoczynają się w sieci lokalnej. Wszystkie połączenia z sieci lokalnej są wychodzące do Tulip za pośrednictwem bezpiecznego WebSocket.
Różni się to od hostów łączników w chmurze, które wymagają dostępu przychodzącego do usług. Zazwyczaj jest to decyzja działu IT, polegająca na zezwoleniu na przychodzące, bezpieczne połączenia WebSocket z chmury Tulip do usługi, często przy użyciu reguł przekierowania portów na routerze WAN lub zaporze sieciowej.
Wdrożenie lokalnego hosta łącznika
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.
Standardy techniczne
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.
W przypadku podjęcia decyzji o wdrożeniu rozwiązania lokalnego firma Tulip zaleca ścieżkę samoobsługową z wykorzystaniem rozproszonego obrazu Docker. Najprostszym sposobem na osiągnięcie tego celu jest użycie maszyny wirtualnej z dystrybucją systemu Linux.
Tulip zaleca również hostowanie tylko jednego hosta łącznika lokalnego na każdej maszynie wirtualnej, aby uniknąć pojedynczego punktu awarii w lokalizacjach.
Wymagania dotyczące maszyny wirtualnej:
- Pamięć RAM – 4 GB
- Pamięć ROM – dysk o pojemności 8–16 GB
- Procesor – 2 rdzenie
- Wersja Docker — 20.10+
Jeśli chodzi o wymagania sieciowe, host łącznika lokalnego posiada:
- Adres IP
- Rozpoznawanie DNS do
- Dostęp wychodzący na porcie 443 do serwisu Tulip (adresy IP wymienione tutaj)
- Dostęp wychodzący do repozytorium Docker tutaj
- Dostęp wychodzący do wszystkich odpowiednich systemów zewnętrznych za pośrednictwem portów
Zapoznaj się z pełną listą wymagań sieciowych tutaj
Wdrożenie
W poniższej sekcji opisano, jak wdrożyć lokalny host łącznika w różnych środowiskach. Zarówno AWS, jak i Azure oferują usługi kontenerowe umożliwiające uruchamianie obrazu Docker.
AWS
Skorzystaj z interfejsu użytkownika i poniższego zestawu instrukcji: https://aws.amazon.com/getting-started/hands-on/deploy-docker-containers/
Azure (Bash): LTS16+ OPCH
az container create `-g <NAZWA GRUPY ZASOBÓW W AZURE> `--name <NAZWA KONTEYNERA> `--cpu 2 `--memory 3 `--restart-policy Always `--public.ecr.aws/tulip/connector-host:<TAG>--os-type Linux `-e TULIP_UUID='<UUID>' `TULIP_FACTORY='https://<YOUR SITE>.tulip.co' `TULIP_MACHINE_SECRET='<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 przed wersją LTS16
az container create `-g <NAZWA GRUPY ZASOBÓW W AZURE> `--name <NAZWA KONTEYNERA> `--cpu 2 `--memory 3 `--restart-policy Always `--public.ecr.aws/tulip/connector-host:<TAG> `--os-type Linux `-e TULIP_UUID='<UUID>' `TULIP_FACTORY='https://<YOUR SITE>.tulip.co' `TULIP_MACHINE_SECRET='<SECRET>' `TULIP_DEVICE_TYPE='onprem' `CONNECTORS_HTTP_PROXY='' `CONNECTORS_HTTPS_PROXY=''
Maszyna wirtualna z systemem 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>
Maszyna wirtualna z systemem Linux: wersja sprzed LTS16 OPCH
--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): wersja OPCH sprzed 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>
Rozwiązywanie problemów z certyfikatami
Jeśli OPCH nie uruchamia się z błędami typu „certyfikat z podpisem własnym w łańcuchu certyfikatów”, przyczyną może być to, że firmowy serwer proxy/zapora sieciowa z niestandardowymi certyfikatami blokuje bezpieczne połączenia z Tulip Cloud.
Objawy: — OPCH wyświetla status „Never seen” — Proces kończy działanie podczas uruchamiania — Błędy łańcucha certyfikatów SSL w logach
Aby rozwiązać ten problem, podczas uruchamiania OPCH można odwołać się do dodatkowych urzędów certyfikacji za pomocą poniższej zmiennej środowiskowej. Należy pamiętać, że plik ten powinien znajdować się w kontenerze Docker.
Dla OPCH starszego niż LTS16: -e CONNECTORS_EXTRA_TRUSTED_CAS_FROM_FILES='["/etc/tulipCa/ca.pem"]'
Dla OPCH w wersji LTS16 i nowszych: -e TULIP_CONNECTORS_EXTRA_TRUSTED_CAS_FROM_FILES='["/etc/tulipCa/ca.pem"]'
Aktualizacja hosta łącznika w środowisku lokalnym
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.
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.
:::(Ostrzeżenie) (Konieczna może być również aktualizacja urządzenia Edge IO)
OPCH może działać na urządzeniach typu „ Edge IO ”. Jeśli na Twoim urządzeniu nie jest włączona funkcja automatycznej aktualizacji, należy je zaktualizować ręcznie.
Jeśli ten baner ostrzegawczy nadal się wyświetla po zakończeniu wszystkich aktualizacji OPCH, upewnij się, że urządzenie Edge IO również zostało zaktualizowane.
:::
Firma Tulip udostępnia aktualizacje dla hosta On-Premise Connector zgodnie z harmonogramem wydawania wersji z długoterminowym wsparciem (LTS). Aby zaktualizować usługę, postępuj zgodnie z poniższymi instrukcjami:
Proces aktualizacji OPCH spowoduje przestój, podczas którego pod zostanie zatrzymany i utworzony ponownie.
-
Pobierz najnowszą wersję obrazu Docker dla On-Premise Connector Host.
docker pull public.ecr.aws/tulip/connector-host:<TAG>2. Uruchom poniższe polecenie, aby uzyskać identyfikator kontenera Docker.docker ps3. Jeśli masz dostęp doTULIP_FACTORY,TULIP_UUIDiTULIP_MACHINE_SECRET, przejdź do kroku 4. Jeśli nie, uruchom poniższe polecenie i zapisz wynik tego polecenia w bezpiecznym miejscu.docker exec <identyfikator-kontenera> env4. Zatrzymaj istniejący kontener Docker.docker stop <identyfikator-kontenera>5. Usuń istniejący kontener Docker.docker rm <identyfikator-kontenera>6. Uruchom standardowe polecenieDocker run, wykorzystując zapisany zestaw poświadczeń.
Dla OPCH w wersji 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>Dla OPCH sprzed wersji 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>
-
Sprawdź, czy nowy kontener Docker jest aktywny.
docker ps
Wykorzystaj środowiska łączników do przetestowania aktualizacji
Każdy łącznik ma trzy różne środowiska (produkcyjne, przedprodukcyjne i deweloperskie), a każde z tych środowisk może mieć własny host łącznika i może korzystać z różnych wersji. W zależności od stanu aplikacji (wersja deweloperska, oczekująca na zatwierdzenie, opublikowana) można użyć innego środowiska.Przewidywany proces walidacji hosta łącznika powinien wyglądać następująco: 1. Zaktualizuj OPCH w środowisku deweloperskim. 2. Zaktualizuj host łącznika do walidacji (środowisko przedprodukcyjne wskazuje tutaj na środowisko deweloperskie). 1. Przetestuj łącznik na stronie łączników lub w trybie deweloperskim aplikacji. 3. Po zakończeniu testów walidacyjnych zaktualizuj host łącznika w środowisku produkcyjnym.
Więcej informacji można znaleźć w sekcji Środowiska łączników.
Alternatywnie można zaktualizować OPCH na instancji deweloperskiej, a następnie bez obaw zaktualizować środowisko produkcyjne.
Przekazywanie logów do zewnętrznych narzędzi do zarządzania logami
This capability is available for LTS15+ OPCH.
Można przekazywać logi hosta łącznika lokalnego (OPCH) do narzędzi innych firm w celu scentralizowanego monitorowania i rozwiązywania problemów. OPCH obsługuje Datadog, Grafana Loki i Splunk za pośrednictwem zmiennych środowiskowych. Dostępne typy logów dotyczą stanu OPCH (zwłaszcza w zakresie połączenia z Factory), wykonywania wywołań łącznika oraz logów subskrypcji. W ramach procesu uruchamiania OPCH użytkownicy mogą skonfigurować zewnętrzne narzędzie do logowania, do którego mają być kierowane logi. Jeśli dodano poświadczenia dla wielu usług, logi są wysyłane do wszystkich usług
- Wybierz miejsce docelowe
- Datadog: globalny punkt końcowy; wymagany jest jedynie klucz API.
- Grafana Loki: Loki hostowany przez klienta; adres URL może zawierać uwierzytelnianie podstawowe.
- Splunk (HEC): wiele instancji; wymagany jest zarówno adres URL, jak i token.
- Dodaj zmienne środowiskowe Dodaj poniższe zmienne do środowiska hosta łącznika. Używaj tylko tych, które odpowiadają wybranemu miejscu docelowemu.
Datadog
TULIP_LOGGING_DATADOG_API_KEY=<twój_klucz_api_datadog>
Grafana Loki
TULIP_LOGGING_LOKI_URL=https://<user>:<password>@loki.your-domain.com/loki/api/v1/push
(Obsługiwane jest uwierzytelnianie podstawowe poprzez umieszczenie pary„użytkownik:hasło”w adresie URL — opcjonalnie.)
Splunk (HEC)
TULIP_LOGGING_SPLUNK_URL=https://splunk.your-domain.com:8088/services/collectorTULIP_LOGGING_SPLUNK_TOKEN=<twój_token_splunk_hec>
- Uruchom ponownie host łącznika
Uruchom ponownie usługę, aby nowe zmienne środowiskowe zaczęły obowiązywać.
- Sprawdź dostarczenie
Wygeneruj aktywność (np. uruchom funkcję łącznika) i sprawdź, czy logi pojawiają się w miejscu docelowym:
- Datadog: Sprawdź najnowsze logi pod kątem nazwy hosta/usługi.
- Loki: W Grafana Explore wykonaj zapytanie według etykiety hosta lub znanego podciągu wiadomości.
- Splunk: Przeszukaj ostatnie zdarzenia z hosta (np.
index=<twój_indeks> source="tulip-connector-host"). - Zmiana lub wyłączenie logowania
- Aby zmienić miejsce docelowe, zaktualizuj zmienne, podając nowego dostawcę (i usuń stare).
- Aby wyłączyć rejestrowanie, usuń zmienne rejestrowania i uruchom ponownie usługę.
Dodatkowe informacje
Implementacja oparta na eksporterach Grafana Alloy:
Eksporter Datadog:https://grafana.com/docs/alloy/next/reference/components/otelcol/otelcol.exporter.datadog/
Eksporter Splunk HEC: https://grafana.com/docs/alloy/next/reference/components/otelcol/otelcol.exporter.splunkhec/
Obciążenie połączeniami przychodzącymi i wychodzącymi
W tej sekcji wyjaśniono, ile żądań HTTP wysyła OPCH do Tulip Cloud. Żądania te można podzielić na żądania o stałej częstotliwości (zawsze aktywne) oraz żądania o zmiennej częstotliwości (zależne od konfiguracji i aktywności).
Żądania o stałej częstotliwości
Żądania te występują ze stałą, przewidywalną częstotliwością:
| Typ | Częstotliwość | Opis |
|---|---|---|
| Sygnał kontrolny | 6 żądań na minutę | Potwierdza, że OPCH jest online i połączony. |
| Odczytywanie źródła danych | 20 żądań na minutę | Regularnie |
| sprawdza, czy są aktualizacje w skonfigurowanych źródłach danych. |
Zmienna częstotliwość żądań
Liczba tych żądań zależy od konfiguracji i aktywności.
Im więcej zmian lub zdarzeń ma miejsce, tym wyższa jest częstotliwość żądań.
| Typ | Typowa częstotliwość |
|---|---|
| Zmiany statusu online źródła danych maszynowych | 1 żądanie na zmianę (do 60 żądań na minutę) |
| Wywołania łącznika | 1 żądanie wychodzące na każde wywołanie łącznika HTTP |
Przykładowe obliczenia
Rozważmy konfigurację obejmującą: - 1 źródło danych maszynowych- 500 atrybutów maszynowych, z których każdy przekazuje dane z częstotliwości ą 1 Hz (raz na sekundę)
Najgorszy scenariusz częstotliwości żądań:`Częstotliwość (najgorszy scenariusz) = (6 + 1 + 20) + 40 + 60 + 240 = 367 żądań na minutę
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.
Dodatkowe materiały
Włącz rotację logów dla Docker
W przypadku istniejących instancji On-Premise Connector Hosts, które nie korzystają z rotacji logów w Dockerze, postępuj zgodnie z instrukcjami opisanymi tutaj, aby zapewnić prawidłowe zarządzanie przestrzenią dyskową.
Sprawdź stan OPCH
Aby zintegrować OPCH z orkiestratorem usług opartym na platformie Azure lub Kubernetes, można skorzystać z następującej konfiguracji:
Dla OPCH w wersji LTS16+:
Aby zintegrować OPCH z orkiestratorem usług opartym na platformie Azure lub Kubernetes, można użyć następującej konfiguracji: Punkt końcowy sprawdzania stanu jest losowo przypisywany do portu i udostępniany w ścieżce głównej /health-check. Opcjonalnie przypisany port można nadpisać, ustawiając zmienną TULIP_HEALTH_HTTP_PORT na określony port. Na przykład: TULIP_HEALTH_HTTP_PORT = 80. Pomyślna odpowiedź zwróci kod stanu HTTP 204, wskazujący, że usługa OPCH działa poprawnie i jest gotowa do pracy.
W przypadku OPCH sprzed wersji LTS16:
Aby zintegrować OPCH z orkiestratorem usług opartym na platformie Azure lub Kubernetes, można skorzystać z następującej konfiguracji: Punkt końcowy sprawdzania stanu należy włączyć, ustawiając zmienną środowiskową CONNECTORS_HEALTHZ_SERVER_ENABLED na wartość „true”.Punkt końcowy jest dostępny na porcie 9223 i udostępniony w ścieżce głównej /. Opcjonalnie domyślny port 9223 można zastąpić, ustawiając CONNECTORS_PORT na określony port. Na przykład: CONNECTORS_PORT = 80
Pomyślna odpowiedź zwróci kod stanu HTTP 200 (OK), wskazujący, że usługa OPCH działa poprawnie i jest gotowa do pracy.
Opcjonalnie domyślny port 9223 można zmienić, ustawiając CONNECTORS_PORT na określony port. Na przykład: CONNECTORS_PORT = 80
Pomyślna odpowiedź zwróci kod statusu HTTP 200 (OK), wskazujący, że usługa OPCH działa poprawnie i jest gotowa do pracy.
{{snippet.Czy znalazłeś to, czego szukałeś?}}
