forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
76 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,26 @@ versions: | |
|
||
{% endnote %} | ||
|
||
{% if currentVersion ver_gt "[email protected]" and currentVersion ver_lt "[email protected]" %} | ||
|
||
### About minimum requirements for {% data variables.product.prodname_ghe_server %} 3.0 and later | ||
|
||
Before upgrading to {% data variables.product.prodname_ghe_server %} 3.0 or later, review the hardware resources you've provisioned for your instance. {% data variables.product.prodname_ghe_server %} 3.0 introduces new features such as {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %}, and requires more resources than versions 2.22 and earlier. For more information, see the [{% data variables.product.prodname_ghe_server %} 3.0 release notes](/[email protected]/admin/release-notes). | ||
|
||
Increased requirements for {% data variables.product.prodname_ghe_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**<br/>_Up from 2_ | **32 GB**<br/>_Up from 16 GB_ | **150 GB**<br/>_Up from 100 GB_ | 200 GB | | ||
| 10 to 3,000 | **8**<br/>_Up from 4_ | **48 GB**<br/>_Up from 32 GB_ | **300 GB**<br/>_Up from 250 GB_ | 200 GB | | ||
| 3,000 to 5000 | **12**<br/>_Up from 8_ | 64 GB | 500 GB | 200 GB | | ||
| 5,000 to 8000 | **16**<br/>_Up from 12_ | 96 GB | 750 GB | 200 GB | | ||
| 8,000 to 10,000+ | **20**<br/>_Up from 16_ | **160 GB**<br/>_Up from 128 GB_ | 1000 GB | 200 GB | | ||
|
||
{% data reusables.enterprise_installation.about-adjusting-resources %} | ||
|
||
{% endif %} | ||
|
||
### Taking a snapshot | ||
|
||
A snapshot is a checkpoint of a virtual machine (VM) at a point in time. We highly recommend taking a snapshot before upgrading your virtual machine so that if an upgrade fails, you can revert your VM back to the snapshot. If you're upgrading to a new feature release, you must take a VM snapshot. If you're upgrading to a patch release, you can attach the existing data disk. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,26 +9,42 @@ versions: | |
enterprise-server: '>=2.22' | ||
--- | ||
|
||
{% if currentVersion == "[email protected]" %} | ||
{% note %} | ||
|
||
**Note:** {% data variables.product.prodname_actions %} support on {% data variables.product.prodname_ghe_server %} 2.22 is a limited public beta. Review the external storage requirements below and [sign up for the beta](https://resources.github.com/beta-signup/). | ||
|
||
{% endnote %} | ||
{% endif %} | ||
{% data reusables.actions.enterprise-beta %} | ||
|
||
{% data reusables.actions.enterprise-github-hosted-runners %} | ||
|
||
{% if currentVersion ver_gt "[email protected]" %} | ||
|
||
This article explains how site administrators can configure {% data variables.product.prodname_ghe_server %} to use {% data variables.product.prodname_actions %}. It covers the hardware and software requirements, presents the storage options, and describes the security management policies. | ||
|
||
{% endif %} | ||
|
||
### Review hardware considerations | ||
|
||
{% data reusables.actions.enterprise-hardware-considerations %} | ||
{% if currentVersion == "[email protected]" or currentVersion == "[email protected]" %} | ||
|
||
{% note %} | ||
|
||
**Note**: {% if currentVersion == "[email protected]" %}{% data variables.product.prodname_actions %} was available for {% data variables.product.prodname_ghe_server %} 2.22 as a limited beta. {% endif %}If you're upgrading an existing {% data variables.product.prodname_ghe_server %} instance to 3.0 or later and want to configure {% data variables.product.prodname_actions %}, note that the minimum hardware requirements have increased. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server#about-minimum-requirements-for-github-enterprise-server-30-and-later)." | ||
|
||
{% endnote %} | ||
|
||
{% endif %} | ||
|
||
{% data reusables.actions.enterprise-hardware-considerations %} | ||
|
||
For more information about resource requirements for {% data variables.product.prodname_ghe_server %}, see the hardware considerations for your instance's platform. | ||
|
||
- [AWS](/admin/installation/installing-github-enterprise-server-on-aws#hardware-considerations) | ||
- [Azure](/admin/installation/installing-github-enterprise-server-on-azure#hardware-considerations) | ||
- [Google Cloud Platform](/admin/installation/installing-github-enterprise-server-on-google-cloud-platform#hardware-considerations) | ||
- [Hyper-V](/admin/installation/installing-github-enterprise-server-on-hyper-v#hardware-considerations) | ||
- [OpenStack KVM](/admin/installation/installing-github-enterprise-server-on-openstack-kvm#hardware-considerations) | ||
- [VMware](/admin/installation/installing-github-enterprise-server-on-vmware#hardware-considerations) | ||
- [XenServer](/admin/installation/installing-github-enterprise-server-on-xenserver#hardware-considerations) | ||
|
||
{% data reusables.enterprise_installation.about-adjusting-resources %} | ||
|
||
### External storage requirements | ||
|
||
To enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, you must have access to external blob storage. | ||
|
@@ -55,7 +71,7 @@ To enable {% data variables.product.prodname_actions %} on {% data variables.pro | |
|
||
### Enabling {% data variables.product.prodname_actions %} | ||
|
||
{% data variables.product.prodname_actions %} support on {% data variables.product.prodname_ghe_server %} 2.22 is a limited public beta. [Sign up for the beta](https://resources.github.com/beta-signup/). | ||
{% data variables.product.prodname_actions %} support on {% data variables.product.prodname_ghe_server %} 2.22 was available as a limited beta. To configure {% data variables.product.prodname_actions %} for your instance, upgrade to {% data variables.product.prodname_ghe_server %} 3.0 or later. For more information, see the [{% data variables.product.prodname_ghe_server %} 3.0 release notes](/[email protected]/admin/release-notes) and "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server)." | ||
|
||
### Further reading | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,12 @@ | ||
{% if enterpriseServerVersions contains currentVersion and currentVersion == "[email protected]" %} | ||
{% note %} | ||
|
||
**Note:** {% data variables.product.prodname_actions %} support on {% data variables.product.prodname_ghe_server %} 2.22 is a limited public beta. To review the external storage requirements and request access to the beta, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)." | ||
**Note:** {% data variables.product.prodname_actions %} was available for {% data variables.product.prodname_ghe_server %} 2.22 as a limited beta. The beta has ended. {% data variables.product.prodname_actions %} is now generally available in {% data variables.product.prodname_ghe_server %} 3.0 or later. For more information, see the [{% data variables.product.prodname_ghe_server %} 3.0 release notes](/[email protected]/admin/release-notes). | ||
|
||
<br/> | ||
|
||
- For more information about upgrading to {% data variables.product.prodname_ghe_server %} 3.0 or later, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server)." | ||
- For more information about configuring {% data variables.product.prodname_actions %} after you upgrade, see the [documentation for {% data variables.product.prodname_ghe_server %} 3.0](/[email protected]/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server). | ||
|
||
{% endnote %} | ||
{% endif %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
{% data variables.product.prodname_ghe_server %} requires additional CPU and memory resources when {% data variables.product.prodname_actions %} is enabled. Before enabling {% data variables.product.prodname_actions %}, review the "Hardware considerations" for your platform in "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/admin/installation/setting-up-a-github-enterprise-server-instance)" and ensure that you satisfy the minimum requirements for the features that you want to enable on {% data variables.product.product_location %}. | ||
If you {% if currentVersion == "[email protected]" %} configured the beta of{% else %} configure{% endif %} {% data variables.product.prodname_actions %} for the users of your {% data variables.product.prodname_ghe_server %} instance, we recommend that you provision additional CPU and memory resources. The additional resources you need to provision depend on the number of workflows your users run concurrently, and the overall levels of activity for your instance. |
1 change: 1 addition & 0 deletions
1
data/reusables/enterprise_installation/about-adjusting-resources.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
For more information about adjusting resources for an existing instance, see "[Increasing storage capacity](/enterprise/admin/installation/increasing-storage-capacity)" and "[Increasing CPU or memory resources](/enterprise/admin/installation/increasing-cpu-or-memory-resources)." |
30 changes: 3 additions & 27 deletions
30
data/reusables/enterprise_installation/aws-supported-instance-types.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,13 @@ | ||
{% data variables.product.prodname_ghe_server %} is supported on the following EC2 instance types. For more information, see [the AWS EC2 instance type overview page](http://aws.amazon.com/ec2/instance-types/). | ||
{% data variables.product.prodname_ghe_server %} is supported on the following EC2 instance sizes. For more information, see [the AWS EC2 instance type overview page](http://aws.amazon.com/ec2/instance-types/). | ||
|
||
| EC2 instance type | Model | | ||
| ----------------- | ----- | | ||
| Type | Size | | ||
| :- | :- | | ||
| C3 | c3.2xlarge, c3.4xlarge, c3.8xlarge | | ||
|
||
| EC2 instance type | Model | | ||
| ----------------- | ----- | | ||
| C4 | c4.2xlarge, c4.4xlarge, c4.8xlarge | | ||
|
||
| EC2 instance type | Model | | ||
| ----------------- | ----- | | ||
| C5 | c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.18xlarge | | ||
|
||
| EC2 instance type | Model | | ||
| ----------------- | ----- | | ||
| M3 | m3.xlarge, m3.2xlarge | | ||
|
||
| EC2 instance type | Model | | ||
| ----------------- | ----- | | ||
| M4 | m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge | | ||
|
||
| EC2 instance type | Model | | ||
| ----------------- | ----- | | ||
| M5 | m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.12xlarge, m5.24xlarge | | ||
|
||
| EC2 instance type | Model | | ||
| ----------------- | ----- | | ||
| R4 | r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge | | ||
|
||
| EC2 instance type | Model | | ||
| ----------------- | ----- | | ||
| R5 | r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.12xlarge, r5.24xlarge{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "[email protected]" %}, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.12xlarge, r5n.24xlarge, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.12xlarge, r5a.24xlarge{% endif %} | | ||
|
||
| EC2 instance type | Model | | ||
| ----------------- | ----- | | ||
| X1 | x1.16xlarge, x1.32xlarge | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,13 @@ | ||
- [Minimum requirements](#minimum-requirements){% if currentVersion == "[email protected]" %} | ||
- [Beta features in {% data variables.product.prodname_ghe_server %} 2.22](#beta-features-in-github-enterprise-server-222){% endif %}{% if currentVersion ver_gt "[email protected]" %} | ||
- [Optional features](#optional-features){% endif %} | ||
- [Beta features in {% data variables.product.prodname_ghe_server %} 2.22](#beta-features-in-github-enterprise-server-222){% endif %} | ||
- [Storage](#storage) | ||
- [CPU and memory](#cpu-and-memory) | ||
|
||
#### Minimum requirements | ||
|
||
We recommend different hardware configurations depending on the number of user licenses for {% data variables.product.product_location %}. If you provision more resources than the minimum requirements, your instance will perform and scale better. | ||
|
||
{% data reusables.enterprise_installation.hardware-rec-table %}{% if currentVersion ver_gt "[email protected]" %} If you enable {% if currentVersion == "[email protected]" %}the beta for {% endif %}{% data variables.product.prodname_actions %}, review the following requirements and recommendations. | ||
|
||
- You must configure at least one runner for {% data variables.product.prodname_actions %} workflows. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)." | ||
- You must configure external blob storage. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)." | ||
- You may need to configure additional CPU and memory resources. The additional resources you need to provision for {% data variables.product.prodname_actions %} depend on the number of workflows your users run concurrently, and the overall levels of activity for users, automations, and integrations. | ||
|
||
| Maximum jobs per minute | Additional vCPUs | Additional memory | | ||
| :- | -: | -: | | ||
| Light testing | 4 | 30.5 GB | | ||
| 25 | 8 | 61 GB | | ||
| 35 | 16 | 122 GB | | ||
| 100 | 32 | 244 GB | | ||
|
||
{% endif %} | ||
{% data reusables.enterprise_installation.hardware-rec-table %} | ||
|
||
#### Storage | ||
|
||
|
@@ -31,15 +17,15 @@ Your instance requires a persistent data disk separate from the root disk. For m | |
|
||
{% if currentVersion ver_gt "[email protected]" %} | ||
|
||
If you enable{% if currentVersion == "[email protected]" %} the beta of{% endif %} {% data variables.product.prodname_actions %}, you'll need to configure external blob storage. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)." | ||
To configure{% if currentVersion == "[email protected]" %} the beta of{% endif %} {% data variables.product.prodname_actions %}, you must provide external blob storage. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server)." | ||
|
||
{% endif %} | ||
|
||
You can resize your instance's root disk by building a new instance or using an existing instance. For more information, see "[Increasing storage capacity](/enterprise/{{ currentVersion }}/admin/guides/installation/increasing-storage-capacity)." | ||
|
||
#### CPU and memory | ||
|
||
{% data variables.product.prodname_ghe_server %} requires more CPU and memory resources depending on levels of activity for users, automations, and integrations. | ||
The CPU and memory resources that {% data variables.product.prodname_ghe_server %} requires depend on the levels of activity for users, automations, and integrations. {% if currentVersion ver_gt "[email protected]" %}{% data reusables.actions.enterprise-hardware-considerations %}{% endif %} | ||
|
||
{% data reusables.enterprise_installation.increasing-cpus-req %} | ||
|
||
|
Oops, something went wrong.