Configurar plug-in Jenkins

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 4 min. de leitura
  • Configure Jenkins para enviar notificações em tempo real para suas execuções de pipeline para Velocidade de mudança para DevOps.

    Antes de Iniciar

    Função necessária: administrador do Jenkins

    Procedimento

    1. Instale o plug-in ServiceNow DevOps no Jenkins Marketplace navegando até Gerenciar Jenkins > Configuração do sistema > Plug-ins na sua instância do Jenkins.
    2. Pesquise o plug-in ServiceNow DevOps e selecione-o e, em seguida, selecione Instalar.

    Configurar webhooks manualmente para Jenkins

    Configure webhooks no Jenkins para enviar notificações de sincronização para a aplicação Velocidade de mudança para DevOps.

    Antes de Iniciar

    Função necessária: sn_devops.admin ou sn_devops.tool_owner em Velocidade de mudança para DevOps, administrador do Jenkins

    Por Que e Quando Desempenhar Esta Tarefa

    Você pode adicionar um total de dez configurações do ServiceNow DevOps. Por exemplo, você pode configurar Jenkins conexões para suas instâncias de Desenvolvimento, Teste, Produção e assim por diante.

    Se você for um cliente de atualização, deverá baixar e instalar o plug-in Jenkins mais recente para habilitar várias configurações ServiceNow. Após a instalação, a configuração existente será mantida e se tornará a configuração padrão.

    Na seção Configuração de DevOps da ServiceNow em Jenkins, os valores no campo Nome e a combinação dos campos URL da instância e ID da ferramenta de Orquestração devem ser exclusivos.

    Se você optar por configurar automaticamente uma ferramenta de ServiceNow, a configuração existente para ServiceNow Configuração de DevOps será substituída em Jenkins.

    Se a Configuração de DevOps estiver instalada, você só poderá configurar o Jenkins manualmente.

    Procedimento

    1. Em Velocidade de mudança para DevOps, escolha Configurar manualmente ao configurar a instância da ferramenta para enviar dados.
      Configure os webhooks automaticamente.
    2. Selecione Copiar no campo apropriado para copiar o valor para a área de transferência.

      O rótulo do campo muda para Copiado, mas você pode copiar várias vezes.

      Configure os webhooks manualmente.
    3. No Jenkins, navegue até Gerenciar Jenkins > Configuração do sistema > Gerenciar plug-ins > Configurar sistema.
    4. Na seção Configuração de DevOps da ServiceNow, selecione Adicionar.
      Nota:
      Você pode adicionar várias conexões selecionando Adicionar para cada nova configuração.
    5. Configure o plug-in preenchendo os campos.

      Quando habilitado, Jenkins começa a enviar eventos para DevOps como eventos de entrada.

      Nota:
      Os valores fazem distinção entre maiúsculas e minúsculas.

      Campos a serem configurados no Jenkins.

      Campo Descrição
      Ativo Selecione esta opção para ativar a conexão. Por padrão, esta opção é selecionada quando você seleciona Adicionar para uma nova conexão.
      Nota:
      Todas as conexões com Ativo habilitado enviarão notificações de webhook para a execução do pipeline. No entanto, para a etapa de mudança, somente a conexão especificada será considerada.
      Padrão Selecione esta opção para tornar a conexão padrão quando o nome da conexão não for passado em uma etapa existente em um pipeline.
      Nota:
      Não selecionar esta opção quando houver apenas uma conexão disponível resultará em erro.
      Nome Nome exclusivo da conexão.
      Nota:
      O valor do nome é gerado automaticamente quando você configura automaticamente uma conexão de ServiceNow.
      URL da instância

      Insira a URL da instância da ServiceNow que você copiou na etapa 2. Por exemplo, https://<your-instance> .service-now.com .

      ID da ferramenta de Orquestração

      O sys_id da ferramenta de orquestração que você copiou na etapa 2.

      Como alternativa, você pode copiar este valor da URL do webhook (valortoolid ) ou obtê-lo diretamente usando o comando Copiar sys_id no registro da Ferramenta de Orquestração.

      Nota:
      A combinação dos valores de URL da instância e ID da ferramenta de Orquestração deve ser exclusiva para cada conexão.
      ID da ferramenta de artefato

      O sys_id da ferramenta de artefato.

      Credenciais

      Selecione as credenciais de autenticação básica que você deseja usar para se conectar ao Jenkins.

      1. Para adicionar credenciais, selecione Adicionar.
      2. No campo Nome de usuário, insira os detalhes do usuário de integração de DevOps. Por padrão, é devops.integration.user.
      3. No campo Senha, insira a senha do usuário de integração de DevOps.
      Credenciais secretas

      Selecione o token secreto que você copiou na etapa 2. Como alternativa, você pode executar as etapas a seguir para obter o token secreto do registro da ferramenta.

      1. Copie o token secreto da ferramenta Jenkins em Mudança de DevOps.
        • Espaço: navegue até o registro da ferramenta, selecione Configurar e copie o token secreto.
        • IU clássica: navegue até o registro da ferramenta e selecione Copiar token.
      2. Para adicionar tokens, selecione Adicionar.
      3. Na lista Tipo, selecione Texto secreto.
      4. No campo Segredo, insira o token secreto gerado ao criar a conexão da ferramenta Jenkins em DevOps.
      5. No campo ID, insira um nome para o token.
      Nível de Log O nível de mensagens de log que você deseja armazenar no Jenkins logs/ ServiceNow log recorder.
      Selecione uma das seguintes opções:
      • herança
      • off
      • grave
      • aviso
      • informações
      • config
      • fino
      • mais fino
      • melhor
      • tudo

      Para obter mais informações sobre níveis de log e registradores de log, consulte Jenkins níveis de log e registradores de log

      Forçar verificação de acompanhamento

      Marque a caixa de seleção para fazer uma chamada de API REST (POST) para Jenkins para cada execução de pipeline para determinar se o pipeline é rastreado ou não.

      Desmarque a caixa de seleção para armazenar detalhes no arquivo snPipelineInfo.json e parar de fazer chamadas de API para cada execução de pipeline.

      Nota:
      Quando um pipeline for rastreado, todas as configurações ativas do Jenkins receberão notificações de trabalho.
      Verificação de acompanhamento do pipeline de solicitação de extração

      Marque a caixa de seleção para habilitar o acompanhamento de pipelines de solicitação de pull.

      Nota:
      Quando um pipeline for rastreado, todas as configurações ativas do Jenkins receberão notificações de trabalho.
    6. Selecione Testar Conexão.
      Verifique se a mensagem de conexão bem-sucedida é exibida.
      • Se você tiver adicionado credenciais de autenticação básica, a mensagem será exibida após a conexão bem-sucedida: A conexão usando "Credenciais" foi bem-sucedida.
      • Se você adicionou o token secreto, na conexão bem-sucedida, verá a mensagem: A conexão usando "Credenciais secretas" foi bem-sucedida.
    7. Selecione Aplicar para aplicar as mudanças e selecione Salvar.