关于 GitHub Enterprise Importer 所需的访问权限
为了保护数据,GitHub 强制实施特定的访问要求来使用 GitHub Enterprise Importer。 这些要求会因尝试执行的任务而异。 为防止出错,应仔细查看本文,并确认是否符合要完成的任务的所有要求。
若要运行迁移,需要对迁移的源和目标具有足够的访问权限。 源即是要从中迁移数据的 GitHub.com 或 GitHub Enterprise Server 上的组织。 如果要迁移存储库,则目标为 GitHub.com 上的组织帐户;如果要迁移整个组织,则目标为 GitHub.com 上的企业帐户。
要对源和目标的迁移都具有足够的访问权限,需满足以下条件:
- 组织或企业帐户中的必需角色
- 可以访问组织或企业帐户的 personal access token
- personal access token 必须具有所有必需的范围,具体取决于你的角色和要完成的任务。
- 如果源或目标对 GitHub.com 使用 SAML 单一登录,则必须授权 personal access token 以实现 SSO。
此外,如果将 IP 允许列表用于源或目标,则可能需要配置允许列表以允许 GitHub Enterprise Importer 访问。
如果是首次从 GitHub Enterprise Server 3.8 或更高版本迁移,还需要有权访问 管理控制台 的人员为 你的 GitHub Enterprise Server 实例 设置 Blob 存储。
关于迁移者角色
为了使组织所有者不再需要完成迁移,GitHub.com 包含使用 GitHub Enterprise Importer 的不同角色。 通过授予迁移者角色,可以指定其他团队或个人来处理迁移。 只能为 GitHub.com 上的组织授予迁移者角色。
可以将迁移者角色授予单个用户或团队。 强烈建议将迁移者角色分配给团队。 然后,可以通过调整团队成员身份来进一步自定义可运行迁移的人员。 有关更改团队成员身份的详细信息,请参阅“添加组织成员到团队”或“从团队中删除组织成员”。
要授予迁移者角色,请参阅“授予迁移者角色”。
授予迁移者角色后,请确保迁移者使用的 personal access token 满足运行迁移的所有要求。
注意:
- 如果要在 GitHub.com 上的两个组织之间迁移存储库,则可以将迁移者角色授予两个组织的同一个人或团队,但必须分别授予。
- 不能为企业帐户授予迁移者角色。 因此,只有当你是目标企业的所有者时,你才能运行组织迁移。 但是,可以将迁移者角色授予源组织的企业所有者。
- GitHub CLI 不支持为 GitHub Enterprise Server 上的组织授予迁移者角色,因此必须是源组织的组织所有者才能从 GitHub Enterprise Server 迁移存储库。
必需的角色
对迁移的源和目标而言,不同任务需要不同角色。
源组织
下表列出了可以执行某些任务的具体角色。
任务 | 组织所有者 | 迁移者 |
---|---|---|
运行迁移 | ||
为存储库迁移分配迁移者角色 |
目标组织或企业
下表列出了可以执行某些任务的具体角色。
任务 | 企业所有者 | 组织所有者 | 迁移者 |
---|---|---|---|
将组织迁移到企业 | |||
为存储库迁移分配迁移者角色 | |||
将存储库迁移到组织 | |||
下载迁移日志 | |||
回收模型 |
personal access token 所需的范围
若要运行迁移,需要一个可以访问目标组织(用于存储库迁移)或企业帐户(用于组织迁移)的 personal access token。 要访问源组织,还需另一个 personal access token。
在其他任务(例如下载迁移日志)中,只需要一个可以访问操作目标的 personal access token。
GitHub personal access token (classic) 所需的范围取决于你的角色和要完成的任务。
注意:只能使用 personal access token (classic),而不能使用 fine-grained personal access token。这意味着,如果贵组织使用“限制 personal access tokens (classic) 访问组织”策略,则你无法使用 GitHub Enterprise Importer。 有关详细信息,请参阅“在企业中为个人访问令牌实施策略”。
任务 | 企业所有者 | 组织所有者 | 迁移者 |
---|---|---|---|
为存储库迁移分配迁移者角色 | admin:org | ||
运行存储库迁移(目标组织) | repo 、admin:org 、workflow | repo 、read:org 、workflow | |
下载迁移日志 | repo 、admin:org 、workflow | repo 、read:org 、workflow | |
回收模型 | admin:org | ||
运行迁移(源组织) | admin:org 、repo | admin:org 、repo | |
运行组织迁移(目标企业) | read:enterprise 、admin:org 、repo 、workflow |
授予迁移者角色
若要允许除组织所有者以外的其他人运行存储库迁移或下载迁移日志,可以向用户或团队授予迁移者角色。 有关详细信息,请参阅“关于迁移者角色”。
可以使用 GEI extension of the GitHub CLI 或 GraphQL API 授予迁移者角色。
使用 GEI extension
授予迁移者角色
若要使用 CLI 授予迁移者角色,必须已安装 GEI extension of the GitHub CLI。 有关详细信息,请参阅“将存储库从 GitHub.com 迁移到 GitHub Enterprise Cloud”。
-
在 GitHub.com 上,创建并记录满足授予迁移者角色的所有要求的 personal access token。 有关详细信息,请参阅“为 GitHub Enterprise Importer 创建 personal access token。”
-
将 personal access token 设置为环境变量,将以下命令中的 TOKEN 替换为你在上面记录的 personal access token。
-
如果使用终端,请使用
export
命令。Shell export GH_PAT="TOKEN"
export GH_PAT="TOKEN"
-
如果使用 PowerShell,请使用
$env
命令。Shell $env:GH_PAT="TOKEN"
$env:GH_PAT="TOKEN"
-
-
使用
gh gei grant-migrator-role
命令,将 ORGANIZATION 替换为你要为其授予迁移者角色的组织,将 ACTOR 替换为用户或团队名称,并将 TYPE 替换为USER
或TEAM
。Shell gh gei grant-migrator-role --github-org ORGANIZATION --actor ACTOR --actor-type TYPE
gh gei grant-migrator-role --github-org ORGANIZATION --actor ACTOR --actor-type TYPE
使用 GraphQL API 授予迁移者角色
可以使用 grantMigratorRole
GraphQL 突变来分配迁移者角色,并使用 revokeMigratorRole
突变来撤销迁移者角色。
必须使用满足所有访问要求的 personal access token (PAT)。 有关详细信息,请参见“personal access token 所需的作用域。”
grantMigratorRole
突变
此 GraphQL 突变设置迁移角色。
mutation grantMigratorRole (
$organizationId: ID!,
$actor: String!,
$actor_type: ActorType!
) {
grantMigratorRole( input: {
organizationId: $organizationId,
actor: $actor,
actorType: $actor_type
})
{ success }
}
查询变量 | 说明 |
---|---|
organizationId | 组织的 ownerId 或组织 ID(来自 GetOrgInfo 查询)。 |
actor | 要将迁移角色分配到的团队或用户名。 |
actor_type | 指定迁移者是 USER 还是 TEAM 。 |
revokeMigratorRole
突变
此突变将删除迁移者角色。
mutation revokeMigratorRole (
$organizationId: ID!,
$actor: String!,
$actor_type: ActorType!
) {
revokeMigratorRole( input: {
organizationId: $organizationId,
actor: $actor,
actorType: $actor_type
})
{ success }
}
为 GitHub Enterprise Importer 创建 personal access token
- 验证是否有足够的角色权限来完成要完成的任务。 有关详细信息,请参阅“必需的角色”。
- 创建 personal access token (classic),确保授予要完成的任务所需的全部范围。 只能使用 personal access token (classic),而不能使用 fine-grained personal access token。 有关详细信息,请参阅“管理个人访问令牌”和“personal access token 所需的范围”。
- 如果对需要访问的组织强制实施 SAML 单一登录,请授权 personal access token 以实现 SSO。 有关详细信息,请参阅“授权用于 SAML 单点登录的个人访问令牌”。
为迁移配置 IP 允许列表
如果迁移的源或目的地使用 IP 允许列表(GitHub的 IP 允许列表功能或标识提供者 (IdP) 的 IP 允许列表限制,例如 Azure CAP),则需要在 GitHub 上配置 IP 允许列表。
- 如果使用 GitHub 的 IP 允许列表功能,则必须将下面的 GitHub IP 范围添加到源和/或目标组织的允许列表中。
- 如果使用 IdP 的 IP 允许列表来限制对 GitHub 上企业的访问,则应在迁移完成之前在企业帐户设置中禁用这些限制。
有关详细信息,请参阅“管理组织允许的 IP 地址”和“使用 IP 允许列表限制到企业的网络流量”。
如果迁移源为 GitHub Enterprise Server,则无需将任何 GitHub IP 范围添加到防火墙配置或 你的 GitHub Enterprise Server 实例 上的 IP 允许列表。 但是,根据 Blob 存储提供程序的设置,可能需要更新 Blob 存储提供程序的配置,以允许访问下面的 GitHub IP 范围。
确定 GitHub 的 IP 范围
需要将以下 IP 范围添加到 IP 允许列表:
- 192.30.252.0/22
- 185.199.108.0/22
- 140.82.112.0/20
- 143.55.64.0/20
- 40.71.233.224/28
- 2a0a:a440::/29
- 2606:50c0::/32
- 20.125.12.8/29 (从 UTC 2023 年 11 月 8 日 00:00 起生效)
可以使用 REST API 的“获取 GitHub 元信息”终结点随时获取 GitHub Enterprise Importer 使用的最新 IP 范围列表。
响应中的 github_enterprise_importer
键包含用于迁移的 IP 范围列表。
有关详细信息,请参阅“元数据的 REST API 终结点”。
延伸阅读
- "组织中的角色"