Skip to content

Commit eb4f299

Browse files
Luke-J-ReidCopilotjc-clark
authored
Add platform / hypervisor supported migration path documentation (#55234)
Co-authored-by: Copilot <[email protected]> Co-authored-by: Joe Clark <[email protected]>
1 parent 00d909a commit eb4f299

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Changing your platform
3+
shortTitle: Changing platform
4+
intro: 'How to change the platform that runs {% data variables.location.product_location %}'
5+
type: how_to
6+
topics:
7+
- Infrastructure
8+
- Migration
9+
- Enterprise
10+
versions:
11+
ghes: '*'
12+
---
13+
14+
In some cases, you may need to change the platform on which {% data variables.location.product_location %} runs, such as moving from VMware to Azure.
15+
16+
## Recommendations
17+
18+
You should carefully plan any out migration procedures and consider first testing on a staging environment. For more information, see [AUTOTITLE](/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance).
19+
20+
Moving platforms using a replica will require the least amount of time for the migration process but will require you to make changes to your live environment in order to setup the replication.
21+
22+
Moving via backup and restore will not require any changes to your live environment, however the migration will take a significant amount of time. The specific amount of time to complete the migration will vary based the performance of your backup host, and the network speeds between your backup host and the new instance. Maintenance mode should also be enabled throughout the process otherwise users may be able to make changes which will not be reflected on your new instance.
23+
24+
> [!WARNING]
25+
> You should not use utilities which convert {% data variables.location.product_location %} from one platform to another. Doing so could cause unintended side effects such as system instability.
26+
27+
## Move platforms using a HA replica
28+
29+
1. Set up a new {% data variables.product.prodname_ghe_server %} instance on your chosen platform. See [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance).
30+
1. Configure your new {% data variables.product.prodname_ghe_server %} instance as a replica. See [AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-high-availability/creating-a-high-availability-replica).
31+
1. Failover to your replica. See [AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-high-availability/initiating-a-failover-to-your-replica-appliance).
32+
33+
## Moving platforms using backup and restore
34+
35+
1. Setup backups for your existing {% data variables.product.prodname_ghe_server %} instance. See [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance).
36+
1. Set up a new {% data variables.product.prodname_ghe_server %} instance on your chosen platform. See [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance).
37+
1. Communicate the upcoming downtime to your users and enable maintenance mode. For more information, see the following articles.
38+
39+
* [AUTOTITLE](/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-mandatory-message)
40+
* [AUTOTITLE](/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode)
41+
1. Create a new backup of your existing {% data variables.product.prodname_ghe_server %} instance.
42+
1. Restore the backup to your new {% data variables.product.prodname_ghe_server %} instance. If you are using {% data variables.product.prodname_actions %}, see [AUTOTITLE](/admin/managing-github-actions-for-your-enterprise/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled)
43+
1. Update the DNS to point to the address of your new {% data variables.product.prodname_ghe_server %} instance.
44+
1. Disable maintenance mode and let users know they can continue normal operations.
45+
46+
## Further reading
47+
48+
* [AUTOTITLE](/admin/overview/about-github-enterprise-server)
49+
* [AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-high-availability/about-high-availability-configuration)
50+
* [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance#about-github-enterprise-server-backup-utilities)

content/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ children:
1616
- /increasing-storage-capacity
1717
- /increasing-cpu-or-memory-resources
1818
- /using-generation-2-virtual-machines
19+
- /changing-your-platform
1920
shortTitle: Update VM & resources
2021
---

0 commit comments

Comments
 (0)