Skip to content

Commit 31084cb

Browse files
Merge branch 'main' into patch-4
2 parents d11f5e3 + f49eedb commit 31084cb

File tree

92 files changed

+774
-491
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+774
-491
lines changed
452 KB
Loading
391 KB
Loading

content/actions/hosting-your-own-runners/managing-self-hosted-runners/communicating-with-self-hosted-runners.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,14 @@ For caching to work, the runner must be able to communicate with the blob storag
4040

4141
You must ensure that the machine has the appropriate network access with at least 70 kilobits per second upload and download speed to communicate with the {% data variables.product.prodname_dotcom %} hosts listed below. Some hosts are required for essential runner operations, while other hosts are only required for certain functionality.
4242

43-
You can use the REST API to get meta information about {% data variables.product.company_short %}, including the IP addresses of {% data variables.product.company_short %} services. See [AUTOTITLE](/rest/meta/meta).
43+
You can use the REST API to get meta information about {% data variables.product.company_short %}, including the IP addresses and domain details for {% data variables.product.company_short %} services. The `actions_inbound` section of the API supports both fully qualified and wildcard domains. Fully qualified domains specify a complete domain name (e.g., `example.github.com`), while wildcard domains use a `*` to represent multiple possible subdomains (e.g., `*.github.com`). An example of the self-hosted runner requirements using wildcard domains has been listed below. For more information, see [AUTOTITLE](/rest/meta/meta).
44+
45+
```shell copy
46+
github.com
47+
*.github.com
48+
*.githubusercontent.com
49+
ghcr.io
50+
```
4451

4552
{% data reusables.actions.domain-name-cname-recursive-firewall-rules %}
4653

@@ -71,6 +78,15 @@ codeload.github.com
7178
pkg.actions.githubusercontent.com
7279
```
7380

81+
You can use the REST API to get meta information about {% data variables.product.company_short %}, including the IP addresses and domain details for {% data variables.product.company_short %} services. The `actions_inbound` section of the API supports both fully qualified and wildcard domains. Fully qualified domains specify a complete domain name (e.g., `example.github.com`), while wildcard domains use a `*` to represent multiple possible subdomains (e.g., `*.github.com`). An example of the self-hosted runner requirements using wildcard domains has been listed below. For more information, see [AUTOTITLE](/rest/meta/meta).
82+
83+
```shell copy
84+
github.com
85+
*.github.com
86+
*.githubusercontent.com
87+
ghcr.io
88+
```
89+
7490
{% data reusables.actions.domain-name-cname-recursive-firewall-rules %}
7591

7692
{% endif %}

content/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ The following features are currently unavailable on {% data variables.enterprise
2828
| {% data variables.product.prodname_copilot %} Workspaces | Currently unavailable | N/A |
2929
| {% data variables.product.prodname_copilot_extensions %} | Currently unavailable | [AUTOTITLE](/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat) |
3030
| {% data variables.product.prodname_copilot_short %} Metrics API | Currently unavailable | [AUTOTITLE](/rest/copilot/copilot-metrics) |
31-
| Interactive maps | Currently can't use GeoJSON/TopoJSON syntax to create interactive maps. | [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams#creating-geojson-and-topojson-maps) |
3231
| Restricting {% data variables.product.prodname_actions %} policies to verified creators | Currently unavailable | [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#allow-enterprise-and-select-non-enterprise-actions-and-reusable-workflows) |
3332
| Some features currently in {% data variables.release-phases.public_preview %} or {% data variables.release-phases.private_preview %} | Certain features that are in a preview phase on {% data variables.product.prodname_dotcom_the_website %} may not be available on {% data variables.enterprise.data_residency_site %} | |
3433

content/admin/data-residency/network-details-for-ghecom.md

Lines changed: 35 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -36,39 +36,34 @@ To access your enterprise on {% data variables.enterprise.data_residency_site %}
3636

3737
These are {% data variables.product.company_short %}'s IP address ranges for enterprises hosted in the EU.
3838

39-
#### Ranges for egress traffic
40-
41-
* 108.143.221.96/28
42-
* 20.61.46.32/28
43-
* 20.224.62.160/28
44-
* 51.12.252.16/28
45-
* 74.241.131.48/28
46-
* 20.240.211.176/28
47-
48-
#### Ranges for ingress traffic
49-
50-
* 108.143.197.176/28
51-
* 20.123.213.96/28
52-
* 20.224.46.144/28
53-
* 20.240.194.240/28
54-
* 20.240.220.192/28
55-
* 20.240.211.208/28
39+
| Ranges for egress traffic | Ranges for ingress traffic |
40+
|--------------------------|---------------------------|
41+
| 108.143.221.96/28 | 108.143.197.176/28 |
42+
| 20.61.46.32/28 | 20.123.213.96/28 |
43+
| 20.224.62.160/28 | 20.224.46.144/28 |
44+
| 51.12.252.16/28 | 20.240.194.240/28 |
45+
| 74.241.131.48/28 | 20.240.220.192/28 |
46+
| 20.240.211.176/28 | 20.240.211.208/28 |
5647

5748
### Australia
5849

5950
These are {% data variables.product.company_short %}'s IP address ranges for enterprises hosted in Australia.
6051

61-
#### Ranges for egress traffic
52+
| Ranges for egress traffic | Ranges for ingress traffic |
53+
|--------------------------|---------------------------|
54+
| 20.5.34.240/28 | 4.237.73.192/28 |
55+
| 20.5.146.128/28 | 20.5.226.112/28 |
56+
| 68.218.155.16/28 | 20.248.163.176/28 |
6257

63-
* 20.5.34.240/28
64-
* 20.5.146.128/28
65-
* 68.218.155.16/28
58+
### US
6659

67-
#### Ranges for ingress traffic
60+
These are {% data variables.product.company_short %}'s IP address ranges for enterprises hosted in the US.
6861

69-
* 4.237.73.192/28
70-
* 20.5.226.112/28
71-
* 20.248.163.176/28
62+
| Ranges for egress traffic | Ranges for ingress traffic |
63+
|--------------------------|---------------------------|
64+
| 20.221.76.128/28 | 74.249.180.192/28 |
65+
| 135.233.115.208/28 | 48.214.149.96/28 |
66+
| 20.118.27.192/28 | 172.202.123.176/28 |
7267

7368
## Supported regions for Azure private networking
7469

@@ -90,6 +85,14 @@ If you use Azure private networking for {% data variables.product.company_short
9085
| arm64 | `australiaeast`, `australiacentral` |
9186
| GPU | N/A |
9287

88+
### Supported regions in the US
89+
90+
| Runner type | Supported regions |
91+
| ----------- | ----------------- |
92+
| x64 | `centralus`, `eastus2`, `westus3` |
93+
| arm64 | `centralus`, `eastus2`, `westus3` |
94+
| GPU | `centralus`, `eastus2`, `westus3` |
95+
9396
## IP ranges for {% data variables.product.prodname_importer_proper_name %}
9497

9598
If you're running a migration to your enterprise with {% data variables.product.prodname_importer_proper_name %}, you may need to add certain ranges to an IP allow list. See [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#configuring-ip-allow-lists-for-migrations).
@@ -134,3 +137,10 @@ You must allow:
134137
* 20.5.34.240/28
135138
* 20.5.146.128/28
136139
* 68.218.155.16/28
140+
141+
### Required in the US
142+
143+
* 130.213.245.128/28
144+
* 20.171.204.144/28
145+
* 20.171.204.176/28
146+
* 4.150.167.192/28

content/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,34 @@ This guide recommends the principle of least privilege when setting up {% data v
3939

4040
{% data reusables.enterprise_installation.hardware-considerations-all-platforms %}
4141

42+
### Storage volume performance recommendations for AWS
43+
44+
{% data variables.product.prodname_ghe_server %} is I/O intensive and requires high-performance storage for both the root volume and data volume to ensure optimal performance. Both volumes need high IOPS and low latency, as insufficient disk I/O is a common cause of performance degradation and service disruptions.
45+
46+
When selecting Amazon EBS volume types, consider the following guidance:
47+
48+
* For most deployments, `gp3` volumes provide a good starting point with configurable IOPS and throughput
49+
* For larger or high-activity deployments, `io1` or `io2` volumes may be more appropriate due to their consistent performance characteristics
50+
* Very large or mission-critical deployments may benefit from `io2 Block Express` for the highest performance levels
51+
52+
> [!IMPORTANT]
53+
> The optimal storage configuration for your instance will vary significantly based on your specific usage patterns. Factors that increase I/O requirements include:
54+
>
55+
> * Number of active users and repositories
56+
> * CI/CD workload volume and frequency
57+
> * API usage patterns and automation
58+
> * Git operation frequency and repository sizes
59+
>
60+
> We strongly recommend continuously monitoring your instance's disk performance in the Management Console metrics dashboard. Pay particular attention to:
61+
>
62+
> * **Disk queue length**: Should remain near zero.
63+
> * **I/O utilization**: Sustained periods above 80% indicate need for more IOPS.
64+
> * **Disk latency**: Should remain below 1-2ms.
65+
>
66+
> Be prepared to adjust your storage configuration as your usage patterns evolve. Scale up IOPS allocation proactively if you observe performance bottlenecks to prevent service degradation.
67+
68+
For more information about Amazon EBS volume types, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html#vol-type-ssd) in the AWS documentation.
69+
4270
## Determining the instance type
4371

4472
Before launching {% data variables.location.product_location %} on AWS, you'll need to determine the machine type that best fits the needs of your organization. To review the minimum recommended requirements for {% data variables.product.prodname_ghe_server %}, see [Minimum recommended requirements](#minimum-recommended-requirements).

content/admin/managing-iam/provisioning-user-accounts-with-scim/configuring-scim-provisioning-for-users.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,8 @@ To use a partner IdP's application for both authentication and provisioning, rev
176176

177177
If you don't use a partner IdP, or if you only use a partner IdP for authentication, you can manage the lifecycle of user accounts using {% data variables.product.company_short %}'s REST API endpoints for SCIM provisioning. See [AUTOTITLE](/admin/identity-and-access-management/provisioning-user-accounts-for-enterprise-managed-users/provisioning-users-and-groups-with-scim-using-the-rest-api).
178178

179+
{% data reusables.emus.mixed-systems-note %}
180+
179181
{% ifversion emu-public-scim-schema %}
180182

181183
{% data reusables.emus.sign-in-as-setup-user %}

content/admin/managing-iam/provisioning-user-accounts-with-scim/provisioning-users-and-groups-with-scim-using-the-rest-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,15 @@ When you configure authentication and provisioning for your enterprise, you can
5757

5858
### Using a partner identity provider
5959

60-
Each partner IdP provides a "paved-path" application, which implements both SSO and user lifecycle management. To simplify configuration, {% data variables.product.company_short %} recommends that you use a partner IdP's application for both authentication and provisioning. For more information and a list of partner IdPs, see {% ifversion ghec %}[AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users#identity-management-systems).{% else %}[AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/user-provisioning-with-scim-on-ghes#supported-identity-providers).{% endif %}
60+
Each partner IdP provides a "paved-path" application, which implements both SSO and user lifecycle management. To simplify configuration, {% data variables.product.company_short %} recommends that you use a single partner IdP application for both authentication and provisioning. For more information and a list of partner IdPs, see {% ifversion ghec %}[AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users#identity-management-systems).{% else %}[AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/user-provisioning-with-scim-on-ghes#supported-identity-providers).{% endif %}
6161

6262
For more information about configuring SCIM provisioning using a partner IdP, see [AUTOTITLE](/admin/identity-and-access-management/provisioning-user-accounts-for-enterprise-managed-users/configuring-scim-provisioning-for-enterprise-managed-users).
6363

6464
### Using other identity management systems
6565

66-
If you cannot use a partner IdP for both authentication and provisioning due to migration overhead, licensing costs, or organizational inertia, you can use another identity management system or combination of systems. The systems must provide authentication using SAML and user lifecycle management using SCIM, and must adhere to {% data variables.product.company_short %}'s integration guidelines.
66+
If you cannot use a single partner IdP for both authentication and provisioning due to migration overhead, licensing costs, or organizational inertia, you can use another identity management system or combination of systems. The systems must provide authentication using SAML and user lifecycle management using SCIM, and must adhere to {% data variables.product.company_short %}'s integration guidelines.
6767

68-
{% data variables.product.company_short %} has not tested integration with every identity management system. While integration with {% ifversion ghec %}{% data variables.product.prodname_emus %}{% else %}{% data variables.product.prodname_ghe_server %}{% endif %} may be possible, {% data variables.product.company_short %}'s support team may not be able to assist you with issues related to these systems. If you need help with an identity management system that's not a partner IdP, or if you use a partner IdP only for SAML authentication, you must consult the system's documentation, support team, or other resources.
68+
{% data reusables.emus.mixed-systems-note %}
6969

7070
## Prerequisites
7171

content/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ If you cannot use a single partner IdP for both authentication and provisioning,
6565
* Provide **authentication using SAML**, adhering to SAML 2.0 specification
6666
* Provide **user lifecycle management using SCIM**, adhering to the SCIM 2.0 specification and communicating with {% data variables.product.company_short %}'s REST API (see [AUTOTITLE](/admin/identity-and-access-management/provisioning-user-accounts-for-enterprise-managed-users/provisioning-users-with-scim-using-the-rest-api))
6767

68-
{% data variables.product.company_short %} does not expressly support mixing and matching partner IdPs for authentication and provisioning and does not test all identity management systems. **{% data variables.product.company_short %}'s support team may not be able to assist you with issues related to mixed or untested systems.** If you need help, you must consult the system's documentation, support team, or other resources.
68+
{% data reusables.emus.mixed-systems-note %}
6969

7070
## Usernames and profile information
7171

content/admin/overview/setting-up-a-trial-of-github-enterprise-cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To set up a trial, you must be signed in to a personal account. If you don't hav
2020

2121
<a href="https://github.com/account/enterprises/new?ref_cta=GHEC+trial&ref_loc=setting+up+a+trial+of+github+enterprise+cloud&ref_page=docs" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Set up a trial of {% data variables.product.prodname_ghe_cloud %}</span> {% octicon "link-external" height:16 %}</a>
2222

23-
>[!IMPORTANT] Your trial enterprise will be hosted in the USA. If you require {% data variables.enterprise.data_residency_short %} outside the USA, contact {% data variables.contact.contact_sales_data_residency %}.
23+
>[!IMPORTANT] Your trial enterprise will be hosted in the US. If you require {% data variables.enterprise.data_residency_short %} in a specific region, contact {% data variables.contact.contact_sales_data_residency %}.
2424
2525
{% data reusables.enterprise.enterprise-types %}
2626

0 commit comments

Comments
 (0)