Ir para o conteúdo

Registro de Agente para agentes privados Jitterbit

Introdução

Antes que um agente privado possa processar operações de projeto de integração, ele deve se registrar em um servidor Harmony. As informações que ele precisa registrar incluem a URL do servidor Harmony para a região da sua organização, suas credenciais de conta Harmony, o nome do grupo de agentes privados ao qual ele deve se juntar e o nome do próprio agente. Para obter o nome de um agente privado, você deve primeiro adicionar um usando o Management Console Agents página. Você pode então fornecê-lo como uma das informações de registro necessárias durante a etapa de instalação no Windows (com entrada manual no instalador), a etapa de configuração no Linux (com entrada manual ou parâmetros para jitterbit-config), ou ao iniciar um Docker contêiner (com variáveis de ambiente). Essa abordagem para registro é conhecida como registro manual.

Se você quiser provisionar e descartar automaticamente agentes privados em contêineres (por exemplo, usando o Kubernetes), você deve usar o agente privado Jitterbit auto-register. Com isso, você não precisa adicionar um agente com a página Agentes do Management Console. O sistema adiciona automaticamente um agente privado a um grupo de agentes nomeado, gera um nome e o registra. O sistema também pode, opcionalmente, cancelar o registro e remover o agente privado do grupo de agentes quando o agente parar. (Há uma desvantagem: você não pode usar um proxy com registro automático.)

Dica

Embora o registro automático tenha sido projetado para dimensionamento automático com agentes em contêineres, ele também pode ser usado em agentes Linux.

Registro manual

Para registrar manualmente um agente, siga estas etapas:

  1. Abra o Management Console Agentes página.

  2. Adicione um grupo de agentes privados ou identifique um existente e adicione um novo agente privado a ele.

  3. Forneça as informações de registro. Quando você faz isso depende do tipo de hospedar do agente:

    Durante instalação, a interface do usuário solicita que você selecione qual grupo de agentes deseja ingressar e qual agente deseja registrar.

    Durante configuração, o jitterbit-config comando solicita que você selecione qual grupo de agentes deseja ingressar e qual agente deseja registrar. (Alternativamente, esses valores podem ser fornecidos como parâmetros para jitterbit-config.)

    Ao executar o contêiner, use as variáveis de ambiente abaixo.

Registro manual de um agente privado Docker usando variáveis de ambiente

Para usar o registro manual com agentes privados em contêineres, defina valores para as seguintes variáveis de ambiente e passe-as para o contêiner:

Variável de ambiente Descrição
HARMONY_ORIGIN A URL de login para sua conta Harmony, https://REGION.jitterbit.com, onde REGION é um dos na-east, emea-west, ou apac-southeast.
HARMONY_USERNAME Seu nome de usuário da conta Harmony em texto simples.
HARMONY_PASSWORD Sua senha de conta Harmony em texto simples.
HARMONY_ORG_NAME Nome da sua organização Harmony.
HARMONY_AGENT_GROUP_NAME O nome do grupo de agentes privados e o nome do ambiente associado, separados por um sublinhado.
HARMONY_AGENT_NAME O nome do 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

Dica

Coloque os valores em um arquivo e use o --env-file Opção Docker em vez de múltiplos -e opções.

Registro Automático

Com o registro automático, há duas maneiras de fornecer informações de registro: em um register.json arquivo ou como variáveis de ambiente.

Registre um agente privado do Docker usando o register.json arquivo

Para registrar automaticamente um agente privado do Docker usando um register.json arquivo, siga estes passos:

  1. Crie um diretório e um arquivo conf/register.json contendo o seguinte, com valores definidos de acordo com a tabela abaixo:

    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 Descrição do valor
    cloudUrl A URL de login para sua conta Harmony, https://REGION.jitterbit.com, onde REGION é um dos na-east, emea-west, ou apac-southeast.
    agentGroupId O número de identificação do grupo de agentes privados.
    username Seu nome de usuário da conta Harmony criptografada.
    password Sua senha criptografada da conta Harmony.
    agentNamePrefix Um prefixo para o nome do agente privado gerado automaticamente.
    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 o agente privado do Docker com o conf diretório montado no contêiner /conf diretório. (Veja Registro automático com register.json arquivo para um exemplo.)

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

    Dica

    Você deve usar um credentials.txt arquivo ou um register.json arquivo. O agente privado não iniciará se o conf diretório contém ambos.

Para usar o register.json arquivo em agentes privados Linux não conteinerizados, mova ou remova o /opt/jitterbit/Resources/credentials.txt arquivo, crie um /opt/jitterbit/Resources/register.json arquivo como mostrado acima, então reinicie o agente.

Registre um agente privado do Docker usando variáveis de ambiente

Para registrar automaticamente um agente privado do Docker usando variáveis de ambiente, siga estas etapas:

  1. Crie um arquivo contendo o seguinte, com os valores substituídos de acordo com a tabela abaixo:

    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=
    
    Variável Descrição do valor
    HARMONY_ORIGIN A URL de login para sua conta Harmony, https://REGION.jitterbit.com, onde REGION é um dos na-east, emea-west, ou apac-southeast.
    AUTO_REGISTER_AGENT_GROUP_ID O número de identificação do grupo de agentes privados.
    AUTO_REGISTER_ENCRYPTED_USERNAME Seu nome de usuário da conta Harmony criptografada.
    AUTO_REGISTER_ENCRYPTED_PASSWORD Sua senha criptografada da conta Harmony.
    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 o agente privado do Docker, passando o arquivo de variáveis de ambiente usando o --env-file opção para docker run:

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

    Dica

    Alternativamente, use o -e/--env opção para definir variáveis de ambiente individualmente.

Comparação de register.json parâmetros e variáveis de ambiente

A tabela a seguir compara os parâmetros usados no register.json arquivo com seus equivalentes de variáveis de ambiente:

register.json parâmetro Variável de ambiente Tipo de valor Descrição
(Nenhum) AUTO_REGISTER Booleano (true ou false) Habilitar registro automático.
cloudUrl HARMONY_ORIGIN String A URL da nuvem Harmony : "https://REGION.jitterbit.com" onde REGION é na-east, emea-west, ou apac-southeast.
username AUTO_REGISTER_ENCRYPTED_USERNAME String Versão criptografada do nome de usuário da sua conta Harmony. (Primeira linha de saída de jitterbit-utils -e USERNAME PASSWORD.) Ignorado se token está definido.
password AUTO_REGISTER_ENCRYPTED_PASSWORD String Versão criptografada da senha da sua conta Harmony. (Segunda linha de saída de jitterbit-utils -e USERNAME PASSWORD.) Ignorado se token está definido.
token Nenhuma variável correspondente no momento String Registro de agente privado token de acesso. Se fornecido, username e password são ignorados.
deregisterAgentOnDrainstop AUTO_REGISTER_DEREGISTER_ON_DRAINSTOP Booleano (true ou false) Se true, o agente é removido quando parado. Definido como false para permitir que o agente se registre novamente quando reiniciado. (Veja também DeregisterAgentOnDrainstop.)
agentGroupId AUTO_REGISTER_AGENT_GROUP_ID Inteiro O número de ID do grupo de agentes privados ao qual ingressar.
agentNamePrefix AUTO_REGISTER_AGENT_NAME_PREFIX String O nome do agente privado. Esses tokens são expandidos: %ip%: endereço IP do servidor; %host%: nome do host do servidor; %guid%: um ID aleatório de 8 caracteres.
retryCount AUTO_REGISTER_RETRY_COUNT Inteiro Quantas vezes tentar novamente quando um agente privado falha em registrar. Faixa: 0-300. Padrão: 10.
retryIntervalSeconds AUTO_REGISTER_RETRY_INTERVAL_SECONDS Inteiro Quantos segundos entre as tentativas. Intervalo: 5-600. Padrão: 5.