reference deployment

GitHub Enterprise on AWS

Development, continuous integration, and collaboration platform on the AWS Cloud

This solution deploys a free, 45-day trial version of GitHub Enterprise automatically into your Amazon Web Services (AWS) account.

GitHub Enterprise is a development and collaboration platform built on Git that enables developers to build and share software easily and effectively. It provides an integrated platform for continuous integration and development, a non-linear workflow for collaboration, and in-depth monitoring and auditing for administrators. By deploying GitHub Enterprise on AWS, you can take advantage of a configurable infrastructure for your coding and deployment tasks.

aws logo

This solution was developed by AWS solutions architects.

  •  What you'll build
  • Use this solution to set up the following GitHub Enterprise environment on AWS:

    • A virtual private cloud (VPC) with a single Availability Zone and public subnet.*
    • An internet gateway to provide access to the internet.*
    • In the public subnet, a GitHub Enterprise EC2 instance with an attached, customizable Amazon Elastic Block Store (Amazon EBS) volume.
    • An Amazon CloudWatch monitoring resource that will automatically restore the GitHub Enterprise EC2 instance if it becomes unresponsive.
    • An AWS Identity and Access Management (IAM) role with the necessary permissions to manage access to resources.
    • A security group to enable communication within the VPC and to interact with the GitHub Enterprise EC2 instance.
    • A sample Github organization and repository you can use to test the deployment.

    * The template that deploys the solution into an existing VPC skips the tasks marked by asterisks and prompts you for your existing VPC configuration.

  •  How to deploy
  • To build your GitHub Enterprise environment, follow the instructions in the deployment guide. The deployment process includes these steps:

    1. If you don't already have an AWS account, sign up at https://aws.amazon.com.
    2. Sign up for a free, 45-day trial license for GitHub Enterprise at https://enterprise.github.com/sn-trial.
    3. Launch the solution. Each deployment takes about 15 minutes. You can choose from two options:
    4. Test the deployment by accessing the GitHub Enterprise instance on AWS, and by accessing and cloning the sample repository set up by the solution.

    You can customize your deployment by configuring your network resources and modifying the instance type and storage options for the GitHub Enterprise web server.

    Amazon may share user-deployment information with the AWS Partner that collaborated with AWS on this solution.  

  •  Costs and licenses
  • This solution requires a trial version of GitHub Enterprise, which is available for free from GitHub.

    You are responsible for the cost of the AWS services and any third-party licenses used while running this solution. There is no additional cost for using the solution.

    This solution includes configuration parameters that you can customize. Some of these settings, such as instance type, affect the cost of deployment. For cost estimates, refer to the pricing pages for each AWS service you use. Prices are subject to change.

    Tip: After you deploy a solution, create AWS Cost and Usage Reports to track associated costs. These reports deliver billing metrics to an Amazon Simple Storage Service (Amazon S3) bucket in your account. They provide cost estimates based on usage throughout each month and aggregate the data at the end of the month. For more information, refer to What are AWS Cost and Usage Reports?