Saltar al contenido

Registro de Agente para agentes privados de Jitterbit

Introducción

Para que un agente privado pueda procesar operaciones de proyectos de integración, debe registrarse en un servidor Harmony. La información necesaria para registrarse incluye la URL del servidor Harmony para la región de su organización, las credenciales de su cuenta de Harmony, el nombre del grupo de agentes privados al que se unirá y el nombre del propio agente. Para obtener el nombre de un agente privado, primero debe agregarlo mediante la Management Console Agentes. Luego, puede proporcionarlo como parte de la información de registro requerida durante la instalación en Windows (con entrada manual en el instalador), el paso de configuración en Linux (con entrada manual o parámetros para jitterbit-config), o al iniciar un Docker contenedor (con variables de ambiente). Este método de registro se conoce como registro manual.

Si desea aprovisionar y eliminar automáticamente agentes privados en contenedores (por ejemplo, mediante Kubernetes), debe usar el agente privado Jitterbit auto-register. Con esto, no es necesario agregar un agente desde la página Agentes de la Management Console. El sistema agrega automáticamente un agente privado a un grupo de agentes con nombre, genera un nombre y lo registra. El sistema también puede, opcionalmente, dar de baja y eliminar el agente privado del grupo cuando este se detiene. (Tiene una desventaja: no se puede usar un proxy con registro automático.)

Consejo

Aunque el registro automático fue diseñado para el escalamiento automático con agentes en contenedores, también se puede utilizar en agentes de Linux.

Registro manual

Para registrar manualmente un agente, siga estos pasos:

  1. Abra la Management Console Agentes página.

  2. Agregue un grupo de agentes privados o identifique uno existente y luego agréguele un nuevo agente privado.

  3. Proporcione la información de registro. El momento de hacerlo depende del tipo de alojar del agente:

    Durante la instalación, la interfaz de usuario le solicita que seleccione a qué grupo de agentes unirse y qué agente registrar.

    Durante la configuración, el jitterbit-config dominio le solicita que seleccione a qué grupo de agentes unirse y qué agente registrar. (Alternativamente, estos valores se pueden proporcionar como parámetros para jitterbit-config.)

    Al ejecutar el contenedor, utilice las variables de ambiente abajo.

Registro manual de un agente privado de Docker mediante variables de ambiente

Para utilizar el registro manual con agentes privados en contenedores, establezca valores para las siguientes variables de ambiente y páselos al contenedor:

Variable de ambiente Descripción
HARMONY_ORIGIN La URL de inicio de sesión de su cuenta de Harmony, https://REGION.jitterbit.com, dónde REGION es uno de na-east, emea-west, o apac-southeast.
HARMONY_USERNAME Su nombre de usuario de cuenta Harmony en texto sin formato.
HARMONY_PASSWORD Su contraseña de cuenta Harmony en texto sin formato.
HARMONY_ORG_NAME Nombre de su organización Harmony.
HARMONY_AGENT_GROUP_NAME El nombre del grupo de agentes privados y el nombre del ambiente asociado, separados por un guion bajo.
HARMONY_AGENT_NAME El nombre del agente privado.
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

Consejo

Guarde los valores en un archivo y use el --env-file opción de Docker en lugar de múltiples -e Opciones.

Registro automático

Con el registro automático, hay dos maneras de proporcionar la información de registro: en un register.json archivo, o como variables de ambiente.

Registre un agente privado de Docker usando el register.json archivo

Para registrar automáticamente un agente privado de Docker mediante un register.json Archivo, siga estos pasos:

  1. Cree un directorio y un archivo. conf/register.json contiene lo siguiente, con valores establecidos según la tabla a continuación:

    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
    }
    
    Parámetro Descripción del valor
    cloudUrl La URL de inicio de sesión de su cuenta de Harmony, https://REGION.jitterbit.com, dónde REGION es uno de na-east, emea-west, o apac-southeast.
    agentGroupId El número de identificación del grupo del agente privado.
    username Su nombre de usuario de la cuenta Harmony cifrada.
    password Su contraseña de cuenta Harmony cifrada.
    agentNamePrefix Un prefijo para el nombre del agente privado generado automáticamente.
    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. Inicie el agente privado de Docker con conf directorio montado en el contenedor /conf directorio. (Ver Registro automático con register.json archivo por ejemplo.)

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

    Consejo

    Debes usar un credentials.txt archivo o un register.json archivo. El agente privado no se iniciará si el conf El directorio contiene ambos.

Para usar el register.json archivo en agentes privados de Linux no contenedorizados, mover o eliminar el /opt/jitterbit/Resources/credentials.txt archivo, crear un /opt/jitterbit/Resources/register.json Archivo como se muestra arriba y luego reinicie el agente.

Registrar un agente privado de Docker mediante variables de ambiente

Para registrar automáticamente un agente privado de Docker mediante variables de ambiente, siga estos pasos:

  1. Cree un archivo que contenga lo siguiente, con valores sustituidos según la siguiente tabla:

    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 Descripción del valor
    HARMONY_ORIGIN La URL de inicio de sesión de su cuenta de Harmony, https://REGION.jitterbit.com, dónde REGION es uno de na-east, emea-west, o apac-southeast.
    AUTO_REGISTER_AGENT_GROUP_ID El número de identificación del grupo del agente privado.
    AUTO_REGISTER_ENCRYPTED_USERNAME Su nombre de usuario de la cuenta Harmony cifrada.
    AUTO_REGISTER_ENCRYPTED_PASSWORD Su contraseña de cuenta Harmony cifrada.
    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. Inicie el agente privado de Docker, pasando el archivo de variables de ambiente mediante el comando --env-file opción para docker run:

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

    Consejo

    Alternativamente, utilice el -e/--env Opción para configurar variables de ambiente individualmente.

Comparación de register.json parámetros y variables de ambiente

La siguiente tabla compara los parámetros utilizados en el register.json archivo con sus variables de ambiente equivalentes:

register.json parámetro Variable de ambiente Tipo de valor Descripción
(Ninguno) AUTO_REGISTER Booleano (true o false) Habilitar el registro automático.
cloudUrl HARMONY_ORIGIN Cadena La URL de la nube de Harmony : "https://REGION.jitterbit.com" dónde REGION es na-east, emea-west, o apac-southeast.
username AUTO_REGISTER_ENCRYPTED_USERNAME Cadena Versión cifrada del nombre de usuario de su cuenta de Harmony. (Primera línea de salida de jitterbit-utils -e USERNAME PASSWORD.) Ignorado si token está configurado.
password AUTO_REGISTER_ENCRYPTED_PASSWORD Cadena Versión cifrada de la contraseña de su cuenta de Harmony. (Segunda línea de salida de jitterbit-utils -e USERNAME PASSWORD.) Ignorado si token está configurado.
token Actualmente no hay ninguna variable coincidente Cadena Registro de agente privado token de acceso. Si se proporciona, username y password son ignorados.
deregisterAgentOnDrainstop AUTO_REGISTER_DEREGISTER_ON_DRAINSTOP Booleano (true o false) Si true El agente se elimina al detenerse. Establecer en false para permitir que el agente se vuelva a registrar al reiniciarse. (Véase también DeregisterAgentOnDrainstop.)
agentGroupId AUTO_REGISTER_AGENT_GROUP_ID Entero El número de identificación del grupo de agentes privados al que unirse.
agentNamePrefix AUTO_REGISTER_AGENT_NAME_PREFIX Cadena El nombre del agente privado. Estos tokens se expanden: %ip%:dirección IP del servidor; %host%:nombre de host del servidor; %guid%:un ID aleatorio de 8 caracteres.
retryCount AUTO_REGISTER_RETRY_COUNT Entero Cuántas veces se debe reintentar cuando un agente privado no se registra. Rango: 0-300. Predeterminado: 10.
retryIntervalSeconds AUTO_REGISTER_RETRY_INTERVAL_SECONDS Entero Cuántos segundos transcurren entre reintentos. Rango: 5-600. Predeterminado: 5.
agentMetricsToken AUTO_REGISTER_AGENT_METRICS_TOKEN Cadena Cuando ENABLE_JITTERBIT_METRICS es true, las métricas del agente privado token de acceso con alcance Métrica del Agente, que permite la configuración automática de métricas con agentes registrados automáticamente. Si está vacío, no se recopilan métricas.
(Ninguno) ENABLE_JITTERBIT_METRICS Booleano (true o false) Si true, habilite las métricas del agente privado Jitterbit para los agentes que se ejecutan como Docker contenedores.