Integrar com GitHub Enterprise Server

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 7 min. de leitura

    • A integração da aplicação Gestão de ativos de software com a aplicação GitHub Enterprise Server ajuda a rastrear suas assinaturas de software e recuperar licenças não utilizadas.

    Importante:
    Minimize os riscos de segurança e proteja as informações concedendo acesso somente ao usuário ou às permissões de API necessárias.
    Tabela 1. Permissões mínimas do usuário
    Processo Função de usuário necessária na aplicação GitHub Enterprise Server Escopos de autenticação
    Download de assinaturas administrador do site site_admin
    Recuperar assinatura administrador do site site_admin

    Gerar um token de acesso de API para GitHub Enterprise Server

    Gere um token que você pode usar para acessar a GitHub Enterprise Server API.

    Antes de Iniciar

    GitHub Função necessária: administrador do site

    Por Que e Quando Desempenhar Esta Tarefa

    O serviço de hospedagem de repositório GitHub usa tokens de acesso pessoal para conceder aos usuários acesso à API GitHub. Os tokens de acesso pessoal funcionam de forma semelhante aos tokens de acesso OAuth, autorizando solicitações de API. Ao gerar um token de acesso pessoal para autorizar suas solicitações de GitHub Enterprise Server API, você pode obter acesso à GitHub Enterprise Server API.

    Procedimento

    1. Em um navegador da Web, abra sua instância do GitHub Enterprise Server.
    2. Entre na sua conta GitHub.
    3. No cabeçalho da página GitHub, selecione sua foto de perfil e selecione Configurações.
      Suas configurações de perfil são abertas.
    4. No painel de navegação esquerdo, selecione Configurações do desenvolvedor.
      Suas configurações de desenvolvedor estão abertas.
    5. No painel de navegação esquerdo, selecione Tokens de acesso pessoal.
    6. Na página Tokens de acesso pessoal, selecione Gerar novo token.
    7. Se você for solicitado a confirmar sua senha antes de prosseguir, insira sua GitHub senha e selecione Confirmar senha.
    8. No formulário Novo token de acesso pessoal, descreva a finalidade do token no campo Anotação.
    9. Na seção de formulário Selecionar escopos, habilite o escopo do OAuth site_admin marcando a caixa de seleção site_admin.
      Os escopos do OAuth limitam o nível de acesso que a aplicação tem aos recursos protegidos. O escopo do OAuth site_admin permite que você gerencie usuários, organizações e repositórios corporativos.
    10. Selecione Gerar token.
      Seu token de acesso pessoal gera.
    11. Copie o token de acesso e salve-o em um local seguro para uso posterior.

    Criar uma GitHub conexão de servidor empresarial

    Crie uma conexão entre suas aplicações GitHub Enterprise Server e sua instância ServiceNow.

    Antes de Iniciar

    Se você quiser usar um MID Server para comunicação entre sua instância ServiceNow e suas aplicações GitHub Enterprise Server, você deve primeiro configurar um MID Server em sua instância. Consulte MID Server para obter instruções detalhadas.

    ServiceNow Função necessária: administrador

    Procedimento

    1. Em sua instância ServiceNow, navegue até Automação de Processo > Flow Designer.
      O Flow Designer é iniciado em uma nova guia.
    2. Selecione a guia Conexões.
    3. Selecione Exibir detalhes para a conexão do servidor GitHub.
    4. Na lista de conexões disponíveis, localize GitHub Servidor e selecione Configurar.
    5. Na caixa de diálogo Configurar conexão, preencha os campos.
      Tabela 2. Caixa de diálogo Configurar conexão
      Campo Descrição
      Nome da Conexão Nome da GitHub conexão do servidor.
      URL de conexão URL da sua instância GitHub.
      Usar MID Server Opção que permite que sua instância ServiceNow use um MID Server para comunicação com suas aplicações GitHub Enterprise Server.
      • Se sua instância exigir um MID Server, defina este campo como verdadeiro.
      • Se sua instância não exigir um MID Server, deixe este campo em branco.
      Importante:
      Para habilitar esta opção, você já deve ter um MID Server configurado em sua instância. Consulte MID Server para obter instruções detalhadas.
      Chave de API Token de acesso pessoal que permite acessar a GitHub Enterprise Server API. Insira <api-key>, em que <api-key> é o token de acesso pessoal que você gerou em Gerar um token de acesso de API para GitHub Enterprise Server.
    6. Selecione Configurar conexão.

    Criar um GitHub perfil de integração do Enterprise Server

    Crie um perfil de integração do GitHub Enterprise Server para rastrear assinaturas de software e otimizar o licenciamento para suas aplicações GitHub Enterprise Server.

    Antes de Iniciar

    Para criar um perfil de integração do GitHub Enterprise Server, solicite o plug-in Gestão de ativos de software - Gestão de licenças de SaaS (sn_sam_saas_int) na ServiceNow Store.

    ServiceNow Função necessária: sam_integrator ou administrador

    Importante:
    Você deve marcar a caixa de seleção Spoke do GitHub para esta integração ao instalar recursos opcionais na página Application Manager. Para obter mais informações sobre como escolher as aplicações SaaS necessárias, consulte Solicitação Gestão de licenças de SaaS.

    Por Que e Quando Desempenhar Esta Tarefa

    Se você estiver usando Espaço para ativos de software, a opção para criar o GitHub perfil de integração de servidor em IU principal estará inativa.

    Procedimento

    1. Navegue até o perfil de integração.
      InterfaceAção
      IU principal
      1. Navegar até Tudo > Ativo de Software > Licença de SaaS > Perfis de Integração Direta.
      2. Selecione Novo.
      3. Selecione Perfil de assinatura de servidor do GitHub.
      Espaço de ativo do software
      1. Navegar até Operações de licença > Assinaturas de Usuário > Perfis de integração diretos.
      2. Selecione Novo.
      3. Selecione Servidor GitHub na lista suspensa.
      4. Selecione Continuar.
    2. No formulário, preencha os campos.
      Tabela 3. Formulário Perfil de integração
      Campo Descrição
      Nome para exibição Nome do perfil de integração. Por exemplo, GitHub Server Integration.
      Status Status do perfil de integração.
      • Se você não publicou o perfil de integração, este campo será definido automaticamente como Rascunho.
      • Se você já publicou o perfil de integração, este campo será definido automaticamente como Publicado.
      Tipo de perfil Tipo de perfil de integração. Este campo é definido automaticamente como github_server_subscription.
    3. Na seção Configuração de processo, revise as funções de usuário necessárias ou as permissões de API especificadas no campo Configuração do fornecedor para cada processo para minimizar os riscos de segurança e otimizar SaaS licenças.
      Nota:
      Para obter mais informações sobre as funções e os escopos necessários, consulte Tabela de permissões mínimas do usuário.

      • A caixa de seleção Baixar assinaturas está marcada por padrão e você não pode desmarcá-la.

      • Nota:
        A caixa de seleção Baixar atividade está marcada por padrão. Se você desmarcar, o trabalho agendado de atividade SAM - Refresh <displayname> Activity não será criado.
        No campo Analisar atividade do usuário, você também pode selecionar a data e a hora a partir de quando deseja analisar a atividade do usuário. Por padrão, você pode analisar a atividade do usuário até 60 dias antes da data atual e exibir eventos realizados por usuários individuais a partir do momento em que cria este perfil.
        Nota:
        Gestão de ativos de software extrai os eventos a partir do momento em que você começa a analisar a atividade do usuário, independentemente da data de criação do perfil.
        Você pode modificar este valor no campo Limite de última atividade das regras de recuperação de software. Para obter mais informações, consulte Revisar uma regra de recuperação de software.

      • A caixa de seleção Recuperar assinaturas está marcada por padrão. Se você não quiser recuperar assinaturas, poderá desmarcar esta caixa de seleção. Se você desmarcar, os candidatos a remoção serão criados, mas o subfluxo de assinatura de recuperação não será acionado ou o processo de recuperação não será iniciado.

    4. Selecione Save (Salvar).
      Sua instância ServiceNow cria um perfil de integração de rascunho.

      O campo Conexão e credencial é exibido e definido automaticamente como sn_github_spoke.GitHub_Server.

    5. No formulário de perfil de integração, selecione Validar conexão para verificar os detalhes de conexão e credencial desta integração.

      A validação da conexão verifica as APIs Baixar assinaturas e Calcular atividade, mas não as APIs Recuperar assinaturas.

    6. Depois que a conexão for validada, selecione Publicar.
    7. Na caixa de diálogo Confirmação de publicação, selecione OK.
      Nota:
      Se você desmarcar a caixa de seleção Atividade de download após a publicação do perfil de integração, deverá revalidar as conexões e publicar novamente o perfil de integração, pois ocorrem os seguintes eventos:
      • O campo Status no formulário de perfil de integração muda para Rascunho.
      • O botão Validar conexão aparece no formulário.
      • O trabalho SAM - Refresh <displayname> Activity atual é excluído.

    O que Fazer Depois

    Depois que a integração se conecta, sua instância ServiceNow cria automaticamente modelos de software, regras de recuperação e assinaturas de software que são atualizadas diariamente.

    Se você quiser configurar vários perfis de integração com conexões exclusivas, crie aliases secundários para gerenciar diferentes configurações e definições para cada perfil de integração. Para obter mais informações, consulte Crie um alias secundário para configurar vários perfis de integração.

    Revise todas as regras de recuperação geradas automaticamente para recuperar assinaturas de usuário. Para obter mais informações, consulte Revisar uma regra de recuperação de software.

    Crie direitos de software para os modelos de software gerados automaticamente para rastrear o software usado em relação ao software de propriedade.
    A reconciliação também é executada em suas assinaturas como um trabalho agendado ou sob demanda. Você pode exibir os resultados da reconciliação no Workbench de licenças (Gestão de ativos de software aplicação clássica) ou na exibição de uso de licença (Software Asset Workspace). Use esses resultados para determinar sua posição de conformidade de licença e corrigir qualquer não conformidade.