Zum Inhalt springen

Agent für private Jitterbit-Agenten

Einführung

Bevor ein privater Agent Integrationsprojektvorgänge verarbeiten kann, muss er sich bei einem Harmony-Server registrieren. Zu den Informationen, die er zur Registrierung benötigt, gehören die Harmony-Server-URL für die Region Ihrer Organisation, Ihre Harmony Kontoanmeldeinformationen, der Name der privaten Agentengruppe, der er beitreten soll, und der Name des Agenten selbst. Um den Namen eines privaten Agenten zu erhalten, müssen Sie zunächst einen mithilfe der Management Console Agenten hinzufügen Seite. Sie können diese dann als eine der erforderlichen Registrierungsinformationen während des Installationsschritts unter Windows angeben (mit manueller Eingabe in das Installationsprogramm), der Konfigurationsschritt unter Linux (mit manueller Eingabe oder Parametern für jitterbit-config) oder beim Starten eines Docker Container (mit Umfeld). Dieser Registrierungsansatz wird als manuelle Registrierung bezeichnet.

Wenn Sie containerisierte private Agenten automatisch bereitstellen und entsorgen möchten (z. B. mit Kubernetes), müssen Sie den privaten Jitterbit-Agenten auto-register verwenden-Funktion. Damit müssen Sie keinen Agenten über die Seite Agenten der Management Console hinzufügen. Das System fügt einen privaten Agenten automatisch einer benannten Agentengruppe hinzu, generiert einen Namen und registriert ihn dann. Das System kann den privaten Agenten optional auch abmelden und aus der Agentengruppe entfernen, wenn der Agent stoppt. (Es gibt einen Nachteil: Sie können keinen Proxy verwenden mit automatischer Anmeldung.)

Tipp

Obwohl die automatische Registrierung für die automatische Skalierung mit containerisierten Agenten entwickelt wurde, kann sie auch auf Linux Agenten verwendet werden.

Manuelle Registrierung

Um einen Agenten manuell zu registrieren, führen Sie diese Schritte aus:

  1. Öffnen Sie die Management Console Agenten Seite.

  2. Fügen Sie eine private Agentengruppe hinzu oder identifizieren Sie eine vorhandene und fügen Sie ihr dann einen neuen privaten Agenten hinzu.

  3. Geben Sie die Registrierungsinformationen ein. Wann Sie dies tun, hängt vom Agent-Host ab:

    Während der Installation werden Sie über die Benutzeroberfläche aufgefordert, auszuwählen, welcher Agentengruppe Sie beitreten und welchen Agenten Sie registrieren möchten.

    Während der Konfiguration, Die jitterbit-config Befehl fordert Sie auf, auszuwählen, welcher Agentengruppe Sie beitreten und welchen Agenten Sie registrieren möchten. (Alternativ können diese Werte als Parameter angegeben werden, um jitterbit-config.)

    Beim Ausführen den Container, verwenden Sie die Umfeld unten.

Manuelle Registrierung eines privaten Docker-Agenten mithilfe von Umfeld

Um die manuelle Registrierung mit containerisierten privaten Agenten zu verwenden, legen Sie Werte für die folgenden Umfeld fest und übergeben Sie sie an den Container:

Umgebungsvariable Beschreibung
HARMONY_ORIGIN Die Anmelde URL für Ihr Harmony-Konto, https://REGION.jitterbit.com, Wo REGION ist einer von na-east, emea-west, oder apac-southeast.
HARMONY_USERNAME Ihr Harmony-Kontobenutzername im Klartext.
HARMONY_PASSWORD Ihr Harmony-Kontokennwort im Klartext.
HARMONY_ORG_NAME Der Name Ihrer Harmony-Organisation.
HARMONY_AGENT_GROUP_NAME Der Name der privaten Agentengruppe und der zugehörige Umfeld, getrennt durch einen Unterstrich.
HARMONY_AGENT_NAME Der Name des privaten Agenten.
Example
docker run -it \
-e HARMONY_ORIGIN=https://na-east.jitterbit.com \
-e HARMONY_USERNAME=example@jbexample.com \
-e HARMONY_PASSWORD=P@55w0rd \
-e HARMONY_ORG_NAME="Example Org" \
-e HARMONY_AGENT_GROUP_NAME="Example Agent Group_Example Environment" \
-e HARMONY_AGENT_NAME=ExampleAgent \
jitterbit/agent

Tipp

Legen Sie die Werte in eine Datei und verwenden Sie die --env-file Docker-Option anstelle mehrerer -e Optionen.

Automatische Registrierung

Bei der automatischen Registrierung gibt es zwei Möglichkeiten, Registrierungsinformationen anzugeben: in einem register.json Datei oder als Umfeld.

Registrieren Sie einen privaten Docker-Agenten mit dem register.json Datei

Um einen privaten Docker-Agenten automatisch mit einem register.json Datei, folgen Sie diesen Schritten:

  1. Erstellen Sie ein Verzeichnis und eine Datei conf/register.json enthält Folgendes, mit Werten, die gemäß der folgenden Tabelle festgelegt sind:

    conf/register.json
    {
        "cloudUrl": "https://REGION.jitterbit.com",
        "agentGroupId": GROUP_ID,
        "username": "ENCRYPTED_USERNAME",
        "password": "ENCRYPTED_PASSWORD",
        "agentNamePrefix": "PREFIX",
        "deregisterAgentOnDrainstop": false,
        "retryCount": 10,
        "retryIntervalSeconds": 5
    }
    
    Parameter Wertbeschreibung
    cloudUrl Die Anmelde URL für Ihr Harmony-Konto, https://REGION.jitterbit.com, Wo REGION ist einer von na-east, emea-west, oder apac-southeast.
    agentGroupId Die ID-Nummer der privaten Agentengruppe.
    username Ihr verschlüsselter Harmony-Kontobenutzername.
    password Ihr verschlüsseltes Harmony-Kontopasswort.
    agentNamePrefix Ein Präfix für den automatisch generierten privaten Agentennamen.
    Example conf/register.json
    {
        "cloudUrl": "https://na-east.jitterbit.com",
        "agentGroupId": 12345,
        "username": "$00HD1uP3SoM3odoS5NklwBp3VBeg1O4COW31ohIMqBBfWOcUrlzADwMawtI8lAcg6C",
        "password": "$003k9pLM1SJvrnh4CeMzw6jBdzsr0TY6s92wNuMiBuIVs=",
        "agentNamePrefix": "test",
        "deregisterAgentOnDrainstop": false,
        "retryCount": 10,
        "retryIntervalSeconds": 5
    }
    
  2. Starten Sie den privaten Docker-Agenten mit dem conf Verzeichnis, das im Container gemountet ist /conf Verzeichnis. (Siehe Automatische Registrierung mit register.json Datei als Beispiel.)

    Example
    docker run --detach --name jitterbit-agent --rm --volume ./conf:/conf jitterbit/agent
    

    Tipp

    Sie sollten entweder ein credentials.txt Datei oder eine register.json Datei. Der private Agent startet nicht, wenn die conf Verzeichnis enthält beides.

Um das zu verwenden, register.json Datei auf nicht-containerisierten privaten Linux Agenten, verschieben oder entfernen Sie die /opt/jitterbit/Resources/credentials.txt Datei, erstellen Sie eine /opt/jitterbit/Resources/register.json Datei wie oben gezeigt, und starten Sie dann den Agenten neu.

Registrieren Sie einen privaten Docker-Agenten mithilfe von Umfeld

Um einen privaten Docker-Agenten automatisch mithilfe von Umfeld zu registrieren, führen Sie die folgenden Schritte aus:

  1. Erstellen Sie eine Datei mit dem folgenden Inhalt, wobei die Werte gemäß der folgenden Tabelle ersetzt werden:

    HARMONY_ORIGIN=
    AUTO_REGISTER=true
    AUTO_REGISTER_AGENT_GROUP_ID=
    AUTO_REGISTER_AGENT_NAME_PREFIX=auto
    AUTO_REGISTER_DEREGISTER_ON_DRAINSTOP=false
    AUTO_REGISTER_ENCRYPTED_USERNAME=
    AUTO_REGISTER_ENCRYPTED_PASSWORD=
    
    Variable Wertbeschreibung
    HARMONY_ORIGIN Die Anmelde URL für Ihr Harmony-Konto, https://REGION.jitterbit.com, Wo REGION ist einer von na-east, emea-west, oder apac-southeast.
    AUTO_REGISTER_AGENT_GROUP_ID Die ID-Nummer der privaten Agentengruppe.
    AUTO_REGISTER_ENCRYPTED_USERNAME Ihr verschlüsselter Harmony-Kontobenutzername.
    AUTO_REGISTER_ENCRYPTED_PASSWORD Ihr verschlüsseltes Harmony-Kontopasswort.
    Example
    HARMONY_ORIGIN=https://na-east.jitterbit.com
    AUTO_REGISTER=true
    AUTO_REGISTER_AGENT_GROUP_ID=12345
    AUTO_REGISTER_AGENT_NAME_PREFIX=auto
    AUTO_REGISTER_DEREGISTER_ON_DRAINSTOP=false
    AUTO_REGISTER_ENCRYPTED_USERNAME=$00HD1uP3SoM3odoS5NklwBp3VBeg1O4COW31ohIMqBBfWOcUrlzADwMawtI8lAcg6C
    AUTO_REGISTER_ENCRYPTED_PASSWORD=$003k9pLM1SJvrnh4CeMzw6jBdzsr0TY6s92wNuMiBuIVs=
    
  2. Starten Sie den privaten Docker-Agenten und übergeben Sie die Umfeld mit dem --env-file Option für Docker Run:

    Example
    docker run --detach --env-file FILE jitterbit/agent
    

    Tipp

    Alternativ nutzen Sie die -e/--env Option zum individuellen Festlegen von Umfeld.

Vergleich von register.json Parameter und Umfeld

Die folgende Tabelle vergleicht die in der register.json Datei mit den entsprechenden Umfeld:

register.json Parameter Umgebungsvariable Werttyp Beschreibung
(Keine) AUTO_REGISTER Boolesch (true oder false) Automatische Registrierung aktivieren.
cloudUrl HARMONY_ORIGIN String Die URL der Harmony Cloud: "https://REGION.jitterbit.com" Wo REGION Ist na-east, emea-west, oder apac-southeast.
username AUTO_REGISTER_ENCRYPTED_USERNAME Zeichenfolge Verschlüsselte Version Ihres Harmony-Kontobenutzernamens. (Erste Ausgabezeile von jitterbit-utils -e USERNAME PASSWORD.) Ignoriert, wenn token ist eingestellt.
password AUTO_REGISTER_ENCRYPTED_PASSWORD String Verschlüsselte Version Ihres Harmony-Kontokennworts. (Zweite Ausgabezeile von jitterbit-utils -e USERNAME PASSWORD.) Ignoriert, wenn token ist eingestellt.
token Derzeit keine passende Variable String Private Agent-Registrierung Zugriffstoken. Falls angegeben, username Und password werden ignoriert.
deregisterAgentOnDrainstop AUTO_REGISTER_DEREGISTER_ON_DRAINSTOP Boolesch (true oder false) Wenn true, Agent wird entfernt, wenn gestoppt. Auf false um dem Agenten die erneute Registrierung beim Neustart zu ermöglichen. (Siehe auch DeregisterAgentOnDrainstop.)
agentGroupId AUTO_REGISTER_AGENT_GROUP_ID Ganzzahl Die ID-Nummer der privaten Agentengruppe, der beigetreten werden soll.
agentNamePrefix AUTO_REGISTER_AGENT_NAME_PREFIX Zeichenfolge Der Name des privaten Agenten. Diese Token werden erweitert: %ip%: Server-IP-Adresse; %host%: Server-Hostname; %guid%: eine zufällige 8-stellige ID.
retryCount AUTO_REGISTER_RETRY_COUNT Ganzzahl Anzahl der Wiederholungsversuche, wenn die Registrierung eines privaten Agenten fehlschlägt. Bereich: 0–300. Standard: 10.
retryIntervalSeconds AUTO_REGISTER_RETRY_INTERVAL_SECONDS Ganzzahl Anzahl der Sekunden zwischen den Wiederholungsversuchen. Bereich: 5–600. Standard: 5.