Acerca de las migraciones de organizaciones con GitHub Enterprise Importer
Puedes ejecutar la migración con la GitHub CLI o la API.
La GitHub CLI simplifica el proceso de migración y se recomienda para la mayoría de los clientes. Los clientes avanzados con necesidades de personalización intensivas pueden usar la API para crear sus propias integraciones con GitHub Enterprise Importer.
Requisitos previos
- Se recomienda encarecidamente realizar una ejecución de prueba de la migración y completar la migración de producción poco después. Para más información sobre las ejecuciones de prueba, consulta "Introducción a una migración entre productos de GitHub".
- Asegúrate de comprender los datos que se migrarán y las limitaciones de compatibilidad conocidas del importador. Para obtener más información, consulte "Acerca de las migraciones entre productos de GitHub".
- Aunque no es necesario, se recomienda detener el trabajo durante la migración de producción. Importer no admite migraciones diferenciales, por lo que los cambios que se produzcan durante la migración no se migrarán. Si decides no detener el trabajo durante la migración de producción, tendrás que migrar manualmente estos cambios.
- Para la organización de origen, debes ser propietario de la organización o tener el rol de migrador. Para obtener más información, vea «Administración del acceso para una migración entre productos de GitHub».
- Para la cuenta empresarial de destino, debes ser propietario de la empresa.
Paso 0: Preparación para usar GraphQL API de GitHub
Para realizar consultas de GraphQL, tendrás que escribir scripts propios, o bien usar un cliente HTTP como Insomnia.
Para más información sobre cómo empezar a trabajar con GraphQL API de GitHub, incluido cómo autenticarse, consulta "Formar llamados con GraphQl".
Paso 1: Obtención del id. empresarial para el destino de la migración
Como propietario de la empresa en GitHub.com, usa la siguiente consulta para devolver el identificador de la cuenta empresarial a la que deseas que pertenezca la organización migrada. Necesitarás el identificador empresarial para identificar el destino de la migración.
query(
$slug: String!
){
enterprise (slug: $slug)
{
slug
id
}
}
Variable de consulta | Descripción |
---|---|
slug | El slug de aplicación de la cuenta empresarial, que puedes identificar examinando la dirección URL de tu empresa, https://github.com/enterprises/SLUG . |
Paso 2: Inicio de la migración de la organización
Cuando inicias la migración, una única organización y sus datos adjuntos se migran a una nueva organización dentro de la empresa de destino que especifiques.
mutation startOrganizationMigration (
$sourceOrgUrl: URI!,
$targetOrgName: String!,
$targetEnterpriseId: ID!,
$sourceAccessToken: String!,
$targetAccessToken: String!
){
startOrganizationMigration( input: {
sourceOrgUrl: $sourceOrgUrl,
targetOrgName: $targetOrgName,
targetEnterpriseId: $targetEnterpriseId,
sourceAccessToken: $sourceAccessToken,
targetAccessToken: $targetAccessToken
}) {
orgMigration {
id
}
}
}
Variable de consulta | Descripción |
---|---|
sourceOrgUrl | Dirección URL de la organización de origen, como https://github.com/octo-org . |
targetOrgName | El nombre que quiere que tenga la nueva organización. Debe ser exclusivo en GitHub.com. |
targetEnterpriseId | Identificador de la empresa en la que deseas crear la nueva organización, devuelto en el paso 2. |
sourceAccessToken | Tu personal access token (classic) para la organización de origen. Para saber los requisitos, consulta "Administración del acceso para una migración entre productos de GitHub." |
targetAccessToken | Tu personal access token (classic) para la empresa de destino. |
En el paso siguiente, usarás el id. de migración devuelto por la mutación startOrganizationMigration
para comprobar el estado de la migración.
Paso 3: Comprobación del estado de la migración
Para detectar errores de migración y asegurarte de que la migración funciona, puedes consultar los elementos OrganizationMigration
que has creado para ver el estado de migración mediante la consulta getMigration
.
La consulta devolverá un estado para informarte de si la migración es queued
, in progress``failed
o completed
, aparte de información sobre cuántos repositorios están esperando para migrarse. Si se ha producido un error en la migración, en Importer se proporcionará un motivo para el error.
query (
$id: ID!
){
node( id: $id ) {
... on OrganizationMigration {
id
sourceOrgUrl
targetOrgName
state
failure_reason
remaining_repositories_count
total_repositories_count
}
}
}
Variable de consulta | Descripción |
---|---|
id | id de tu migración. |
Paso 1: Instalación de la GEI extension of the GitHub CLI
Si se trata de la primera migración, tendrás que instalar la GEI extension of the GitHub CLI. Para más información sobre la GitHub CLI, consulta "Acerca del CLI de GitHub".
-
Instala la GitHub CLI. A fin de obtener instrucciones de instalación para GitHub CLI, vea el repositorio de GitHub CLI.
Nota: Necesitas la versión 2.4.0 o posterior de la GitHub CLI. Puedes comprobar la versión instalada con el comando
gh --version
. -
Instalación de la GEI extension.
Shell gh extension install github/gh-gei
gh extension install github/gh-gei
Cada vez que necesites ayuda con la GEI extension, puedes usar la marca --help
con un comando. Por ejemplo, gh gei --help
enumerará todos los comandos disponibles y gh gei migrate-repo --help
todas las opciones disponibles para el comando migrate-repo
.
Paso 2: Actualización de la GEI extension of the GitHub CLI
La GEI extension se actualiza semanalmente. Para asegurarte de que usas la versión más reciente, actualiza la extensión.
gh extension upgrade github/gh-gei
Paso 3: Establecimiento de variables de entorno
Para poder usar la GEI extension para migrar a GitHub Enterprise Cloud, debes crear personal access tokens (classic) que puedan acceder a la organización de origen y a la empresa de destino y luego establecer los personal access tokens (classic) como variables de entorno.
-
Crea y registra un personal access token que cumpla todos los requisitos para autenticarse en la organización de origen para las migraciones de la organización. Para obtener más información, vea «Administración del acceso para una migración entre productos de GitHub».
-
Crea y registra un personal access token (classic) que cumpla todos los requisitos para autenticarse en la empresa de destino para las migraciones de la organización.
-
Establece variables de entorno para personal access tokens (classic), y reemplaza TOKEN en los comandos siguientes por los valores personal access tokens (classic) que has registrado antes. Usa
GH_PAT
para la empresa de destino yGH_SOURCE_PAT
para la organización de origen.-
Si usas Terminal, utiliza el comando
export
.Shell export GH_PAT="TOKEN" export GH_SOURCE_PAT="TOKEN"
export GH_PAT="TOKEN" export GH_SOURCE_PAT="TOKEN"
-
Si usas PowerShell, utiliza el comando
$env
.Shell $env:GH_PAT="TOKEN" $env:GH_SOURCE_PAT="TOKEN"
$env:GH_PAT="TOKEN" $env:GH_SOURCE_PAT="TOKEN"
-
Paso 4: Migración de la organización
Para migrar una organización, usa el comando gh gei migrate-org
.
gh gei migrate-org --github-source-org SOURCE --github-target-org DESTINATION --github-target-enterprise ENTERPRISE
gh gei migrate-org --github-source-org SOURCE --github-target-org DESTINATION --github-target-enterprise ENTERPRISE
Reemplaza los marcadores de posición del comando anterior por los valores siguientes.
Marcador de posición | Value |
---|---|
SOURCE | Nombre de la organización de origen |
DESTINO | El nombre que quieres que tenga la nueva organización. Debe ser exclusivo en GitHub.com. |
EMPRESA | El slug de aplicación de la empresa de destino, que puedes identificar examinando la dirección URL de tu cuenta empresarial, https://github.com/enterprises/SLUG . |
Paso 5: Validación de la migración y comprobación del registro de errores
Una vez finalizada la migración, se recomienda comprobar el repositorio de registros de migración. Para obtener más información, vea «Acceso a los registros de migración para GitHub Enterprise Importer».
Por último, se recomienda realizar una comprobación de idoneidad de la organización y los repositorios migrados.