Azure VM Standalone Installation Guide

An Azure paid account is required. Note that a free account is not sufficient.

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.

Your Azure user requires the Azure built-in role required for how you want to execute Azure CLI commands.

Develocity is expected to work on most modern Linux systems.

K3s needs several ports to be accessible from the host.

The minimum installation requirements are:

The D8s_v3 instance size provides 8 vCPU / 32 GiB Memory.

Develocity installations have two database options:

By default, Develocity stores its data in an embedded PostgreSQL database that is run as part of the application itself, with data being stored in a directory mounted on the host machine.

In addition to the database, Develocity needs some storage capacity for configuration files, logs, and build cache artifacts. These storage requirements apply regardless of which type of database you use, although the necessary size varies based on the database type. For the embedded database, the majority of data is stored in the "installation directory", which defaults to /opt/gradle, unless otherwise specified in your Helm configuration file.

Develocity requires network connectivity for periodic license validation.

It is strongly recommended that production installations of Develocity are configured to use HTTPS with a trusted certificate.

When installing Develocity, you will need to provide a hostname, such as develocity.example.com.

If you decide to use Azure Cloud Shell or the Azure portal, skip to 3. Generate a Key Pair. Otherwise, follow steps A and B below:

A. Install the Azure CLI

Follow the instructions in the Azure documentation.

B. Configure the Azure CLI

Follow the Get started with Azure CLI guide and Configure settings using az init or Configure settings with az configure. Choose the region in which you wish to install Develocity. Azure provides a list of all available Azure regions.

Create an Azure resource group to contain all the resources you create for Develocity.

You need an SSH key to access Azure resources. To create the SSH key in the Azure portal, see Generate and store SSH keys in the Azure portal. To create the SSH key with the Azure CLI, see Generate and store SSH keys with the Azure CLI. Although you can save the generated keys file with any name, this manual uses the name DevelocityKeyPair. If you choose another name, you’ll need to edit the shell commands in this section.

SSH requires that only your user has permission to read SSH key files.

Create a security group called develocity-nsg.

Choose a server image appropriate for your environment. We focus our support efforts on Ubuntu 18.04/20.04/22.04/24.04, RHEL 8/9, and Debian 11/12. Develocity is expected to work on most modern Linux systems.

To specify virtual machine details:

See General purpose virtual machine sizes for more information.

For simplicity, we expand the OS disk volume to a minimum of 300 GB rather than mounting individual volumes. This is not advisable in a production instance. We recommend adding separate data volumes so that you can control their size, performance, and cost separately from the root volume.

To specify storage options:

The Build Scan® service of Develocity can be configured to store the data in a Azure Blob Storage. This can help performance in high-traffic installations by taking the load off the database. See Appendix B for details.

We need to configure the network settings for the virtual machine to use the security group we created in the Pre-Installation step 5. Create a Security Group.

To configure the network settings:

Now, you are ready to create your Azure virtual machine.

Azure virtual machines are provisioned with an external IP address, but no hostname. Develocity cannot use an IP address as a hostname, but there are services like nip.io that automatically map hostnames to IPs. You can start with a public DNS name based on the IP address and later reconfigure it to use a custom hostname if desired.

If you do not wish to set up a permanent DNS record at this time, you can instead use a service like nip.io to provide one based on the IP address. Any of the dash-based naming schemes on the nip.io web page should work, but the following commands generate a useful short name tied to that IP address:

Use develocity-14732a69.nip.io as the hostname.

If you intend to use a custom hostname to access your Develocity instance, such as develocity.example.com, you must create the appropriate DNS record to route this name to the IP address of the Azure virtual machine instance. Add an A record for your hostname that points to your static IP address. For example:

You should verify that your DNS record works correctly before installing Develocity, such as by using dig develocity.example.com.

You can run Develocity behind a cloud load balancer such as Azure Load Balancer. If you do this, you should generally use /ping to check the load balancer’s health. It will respond as healthy when Develocity is capable of handling requests, even if limited to the interactive starting page while the instance is starting.

This may be unwanted for highly available installations using the load balancer to manage fail-over. If you are installing Develocity in a highly available setup, we recommend submitting a ticket at support.gradle.com for assistance.

Once your instance starts, SSH into your instance with the following command:

If you can’t find the IP address for your vm host, retrieve it with the following command:

A successful response looks like the following:

Use the values.yaml configuration file to configure Develocity during installation and for later configuration changes. You can find configuration details in the Helm configuration section of the Standalone Helm Chart Configuration Guide. To download an example configuration file, see Appendix A of the Standalone Helm Chart Configuration Guide. Then, create a copy named values.yaml and edit it as shown below:

Copy the Helm values file you created to the instance.

To copy the values.yaml file from your local machine to your instance, run the following command:

Optionally copy the develocity.license file to your instance if you did not include it in your values.yaml file:

If you are using a custom SSL certificate, copy the certificate and key files to the instance as well.

SSH into the instance by running the following command:

K3s is a fully compliant Kubernetes distribution and must be installed on the instance.

Once you’re on the machine, install K3s and make it available to the current user:

Then install Helm:

First, add the https://helm.gradle.com/ helm repository and then update it:

Then run helm install with the following command:

The output should be similar to this:

You can see the status of Develocity starting up by examining its pods.

Eventually, the pods should all report as Running:

Develocity has a /ping endpoint, which can be used to verify network connectivity with Develocity.

Connectivity to Develocity installation can be tested by running the following command on machines that need to connect to Develocity:

It should return SUCCESS.

Once all pods have a status of Running and the system is up and connected, you can interact with it by visiting its URL and hostname in a web browser.

Develocity is installed and running.