5.8 KiB
title, intro, redirect_from, versions, type, topics, shortTitle
| title | intro | redirect_from | versions | type | topics | shortTitle | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Installing GitHub Enterprise Server on Hyper-V | To install {% data variables.product.prodname_ghe_server %} on Hyper-V, you must deploy onto a machine running Windows Server 2008 through Windows Server 2022. |
|
|
tutorial |
|
Install on Hyper-V |
Prerequisites
- {% data reusables.enterprise_installation.software-license %}
- You must have Windows Server 2008 through Windows Server 2022, which supports Hyper-V.
- Most actions needed to create your virtual machine (VM) may also be performed using the Hyper-V Manager. However, we recommend using the Windows PowerShell command-line shell for initial setup. Examples using PowerShell are included below. For more information, see the Microsoft guide Getting Started with Windows PowerShell.
Hardware considerations
{% data reusables.enterprise_installation.hardware-considerations-all-platforms %}
Should I use VMotion?
VMotion can be exceptionally helpful for general resource management, however the impact to the guest instance can be significant. With larger {% data variables.product.prodname_ghe_server %} instances (8 CPU/64 GB RAM and above), a VMotion event may result in a full outage of the {% data variables.product.prodname_ghe_server %} to end users as a result of dramatically reduced CPU, RAM, and storage IOPS. With this in mind, {% data variables.product.prodname_ghe_server %} should be considered a "highly latency sensitive" application.
For large(r) deployments on VMWare that have Distributed Resource Scheduler (DRS) enabled, we would recommend configuring a VM-to-Host affinity rule for your {% data variables.product.prodname_ghe_server %} to try and keep the virtual appliance on a single host. If a migration with VMotion is required, we'd recommend considering this a "planned outage", and placing {% data variables.product.prodname_ghe_server %} into maintenance mode until the migration is complete.
We also recommend that the ESXi Power Management Setting be configured to "High Performance". We have seen cases where overall system performance can be negatively impacted if this is left at "Balanced".
Downloading the {% data variables.product.prodname_ghe_server %} image
{% data reusables.enterprise_installation.download-license %} {% data reusables.enterprise_installation.download-appliance %}
- Under "{% data variables.product.prodname_dotcom %} On-premises", select the "Select your hypervisor" dropdown menu and click Hyper-V (VHD).
- Click Download for Hyper-V (VHD).
Creating the {% data variables.product.prodname_ghe_server %} instance
{% data reusables.enterprise_installation.create-ghe-instance %}
-
In PowerShell, create a new Generation 1 virtual machine, configure the size based on your user license count, and attach the {% data variables.product.prodname_ghe_server %} image you downloaded. For more information, see New-VM in the Microsoft documentation.
PS C:\> New-VM -Generation 1 -Name VM_NAME -MemoryStartupBytes MEMORY_SIZE -BootDevice VHD -VHDPath PATH_TO_VHD
{% data reusables.enterprise_installation.create-attached-storage-volume %} Replace PATH_TO_DATA_DISK with the path to the location where you create the disk. For more information, see New-VHD in the Microsoft documentation.
PS C:\> New-VHD -Path PATH_TO_DATA_DISK -SizeBytes DISK_SIZE
-
Attach the data disk to your instance. For more information, see Add-VMHardDiskDrive in the Microsoft documentation.
PS C:\> Add-VMHardDiskDrive -VMName VM_NAME -Path PATH_TO_DATA_DISK -
Start the VM. For more information, see Start-VM in the Microsoft documentation.
PS C:\> Start-VM -Name VM_NAME -
Get the IP address of your VM. For more information, see Get-VMNetworkAdapter in the Microsoft documentation.
PS C:\> (Get-VMNetworkAdapter -VMName VM_NAME).IpAddresses -
Copy the VM's IP address and paste it into a web browser.
Configuring the {% data variables.product.prodname_ghe_server %} instance
{% data reusables.enterprise_installation.new-instance-config-summary %}
{% data reusables.enterprise_installation.new-instance-attack-vector-warning %}
{% data reusables.enterprise_installation.copy-the-vm-public-dns-name %} {% data reusables.enterprise_installation.upload-a-license-file %} {% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} For more information, see AUTOTITLE. {% data reusables.enterprise_installation.instance-will-restart-automatically %} {% data reusables.enterprise_installation.visit-your-instance %}