Skip to content

Commit 47f8250

Browse files
authored
Generalize article on deployment of GitHub AE and add prerequisite (github#26193)
1 parent cfba19d commit 47f8250

File tree

8 files changed

+73
-71
lines changed

8 files changed

+73
-71
lines changed
Binary file not shown.

content/admin/configuration/configuring-your-enterprise/about-enterprise-configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ shortTitle: About configuration
2222
{% endif %}
2323

2424
{% ifversion ghae %}
25+
To get started with {% data variables.product.product_name %}, you first need to deploy {% data variables.product.product_name %}. For more information, see "[Deploying {% data variables.product.product_name %}](/admin/configuration/configuring-your-enterprise/deploying-github-ae)."
26+
2527
The first time you access your enterprise, you will complete an initial configuration to get {% data variables.product.product_name %} ready to use. The initial configuration includes connecting your enterprise with an identity provider (IdP), authenticating with SAML SSO, configuring policies for repositories and organizations in your enterprise, and configuring SMTP for outbound email. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)."
2628

2729
Later, you can use the site admin dashboard and enterprise settings to further configure your enterprise, manage users, organizations and repositories, and set policies that reduce risk and increase quality.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Deploying GitHub AE
3+
intro: 'You can deploy {% data variables.product.product_name %} to an available Azure region.'
4+
versions:
5+
ghae: '*'
6+
topics:
7+
- Accounts
8+
- Enterprise
9+
type: how_to
10+
shortTitle: Deploy GitHub AE
11+
redirect_from:
12+
- /get-started/signing-up-for-github/setting-up-a-trial-of-github-ae
13+
---
14+
15+
## About deployment of {% data variables.product.product_name %}
16+
17+
{% data reusables.github-ae.github-ae-enables-you %} For more information, see "[About {% data variables.product.prodname_ghe_managed %}](/admin/overview/about-github-ae)."
18+
19+
After you purchase or start a trial of {% data variables.product.product_name %}, you can deploy {% data variables.product.product_name %} to an available Azure region. This guide refers to the Azure resource that contains the deployment of {% data variables.product.product_name %} as the {% data variables.product.product_name %} account. You'll use the Azure portal at [https://portal.azure.com](https://portal.azure.com) to deploy the {% data variables.product.product_name %} account.
20+
21+
## Prerequisites
22+
23+
- Before you can deploy {% data variables.product.product_name %}, you must request access from your {% data variables.product.company_short %} account team. {% data variables.product.company_short %} will enable deployment of {% data variables.product.product_name %} for your Azure subscription. If you haven't already purchased {% data variables.product.product_name %}, you can contact {% data variables.contact.contact_enterprise_sales %} to check your eligibility for a trial.
24+
25+
- You must have permission to perform the `/register/action` operation for the resource provider in Azure. The permission is included in the `Contributor` and `Owner` roles. For more information, see [Azure resource providers and types](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types#register-resource-provider) in the Microsoft documentation.
26+
27+
## Deploying {% data variables.product.product_name %} with the {% data variables.actions.azure_portal %}
28+
29+
The {% data variables.actions.azure_portal %} allows you to deploy the {% data variables.product.product_name %} account in your Azure resource group.
30+
31+
1. Click one of the following two links to begin deployment of {% data variables.product.product_name %}. The link you should click depends on the Azure cloud where you plan to deploy {% data variables.product.product_name %}. For more information about Azure Government, see [What is Azure Government?](https://docs.microsoft.com/en-us/azure/azure-government/documentation-government-welcome) in the Microsoft documentation.
32+
33+
- [Deploy {% data variables.product.product_name %} to Azure Commercial](https://aka.ms/create-github-ae-instance)
34+
- [Deploy {% data variables.product.product_name %} to Azure Government](https://aka.ms/create-github-ae-instance-gov)
35+
1. To begin the process of adding a new {% data variables.product.product_name %} account, click **Create GitHub AE account**.
36+
1. Complete the "Project details" and "Instance details" fields.
37+
![{% data variables.actions.azure_portal %} search result](/assets/images/azure/github-ae-azure-portal-form.png)
38+
- **Account name:** The hostname for your enterprise
39+
- **Administrator username:** A username for the initial enterprise owner that will be created in {% data variables.product.product_name %}
40+
- **Administrator email:** The email address that will receive the login information
41+
1. To review a summary of the proposed changes, click **Review + create**.
42+
1. After the validation process has completed, click **Create**.
43+
44+
The email address you entered above will receive instructions on how to access your enterprise. After you have access, you can get started by following the initial setup steps. For more information, see "[Initializing {% data variables.product.product_name %}](/admin/configuration/initializing-github-ae)."
45+
46+
{% note %}
47+
48+
**Note:** Software updates for your {% data variables.product.product_name %} deployment are performed by {% data variables.product.prodname_dotcom %}. For more information, see "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)."
49+
50+
{% endnote %}
51+
52+
## Navigating to your enterprise
53+
54+
You can use the {% data variables.actions.azure_portal %} to navigate to your {% data variables.product.product_name %} deployment. The resulting list includes all the {% data variables.product.product_name %} deployments in your Azure region.
55+
56+
1. On the {% data variables.actions.azure_portal %}, in the left panel, click **All resources**.
57+
1. From the available filters, click **All types**, then deselect **Select all** and select **GitHub AE**:
58+
![{% data variables.actions.azure_portal %} search result](/assets/images/azure/github-ae-azure-portal-type-filter.png)
59+
60+
## Next steps
61+
62+
- Once your deployment has been provisioned, the next step is to initialize {% data variables.product.product_name %}. For more information, see "[Initializing {% data variables.product.product_name %}](/github-ae@latest/admin/configuration/configuring-your-enterprise/initializing-github-ae)."
63+
- If you're trying {% data variables.product.product_name %}, you can upgrade to a full license at any time during the trial period by contacting contact {% data variables.contact.contact_enterprise_sales %}. If you haven't upgraded by the last day of your trial, then the deployment is automatically deleted. If you need more time to evaluate {% data variables.product.product_name %}, contact {% data variables.contact.contact_enterprise_sales %} to request an extension.
64+
65+
## Further reading
66+
67+
- "[Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.product_name %}](/github/getting-started-with-github/about-github-advanced-security#enabling-advanced-security-features-on-github-ae)"
68+
- "[{% data variables.product.product_name %} release notes](/github-ae@latest/admin/overview/github-ae-release-notes)"

content/admin/configuration/configuring-your-enterprise/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ topics:
1616
- Enterprise
1717
children:
1818
- /about-enterprise-configuration
19+
- /deploying-github-ae
1920
- /initializing-github-ae
2021
- /accessing-the-management-console
2122
- /accessing-the-administrative-shell-ssh

content/admin/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ featuredLinks:
9696
- '{% ifversion ghae %}/admin/identity-and-access-management/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad{% endif %}'
9797
- '{% ifversion ghae %}/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise{% endif %}'
9898
- '{% ifversion ghae %}/admin/overview/about-upgrades-to-new-releases{% endif %}'
99-
- '{% ifversion ghae %}/get-started/signing-up-for-github/setting-up-a-trial-of-github-ae{% endif %}'
99+
- '{% ifversion ghae %}/admin/configuration/configuring-your-enterprise/deploying-github-ae{% endif %}'
100100
- '{% ifversion ghes %}/billing/managing-your-license-for-github-enterprise{% endif %}'
101101
- '{% ifversion ghes %}/admin/configuration/command-line-utilities{% endif %}'
102102
- '{% ifversion ghec %}/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise{% endif %}'

content/get-started/signing-up-for-github/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,5 @@ children:
1616
- /verifying-your-email-address
1717
- /setting-up-a-trial-of-github-enterprise-cloud
1818
- /setting-up-a-trial-of-github-enterprise-server
19-
- /setting-up-a-trial-of-github-ae
2019
---
2120

content/get-started/signing-up-for-github/setting-up-a-trial-of-github-ae.md

Lines changed: 0 additions & 69 deletions
This file was deleted.

data/learning-tracks/admin.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ get_started_with_github_ae:
77
guides:
88
- /admin/overview/about-github-ae
99
- /admin/overview/about-data-residency
10+
- /admin/configuration/configuring-your-enterprise/deploying-github-ae
1011
- /admin/configuration/initializing-github-ae
1112
- /admin/configuration/restricting-network-traffic-to-your-enterprise
1213
- /admin/github-actions/getting-started-with-github-actions-for-github-ae

0 commit comments

Comments
 (0)