Como migrar repositórios do GitHub Enterprise Server para o GitHub Enterprise Cloud

Você pode migrar repositórios do GitHub Enterprise Server para o GitHub Enterprise Cloud usando a GitHub CLI ou a API.

Tool navigation

Neste artigo

Sobre as migrações de repositório com o GitHub Enterprise Importer

Você pode executar a migração com a GitHub CLI ou a API.

A GitHub CLI simplifica o processo de migração e é recomendada para a maioria dos clientes. Os clientes avançados com necessidades de personalização intensiva podem usar a API para criar integrações próprias ao GitHub Enterprise Importer.

Se você optar por usar a API, precisará escrever seus scripts ou usar um cliente HTTP como o Insomnia. Saiba mais sobre como começar a usar as APIs do GitHub em Introdução à API REST e Realizar chamadas com o GraphQL.

Para migrar seus repositórios do GitHub Enterprise Server para o GitHub Enterprise Cloud com as APIs, você vai:

  1. Criar um personal access token para a organização de origem e de destino
  2. Buscar a ownerId da organização de destino no GitHub Enterprise Cloud
  3. Configurar uma origem de migração por meio da API do GraphQL do GitHub para identificar a origem da migração
  4. Para cada repositório que você deseja migrar, repita essas etapas.
    • Use a API REST do sua instância do GitHub Enterprise Server para gerar arquivos de migração para seu repositório
    • Carregue os arquivos de migração em um local em que eles possam ser acessados pelo GitHub
    • Inicie sua migração usando a API do GraphQL para o destino de migração, transmitindo as URLs de arquivo morto
    • Verificar o status da migração por meio da API do GraphQL
    • Validar a migração e verificar o log de erros

Para ver instruções para usar os dados da GitHub CLI, use o alternador de ferramentas na parte superior da página.

Pré-requisitos

  • Recomendamos fortemente que você faça uma execução de avaliação da migração e conclua a migração de produção logo em seguida. Para saber mais sobre execuções de avaliação, confira Visão geral de uma migração entre produtos GitHub.
  • Certifique-se de entender os dados que serão migrados e as limitações de suporte conhecidas do Importador. Para obter mais informações, confira Sobre migrações entre produtos GitHub.
  • Embora não seja necessário, recomendamos interromper o trabalho durante a migração de produção. O Importer não dá suporte a migrações delta, ou seja, as alterações que ocorrerem durante a migração não serão migradas. Se você optar por não interromper o trabalho durante a migração de produção, precisará migrar manualmente essas alterações.
  • Nas organizações de origem e de destino, você precisa ser um proprietário da organização ou receber a função de migrador. Para saber mais, confira Gerenciando o acesso para uma migração entre produtos GitHub.
  • Quando você usa o GitHub Enterprise Server 3.8 ou superior para configurar o armazenamento de blobs, precisa acessar o Console de Gerenciamento.

Etapa 1. Criar o personal access token

  1. Crie e registre um personal access token (classic) que será autenticado para a organização de destino no GitHub Enterprise Cloud, verificando se o token atende a todos os requisitos. Para saber mais, confira Gerenciando o acesso para uma migração entre produtos GitHub.
  2. Crie e registre um personal access token que será autenticado para a organização de origem, verificando se esse token também atende a todos os mesmos requisitos.

Etapa 2: Obter a ownerId da organização de destino

Como proprietário de uma organização no GitHub Enterprise Cloud, use a consulta GetOrgInfo para retornar a ownerId, também chamada de ID da organização, na organização da qual você deseja ser proprietário dos repositórios migrados. Você precisará da ownerId para identificar seu destino de migração.

Consulta GetOrgInfo

query(
  $login: String!
){
  organization (login: $login)
  {
    login
    id
    name
    databaseId
  }
}
Variável da consultaDescrição
loginO nome da sua organização.

Resposta GetOrgInfo

{
  "data": {
    "organization": {
      "login": "Octo",
      "id": "MDEyOk9yZ2FuaXphdGlvbjU2MTA=",
      "name": "Octo-org",
      "databaseId": 5610
    }
  }
}

Neste exemplo, MDEyOk9yZ2FuaXphdGlvbjU2MTA= é a ID da organização ou ownerId, que usaremos na próxima etapa.

Etapa 3: Configurar o armazenamento de blobs

Como muitas instâncias do GitHub Enterprise Server são protegidas por firewalls, para o GitHub Enterprise Server versões 3.8 ou superiores, usamos o armazenamento de blobs como um local intermediário para armazenar seus dados que o GitHub poderá acessar.

Primeiro, você precisa configurar o armazenamento de blobs com um provedor de nuvem com suporte e, depois, definir as configurações no Console de Gerenciamento do sua instância do GitHub Enterprise Server.

Note

Você só precisará configurar o armazenamento de blobs se usar o GitHub Enterprise Server versões 3.8 ou superiores. Se você usa o GitHub Enterprise Server versões 3.7 ou inferiores, vá para a Etapa 4: Configurar uma origem de migração no GitHub Enterprise Cloud.

O armazenamento de blobs é necessário para migrar repositórios com metadados ou origem do Git grandes. Se você usar o GitHub Enterprise Server versões 3.7 ou inferiores, não poderá executar migrações em que as exportações de metadados ou de origem do Git excedam 2 GB. Para executar essas migrações, atualize para o GitHub Enterprise Server versões 3.8 ou superiores.

Como configurar o armazenamento de blobs com um provedor de nuvem compatível

A GitHub CLI dá suporte aos seguintes provedores de armazenamento de blobs:

  • AWS (Amazon Web Services) S3
  • Armazenamento do Blobs do Azure

Como configurar um bucket de armazenamento da AWS S3

Na AWS, configure um bucket da S3. Para obter mais informações, confira Como criar um bucket na documentação da AWS.

Você também precisará de uma chave de acesso da AWS e uma chave secreta com as seguintes permissões:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:GetObject",
                "s3:ListBucketMultipartUploads",
                "s3:AbortMultipartUpload",
                "s3:ListBucket",
                "s3:DeleteObject",
                "s3:ListMultipartUploadParts"
            ],
            "Resource": [
                "arn:aws:s3:::github-migration-bucket",
                "arn:aws:s3:::github-migration-bucket/*"
            ]
        }
    ]
}

Note

O GitHub Enterprise Importer não exclui o arquivo da AWS após a conclusão da migração. Para reduzir os custos de armazenamento, recomendamos configurar a exclusão automática do arquivo após um período. Para obter mais informações, confira Como definir a configuração do ciclo de vida em um bucket na documentação da AWS.

Como configurar uma conta do Armazenamento de Blobs do Azure

No Azure, crie uma conta de armazenamento e anote a cadeia de conexão. Para obter mais informações, confira Gerenciar chaves de acesso da conta de armazenamento no Microsoft Docs.

Note

O GitHub Enterprise Importer não exclui o arquivo do Armazenamento de Blobs do Azure após a conclusão da migração. Para reduzir os custos de armazenamento, recomendamos configurar a exclusão automática do arquivo após um período. Para obter mais informações, confira Otimizar os custos gerenciando automaticamente o ciclo de vida dos dados no Microsoft Docs.

Como configurar o armazenamento de blobs no Console de Gerenciamento do sua instância do GitHub Enterprise Server

Depois de configurar um bucket de armazenamento da AWS S3 ou uma conta de armazenamento do Armazenamento de Blobs do Azure, configure o armazenamento de blobs no Console de Gerenciamento do sua instância do GitHub Enterprise Server. Para obter mais informações sobre o Console de Gerenciamento, confira Como administrar sua instância no console de gerenciamento.

  1. Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .

  2. Se você ainda não está na página "Administrador do site", no canto superior esquerdo, clique em Administrador do site. 1. Na barra lateral " Administrador do site", clique em Console de Gerenciamento .

  3. Faça logon no Console de Gerenciamento.

  4. Na barra de navegação superior, clique em Configurações.

  5. Em Migrações, clique em Habilitar as Migrações do GitHub .

  6. Opcionalmente, para importar as configurações de armazenamento que você definiu para o GitHub Actions, selecione Copiar configurações do Armazenamento em Ações. Para obter mais informações, confira Como habilitar o GitHub Actions com o Armazenamento de Blobs do Azure e Como habilitar o GitHub Actions com o armazenamento da Amazon S3.

    Note

    Depois de copiar as configurações de armazenamento, talvez ainda seja necessário atualizar a configuração da sua conta de armazenamento em nuvem para trabalhar com o GitHub Enterprise Importer. Em particular, você deve garantir que os endereços IP do GitHub estejam permitidos. Para saber mais, confira Gerenciando o acesso para uma migração entre produtos GitHub.

  7. Se você não importar as configurações de armazenamento do GitHub Actions, selecione Armazenamento de Blobs do Azure ou Amazon S3 e preencha os detalhes necessários.

    Note

    Caso esteja usando o Amazon S3, deverá configurar a "AWS Service URL" como o ponto de extremidade padrão da região da AWS onde seu bucket está localizado. Por exemplo, se o bucket estiver localizado na região eu-west-1, a "URL do serviço AWS" será https://s3.eu-west-1.amazonaws.com. A rede da instância do GitHub Enterprise Server deve permitir o acesso a esse host. Não há suporte para pontos de extremidade de gateway, como bucket.vpce-0e25b8cdd720f900e-argc85vg.s3.eu-west-1.vpce.amazonaws.com. Para obter mais informações sobre pontos de extremidade de gateway, consulte Pontos de extremidade de gateway d Amazon S3 na documentação da AWS.

  8. Clique em Testar configurações de armazenamento.

  9. Clique em Salvar alterações.

Como permitir o acesso à rede

Se você configurou regras de firewall na sua conta de armazenamento, verifique se permitiu o acesso aos intervalos de IP para o destino de migração. Confira Gerenciando o acesso para uma migração entre produtos GitHub.

Etapa 4: Configurar uma origem de migração no GitHub Enterprise Cloud

Você pode configurar uma origem de migração usando a consulta createMigrationSource. Você precisará fornecer a ownerId, ou a ID da organização, coletada da consulta GetOrgInfo.

A origem de migração é a sua organização no GitHub Enterprise Server.

Mutação createMigrationSource

mutation createMigrationSource($name: String!, $url: String!, $ownerId: ID!) {
  createMigrationSource(input: {name: $name, url: $url, ownerId: $ownerId, type: GITHUB_ARCHIVE}) {
    migrationSource {
      id
      name
      url
      type
    }
  }
}

Note

Lembre-se de usar GITHUB_ARCHIVE para type.

Variável da consultaDescrição
nameUm nome para a origem da migração. Esse nome se destina à sua referência, ou seja, você pode usar qualquer cadeia de caracteres.
ownerIdA ID da sua organização no GitHub Enterprise Cloud.
urlA URL do sua instância do GitHub Enterprise Server. Essa URL não precisa ser acessível no GitHub Enterprise Cloud.

Resposta createMigrationSource

{
  "data": {
    "createMigrationSource": {
      "migrationSource": {
        "id": "MS_kgDaACRjZTY5NGQ1OC1mNDkyLTQ2NjgtOGE1NS00MGUxYTdlZmQwNWQ",
        "name": "GHES Source",
        "url": "https://my-ghes-hostname.com",
        "type": "GITHUB_ARCHIVE"
      }
    }
  }
}

Neste exemplo, MS_kgDaACRjZTY5NGQ1OC1mNDkyLTQ2NjgtOGE1NS00MGUxYTdlZmQwNWQ é a ID de origem da migração, que usaremos em uma etapa posterior.

Etapa 5: Gerar arquivos de migração no sua instância do GitHub Enterprise Server

Você usará a API REST para iniciar duas "migrações" no GitHub Enterprise Server: uma para gerar um arquivo da origem Git do repositório e outra para gerar um arquivo dos metadados do repositório (como problemas e solicitações de pull).

Para gerar o arquivo de origem do Git, faça uma solicitação POST a https://HOSTNAME/api/v3/orgs/ORGANIZATION/migrations, substituindo HOSTNAME pelo nome do host do sua instância do GitHub Enterprise Server e ORGANIZATION pelo logon da sua organização.

No corpo, especifique o repositório individual que deseja migrar. A solicitação será parecida com esta:

POST /api/v3/orgs/acme-corp/migrations HTTP/1.1
Accept: application/vnd.github+json
Authorization: Bearer <TOKEN>
Content-Type: application/json
Host: github.acmecorp.net

{
  "repositories": ["repository_to_migrate"],
  "exclude_metadata": true
}

Para gerar o arquivo de metadados, envie uma solicitação semelhante para a mesma URL com o seguinte corpo:

{
  "repositories": ["repository_to_migrate"],
  "exclude_git_data": true,
  "exclude_releases": false,
  "exclude_owner_projects": true
}

Cada uma dessas duas chamadas à API retornará uma resposta JSON, incluindo a ID da migração iniciada.

HTTP/1.1 201 Created

{
  "id": 123,
  // ...
}

Para obter mais informações, confira Iniciar uma migração de organização.

A geração dos arquivos pode demorar um pouco, dependendo do volume de dados. Verifique regularmente o status das migrações com a API "Obter um status de migração da organização" até que o state da migração mude para exported.

GET /api/v3/orgs/acme-corp/migrations/123 HTTP/1.1
Accept: application/vnd.github+json
Authorization: Bearer <TOKEN>
Host: github.acmecorp.net

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 123,
  "state": "exported",
  // ...
}

Para obter mais informações, confira Obter um status de migração da organização.

Note

Se a migração passar para o estado failed em vez de para o estado exported, tente iniciá-la novamente. Em caso de falhas repetidas na migração, recomendamos gerar os arquivos usando ghe-migrator em vez da API.

Siga as etapas descritas em Como exportar dados de migração da sua empresa, adicionando apenas um repositório à migração. No final do processo, você terá um arquivo de migração individual com os metadados e a origem do Git e poderá ir para a etapa 6 deste artigo.

Depois que o state de uma migração passar para exported, busque a URL da migração usando a API "Baixar um arquivo de migração da organização".

GET /api/v3/orgs/acme-corp/migrations/123/archive HTTP/1.1
Accept: application/vnd.github+json
Authorization: Bearer <TOKEN>
Host: github.acmecorp.net

HTTP/1.1 302 Found
Location: https://media.github.acmecorp.net/migrations/123/archive/cca2ebe9-7403-4ffa-9b6a-4c9e16c94410?token=AAAAABEWE7JP4H2HACKEGMTDOYRC6

A API retornará uma resposta 302 Found com um cabeçalho Location redirecionando você para a URL em que o arquivo para download está localizado. Baixe os dois arquivos: um para a origem do Git e o outro para os metadados.

Para obter mais informações, confira Baixar um arquivo de migração da organização.

Depois que as duas migrações forem concluídas e você baixar os arquivos, vá para a próxima etapa.

Etapa 6: Carregar os arquivos de migração

Para importar seus dados para o GitHub Enterprise Cloud, você precisa transmitir os dois arquivos para cada repositório (metadados e origem do Git) do computador para o GitHub usando a API do GraphQL.

Se estiver usando o GitHub Enterprise Server 3.7 ou inferior, você primeiro precisará gerar URLs para os arquivos acessíveis para o GitHub. A maioria dos clientes opta por carregar os arquivos no serviço de armazenamento de blobs de um provedor de nuvem, como a Amazon S3 ou o Armazenamento de Blobs do Azure e, em seguida, gerar uma URL de curta duração para cada um.

Se você estiver usando o GitHub Enterprise Server 3.8 ou superior, a instância vai carregar os arquivos e gerar as URLs para você. O cabeçalho Location da etapa anterior retornará a URL de curta duração.

Talvez seja necessário incluir os intervalos de IP do GitHub na lista de permitidos. Para saber mais, confira Gerenciando o acesso para uma migração entre produtos GitHub.

Etapa 7: Iniciar a migração do repositório

Quando você inicia uma migração, um repositório individual e os dados complementares são migrados para um novo repositório do GitHub identificado por você.

Caso você deseje mover vários repositórios ao mesmo tempo da mesma organização de origem, coloque várias migrações na fila. É possível executar até cinco migrações de repositório ao mesmo tempo.

Mutação startRepositoryMigration

mutation startRepositoryMigration (
  $sourceId: ID!,
  $ownerId: ID!,
  $repositoryName: String!,
  $continueOnError: Boolean!,
  $accessToken: String!,
  $githubPat: String!,
  $gitArchiveUrl: String!,
  $metadataArchiveUrl: String!,
  $sourceRepositoryUrl: URI!,
  $targetRepoVisibility: String!
){
  startRepositoryMigration( input: {
    sourceId: $sourceId,
    ownerId: $ownerId,
    repositoryName: $repositoryName,
    continueOnError: $continueOnError,
    accessToken: $accessToken,
    githubPat: $githubPat,
    targetRepoVisibility: $targetRepoVisibility
    gitArchiveUrl: $gitArchiveUrl,
    metadataArchiveUrl: $metadataArchiveUrl,
    sourceRepositoryUrl: $sourceRepositoryUrl,
  }) {
    repositoryMigration {
      id
      migrationSource {
        id
        name
        type
      }
      sourceUrl
    }
  }
}
Variável da consultaDescrição
sourceIdA origem de migração id retornou da mutação createMigrationSource.
ownerIdA ID da sua organização no GitHub Enterprise Cloud.
repositoryNameUm nome de repositório exclusivo personalizado não usado atualmente por nenhum dos seus repositórios pertencentes à organização no GitHub Enterprise Cloud. Um problema de log de erros será criado neste repositório quando a migração for concluída ou tiver sido interrompida.
continueOnErrorConfiguração de migração que permite que a migração continue ao encontrar erros que não causam falha na migração. Deve ser true ou false. Recomendamos fortemente definir continueOnError como true, de modo que a migração continue, a menos que o Importer não possa mover a origem do Git ou o Importer tenha perdido a conexão e não possa se reconectar para concluir a migração.
githubPatO personal access token da sua organização de destino no GitHub Enterprise Cloud.
accessTokenOs dados do personal access token da origem.
targetRepoVisibilityA visibilidade do novo repositório. Deve ser private, public ou internal. Se isso não estiver definido, seu repositório será migrado como privado.
gitArchiveUrlUma URL acessível para o GitHub Enterprise Cloud para o arquivo de origem do Git.
metadataArchiveUrlUma URL acessível para o GitHub Enterprise Cloud para o arquivo de metadados.
sourceRepositoryUrlA URL do repositório na instância do GitHub Enterprise Server. Isso é obrigatório, mas o GitHub Enterprise Cloud não se comunicará diretamente com a sua instância do GitHub Enterprise Server.

Para ver os requisitos do personal access token, confira Gerenciando o acesso para uma migração entre produtos GitHub.

Na próxima etapa, você usará a ID de migração retornada da mutação startRepositoryMigration para verificar o status da migração.

Etapa 8: Verificar o status da migração

Para detectar qualquer falha de migração e garantir que a migração esteja funcionando, verifique o status da migração usando a consulta getMigration. Você também pode verificar o status de várias migrações com getMigrations.

A consulta getMigration retornará com um status para informar se a migração é queued, in progress, failed ou completed. Em caso de falha na migração, o Importer fornecerá um motivo para a falha.

Consulta getMigration

query (
  $id: ID!
){
  node( id: $id ) {
    ... on Migration {
      id
      sourceUrl
      migrationSource {
        name
      }
      state
      failureReason
    }
  }
}
Variável da consultaDescrição
idA id da migração que a mutação startRepositoryMigration retornou.

Etapa 9: Validar a migração e verificar o log de erros

Para concluir a migração, recomendamos que você verifique o problema "Log de Migração". Esse problema é criado no GitHub no repositório de destino.

Captura de tela de um problema com o título "Log de Migração". O segundo comentário no problema inclui os logs de uma migração.

Por fim, recomendamos que você revise os repositórios migrados para uma verificação de integridade.