System Requirements
Limited Availability
The Develocity Artifact and Setup Cache is in Limited Availability.
Please contact the Develocity support team to get started with Develocity Artifact and Setup Cache.
This page details the system requirements for Develocity Artifact and Setup Cache.
Develocity Components
| Component | Version |
|---|---|
Develocity |
2025.3 |
Edge node |
1.6 |
Develocity Edge
At least one Develocity Edge location must be available in physical proximity to your CI agents and registered with Develocity.
Refer to the Develocity Edge User Manual for instructions on setting up a new Edge.
Disk Storage
The sizing of the volume attached to Edge nodes is important for maintaining optimal performance and avoiding churn. The Artifact Cache CLI stores a variety of build artifacts, some possibly reaching gigabytes in size.
The volume size should accommodate all build dependency and setup and build cache artifacts from projects using Develocity Artifact and Setup Cache.
A rough estimate for the size required can be deduced using the following formula:
storage = (number of projects)
× (avg dependencies per project)
× (number of base branches)
× (safety factor)
Where safety factor recommended value is 2-3 (for growth and retention).
Make sure that the Edge node has sufficient free storage space available both to "Develocity Artifact and Setup Cache" and "Build Cache" services.
Example Calculation:
-
5 projects
-
2 GB average dependencies per project
-
3 branches per project (main, develop, staging)
-
2 × safety factor
5 × 2 GB × 3 × 2 = 60 GB minimum
| If build caching is already enabled for projects that will start to use Develocity Artifact and Setup Cache, then it’s recommended to increase the size of the existing storage volume by a factor of 1.5. |
- Maximum artifact size
-
Must fit the largest single artifact stored by the Artifact Cache CLI.
Recommendation: Start with
1024 MiB(1 GiB).
| The configured maximum artifact size limit is shared between the Develocity Artifact and Setup Cache and Develocity Build Cache. Please refer to the Build Cache configuration section of the Administration Manual for instructions on how to configure this value. |
CI Requirements
CI Platforms
The Artifact Cache CLI can integrate into any modern CI platform that uses self-hosted CI runners that support executing shell commands.
Integration examples are provided for Jenkins and GitHub Actions.
CI Runners
Java Runtime
The Artifact Cache CLI is a Java application and requires a compatible Java runtime to be installed.
| Artifact Cache CLI | Java version |
|---|---|
Version 0.10.0 and later |
Java 21 |
Operating System
The Artifact Cache CLI is platform-independent (runs on any OS with Java 21+).
Tested Platforms:
-
Linux
-
Windows
-
macOS
Connectivity
The Artifact Cache CLI requires network access to both Develocity server (over HTTP/1) and a Develocity Edge (over HTTP/2) location.
Co-location of the CI runners and Develocity Edge nodes (in the same Availability Zone or network) is required to minimize latency and maximize bandwidth. Please review that any proxies or load-balancers on the network path between CI runners and Edge nodes support HTTP/2 and have sufficient capacity to handle sustained high-throughput connections.
Security Requirements
Develocity Access Key
A valid Develocity Access Key with "Read and write build cache data" permission must be provisioned and passed to the Artifact Cache CLI.
For information on creating access keys, refer to the Develocity Administration Manual.