Skip to content

Commit acebb2f

Browse files
[GEI 1d] Move content in "Granting the migrator role" article (#48704)
Co-authored-by: Tim Rogers <[email protected]>
1 parent 82cd3df commit acebb2f

17 files changed

+166
-150
lines changed

content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ People with read access to a repository can access the migration log for the rep
4141

4242
## Downloading a repository migration log with the {% data variables.product.prodname_cli %}
4343

44-
Organization owners and people with the migrator role can download migration logs using the {% data variables.product.prodname_cli %}. For more information about the migrator role, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/granting-the-migrator-role-for-github-enterprise-importer)."
44+
Organization owners and organization members with the migrator role can download migration logs using the {% data variables.product.prodname_cli %}.
4545

4646
You can download the latest migration log for an individual repository with the `download-logs` command. The exact command depends on your migration source.
4747

content/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ redirect_from:
1010
- /early-access/github/migrating-with-github-enterprise-importer/running-a-migration-with-github-enterprise-importer/managing-access-for-github-enterprise-importer
1111
- /early-access/enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/managing-access-for-github-enterprise-importer
1212
- /migrations/using-github-enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/managing-access-for-github-enterprise-importer
13+
- /early-access/enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/granting-the-migrator-role-for-github-enterprise-importer
14+
- /migrations/using-github-enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/granting-the-migrator-role-for-github-enterprise-importer
1315
---
1416

1517
## About required access for {% data variables.product.prodname_importer_proper_name %}
@@ -28,9 +30,22 @@ Additionally, if you use IP allow lists with the source or destination, you may
2830

2931
If you're migrating from {% data variables.product.prodname_ghe_server %} 3.8 or higher for the first time, you also need someone with access to the {% data variables.enterprise.management_console %} to set up blob storage for {% data variables.location.product_location_enterprise %}.
3032

33+
## About the migrator role
34+
35+
{% data reusables.enterprise-migration-tool.about-the-migrator-role %}
36+
37+
{% note %}
38+
39+
**Notes:**
40+
- If you're migrating a repository between two organizations on {% data variables.product.prodname_dotcom_the_website %}, you can grant the migrator role to the same person or team for both organizations, but you must grant each separately.
41+
- You cannot grant the migrator role for enterprise accounts. Therefore, you can only run an organization migration if you're an owner of the destination enterprise. However, you can grant the migrator role to that enterprise owner for the source organization.
42+
- The {% data variables.product.prodname_cli %} does not support granting the migrator role for organizations on {% data variables.product.prodname_ghe_server %}, so you must be an organization owner of the source organization to migrate repositories from {% data variables.product.prodname_ghe_server %}.
43+
44+
{% endnote %}
45+
3146
## Required roles
3247

33-
For the source and destination of the migration, different roles are required for different tasks. For some tasks, you can grant the migrator role to a user or team. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/granting-the-migrator-role-for-github-enterprise-importer)."
48+
For the source and destination of the migration, different roles are required for different tasks.
3449

3550
### Source organization
3651

@@ -76,6 +91,31 @@ Reclaiming mannequins | {% octicon "dash" aria-label="Not applicable" %} | `admi
7691
Running a migration (source organization) | {% octicon "dash" aria-label="Not applicable" %} | `read:org`, `repo` | `read:org`, `repo` |
7792
Running an organization migration (destination enterprise) | `read:enterprise`, `admin:org`, `repo`, `workflow` | {% octicon "dash" aria-label="Not applicable" %} | {% octicon "dash" aria-label="Not applicable" %} |
7893

94+
## Granting the migrator role
95+
96+
To allow someone other than an organization owner to run a repository migration or download migration logs, you can grant the migrator role to a user or team. For more information, see "[About the migrator role](#about-the-migrator-role)."
97+
98+
You can grant the migrator role using either the {% data variables.product.prodname_gei_cli %} or the GraphQL API.
99+
100+
- "[Granting the migrator role with the {% data variables.product.prodname_gei_cli_short %}](#granting-the-migrator-role-with-the-ado2gh-extension)"
101+
- "[Granting the migrator role with the GraphQL API](#granting-the-migrator-role-with-the-graphql-api)"
102+
103+
### Granting the migrator role with the {% data variables.product.prodname_gei_cli_short %}
104+
105+
To grant the migrator role using the CLI, you must have installed the {% data variables.product.prodname_gei_cli %}. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/migrating-repositories-from-githubcom-to-github-enterprise-cloud#step-1-install-the-gei-extension-of-the-github-cli)."
106+
107+
1. On {% data variables.product.prodname_dotcom_the_website %}, create and record a {% data variables.product.pat_generic %} that meets all the requirements for granting the migrator role. For more information, see "[Creating a {% data variables.product.pat_generic %} for {% data variables.product.prodname_importer_proper_name %}](#creating-a-personal-access-token-for-github-enterprise-importer)."
108+
{% data reusables.enterprise-migration-tool.grant-migrator-role-pat %}
109+
1. Use the `gh gei grant-migrator-role` command, replacing ORGANIZATION with the organization you want to grant the migrator role for, ACTOR with the user or team name, and TYPE with `USER` or `TEAM`.
110+
111+
```shell copy
112+
gh gei grant-migrator-role --github-org ORGANIZATION --actor ACTOR --actor-type TYPE
113+
```
114+
115+
### Granting the migrator role with the GraphQL API
116+
117+
{% data reusables.enterprise-migration-tool.grant-migrator-role-graphql %}
118+
79119
## Creating a {% data variables.product.pat_generic %} for {% data variables.product.prodname_importer_proper_name %}
80120

81121
{% data reusables.enterprise-migration-tool.creating-a-pat-steps %}

content/migrations/using-github-enterprise-importer/migrating-between-github-products/migrating-organizations-from-githubcom-to-github-enterprise-cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ redirect_from:
2727
## Prerequisites
2828

2929
{% data reusables.enterprise-migration-tool.migration-prerequisites %}
30-
- For the source organization, you must be an organization owner or have the migrator role. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/granting-the-migrator-role-for-github-enterprise-importer)."
30+
- For the source organization, you must be an organization owner or have the migrator role. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#about-the-migrator-role)."
3131
- For the destination enterprise account, you must be an enterprise owner.
3232

3333
{% api %}

content/migrations/using-github-enterprise-importer/migrating-between-github-products/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ To migrate your repositories from {% data variables.product.prodname_ghe_server
5050
## Prerequisites
5151

5252
{% data reusables.enterprise-migration-tool.migration-prerequisites %}
53-
- You must be either an organization owner or be granted the migrator role for both the source and destination organizations. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/granting-the-migrator-role-for-github-enterprise-importer)."
53+
- In both the source and destination organizations, you must be either an organization owner or be granted the migrator role. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#about-the-migrator-role)."
5454
- If you use {% data variables.product.prodname_ghe_server %} 3.8 or higher, you need access to the {% data variables.enterprise.management_console %}.
5555

5656
{% api %}

content/migrations/using-github-enterprise-importer/migrating-between-github-products/migrating-repositories-from-githubcom-to-github-enterprise-cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ redirect_from:
2727
## Prerequisites
2828

2929
{% data reusables.enterprise-migration-tool.migration-prerequisites %}
30-
- You must be either an organization owner or be granted the migrator role for both the source and destination organizations. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/granting-the-migrator-role-for-github-enterprise-importer)."
30+
- In both the source and destination organization, you must be either an organization owner or be granted the migrator role. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#about-the-migrator-role)."
3131

3232
{% api %}
3333

content/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,15 @@ To migrate an organization, you must be an organization owner for the source org
7878
Additionally, you must be an enterprise owner on the destination enterprise account. You cannot grant the migrator role for enterprise accounts.
7979

8080
1. Confirm that the person who will run your migrations is an enterprise owner of the destination enterprise account.
81-
1. If that person is not an organization owner for the source organization, grant them the migrator role for the organization. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/granting-the-migrator-role-for-github-enterprise-importer)."
81+
1. If that person is not an organization owner for the source organization, grant them the migrator role for the organization. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#about-the-migrator-role)."
8282
{% data reusables.enterprise-migration-tool.confirm-migrator-has-correct-pats %} For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#required-scopes-for-personal-access-tokens)."
8383

8484
#### Deciding who will run repository migrations
8585

8686
To migrate a repository, you must be an organization owner for both the source organization and the destination organization, or an organization owner must grant you the migrator role for each organization where you're not an owner.
8787

8888
1. Decide whether you want an organization owner to perform your migrations, or whether you need to grant the migrator role to someone else.
89-
{% data reusables.enterprise-migration-tool.grant-migrator-tasks %}
89+
{% data reusables.enterprise-migration-tool.grant-migrator-tasks %} For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#about-the-migrator-role)."
9090

9191
{% note %}
9292

content/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/managing-access-for-a-migration-from-azure-devops.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@ To migrate a repository from Azure DevOps to GitHub, you need sufficient access
2121

2222
Additionally, if you use IP allow lists with the source or destination, you may need to configure the allow lists to allow access by {% data variables.product.prodname_importer_proper_name %}.
2323

24+
## About the migrator role
25+
26+
{% data reusables.enterprise-migration-tool.about-the-migrator-role %}
27+
2428
## Required roles for {% data variables.product.company_short %}
2529

26-
For the destination organization on {% data variables.product.prodname_dotcom %}, different roles are required for different tasks. For some tasks, you can grant the migrator role to a user or team. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/granting-the-migrator-role-for-github-enterprise-importer)."
30+
For the destination organization on {% data variables.product.prodname_dotcom %}, different roles are required for different tasks.
2731

2832
{% data reusables.enterprise-migration-tool.gei-required-roles %}
2933

@@ -43,6 +47,31 @@ Your Azure DevOps {% data variables.product.pat_generic %} must have `work item
4347

4448
If you want to migrate from multiple organizations, allow the {% data variables.product.pat_generic %} to access all accessible organizations. For more information, see [Use {% data variables.product.pat_generic %}s](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page#create-a-pat) in Microsoft Docs.
4549

50+
## Granting the migrator role
51+
52+
To allow someone other than an organization owner to run a migration or download migration logs, you can grant the migrator role to a user or team. For more information, see "[About the migrator role](#about-the-migrator-role)."
53+
54+
You can grant the migrator role using either the {% data variables.product.prodname_ado2gh_cli %} or the GraphQL API.
55+
56+
- "[Granting the migrator role with the {% data variables.product.prodname_ado2gh_cli_short %}](#granting-the-migrator-role-with-the-ado2gh-extension)"
57+
- "[Granting the migrator role with the GraphQL API](#granting-the-migrator-role-with-the-graphql-api)"
58+
59+
### Granting the migrator role with the {% data variables.product.prodname_ado2gh_cli_short %}
60+
61+
To grant the migrator role using the CLI, you must have installed the {% data variables.product.prodname_ado2gh_cli %}. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/migrating-repositories-from-azure-devops-to-github-enterprise-cloud#step-1-install-the-ado2gh-extension-of-the-github-cli)."
62+
63+
1. On {% data variables.product.prodname_dotcom_the_website %}, create and record a {% data variables.product.pat_generic %} that meets all the requirements for granting the migrator role. For more information, see "[Creating a {% data variables.product.pat_generic %} for {% data variables.product.prodname_dotcom %}](#creating-a-personal-access-token-for-github)."
64+
{% data reusables.enterprise-migration-tool.grant-migrator-role-pat %}
65+
1. Use the `gh ado2gh grant-migrator-role` command, replacing ORGANIZATION with the organization you want to grant the migrator role for, ACTOR with the user or team name, and TYPE with `USER` or `TEAM`.
66+
67+
```shell copy
68+
gh ado2gh grant-migrator-role --github-org ORGANIZATION --actor ACTOR --actor-type TYPE
69+
```
70+
71+
### Granting the migrator role with the GraphQL API
72+
73+
{% data reusables.enterprise-migration-tool.grant-migrator-role-graphql %}
74+
4675
## Creating a {% data variables.product.pat_generic %} for {% data variables.product.prodname_dotcom %}
4776

4877
{% data reusables.enterprise-migration-tool.creating-a-pat-steps %}

content/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/migrating-repositories-from-azure-devops-to-github-enterprise-cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ redirect_from:
2727
## Prerequisites
2828

2929
{% data reusables.enterprise-migration-tool.migration-prerequisites %}
30-
- For the destination organization on {% data variables.product.prodname_dotcom_the_website %}, you need to be an organization owner or have the migrator role. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/granting-the-migrator-role-for-github-enterprise-importer)."
30+
- For the destination organization on {% data variables.product.prodname_dotcom_the_website %}, you need to be an organization owner or have the migrator role. For more information about the migrator role, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/managing-access-for-a-migration-from-azure-devops#about-the-migrator-role)."
3131

3232
{% api %}
3333

content/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/overview-of-a-migration-from-azure-devops-to-github-enterprise-cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Service hooks are not migrated from ADO, so you will need to recreate them separ
6464
To migrate a repository, you must be an organization owner for the destination organization, or an organization owner must grant you the migrator role.
6565

6666
1. Decide whether you want an organization owner of the destination organization to perform your migrations, or whether you need to grant the migrator role to someone else.
67-
{% data reusables.enterprise-migration-tool.grant-migrator-tasks %}
67+
{% data reusables.enterprise-migration-tool.grant-migrator-tasks %} For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/managing-access-for-a-migration-from-azure-devops#about-the-migrator-role)."
6868
{% data reusables.enterprise-migration-tool.confirm-migrator-has-correct-pats %} For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/managing-access-for-a-migration-from-azure-devops#required-scopes-for-personal-access-tokens)."
6969

7070
### What organizational structure do we want in {% data variables.product.prodname_dotcom %}?

0 commit comments

Comments
 (0)