Gitpod Enterprise Installation Process

Request your Enterprise trial

Deploying Gitpod Enterprise on AWS is a streamlined and secure process, designed to get your development environment up and running with minimal hassle. Here’s what to expect during the installation:

  • Communication with Account Managers: Your journey begins by communicating your AWS account ID and chosen region to your Gitpod account manager. This initial step ensures that our team is aligned with your setup preferences and requirements.

  • Applying CloudFormation (CF) Stacks: You will receive deep links to CloudFormation templates tailored for Gitpod deployment. The process starts with applying a CF stack that creates an IAM role with the necessary permissions, followed by the main Gitpod CF stack. These templates simplify the setup, allowing for a secure and compliant infrastructure deployment.

  • Setting Up SSO with Admin URL: After the infrastructure is in place, the next step involves setting up Single Sign-On (SSO). We’ll provide you with an admin URL to configure SSO, ensuring secure access control to your Gitpod Enterprise environment.

  • Sit Back and Relax: Once the setup is complete, you can relax while we manage your Gitpod installation. Our team monitors your system around the clock, providing uninterrupted service on your Gitpod instance, ensuring everything is optimized for performance and security.

  • Regular Upgrades: Gitpod Enterprise is continually improving, and you’ll receive updates for your CloudFormation templates. These updates can be applied with a one-click solution, keeping your environment up to date with the latest features and security enhancements.

This comprehensive approach ensures a hassle-free setup, allowing you to focus on what you do best — building great software.

AWS Support and Regions

Gitpod Enterprise is currently supported exclusively on AWS, leveraging its robust and scalable infrastructure to provide a seamless development environment. Here are the key points regarding our AWS support:

Exclusive AWS Support:

Our deep integration with AWS services and infrastructure ensures that Gitpod Enterprise leverages the best of cloud technology, offering scalability, security, and reliability.

Supported AWS Regions:

To ensure optimal performance and compliance with data residency requirements, Gitpod Enterprise is available in specific AWS regions. Currently, we support the following regions:

  • us-east-1
  • us-east-2
  • us-west-2
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • sa-east-1
  • me-south-1

We also offer conditional support for the following regions upon request:

  • us-west-1
  • ap-northeast-1
  • ap-southeast-2

This list is continually updated to reflect our expanding support and capabilities across AWS’s global infrastructure. If you would like to host Gitpod Enterprise in a region that is currently not listed please contact sales.

Choosing the right AWS region for your Gitpod Enterprise setup is crucial for minimizing latency and aligning with your organization’s data residency policies. Our team is here to assist in selecting the best region based on your specific needs.

Frequently Asked Questions

Q. Why two templates?
A. The gitpod-role CloudFormation template is used to create a role with the minimum permissions required to install and update Enterprise. This role and its policies are used to install the second Cloudformation template.

Q. Can the stack created by gitpod-role be deleted after executing the <company>-gitpod-template.json?
A. No, the stack created by gitpod-role should be maintained. The role created is also used when updates are provided to the <company>-gitpod-template.json template. For more details on infrastructure updates, please see Deployment and Updates.

Q. What happens if my Cloudformation stack fails to install? A. If the stack fails to install, you should delete the stack and try again. There are a few resources that need to be cleaned up manually before you attempt another installation. See Deleting your Gitpod installation for details.

Q. Can we grant public access to webhooks and IDP services without exposing the entire Gitpod application to the Internet?
A. Yes. Enterprise can be configured to expose webhooks and IDP services on public endpoints. This can be helpful for connecting to OIDC providers such as Okta, Azure AD. This option also makes it easy for developers to connect to your instance without having to route through a VPN or transit gateway. See Networking and Data flows for more information.

Q. How can we audit the templates before applying them?

A. AWS CloudFormation template deep links shared with you are designed to be readable only from the AWS account associated with your Gitpod account managers. Your template is stored in an S3 bucket accessible only from that AWS account. You can obtain the S3 bucket name from the deep link URL of your template or by requesting the S3 URLs from your Gitpod account manager.

Here’s how to generate the template URL from the Deep Link URL shared with you:

  • The deep link should be in the following format:
  • In this example, the S3 bucket name is cell-877922613839-e674f78d2bf55fd93c878f7f and the path to the template JSON is infrastructure/template.json. Therefore, you can generate the S3 URL as s3://cell-877922613839-e674f78d2bf55fd93c878f7f/infrastructure/template.json.

Once you have the S3 URL, follow these steps to download the template:

  1. Open CloudShell in the Gitpod AWS account or configure the AWS CLI in a terminal.

  2. Run the following command to download the template:

    language icon bash
    aws s3 cp s3://cell-877922613839-e674f78d2bf55fd93c878f7f/infrastructure/template.json .

By following these steps, you can audit your CloudFormation templates before applying them.

❓ Got Questions? Contact Support

Was this helpful?