Upgrade requirements

Recommendations

• Include as few upgrades as possible in your upgrade process. For example, instead of upgrading from GitHub Enterprise 3.2 to 3.3 to 3.4, you could upgrade from GitHub Enterprise 3.2 to 3.4. Use the Upgrade assistant to find the upgrade path from your current release version.
• If you’re several versions behind, upgrade your GitHub Enterprise Server instance as far forward as possible with each step of your upgrade process. Using the latest version possible on each upgrade allows you to take advantage of performance improvements and bug fixes. For example, you could upgrade from GitHub Enterprise 2.7 to 2.8 to 2.10, but upgrading from GitHub Enterprise 2.7 to 2.9 to 2.10 uses a later version in the second step.
• Use the latest patch release when upgrading. 浏览到 GitHub Enterprise Server 发行版页面。 在要升级到的版本旁边，单击 Download（下载），然后单击 Upgrading（升级）选项卡。
• Use a staging instance to test the upgrade steps. For more information, see "Setting up a staging instance."
• When running multiple upgrades, wait at least 24 hours between feature upgrades to allow data migrations and upgrade tasks running in the background to fully complete.
• Take a snapshot before upgrading your virtual machine. For more information, see "Taking a snapshot."
• Ensure you have a recent, successful backup of your instance. For more information, see the GitHub Enterprise Server 备份实用程序 README.md file.

Requirements

• You must upgrade from a feature release that's at most two releases behind. For example, to upgrade to GitHub Enterprise 3.4, you must be on GitHub Enterprise 3.3 or 3.2.
• When upgrading using an upgrade package, schedule a maintenance window for GitHub Enterprise Server end users.
• 您可以使用热更新将 GitHub Enterprise Server 升级为最新的补丁版本，它不需要维护时间窗，通常不需要重启。

您可以使用热更新来升级到更新的补丁版本，但不能升级到功能版本。 例如，您可以从 2.10.1 升级到 2.10.5，� 为它们属于相同的功能系列，但不能从 2. 0.9 升级到 2.11.0，� 为它们处于不同的功能系列中。

• A hotpatch may require downtime if the affected services (like kernel, MySQL, or Elasticsearch) require a VM reboot or a service restart. You'll be notified when a reboot or restart is required. You can complete the reboot or restart at a later time.
• Additional root storage must be available when upgrading through hotpatching, as it installs multiple versions of certain services until the upgrade is complete. Pre-flight checks will notify you if you don't have enough root disk storage.
• When upgrading through hotpatching, your instance cannot be too heavily loaded, as it may impact the hotpatching process.
• Upgrading to GitHub Enterprise Server 2.17 migrates your audit logs from Elasticsearch to MySQL. This migration also increases the amount of time and disk space it takes to restore a snapshot. Before migrating, check the number of bytes in your Elasticsearch audit log indices with this command:

  curl -s http://localhost:9201/audit_log/_stats/store | jq ._all.primaries.store.size_in_bytes

  Use the number to estimate the amount of disk space the MySQL audit logs will need. The script also monitors your free disk space while the import is in progress. Monitoring this number is especially useful if your free disk space is close to the amount of disk space necessary for migration.

About minimum requirements for GitHub Enterprise Server 3.0 and later

Before upgrading to GitHub Enterprise Server 3.0 or later, review the hardware resources you've provisioned for your instance. GitHub Enterprise Server 3.0 introduces new features such as GitHub Actions and GitHub Packages, and requires more resources than versions 2.22 and earlier. For more information, see the GitHub Enterprise Server 3.0 release notes.

Increased requirements for GitHub Enterprise Server 3.0 and later are bold in the following table.

User licenses	vCPUs	Memory	Attached storage	Root storage
Trial, demo, or 10 light users	4 Up from 2	32 GB Up from 16 GB	150 GB Up from 100 GB	200 GB
10 to 3,000	8 Up from 4	48 GB Up from 32 GB	300 GB Up from 250 GB	200 GB
3,000 to 5000	12 Up from 8	64 GB	500 GB	200 GB
5,000 to 8000	16 Up from 12	96 GB	750 GB	200 GB
8,000 to 10,000+	20 Up from 16	160 GB Up from 128 GB	1000 GB	200 GB

For more information about hardware requirements for GitHub Actions, see "Getting started with GitHub Actions for GitHub Enterprise Server."

有关为现有实例调整资源的更多信息，请参阅“增� 存储容量”和“增�  CPU 或内存资源”。

Next steps

After reviewing these recommendations and requirements, you can upgrade GitHub Enterprise Server. For more information, see "Upgrading GitHub Enterprise Server."