3df90fc9b8
Are you looking for something? Here is all of the GitHub Docs history in one single commit. Enjoy! 🎉
7.2 KiB
title, intro, redirect_from, versions
| title | intro | redirect_from | versions | ||||
|---|---|---|---|---|---|---|---|
| Installing GitHub Enterprise Server on Google Cloud Platform | To install {{ site.data.variables.product.prodname_ghe_server }} on Google Cloud Platform, you must deploy onto a supported machine type and use a persistent standard disk or a persistent SSD. |
|
|
Prerequisites
- {{ site.data.reusables.enterprise_installation.software-license }}
- You must have a Google Cloud Platform account capable of launching Google Compute Engine (GCE) virtual machine (VM) instances. For more information, see the Google Cloud Platform website and the Google Cloud Platform Documentation.
- Most actions needed to launch your instance may also be performed using the Google Cloud Platform Console. However, we recommend installing the gcloud compute command-line tool for initial setup. Examples using the gcloud compute command-line tool are included below. For more information, see the "gcloud compute" installation and setup guide in the Google documentation.
Hardware considerations
{{ site.data.reusables.enterprise_installation.hardware-considerations-all-platforms }}
Determining the machine type
Before launching {{ site.data.variables.product.product_location_enterprise }} on Google Cloud Platform, you'll need to determine the machine type that best fits the needs of your organization.
Supported machine types
{{ site.data.variables.product.prodname_ghe_server }} is supported on the following Google Compute Engine (GCE) machine types. For more information, see the Google Cloud Platform machine types article. {% if currentVersion != "free-pro-team@latest" %}
| High-memory |
|---|
| n1-highmem-4 |
| n1-highmem-8 |
| n1-highmem-16 |
| n1-highmem-32 |
| n1-highmem-64 |
| n1-highmem-96 |
| {% endif %} |
Recommended machine types
Based on your user license count, we recommend these machine types.
| Seats | Recommended type |
|---|---|
| Trial, demo, or 10 light users | n1-standard-4 |
| 10 - 3000 | n1-standard-8 |
| 3000 - 5000 | n1-highmem-8 |
| 5000 - 8000 | n1-highmem-16 |
| 8000 - 10000+ | n1-highmem-32 |
{{ site.data.reusables.enterprise_installation.warning-on-scaling }}
Selecting the {{ site.data.variables.product.prodname_ghe_server }} image
- Using the gcloud compute command-line tool, list the public {{ site.data.variables.product.prodname_ghe_server }} images:
$ gcloud compute images list --project github-enterprise-public --no-standard-images
2. Take note of the image name for the latest GCE image of {{ site.data.variables.product.prodname_ghe_server }}.
### Configuring the firewall
GCE virtual machines are created as a member of a network, which has a firewall. For the network associated with the {{ site.data.variables.product.prodname_ghe_server }} VM, you'll need to configure the firewall to allow the required ports listed in the table below. For more information about firewall rules on Google Cloud Platform, see the Google guide "[Firewall Rules Overview](https://cloud.google.com/vpc/docs/firewalls)."
1. Using the gcloud compute command-line tool, create the network. For more information, see "[gcloud compute networks create](https://cloud.google.com/sdk/gcloud/reference/compute/networks/create)" in the Google documentation.
```shell
$ gcloud compute networks create <em>NETWORK-NAME</em> --subnet-mode auto
- Create a firewall rule for each of the ports in the table below. For more information, see "gcloud compute firewall-rules" in the Google documentation.
$ gcloud compute firewall-rules create <em>RULE-NAME</em> \
--network <em>NETWORK-NAME</em> \
--allow tcp:22,tcp:25,tcp:80,tcp:122,udp:161,tcp:443,udp:1194,tcp:8080,tcp:8443,tcp:9418,icmp
This table identifies the required ports and what each port is used for.
{{ site.data.reusables.enterprise_installation.necessary_ports }}
Allocating a static IP and assigning it to the VM
If this is a production appliance, we strongly recommend reserving a static external IP address and assigning it to the {{ site.data.variables.product.prodname_ghe_server }} VM. Otherwise, the public IP address of the VM will not be retained after restarts. For more information, see the Google guide "Reserving a Static External IP Address."
In production High Availability configurations, both primary and replica appliances should be assigned separate static IP addresses.
Creating the {{ site.data.variables.product.prodname_ghe_server }} instance
To create the {{ site.data.variables.product.prodname_ghe_server }} instance, you'll need to create a GCE instance with your {{ site.data.variables.product.prodname_ghe_server }} image and attach an additional storage volume for your instance data. For more information, see "Hardware considerations."
- Using the gcloud compute command-line tool, create a data disk to use as an attached storage volume for your instance data, and configure the size based on your user license count. For more information, see "gcloud compute disks create" in the Google documentation.
$ gcloud compute disks create <em>DATA-DISK-NAME</em> --size <em>DATA-DISK-SIZE</em> --type <em>DATA-DISK-TYPE</em> --zone <em>ZONE</em>
- Then create an instance using the name of the {{ site.data.variables.product.prodname_ghe_server }} image you selected, and attach the data disk. For more information, see "gcloud compute instances create" in the Google documentation.
$ gcloud compute instances create <em>INSTANCE-NAME</em> \
--machine-type n1-standard-8 \
--image <em>GITHUB-ENTERPRISE-IMAGE-NAME</em> \
--disk name=<em>DATA-DISK-NAME</em> \
--metadata serial-port-enable=1 \
--zone <em>ZONE</em> \
--network <em>NETWORK-NAME</em> \
--image-project github-enterprise-public
Configuring the instance
{{ site.data.reusables.enterprise_installation.copy-the-vm-public-dns-name }} {{ site.data.reusables.enterprise_installation.upload-a-license-file }} {{ site.data.reusables.enterprise_installation.save-settings-in-web-based-mgmt-console }} For more information, see "Configuring the {{ site.data.variables.product.prodname_ghe_server }} appliance." {{ site.data.reusables.enterprise_installation.instance-will-restart-automatically }} {{ site.data.reusables.enterprise_installation.visit-your-instance }}