Estimated completion time: 10-15 minutes

This setup is intended for evaluation and testing purposes only. It is not recommended for production environments.

This guide does not include SSL setup because it is intended solely for evaluation purposes; always enable SSL in production environments.

This tutorial doesn’t work on GovCloud accounts (us-gov regions).


1. Overview

This guide will walk you through quickly deploying Develocity on an Amazon EC2 instance.
It assumes that you have a basic understanding of AWS and EC2.

If you’re not familiar with AWS and EC2 and looking for more detailed step-by-step instructions, follow the Amazon EC2 Standalone Installation Guide for more detailed information.

This guide will use the AWS Management Console to create an EC2 instance, and you will use the Amazon EC2 console to connect to the instance.

You will use the Build Scan® example project for publishing your first Build Scan to your Develocity instance.

2. Before You Start

Before you start following the guide, ensure that you complete the following prerequisites:

  • An AWS paid account, a free tier account isn’t sufficient

  • Access to EC2: You should be familiar with launching and managing EC2 instances

  • An AWS IAM user with the AmazonEC2FullAccess AWS managed policy

  • A Develocity license. If you have purchased Develocity or started a trial, you should already have a license file called develocity.license. Otherwise, you may request a Develocity trial license

  • curl (locally)

  • git (locally)

  • A terminal (locally)

3. Launch an EC2 Instance

  • Log in to the AWS Console:

    • Go to the AWS Management Console and sign in with your credentials

  • Launch an EC2 Instance:

  • Configure the instance with the following settings:

  • Key pair (login):

    • (Select your key pair)

  • Network settings:

    • Assign public IP (needed for the Amazon EC2 console)

    • Select Create security group

    • Allow SSH (Default Anywhere 0.0.0.0/0)

    • Configure the Security Group to allow HTTPS access (port 443)

    • Configure the Security Group to allow HTTP access (port 80)

  • Configure storage

  • Launch the Instance:

    • Review your configurations and launch the instance by selecting Launch instance

Example configuration
ec2 qs aws ui 1
ec2 qs aws ui 2
ec2 qs aws ui 3
ec2 qs aws ui 4
ec2 qs aws ui 5

Once the instance is running, navigate to the EC2 Dashboard EC2  Instances, select your newly created instance and write down the Public IPv4 DNS, you will need this URL for the installation.

4. Installation

Login into the instance using the Amazon EC2 console and run sudo apt update -y and sudo apt upgrade -y to make sure your instance is up to date.

4.1. Upload your Develocity license to the EC2 instance

On the instance, create a new file called develocity.license, copy-and-paste your Develocity license into this file and save it.

4.2. Download and validate the installation script

Download the ec2-install.sh and the ec2-install.sh.sha256 files from GitHub by running the following curl commands:

Download the script:

CLI
$ curl -O https://raw.githubusercontent.com/gradle/develocity-quickstart-scripts/refs/heads/main/AWS/EC2/ec2-install.sh

Download the checksum for validation:

CLI
$ curl -O https://raw.githubusercontent.com/gradle/develocity-quickstart-scripts/refs/heads/main/AWS/EC2/ec2-install.sh.sha256

Validate the script against the checksum:

CLI
$ sha256sum -c ec2-install.sh.sha256
Output
ec2-install.sh: OK

The values generated by the sha256sum utility must match.
If they’re different, your download is incomplete or corrupted. You will need to download the files again.
If, after several attempts, you can’t download a copy of the file that produces a valid checksum value, you should open a support case to report the problem.

Adjust the permissions of the script to make it executable for your user:

CLI
$ chmod u+x ec2-install.sh

4.3. Run the installation script

Review the script before you run it, never run scripts without reviewing them before!

The installation script sets up a lightweight Kubernetes (K3s) environment in which the entire Platform is deployed using Helm.

It performs the following actions in a sequence:

  • Installs K3s server

  • Start K3s server

  • Installs Helm

  • Fetches the Develocity charts from the Helm repository

  • Initializes the Develocity Pods in K3s

  • Creates a base settings.gradle.kts file which is pre-configured for your new instance

CLI
$ ./ec2-install.sh --license «path-to-your-develocity-license» \(1)
    --hostname «develocity-host» (2)
1 The path to your Develocity license
2 The public DNS name of your EC2 instance

At the end, the installation script will display the system user credentials. These are saved in a file called credentials.txt as well.

Example of running the script
Output
ubuntu@ip-172-31-3-0:~$ ./ec2-install.sh --license develocity.license --hostname ec2-63-177-95-205.eu-central-1.compute.amazonaws.com

Develocity Platform Installation

This script will setup a Develocity instance which is customized for evaluating purpose only.
Press Enter to continue...
[INFO]  Validating system requirements
[INFO]  Installing K3s...
[INFO]  Using v1.32.2+k3s1 as release
[INFO]  Downloading hash https://github.com/k3s-io/k3s/releases/download/v1.32.2+k3s1/sha256sum-amd64.txt
[INFO]  Downloading binary https://github.com/k3s-io/k3s/releases/download/v1.32.2+k3s1/k3s
[INFO]  Verifying binary download
[INFO]  Installing k3s to /usr/local/bin/k3s
[INFO]  Skipping installation of SELinux RPM
[INFO]  Creating /usr/local/bin/kubectl symlink to k3s
[INFO]  Creating /usr/local/bin/crictl symlink to k3s
[INFO]  Creating /usr/local/bin/ctr symlink to k3s
[INFO]  Creating killall script /usr/local/bin/k3s-killall.sh
[INFO]  Creating uninstall script /usr/local/bin/k3s-uninstall.sh
[INFO]  env: Creating environment file /etc/systemd/system/k3s.service.env
[INFO]  systemd: Creating service file /etc/systemd/system/k3s.service
[INFO]  systemd: Enabling k3s unit
Created symlink /etc/systemd/system/multi-user.target.wants/k3s.service → /etc/systemd/system/k3s.service.
[INFO]  systemd: Starting k3s
k3s service is running.
[INFO]  Configuring K3s, this requires sudo access...
[INFO]  Installing Helm...
Downloading https://get.helm.sh/helm-v3.17.1-linux-amd64.tar.gz
Verifying checksum... Done.
Preparing to install helm into /usr/local/bin
helm installed into /usr/local/bin/helm
[INFO]  Installing/Upgrading DV Platform Helm chart using license path: develocity.license
"gradle" has been added to your repositories
Hang tight while we grab the latest from your chart repositories...
...Successfully got an update from the "gradle" chart repository
Update Complete. ⎈Happy Helming!⎈
NAME: ge-standalone
LAST DEPLOYED: Thu Mar  6 14:38:00 2025
NAMESPACE: develocity
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
Develocity has been installed.
[INFO]  Checking installation status ...
[####################################################################################################] 100% (Ready: 10 / 10)
All pods are ready!
[INFO]  Checking Develocity connectivity
SUCCESS

Your Develocity instance is deployed.
Access Develocity via the browser at: ec2-63-177-95-205.eu-central-1.compute.amazonaws.com

      Develocity user: system
      Develocity password: Je2MvyFXjGousw32FNFACpNYP5PZdJAn

      Credentials are also saved to credentials.txt file in the current directory.

      For more information, please visit:

      Develocity Administration Manual: https://docs.gradle.com/develocity/helm-admin/current/
      Helm Chart Documentation: https://docs.gradle.com/develocity/tutorials/helm-standalone/current/

      You can check the status of the Platform by running the following command:

      kubectl --namespace develocity get pods

      If you have any questions or need any assistance contact the Develocity support team or your customer success representative.

      The installation script created a pre-configured setting.gradle.kts file for you.

For more info about the script, run ./ec2-install.sh -h.

It will take several minutes until Develocity is deployed.

After the installation is finished, open a web browser and navigate to the public DNS name of your EC2 instance.

ec2 qs build scan overview

5. Example Project

In the next part of this guide, you will publish your first Build Scan to your Develocity instance using the Build Scan example from GitHub.

5.1. Clone the project

Clone the Build Scan example from GitHub:

CLI
$ git clone https://github.com/gradle/gradle-build-scan-quickstart.git

Change into the cloned repository

CLI
$ cd gradle-build-scan-quickstart

5.2. Configure the settings

Replace the content of the settings.gradle.kts file with the content of the settings.gradle.kts which was generated during the Develocity deployment

Example
settings.gradle.kts
plugins {
    // Develocity Gradle Plugin
    id("com.gradle.develocity") version("3.19.2") (1)
    id("org.gradle.toolchains.foojay-resolver-convention") version "0.9.0" (2)
}
develocity {
    // The hostname of the Develocity instance
    server.set("http://ec2-63-177-95-205.eu-central-1.compute.amazonaws.com") (3)
    // Disable SSL
    allowUntrustedServer.set(true) (4)
    buildScan {
        publishing.onlyIf { true }
}

rootProject.name = "gradle-build-scan-quickstart" (5)
1 The version of the Develocity Gradle Plugin (it may use a different version)
2 The version of org.gradle.toolchains.foojay-resolver-convention (it may use a different version)
3 Replace ec2-63-177-95-205.eu-central-1.compute.amazonaws.com with the public DNS name of your EC2 instance
4 SSL is disabled
5 The name of the example project

5.3. Create and publish a Build Scan

Run your fist Build Scan using the Gradle wrapper:

CLI
$ ./gradlew build --scan

The build should end with something similar to:

Output
Calculating task graph as no cached configuration is available for tasks: build

BUILD SUCCESSFUL in 1s
4 actionable tasks: 1 executed, 3 from cache

Publishing build scan...
https://ec2-63-177-95-205.eu-central-1.compute.amazonaws.com/s/a4sgb7zk57y3e

Configuration cache entry stored.

Follow the link shown at the end of the build to view your Build Scan on your Develocity instance.

ec2 qs build scan 1
ec2 qs build scan 2

6. Clean Up

Follow these steps to avoid incurring charges to your AWS account for the resources used on this page:

  • In the AWS Management Console, go to the VM instances overview page.

  • Select the Instance ID row containing the VM instance you created in this guide.

  • Select Instance state followed by Terminate (delete) instance.

7. Next Steps

After completing the installation, try these to learn more about Develocity. The following steps are to configure your instance, try the example repository, and sign up for DPE University.

Getting started with Develocity - Learn how to use Develocity.
Develocity Administration Manual - Learn how to configure and administer Develocity.
DPE University - A free, self-paced training portal to get the most out of Develocity.
Develocity Self-Hosted Standalone Installation Guide - How to install Develocity into a single host.


If you have any questions or need any assistance contact the Develocity support team or your customer success representative.