Skip to main content

将数据迁移到 GitHub Enterprise Server

生成迁移存档后,您可以将数据导入目标 GitHub Enterprise Server 实例。 在将变更永久应用到目标实例之前,您需要检查变更,查看有无潜在的冲突。

准备要迁移的数据

  1. 使用 scp 命令,将从源实例或组织生成的迁移存档复制到 GitHub Enterprise Server 目标:

    scp -P 122 PATH-TO-MIGRATION-GUID.tar.gz admin@HOSTNAME:/home/admin/
    
  2. 通过 SSH 连接到目标 GitHub Enterprise Server 实例。 有关详细信息,请参阅“访问管理 shell (SSH)”。

    ssh -p 122 admin@HOSTNAME
    
  3. 使用 ghe-migrator prepare 命令准备要在目标实例上导入的存档,并生成新的迁移 GUID 供你在后续步骤中使用:

    ghe-migrator prepare /home/admin/MIGRATION-GUID.tar.gz
    
    • 若要启动新的导入尝试,请再次运行 ghe-migrator prepare 并获取新的迁移 GUID。
    • 要指定迁移文件的暂存位置,请在命令后附加 --staging-path=/full/staging/path。 默认为 /data/user/tmp

生成迁移冲突列表

  1. ghe-migrator conflicts 命令与迁移 GUID 配合使用,生成 conflicts.csv 文件:

    ghe-migrator conflicts -g MIGRATION-GUID > conflicts.csv
    
  2. 如果存在冲突,请使用 scp 命令将 conflicts.csv 复制到本地计算机:

    scp -P 122 admin@HOSTNAME:conflicts.csv ~/Desktop
    
  3. 继续执行“解决迁移冲突或设置自定义映射”。

检查迁移冲突

  1. 使用文本编辑器或者与 CSV 兼容的电子表格软件,打开 conflicts.csv。
  2. 按照示例中的指导和下面的参考表检查 conflicts.csv 文件,确保导入时将发生正确的操作。

conflicts.csv 文件包含冲突的迁移映射和建议操作。 迁移映射列出了数据的迁移来源和数据应用到目标的方式。

model_namesource_urltarget_urlrecommended_action
userhttps://example-gh.source/octocathttps://example-gh.target/octocatmap
organizationhttps://example-gh.source/octo-orghttps://example-gh.target/octo-orgmap
repositoryhttps://example-gh.source/octo-org/widgetshttps://example-gh.target/octo-org/widgetsrename
teamhttps://example-gh.source/orgs/octo-org/teams/adminshttps://example-gh.target/orgs/octo-org/teams/adminsmerge
projecthttps://example-gh.source/octo-org/widgets/projects/1https://example-gh.target/octo-org/projects/1merge

conflicts.csv 中的每一行都提供了以下信息:

名称说明
model_name正在更改的数据的类型。
source_url数据的源 URL。
target_url数据的预期目标 URL。
recommended_action导入数据时 ghe-migrator 将执行的首选操作。

每个记录类型的可能映射

转移数据时,ghe-migrator 可以执行多种不同的映射操作:

action说明适用的模型
import(默认)源中的数据将导入目标。所有记录类型
map使用目标中的现有记录,而不是基于源数据创建新模型。 用于将存储库导入现有组织或将目标中的用户标识映射到源中的用户标识。用户、组织、项目
rename源中的数据将重命名,然后复制到目标。用户、组织。存储库、项目
map_or_rename如果存在目标,请映射到该目标。 否则,请重命名导入的模型。用户
merge源中的数据将与目标中的现有数据合并。团队、项目

强烈建议查看 conflicts.csv文件,并使用该 ghe-migrator audit 文件来确保执行适当的操作。 如果一切正常,可以继续执行“将数据迁移到 GitHub Enterprise Server”。

解决迁移冲突或设置自定义映射

如果你认为 ghe-migrator 将执行不正确的变更,可以通过更改 conflicts.csv 中的数据进行修改。 可以更改 conflicts.csv 中的任意行。

例如,假设你注意到源中的 octocat 用户正映射到目标上的 octocat

model_namesource_urltarget_urlrecommended_action
userhttps://example-gh.source/octocathttps://example-gh.target/octocatmap

您可以选择将用户映射到目标上的其他用户。 假设你知道 octocat 实际上应该是位于目标上的 monalisa。 可以更改 conflicts.csv 中的 target_url 列以引用 monalisa

model_namesource_urltarget_urlrecommended_action
userhttps://example-gh.source/octocathttps://example-gh.target/monalisamap

再举一个例子,如果要在目标实例上将 octo-org/widgets 存储库重命名为 octo-org/amazing-widgets,请将 target_url 更改为 octo-org/amazing-widgets,将 recommend_action 更改为 rename

model_namesource_urltarget_urlrecommended_action
repositoryhttps://example-gh.source/octo-org/widgetshttps://example-gh.target/octo-org/amazing-widgetsrename

添加自定义映射

迁移过程中一个常见的情况是,迁移用户的用户名在目标上与在源上不同。

如果拥有源中的用户名列表和目标上的用户名列表,您可以通过自定义映射构建一个 CSV 文件,然后应用此文件,确保迁移结束时每个用户的用户名和内容都有正确的映射。

可以使用 ghe-migrator audit 命令,以 CSV 格式快速生成应用自定义映射所需的正在迁移的用户的 CSV:

ghe-migrator audit -m user -g MIGRATION-GUID > users.csv

现在,你可以编辑该 CSV,并为你想要映射或重命名的每个用户输入新 URL,然后根据需要将第四列更新为包含 maprename

例如,若要在目标 https://example-gh.target 上将用户 octocat 重命名为 monalisa,需创建包含以下内容的行:

model_namesource_urltarget_urlstate
userhttps://example-gh.source/octocathttps://example-gh.target/monalisarename

可以使用相同的流程为支持自定义映射的每个记录创建映射。 有关详细信息,请参阅有关记录的可能映射的表

应用修改的迁移数据

  1. 进行更改后,使用 scp 命令将修改后的 conflicts.csv(或具有正确格式的任何其他映射 .csv 文件)应用于目标实例:

    scp -P 122 ~/Desktop/conflicts.csv admin@HOSTNAME:/home/admin/
    
  2. 使用 ghe-migrator map 命令重新映射迁移数据,并传入修改后的 .csv 文件的路径和迁移 GUID:

    ghe-migrator map -i conflicts.csv  -g MIGRATION-GUID
    
  3. 如果 ghe-migrator map -i conflicts.csv -g MIGRATION-GUID 命令报告冲突仍然存在,请再次运行迁移冲突解决过程。

在 GitHub Enterprise Server 上应用导入的数据

  1. 通过 SSH 连接到目标 GitHub Enterprise Server 实例。 有关详细信息,请参阅“访问管理 shell (SSH)”。

    ssh -p 122 admin@HOSTNAME
    
  2. 使用 ghe-migrator import 命令启动导入过程。 需要:

    $ ghe-migrator import /home/admin/MIGRATION-GUID.tar.gz -g MIGRATION-GUID -u USERNAME -p TOKEN
    
    > Starting GitHub::Migrator
    > Import 100% complete /
    
    • 要指定迁移文件的暂存位置,请在命令后附加 --staging-path=/full/staging/path。 默认为 /data/user/tmp

检查迁移数据

默认情况下,ghe-migrator audit 返回每条记录。 它还可以让您按以下方式筛选记录:

  • 记录的类型。
  • 记录的状态。

记录类型与迁移数据中的记录类型相匹配。

记录类型筛选器

记录类型筛选器名称
用户user
组织organization
存储库repository
Teamsteam
里程碑milestone
项目(经典)project
问题issue
问题评论issue_comment
拉取请求pull_request
拉取请求审查pull_request_review
提交注释commit_comment
拉取请求审查评论pull_request_review_comment
版本release
在拉取请求或问题上进行的操作issue_event
受保护的分支protected_branch

记录状态筛选器

记录状态说明
export将导出记录。
import将导入记录。
map将映射记录。
rename将重命名记录。
merge将合并记录。
exported已成功导出记录。
imported已成功导入记录。
mapped已成功映射记录。
renamed已成功重命名记录。
merged已成功合并记录。
failed_export记录导出失败。
failed_import记录导入失败。
failed_map记录映射失败。
failed_rename记录重命名失败。
failed_merge记录合并失败。

筛选审核的记录

通过 ghe-migrator audit 命令,可以使用 -m 标志根据记录类型进行筛选。 同样,可以使用 -s 标志筛选导入状态。 命令如下所示:

ghe-migrator audit -m RECORD_TYPE -s STATE -g MIGRATION-GUID

例如,要查看每个成功导入的组织和团队,您可以输入:

$ ghe-migrator audit -m organization,team -s mapped,renamed -g MIGRATION-GUID
> model_name,source_url,target_url,state
> organization,https://gh.source/octo-org/,https://ghe.target/octo-org/,renamed

我们强烈建议审核每个失败的导入。 为此,你将输入:

$ ghe-migrator audit -s failed_import,failed_map,failed_rename,failed_merge -g MIGRATION-GUID
> model_name,source_url,target_url,state
> user,https://gh.source/octocat,https://gh.target/octocat,failed
> repository,https://gh.source/octo-org/octo-project,https://ghe.target/octo-org/octo-project,failed

如果对失败的导入有任何疑问,请通过访问 GitHub Enterprise 支持 联系我们。

在 GitHub Enterprise Server 上完成导入

在迁移应用到目标实例并且您已审查迁移后,您需要解锁仓库并将其从源中删除。 我们建议等待两周再删除您的源数据,以便确保所有数据都能按预期运行。

在目标实例上解锁仓库

  1. 通过 SSH 连接到 你的 GitHub Enterprise Server 实例。 如果实例包含多个节点,例如,如果配置了高可用性或异地复制,则通过 SSH 连接到主节点。 如果使用群集,则可以通过 SSH 连接到任何节点。 将 HOSTNAME 替换为实例的主机名,或节点的主机名或 IP 地址。 有关详细信息,请参阅“访问管理 shell (SSH)”。

    Shell
    ssh -p 122 admin@HOSTNAME
    
  2. 使用 ghe-migrator unlock 命令解锁所有导入的存储库。 您将需要迁移 GUID:

$ ghe-migrator unlock -g MIGRATION-GUID
> Unlocked octo-org/octo-project

警告: 如果你的存储库包含使用 schedule 触发器的 GitHub Actions 工作流,则导入后,工作流将不会自动运行。 若要再次启动计划的工作流,请向存储库推送一个提交。 有关详细信息,请参阅“触发工作流的事件”。

在源上解锁仓库

从 GitHub.com 上的组织解锁仓库

若要解锁 GitHub.com 组织上的存储库,你需要向迁移解锁终结点发送 DELETE 请求。 需要:

  • 身份验证的访问令牌
  • 迁移的唯一 id
  • 要解锁的仓库的名称
curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \
  -H "Accept: application/vnd.github.wyandotte-preview+json" \
  https://api.github.com/orgs/ORG-NAME/migrations/ID/repos/REPO_NAME/lock

从 GitHub.com 上的组织中删除仓库

解锁 GitHub.com 组织的存储库后,应该删除之前使用存储库删除终结点迁移的每个存储库。 您需要身份验证的访问令牌:

curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \
  https://api.github.com/repos/ORG-NAME/REPO_NAME

从 GitHub Enterprise Server 实例解锁仓库

  1. 通过 SSH 连接到 你的 GitHub Enterprise Server 实例。 如果实例包含多个节点,例如,如果配置了高可用性或异地复制,则通过 SSH 连接到主节点。 如果使用群集,则可以通过 SSH 连接到任何节点。 将 HOSTNAME 替换为实例的主机名,或节点的主机名或 IP 地址。 有关详细信息,请参阅“访问管理 shell (SSH)”。

    Shell
    ssh -p 122 admin@HOSTNAME
    
  2. 使用 ghe-migrator unlock 命令解锁所有导入的存储库。 您将需要迁移 GUID:

$ ghe-migrator unlock -g MIGRATION-GUID
> Unlocked octo-org/octo-project