Introdução à residência de dados no GitHub Enterprise Cloud

Configure sua empresa no GHE.com integrando usuários, habilitando a cobrança e migrando dados.

Neste artigo

Ao adotar o GitHub Enterprise Cloud com residência de dados, você pode escolher o local de armazenamento do código e dos dados da sua empresa.

Depois de trabalhar com Equipe de vendas do GitHub para criar uma conta empresarial com uma URL dedicada no GHE.com, você usará este guia para configurar sua empresa. Você terá a oportunidade de:

  • Adicionar usuários configurando a autenticação e o provisionamento com um sistema de gerenciamento de identidades
  • Configurar a cobrança para sua empresa
  • Opcionalmente, migre os dados de outra plataforma
  • Saiba mais sobre os recursos disponíveis, incluindo recursos que funcionam de maneira diferente ou exigem configuração adicional

Após essa configuração inicial, você poderá criar organizações e repositórios, colaborar no código, configurar políticas, entre outros.

Pré-requisitos

  • Você precisa ter sido provisionado com uma empresa no GHE.com.

  • Se você pretende pagar com uma assinatura do Microsoft Azure, precisa ter acesso de administrador ao portal do Azure ou trabalhar com alguém para configurar um fluxo de trabalho de consentimento do administrador. Para obter uma lista completa de pré-requisitos, confira Conectar uma assinatura do Azure.

  • Você precisa garantir que os sistemas cliente confiem nas impressões digitais de chave SSH do GitHub e possam acessar certos nomes de host e endereços IP. Confira "Detalhes de rede do GHE.com".

1. Adicionar usuários à sua empresa

As empresas do GHE.com usam os Enterprise Managed Users. Para criar contas de usuário e permitir acesso à sua nova empresa no GHE.com, você precisa configurar a autenticação e o provisionamento do SCIM. Confira Introdução aos Enterprise Managed Users.

Entrar como o usuário de instalação

Depois de criarmos sua empresa, você receberá um e-mail solicitando que você escolha uma senha para o usuário de configuração, que será usada para configurar a autenticação e o provisionamento. O nome de usuário é um código curto gerado aleatoriamente, acrescentado com o sufixo _admin.

Usar uma janela de navegação anônima ou privada:

  1. Defina a senha de usuário.
  2. Salve os códigos de recuperação do usuário.

Caso precise redefinir a senha para o usuário de instalação, entre em contato com o Suporte do GitHub por meio do Portal de Suporte do GitHub. A opção usual de redefinição de senha, fornecendo seu email, não funcionará.

Criar um personal access token

Em seguida, crie um personal access token que você pode usar para configurar o provisionamento.

  • Você deve estar conectado como o usuário de configuração ao criar o token.
  • O token deve ter pelo menos o escopo scim:enterprise.
  • O token não deve ter expiração.

Para saber como criar um personal access token (classic), consulte "Gerenciar seus tokens de acesso pessoal".

Configurar autenticação

Em seguida, configure como seus membros serão autenticados.

Se você estiver usando o Entra ID como seu IdP, poderá escolher entre o OpenID Connect (OIDC) e o SAML (Security Assertion Markup Language).

  • Recomendamos o OIDC, que inclui suporte para CAP (Políticas de Acesso Condicional).
  • Se precisar ter várias empresas provisionadas por meio de um locatário, você poderá usar o SAML ou o OIDC para a primeira empresa, mas precisará usar o SAML para cada empresa adicional.

Se você estiver usando outro IdP, como Okta ou PingFederate, use o SAML para autenticar seus membros.

Para começar, leia o guia do método de autenticação escolhido.

Configurar provisionamento

Depois de configurar a autenticação, você poderá configurar o provisionamento do SCIM, que é a forma que será usada pelo IdP para criar contas de usuário gerenciadas no GitHub. Confira "Configurando o provisionamento do SCIM para Usuários Gerenciados da Empresa".

Gerenciar associação a organizações

Depois que a autenticação e o provisionamento forem configurados, você poderá começar a gerenciar a associação à organização para os contas de usuário gerenciadas sincronizando os grupos de IdP com as equipes. Confira "Gerenciando associações de equipes com grupos de provedores de identidade".

2. Configurar cobrança

Para pagar licenças e serviços, você pode usar um cartão de crédito, o PayPal ou uma assinatura do Microsoft Azure.

3. Migrar dados

Opcionalmente, para migrar dados existentes para sua nova empresa no GHE.com, use as ferramentas de migração do GitHub.

Script de exemplo para o GitHub Enterprise Importer

O script a seguir demonstra o uso do GitHub Enterprise Importer para a migração de um repositório de origem individual do GitHub.com para um repositório de destino no GHE.com. O parâmetro --target-api-url define sua empresa no GHE.com como o destino da migração.

Você pode usar as definições de variável de ambiente no script como exemplo para criar comandos adicionais que migram dados usando o GitHub Enterprise Importer.

No script a seguir, substitua o seguinte de espaço reservado a seguir por valores reais.

Espaço reservadoDescrição
TARGET-TOKENPAT (Personal access token) para acessar a empresa de destino no GHE.com
SOURCE-TOKENPAT para acessar os recursos de origem no GitHub.com
TARGET-GHE-API-URLA URL para acessar os pontos de extremidade de API da sua empresa. Por exemplo, se o subdomínio da sua empresa for octocorp, esse valor precisará ser https://api.octocorp.ghe.com.
SOURCE-GH-ORGANIZATION-NAMEO nome da organização de origem no GitHub.com.
SOURCE-GH-REPOSITORY-NAMEO nome do repositório de origem no GitHub.com.
TARGET-GHE-ORGANIZATION-NAMEO nome da organização de destino no GHE.com.
TARGET-GHE-REPOSITORY-NAMEO nome do repositório de destino no GHE.com.
Bash
#!/bin/sh

export GH_PAT="TARGET-TOKEN"
export GH_SOURCE_PAT="SOURCE-TOKEN"
export TARGET_API_URL="TARGET-GHE-API-URL"
export GITHUB_SOURCE_ORG="SOURCE-GH-ORGANIZATION-NAME"
export SOURCE_REPO="SOURCE-GH-REPOSITORY-NAME"
export GITHUB_TARGET_ORG="TARGET-GHE-ORGANIZATION-NAME"
export TARGET_REPO="TARGET-GHE-REPOSITORY-NAME"

gh gei migrate-repo --target-api-url $TARGET_API_URL --github-source-org $GITHUB_SOURCE_ORG --source-repo $SOURCE_REPO --github-target-org $GITHUB_TARGET_ORG --target-repo $TARGET_REPO --verbose

4. Saiba mais sobre os recursos do GitHub

Quando você concluir a configuração inicial da sua empresa, você e os membros da empresa poderão começar a usar os recursos do GitHub.

Os recursos disponíveis para o residência de dados no GHE.com são semelhantes aos recursos disponíveis para os contas de usuário gerenciadas no GitHub.com, com algumas adições e exceções. Alguns recursos funcionam de maneira diferente ou exigem configuração adicional comparado ao recurso equivalente do GitHub.com. Confira Visão geral de recursos do GitHub Enterprise Cloud com residência de dados.

Leitura adicional