Integrar com GitHub Enterprise Cloud

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 8 min. de leitura

    • A integração da aplicação Gestão de ativos de software com a aplicação GitHub Enterprise Cloud 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 Enterprise Cloud GitHub Escopos de autenticação
    Baixar assinaturas Proprietário da organização ler:org
    Extrair atividade do usuário Proprietário da organização
    • ler:org
    • repo
    Recuperar assinatura Proprietário da organização write:org

    Gerar um token de acesso de API para GitHub Enterprise Cloud

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

    Antes de Iniciar

    GitHub Função necessária: proprietário da organização

    A conta de usuário usada para autenticação deve ser capaz de ler todos os repositórios na organização da qual fazem parte.

    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 da GitHub Enterprise Cloud API, você pode obter acesso à GitHub Enterprise Cloud API.

    Procedimento

    1. Em um navegador da Web, abra o GitHub.
    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. Selecione Tokens (clássico).
    7. Na página Tokens de acesso pessoal, selecione Gerar novo token.
    8. Selecione Gerar novo token (clássico).
    9. Se você for solicitado a confirmar sua senha antes de prosseguir, insira sua GitHub senha e selecione Confirmar senha.
    10. No formulário Novo token de acesso pessoal, descreva a finalidade do token no campo Anotação.
    11. Para dar uma expiração ao seu token, selecione o menu suspenso Expiração e selecione um valor padrão ou use o seletor de calendário.
    12. Na seção de formulário Selecionar escopos, habilite os escopos do OAuth repo, write:org e read:org.
      Os escopos do OAuth limitam o nível de acesso que a aplicação tem aos recursos protegidos. O escopo do OAuth de repositório oferece controle total sobre seus repositórios privados. Os escopos do OAuth write:org e read:org permitem que você gerencie toda a organização, incluindo todas as equipes, projetos e associações. Consulte Escopos para aplicações OAuth para obter mais informações sobre GitHub escopos OAuth.
      1. Habilite o escopo do OAuth do repositório marcando a caixa de seleção do repositório.
        Ao habilitar este escopo do OAuth, você habilita automaticamente os escopos do OAuth repo:status, repo_deployment, public_repo, repo:invite security_events.
      2. Habilite o escopo do OAuth write:org e read:org.
    13. Selecione Gerar token.
      Seu token de acesso pessoal gera.
    14. Copie o token de acesso e salve-o em um local seguro para uso posterior.
    15. Para usar seu token para acessar recursos de propriedade de uma organização que usa logon único SAML, autorize o token.
      Para obter mais informações, consulte Autorização de um token de acesso pessoal para uso com logon único SAML.

    Criar uma GitHub conexão do Enterprise Cloud

    Crie uma conexão entre suas GitHub aplicações Enterprise Cloud 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 Cloud, 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.
      A guia Flow Designer é criada.
    2. Selecione a guia Conexões.
    3. Selecione Exibir detalhes para sua conexão GitHub.
    4. Na lista de conexões disponíveis, localize GitHub 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 conexão GitHub.
      URL de Conexão URL do endpoint da API GitHub.

      Insira https://api.github.com.
      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 Cloud.
      • 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 Cloud API.
      • Se a versão do spoke GitHub instalada for 2.2.5 ou superior, insira<api-key> .
      • Se a versão do spoke GitHub instalada for anterior à 2.2.5, insira Portador<api-key> .
      O <api-key> é o token de acesso pessoal que você gerou em Gerar um token de acesso de API para GitHub Enterprise Cloud
    6. Selecione Configurar conexão.

    Criar um GitHub Enterprise perfil de integração em nuvem

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

    Antes de Iniciar

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

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

    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 em nuvem em IU principal estará inativa.

    Procedimento

    1. Navegue até o perfil de integração.
      InterfaceAção
      IU principal
      1. Navegar até Todos > Ativo de Software > Licença de SaaS > Perfis de Integração Direta.
      2. Selecione Novo.
      3. Selecione Perfil de integração em nuvem do GitHub.
      Espaço de ativo do software
      1. Navegar até Operações de licença > Assinaturas de Usuário > Perfis de integração direta.
      2. Selecione Novo.
      3. Selecione GitHub Cloud 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 de exibição Nome do perfil de integração. Por exemplo, GitHub Cloud Integration.
      Conexão e Credencial Alias de conexão e credencial para o spoke GitHub.

      Este campo é definido automaticamente como sn_github_spoke.GitHub.
      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_cloud_subscription.
    3. Na guia Subfluxo de assinatura de download, verifique se o campo Subfluxo está definido como Assinaturas de download do GitHub Cloud.
      Gestão de ativos de software O extrai os membros, colaboradores externos, convites pendentes e colaboradores externos pendentes para fornecer uma exibição completa das assinaturas do GitHub Enterprise Cloud.
      Importante:
      Para extrair colaboradores externos pendentes, habilite a propriedade do sistema sn_sam_saas_int.pull_pending_collaborator_github. Um número maior de repositórios levaria a um número maior de transações de API.
    4. Na guia Calcular subfluxo de atividade, verifique se o campo Subfluxo está definido como GitHub Cloud Update User Activity.
      Você também pode selecionar a data e a hora em que deseja analisar a atividade do usuário no campo Analisar atividade do usuário de. 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.
      Dica:
      Para evitar problemas de desempenho com este subfluxo, a melhor abordagem é definir o campo Analisar atividade do usuário de para um máximo de sete dias antes da data atual.
    5. Na guia Recuperar subfluxo de assinatura, verifique se o campo Subfluxo está definido como Recuperar assinatura do GitHub Cloud.
    6. Selecione Salvar.
      Sua instância ServiceNow cria um perfil de integração de rascunho. O perfil de integração usa os subfluxos GitHub Assinaturas de download na nuvem, GitHub Atividade do usuário de atualização na nuvem e GitHub Assinatura de recuperação na nuvem para recuperar dados do usuário de suas aplicações na nuvem GitHub Enterprise.
    7. Depois que o formulário for recarregado, selecione Publicar.
      A caixa de diálogo Confirmação de publicação é aberta.
    8. Na caixa de diálogo, selecione OK.

    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 usuário que são atualizadas diariamente.

    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.