GroundRunners gör det möjligt för kommandokedjor att interagera med lokala system eller fjärrdatakällor som annars inte har åtkomst via internet. De installeras vanligtvis på en dedikerad server, till exempel den som är värd för din anslutna datakälla, av en IT-proffs eller någon annan som är bekant med organisationens nätverksinställningar.
Innan du installerar en GroundRunner rekommenderar vi att du läser igenom Chain Builder säkerhetsarkitektur.
Krav
Ett kompatibelt operativsystem krävs, och om din GroundRunner ska ha åtkomst till aktieresurser, t.ex. en UNC-sökväg (Windows Universal Naming Convention), krävs också ett användarkonto med tillräckliga behörigheter.
En Java Runtime Environment (JRE) installeras inte med GroundRunner under den första GroundRunner-installationen.
När installationen är klar och GroundRunner körs, laddar den automatiskt ner en JRE efter behov för att köra kommandon som är beroende av Java. Ingen installation eller administrativ åtgärd krävs, och den hämtade JRE:n kommer inte att påverka befintliga JRE-installationer om de finns på värden.
Alternativt, om du har organisatoriska krav som kräver användning av en viss JRE, kan miljövariabeln SHARED_LIBRARY_OVERRIDES ställas in så att den pekar på systeminstallationen. I det här fallet kommer GroundRunner inte automatiskt att ladda ner Workivas standard-JRE, utan kommer att använda den medföljande system-JRE-installationen.
Workiva-levererade JRE:er är licensierade under GPL v2 och omfattas av klassvägsundantaget.
Obs: För att använda anpassade certifikat med din Java-installation, seAnvända anpassade certifikat med GroundRunners.
Rollkrav
På Workiva-plattformen
På Workiva-plattformen behöver du en roll som ger åtkomst till inställningarna för Chain Builder och möjligheten att hantera Runners. Det finns två:
- Kedjeägare: Detta är den primära rollen som krävs. Användare med den här rollen kan komma åt avsnittet "Nedladdningar" i Chain Builder för att hämta de senaste installationsfilerna för GroundRunner och hantera fliken "Runners" för att aktivera eller övervaka tjänsten.
- Säkerhetsadministratör för organisationskedjan: Denna roll på organisationsnivå har även behörighet att hantera anslutningar och löpare över flera arbetsytor.
På servern
Eftersom en "manuell uppdatering" innebär att tjänster stoppas och körbara filer ersätts på den fysiska eller virtuella maskinen där GroundRunner är installerad, måste användaren ha administratörsbehörighet på värdservern.
- Windows: Du måste kunna köra kommandotolken som administratör och komma åt Windows Service Manager (för att stoppa och starta om GroundRunner-tjänsten).
- Linux/macOS: Du måste ha sudo eller root åtkomst för att flytta filer till installationskatalogen och starta om bakgrundsprocessen.
Ladda ner GroundRunner
För att ladda ner en GroundRunner för installation eller manuell uppdatering:
- I sidofältet i Workiva Home klickar du på Kedjor.
- I sidofältet för Kedjebyggaren (detta är en ny flik) klickar du på Anslutningar.
Alternativt kan du klicka på användarprofilikonen längst upp till höger, välja Kedjeadministratöroch sedan Arbetsplatsinställningar. - Klicka på Nedladdningar i den översta menyraden.
- Hitta GroundRunner för ditt operativsystem och klicka på Ladda ner.
- När nedladdningen till din dator har genomförts väljer du lämpliga instruktioner från nedanstående lista och följer dem för att installera GroundRunner.
Installera GroundRunner
Microsoft Installer (MSI) kräver .NET 3.5 eller högre.
Om du inte kan uppfylla detta krav måste du installera GroundRunner med hjälp av kommandoradsgränssnittet istället.
För att installera GroundRunner:
- Packa upp GroundRunner.zip till en ny mapp och öppna mappen.
- Kör GroundRunner.msi för att öppna installationsguiden för GroundRunner.
- Klicka på Nästa.
- Granska och godkänn villkoren i licensavtalet och klicka på Nästa.
- För målmappen anger du sökvägen där GroundRunner ska installeras (till exempel:
C:\Program Files\GroundRunner\) och klickar på Nästa.
- I Plattformsföretagstokenanger du din företagstoken.
- I Platform auth host:
- För APAC, ange
h.apac.wdesk.com/s/chains-reaper. - För EMEA, ange
h.eu.wdesk.com/s/chains-reaper. - För USA, Centralamerika och Sydamerika, ange
h.app.wdesk.com/s/chains-reaper.
- För APAC, ange
- Om du använder en proxyserver, ange dess URL och port i Proxyvärd.
(Till exempel,http://dinproxy:3000.)
För att kringgå proxyservern, ange en kommaseparerad lista över värdar under Ingen proxyvärd. - Klicka på Next, Install, och Finish.
- När GroundRunner är installerat, högerklicka på den i Windows Service Manager och välj Starta.
Din GroundRunner har nu installerats och är redo för aktivering.
För att installera via kommandoradsgränssnittet måste du ladda ner GroundRunners installationsprogram till dess egen katalog i dina programfiler (till exempel c:\Program Files (x86)\wdata). Du kan sedan packa upp installationsfilen och extrahera den till rotkatalogen i den katalogen.
Du kan sedan installera GroundRunner:
- I Windows kommandofönster skriver du in
och accepterar alla standardinställningar.c:\Program Files (x86)\wdata\installer.exe install- Välj "Windows" för init-systemet.
Du måste ange att GroundRunner ska fungera som en Windows-tjänst för att den ska stödjas med automatiska uppdateringar. GroundRunners bör endast köras som en tjänst, förutom för teständamål.
- För sökvägen, skapa en mapp av typen Files i den nya katalogen
(till exempelC:\Program Files (x86)\Wdata\Files). - För värdnamnet för auktorisering (AUTH_HOST):
- För APAC, ange
h.apac.wdesk.com/s/chains-reaper. - För EMEA, ange
h.eu.wdesk.com/s/chains-reaper. - För USA, Centralamerika och Sydamerika, ange
h.app.wdesk.com/s/chains-reaper.
- För APAC, ange
- Ange din företagstoken.
- Välj "Windows" för init-systemet.
- Ta bort alla arkiveringar från katalogen utom den körbara katalogen för GroundRunner.
- Välj om GroundRunner ska köras som en tjänst eller en förgrundsprocess.
- Om du kör som en tjänst, gör något av följande:
- I kommandodialogrutan, skriv
sc start GroundRunner. - I Windows Service Manager, starta GroundRunnertjänsten.
- I kommandodialogrutan, skriv
- Om den körs som en förgrundsprocess, ange följande i kommandodialogrutan:
cd c:\Program Files (x86)\wdata GroundRunner.exe
- Om du kör som en tjänst, gör något av följande:
Din GroundRunner är nu installerad och redo för aktivering.
Steg 1. Installera GroundRunner
-
Ladda ner GroundRunners installationsfil till dess egen katalog,
till exempel:/home/användarnamn/wdata/.Obs: "/home/användarnamn/wdata" ges som ett exempel. Följ din organisations policy för installationsplatser för tjänster.
- I en kommandodialogruta, packa upp installationsfilen med hjälp av:
unzip GroundRunner.zip - Ange GroundRunner-uppgifterna.
- Skriv in
./installer installera - För värdnamnet för auktorisering (AUTH_HOST):
- För APAC, ange
h.apac.wdesk.com/s/chains-reaper. - För EMEA, ange
h.eu.wdesk.com/s/chains-reaper. - För USA, Centralamerika och Sydamerika, ange
h.app.wdesk.com/s/chains-reaper.
- För APAC, ange
- Ange din företagstoken.
- Skriv in
- Ta bort alla filer från katalogen förutom den mapp som skapades under installationsprocessen.
Steg 2. Konfigurera din GroundRunner som en systemd-tjänst (Linux)
För att säkerställa att automatiska uppdateringar i GroundRunner fungerar, och för god GroundRunner-hygien, måste GroundRunner installeras som en aktiverad, omstartbar systemd-tjänst. Se dokumentationen och organisationens policy för ditt operativsystem angående hur man kör GroundRunner som en systemd-tjänst.
För grundläggande konfigurationer har vi följande krav för systemd-enhetsfiler för att automatiska uppdateringar ska fungera korrekt:
- Se till att den körbara filen
ExecStartpekar på binärfilenGroundRunnerMonitoroch INTE binärfilen
GroundRunner. - Ställ in
Omstart = alltid. - Ställ inte in
StartLimitBurstellerStartLimitIntervalSec, eftersom dessa kan förhindra att GroundRunner startas om på grund av tillfälliga fel. Om du vill att GroundRunner inte ska hamna i en snabb omstartsloop kan du konfigureraRestartSec. - Skriv in
systemctl enableför att aktivera systemd GroundRunner-tjänstenheten så att GroundRunner överlever en omstart.
Workiva har inte officiellt stöd för att köra en GroundRunner som en förgrundsprocess. Detta kan vara användbart för att testa en konfiguration, men när en GroundRunner väl är konfigurerad bör den konfigureras som en långlivad bakgrundsprocess.
Använda GroundRunners på macOS (endast testning)
Workiva stöder GroundRunners på macOS endast i testsyfte. Medan macOS GroundRunners kan köra samma kommandon som Linux- och Windows-versionerna, stöder Workiva inte officiellt launchd som en giltig tjänsthanterare. Detta beror på att Apple upphörde med stödet för sin macOS-serverprogramvara år 2022. Apples bärbara och stationära datorer är inte lämpliga för att köra GroundRunners.
Aktivera GroundRunner
När du har installerat din GroundRunner måste du aktivera den i Chain Builder.
- I sidofältet för Kedjebyggaren klickar du på Anslutningar.
- Klicka på Löpare högst upp och klicka sedan på Väntar på registrering.
- Ange ett kort, beskrivande namn för löparen.
Till exempel "<datasource> "-GroundRunner".
- Klicka på Aktivera.
Uppdatera en GroundRunner manuellt
Även om detta sällan krävs kan du behöva uppgradera en GroundRunner manuellt.
Se Workivas supportsida Uppdatering av GroundRunner-manualen för instruktioner om hur du gör detta.
Avinstallera en GroundRunner
Om du inte längre behöver en GroundRunner kan du avinstallera den.
- Stoppa GroundRunner-tjänsten.
- Om den körs som en tjänst, använd Windows Service Manager eller skriv
sc stop GroundRunneri ett kommandofönster. - Om den körs som en förgrundsprocess, tryck Ctrl+C.
- Om den körs som en tjänst, använd Windows Service Manager eller skriv
- I kommandodialogrutan, som administratör, ange
installer.exe avinstallera. - Ta bort den körbara katalogen
GroundRunner.
I kommandodialogrutan, stoppa GroundRunner-tjänsten och ta bort dess körbara katalog (t.ex. /home/<username> /wdata/Innehåll).
Installera en anpassad JRE
Om det behövs kan du installera din egen JRE för att stödja en GroundRunner. Java-versionen av denna JRE måste matcha den som krävs för Groundrunner. Förutom Oracle Essbase ochOracle Hyperion Financial Management (HFM) GroundRunners använder alla GroundRunners samma JRE-version.För information om hur du installerar en anpassad JRE, se Inaktivera delade Workiva-bibliotek.
Konfigurationsinställningar för GroundRunner och utgående domäner
För att möjliggöra kommunikation med datakällan kan du behöva öppna brandväggsportar på den server där GroundRunner är installerad. Om du vill ändra konfigurationsinställningarna för vissa GroundRunners kan du redigera arkiveringen GroundRunner.config i den katalog där binärprogrammen är installerade.
| Konfiguration | Inställningar |
|---|---|
| PORT |
0 till 65535. Som standard använder GroundRunners port 8821 för att kommunicera med varandra. En port krävs dock endast om GroundRunners på olika servrar aktie kommandoutgångar inom ditt nätverk. |
| COMPANY_TOKEN | Lämna som standard, såvida inte GroundRunner är konfigurerad för en annan hyresgäst. |
| LOG_NIVÅ | Info eller felsökning |
| PROTOKOLL | Lämna som standard. |
| HTTP_PROXY_URL |
Om du använder en proxyserver anger du dess URL och port (om det behövs). Obs: GroundRunners kan använda proxyservrar, men inte sådana som autentiseras via NTLM (New Technology LAN Manager). Tillåt istället serverns IP-adress. |
| LONG_POLL | Om du använder en proxyserver ska du ange true för att instruera runnern att använda long-polling för att hämta kommandon. För att säkerställa prestanda bör du endast använda long-polling om webbsockets inte har support från din proxyserver eller brandvägg. |
| NO_PROXY | Om du vill kringgå proxyservern anger du en kommaseparerad lista över värdar som ska nås direkt i stället. Om du vill inkludera flera värdar utifrån ett gemensamt mönster använder du jokertecknet *. |
| GROUNDRUNNER_CERT |
Behövs om man använder mer än en GroundRunner och vill skicka krypterad information till den andra GroundRunnern. Detta måste användas tillsammans med PORT. Du måste också ange fältet PROTOCOL som HTTPS när du aktiverar löparen. |
| GROUNDRUNNER_CERT_NYCKEL | Behövs om man använder mer än en GroundRunner och vill ta emot krypterad information från en andra GroundRunner. Detta måste också användas tillsammans med PORT. |
| INAKTIVERA_WEBSOCKETS | Websockets krävs för att köra transformationer. När den är inaktiverad kommer alla kommandon som använder transformationer att hoppas över helt. |
Obs: Ditt självsignerade certifikat måste ha ett Subject Alternative Name (SAN). Om den inte gör det, kommer din GroundRunner att visa ett felmeddelande som hänvisar till det saknade SAN-et när den försöker ladda ner filer.
Om ditt nätverk måste tillåta utgående domäner gäller dessa för GroundRunners:
| Domän | Syfte |
|---|---|
|
|
De viktigaste underdomänerna för vanliga Workiva-tjänster, inklusive Wdata. |
*.wdesk.com |
Huvuddomänen för Workiva-plattformen för produktion. |
*.*.wdesk.com |
Underdomänerna för support-komponenter i Workiva-plattformen. |
värdepapper
GroundRunners samlar aldrig in eller sammanställer data Ett EV-certifikat (Extended Validation) krypterar och skyddar alltid trafiken mellan en GroundRunner och dess datakälla via DigiCert®.
Obs: För att säkra lokala data kan CloudRunners dela utdata med GroundRunners, men GroundRunners kan inte dela filutdata med CloudRunner.
Felsökning av GroundRunner-fel
Om du får dessa fel när en kedja körs ska du kontrollera kommandots GroundRunners.
Tips: För att underlätta felsökning kan du skapa en kedja för att automatiskt ladda ner en GroundRunner-loggfil till en tabell.
| Felmeddelande | Orsak | Upplösning |
|---|---|---|
| Det gick inte att kommunicera med agenten - detta kommando utfördes inte |
Kommandot kunde inte kommunicera med sin GroundRunner. Om detta händer startade inte GroundRunner eller så har ett nätverksavbrott inträffat mellan GroundRunner och Chain Builder. |
Verifiera:
|
| Det går inte att ladda ner resurser som är kopplade till kommandot. Kontakta support om felet kvarstår. |
De löpare som är kopplade till dessa kedjors kommandon kan inte kommunicera med varandra. Detta inträffar ofta när kommandon använder olika runners och CloudRunner försöker använda en arkivering från ett GroundRunner-baserat kommando. |
Använd samma löpare för alla kommandon i kedjan. Om kedjans kommandon kräver flera löpare, kontrollera att inga kommandon med GroundRunners skickar arkivering till kommandon som använder CloudRunner. |
Fel vid start av kommando: exec: \\\[connector].exe\": filen finns inte" commandExecutorId=[ID] |
En malware- eller antivirusapplikation identifierade felaktigt kontakten och avlyssnade dess kommunikation med GroundRunner. | Uteslut installationskatalogen för GroundRunner från programmets sökningar. |
| Fel i certifikat | Använda självsignerade certifikat |
I många fall kan det vara praktiskt att använda självsignerade certifikat för att kryptera GroundRunner-kommunikation. Om du använder ett självsignerat certifikat, se till att certifikatetsVanliga namn matchar den URL som servern kan nås från. Om till exempel din GroundRunner lyssnar på port 8821 och du kan komma åt servern från ditt nätverk |
| Intermittent kedjefel med fel: "Anslutning återställd av peer" |
När flera löpare är installerade på samma maskin måste de alla ha ett unikt GUID. Om samma GUID används kan löparna överlappa varandra och hamna i en uppdateringsslinga – vilket kan orsaka enstaka kedjefel. |
Vi rekommenderar en fullständig ominstallation av GroundRunner. |
| Kommandon hoppas över på GroundRunner men lyckas på CloudRunner | Websockets krävs för att köra transformationer. När websockets inaktiveras kommer alla transformationer att hoppas över helt. | Öppna din konfigurationsfil och sättDISABLE_WEBSOCKETS=false. |
Fel vid läsning från sockeln. Försöker anslutning igen: läs tcp<IP> :<Port> -> : wsarecv: Ett anslutningsförsök misslyckades eftersom den anslutna parten inte svarade korrekt efter en viss tid, eller så misslyckades den upprättade anslutningen eftersom den anslutna värden inte svarade. |
Intern brandvägg eller nätverksproblem | Be ditt interna IT- eller nätverksteam att granska loggarna och konfigurationen för att åtgärda felet. |
läsa<IP> :<Port> -> : : wsarecv: En befintlig anslutning stängdes med våld av fjärrdatorn |
Intern brandvägg eller nätverksproblem | Be ditt interna IT- eller nätverksteam att granska loggarna och konfigurationen för att åtgärda felet. |