Untitled

Using Amazon RDS and S3

When using both Amazon RDS and S3 with Develocity, you should follow the principle of least privilege by assigning dedicated IAM roles to each component based on its specific access requirements.

The gradle-database, test-distribution-broker, and gradle-keycloak components require access only to Amazon RDS.
The gradle-monitoring and gradle-enterprise-operator components require access only to the S3 monitoring data bucket.
The gradle-enterprise-app and gradle-enterprise-app-background-processor components require access to both Amazon RDS and the S3 application data bucket.

This page provides step-by-step instructions for creating and assigning these fine-grained IAM roles, ensuring each Develocity component has only the permissions it needs to interact securely with AWS services.

Using Amazon RDS

This section will walk you through using an Amazon RDS PostgreSQL instance as your database.

1. Obtain the Required Permissions

You need permission to create and manage Amazon RDS instances and security groups.

The necessary permissions are granted using the AmazonRDSFullAccess AWS managed policy.

2. Set up an RDS Instance

Develocity is compatible with PostgreSQL versions 14 through 17. The minimum storage space required is 250 GB with 3,000 or more IOPS.

A. Create a root username and password

Create a root username and password for the database instance, referred to below as «db-root-username» and «db-root-password», respectively. These are the credentials you will use for your database setup; save them somewhere secure.

B. Create a Security Group

Before creating the database, you have to create a security group in the VPC you want to use.

In this tutorial you will use the eksctl created VPC used by your cluster.

You can use a different VPC, but you will need to make the RDS instance accessible from your cluster (for example, by peering the VPCs).

To create the Security Group, run:

CLUSTER_VPC_ID=$(
  aws ec2 describe-vpcs \
  --filters Name=tag:aws:cloudformation:stack-name,Values=eksctl-develocity-cluster \
  --query 'Vpcs[0].VpcId' \
  --output text
)

aws ec2 create-security-group --group-name develocity-database \
  --description "Develocity DB security group" \
  --vpc-id ${CLUSTER_VPC_ID}

C. Enable Ingress

Then enable ingress to the RDS instance from your cluster for port 5432 by running:

CLUSTER_SECURITY_GROUP_ID=$(
  aws eks describe-cluster --name develocity \
  --query cluster.resourcesVpcConfig.clusterSecurityGroupId \
  --output text
)

RDS_SECURITY_GROUP_ID=$(
  aws ec2 describe-security-groups \
  --filters Name=group-name,Values=develocity-database \
  --query 'SecurityGroups[0].GroupId' \
  --output text
)

aws ec2 authorize-security-group-ingress \
  --protocol tcp --port 5432 \
  --source-group ${CLUSTER_SECURITY_GROUP_ID} \
  --group-id ${RDS_SECURITY_GROUP_ID}

D. Create a subnet group

Before creating the database, you need to create a subnet group to specify how the RDS instance will be networked.

This subnet group must have subnets in two availability zones, and typically should use private subnets.

eksctl has already created private subnets you can use.

Create a subnet group containing them by running:

CLUSTER_VPC_ID=$(
  aws ec2 describe-vpcs \
  --filters Name=tag:aws:cloudformation:stack-name,Values=eksctl-develocity-cluster \
  --query 'Vpcs[0].VpcId' \
  --output text
)

SUBNET_IDS=$(
aws ec2 describe-subnets \
  --query 'Subnets[?!MapPublicIpOnLaunch].SubnetId' \
  --filters Name=vpc-id,Values=${CLUSTER_VPC_ID} \
  --output json
)

aws rds create-db-subnet-group --db-subnet-group-name develocity-database \
  --db-subnet-group-description "Develocity DB subnet group" \
  --subnet-ids ${SUBNET_IDS}

Consult RDS’s subnet group documentation for more details on subnet groups and their requirements.

E. Create the RDS instance

Create the RDS instance:

RDS_SECURITY_GROUP_ID=$(
aws ec2 describe-security-groups \
  --filters Name=group-name,Values=develocity-database \
  --query 'SecurityGroups[0].GroupId' \
  --output text
)

RDS_POSTGRES_VERSION=$(
aws rds describe-db-engine-versions \
  --engine postgres \
  --engine-version 17 \(1)
  --default-only \
  --query 'DBEngineVersions[0].EngineVersion' \
  --output text
)

1	The latest major version of PostgreSQL that Develocity supports.

aws rds create-db-instance \
  --engine postgres \
  --engine-version ${RDS_POSTGRES_VERSION} \
  --db-instance-identifier develocity-database \
  --db-name gradle_enterprise \
  --allocated-storage 250 \(1)
  --iops 3000 \(2)
  --db-instance-class db.m5.large \
  --db-subnet-group-name develocity-database \
  --backup-retention-period 3 \(3)
  --no-publicly-accessible \
  --vpc-security-group-ids ${RDS_SECURITY_GROUP_ID} \
  --master-username «db-root-username» \
  --master-user-password «db-root-password»

1	Develocity should be installed with 250GB of database storage to start with.
2	Develocity’s data volumes and database should support at least 3,000 IOPS.
3	The backup retention period, in days.

While you don’t configure it here, RDS supports storage autoscaling.

Consult AWS’s database creation guide and the CLI command reference for more details on RDS instance creation.

You can view the status of your instance with:

aws rds describe-db-instances --db-instance-identifier develocity-database

Wait until the DBInstanceStatus is available.

Once available, you can see the hostname of the instance under Endpoint > Address. This is the hostname you will use to connect to the instance, subsequently referred to as «database-hostname».

3. Configure the RDS instance for IAM authentication

Develocity supports connecting to the database using IAM authentication. This step describes how to configure your RDS instance to allow IAM database authentication for all the database users that Develocity will connect as (including the superuser, although it is possible for Develocity to not require superuser access, as explained in the Database setup with IAM database authentication section of the Kubernetes Helm chart Configuration Guide).

A. Enable IAM database authentication on the RDS instance

To modify your created RDS database instance to allow IAM database authentication, run:

aws rds modify-db-instance \
  --db-instance-identifier develocity-database \
  --apply-immediately \
  --enable-iam-database-authentication

Using Amazon S3

Develocity can use a user-managed Object Storage instead of its own embedded version. This has several benefits, from scalable storage to reduced operation burden and better backup and failover management. This appendix will walk you through using an Amazon S3 buckets to store Build Scan® data and monitoring data such as metrics.

1. Obtain the required permissions

You will need permission to create and manage Amazon S3 buckets. You also need to create IAM policies and roles, but you already have permission to do that from the eksctl policies.

The necessary permissions can be granted by using the AmazonS3FullAccess AWS managed policy.

2. Set up S3 Buckets

To create the S3 buckets, run:

ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text) \
aws s3 mb s3://develocity-application-data-${ACCOUNT_ID} && \(1)
aws s3 mb s3://develocity-monitoring-data-${ACCOUNT_ID} (2)

1	The name of the bucket meant to store application data, like Build Scan data or Build Cache entries
2	The name of the bucket meant to store monitoring data, like metrics collected during application lifetime

Storing data in different buckets allows you to apply various strategies, such as access control, replication, soft-delete, backup, and more. However, you can use only one bucket for both application and monitoring data; this is an operation’s decision based on your practices.

Create IAM Policies and Roles

1. Create policies allowing RDS and S3 access

A. Create a policy allowing RDS access

To create a role that is permitted to connect to the RDS database as the required database users, using IAM authentication, create a database-policy.json file with the following content:

CONFIGURED_REGION=$(aws configure list | grep region | awk '{print $2}')

ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text)

DBI_RESOURCE_ID=$(
  aws rds describe-db-instances \
  --db-instance-identifier develocity-database \
  --query 'DBInstances[0].DbiResourceId' \
  --output text
)

database-policy.json

cat <<EOF > database-policy.json
{
   "Version": "2012-10-17",
   "Statement": [
      {
         "Effect": "Allow",
         "Action": [
             "rds-db:connect"
         ],
         "Resource": [
             "arn:aws:rds-db:${CONFIGURED_REGION}:${ACCOUNT_ID}:dbuser:${DBI_RESOURCE_ID}/ge_app",
             "arn:aws:rds-db:${CONFIGURED_REGION}:${ACCOUNT_ID}:dbuser:${DBI_RESOURCE_ID}/ge_migrator",
             "arn:aws:rds-db:${CONFIGURED_REGION}:${ACCOUNT_ID}:dbuser:${DBI_RESOURCE_ID}/ge_monitor",
             "arn:aws:rds-db:${CONFIGURED_REGION}:${ACCOUNT_ID}:dbuser:${DBI_RESOURCE_ID}/«db-root-username»" (1)
         ]
      }
   ]
}
EOF

1	Replace `«db-root-username»` with the username you chose when creating your RDS instance’s root credentials.

Then run the following command:

aws iam create-policy \
  --policy-name "develocity-rds-access" \
  --policy-document file://database-policy.json

B. Create a policy allowing application data bucket access

To create a role allowing access to the application data bucket, execute the following commands in the console:

create-application-data-policy.sh

ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text) \
  cat <<EOF > application-data-bucket-policy.json
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::develocity-application-data-${ACCOUNT_ID}"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:GetObject",
                "s3:DeleteObject",
                "s3:AbortMultipartUpload"
            ],
            "Resource": [
                "arn:aws:s3:::develocity-application-data-${ACCOUNT_ID}/*"
            ]
        }
    ]
}
EOF
aws iam create-policy \
    --policy-name "develocity-s3-application-data-access" \
    --policy-document file://application-data-bucket-policy.json

C. Create a policy allowing monitoring data bucket access

To create a role allowing access to the monitoring data bucket, execute the following commands in the console:

create-monitoring-data-policy.sh

ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text) \
  cat <<EOF > monitoring-data-bucket-policy.json
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::develocity-monitoring-data-${ACCOUNT_ID}"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:GetObject",
                "s3:DeleteObject",
                "s3:AbortMultipartUpload"
            ],
            "Resource": [
                "arn:aws:s3:::develocity-monitoring-data-${ACCOUNT_ID}/*"
            ]
        }
    ]
}
EOF
aws iam create-policy \
    --policy-name "develocity-s3-monitoring-data-access" \
    --policy-document file://monitoring-data-bucket-policy.json

2. Create Roles for Develocity components

We create 3 IAM roles for the Develocity components:

Develocity_Database_Role for the components that require access only to Amazon RDS.
Develocity_Monitoring_Role for the components that require access only to the S3 monitoring data bucket.
Develocity_Application_Role for the components that require access to both Amazon RDS and the S3 application data bucket.

To create the IAM roles, run the following commands:

Create the IAM role for the database access:

eksctl create iamserviceaccount \
  --name develocity-database-account \
  --namespace develocity \
  --cluster develocity \
  --approve \
  --role-only \
  --role-name Develocity_Database_Role \
  --attach-policy-arn arn:aws:iam::${ACCOUNT_ID}:policy/develocity-rds-access

Create the IAM role for the monitoring data access:

eksctl create iamserviceaccount \
  --name develocity-monitoring-account \
  --namespace develocity \
  --cluster develocity \
  --approve \
  --role-only \
  --role-name Develocity_Monitoring_Role \
  --attach-policy-arn arn:aws:iam::${ACCOUNT_ID}:policy/develocity-s3-monitoring-data-access

Create the IAM role for the application data and database access:

eksctl create iamserviceaccount \
  --name develocity-application-account \
  --namespace develocity \
  --cluster develocity \
  --approve \
  --role-only \
  --role-name Develocity_Application_Role \
  --attach-policy-arn arn:aws:iam::${ACCOUNT_ID}:policy/develocity-rds-access
  --attach-policy-arn arn:aws:iam::${ACCOUNT_ID}:policy/develocity-s3-application-data-access

3. Update the trust relationship policies

To associate the service account with an AWS IAM role, we need to use an AWS OIDC provider. We already installed one when setting up the Storage Class EBS CSI driver, so we can use it here.

OIDC_PROVIDER=$(aws eks describe-cluster --name develocity \
--query "cluster.identity.oidc.issuer" \
--output text | sed -e "s/^https:\/\///")

Update the database trust relationship policy:

cat <<EOF > database-trust-relationship.json
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Federated": "arn:aws:iam::$ACCOUNT_ID:oidc-provider/$OIDC_PROVIDER"
      },
      "Action": "sts:AssumeRoleWithWebIdentity",
      "Condition": {
        "StringEquals": {
          "${OIDC_PROVIDER}:sub": "system:serviceaccount:develocity:gradle-database",
          "${OIDC_PROVIDER}:aud": "sts.amazonaws.com"
        },
        "StringEquals": {
          "${OIDC_PROVIDER}:sub": "system:serviceaccount:develocity:gradle-test-distribution-broker",
          "${OIDC_PROVIDER}:aud": "sts.amazonaws.com"
        },
        "StringEquals": {
          "${OIDC_PROVIDER}:sub": "system:serviceaccount:develocity:gradle-keycloak",
          "${OIDC_PROVIDER}:aud": "sts.amazonaws.com"
        }
      }
    }
  ]
}
EOF

aws iam update-assume-role-policy \
  --role-name Develocity_Database_Role \
  --policy-document file://database-trust-relationship.json

Update the application data trust relationship policy:

cat <<EOF > application-data-trust-relationship.json
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Federated": "arn:aws:iam::$ACCOUNT_ID:oidc-provider/$OIDC_PROVIDER"
      },
      "Action": "sts:AssumeRoleWithWebIdentity",
      "Condition": {
        "StringEquals": {
          "${OIDC_PROVIDER}:sub": "system:serviceaccount:develocity:gradle-enterprise-app",
          "${OIDC_PROVIDER}:aud": "sts.amazonaws.com"
        },
        "StringEquals": {
          "${OIDC_PROVIDER}:sub": "system:serviceaccount:develocity:gradle-enterprise-app-background-processor",
          "${OIDC_PROVIDER}:aud": "sts.amazonaws.com"
        }
      }
    }
  ]
}
EOF

aws iam update-assume-role-policy \
  --role-name Develocity_Application_Role \
  --policy-document file://application-data-trust-relationship.json

Update the monitoring data trust relationship policy:

cat <<EOF > monitoring-data-trust-relationship.json
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Federated": "arn:aws:iam::$ACCOUNT_ID:oidc-provider/$OIDC_PROVIDER"
      },
      "Action": "sts:AssumeRoleWithWebIdentity",
      "Condition": {
        "StringEquals": {
          "${OIDC_PROVIDER}:sub": "system:serviceaccount:develocity:gradle-enterprise-operator",
          "${OIDC_PROVIDER}:aud": "sts.amazonaws.com"
        },
        "StringEquals": {
          "${OIDC_PROVIDER}:sub": "system:serviceaccount:develocity:gradle-monitoring",
          "${OIDC_PROVIDER}:aud": "sts.amazonaws.com"
        }
      }
    }
  ]
}
EOF

aws iam update-assume-role-policy \
  --role-name Develocity_Monitoring_Role \
  --policy-document file://monitoring-data-trust-relationship.json

4. Configure Develocity to use RDS and S3

A. Update your installation’s resource requirements

When using S3 Build Scan storage, Develocity uses more memory.

To update Develocity’s memory usage specification, update your Helm values file with the following values:

values.yaml

enterprise:
  resources:
    requests:
      memory: 6Gi (1)
    limits:
      memory: 6Gi (1)

1	If you have already set a custom value here, instead increase it by `2Gi`.

When adding items to your Helm values file, merge any duplicate blocks. Alternatively, you can use separate files and pass all of them with --values «file» when running Helm commands.

You may need to scale up your cluster or use nodes with more memory to be able to satisfy the increased memory requirements. See create cluster for scaling instructions.

If you are additionally using the background processor component, you should also update its values:

values.yaml

enterpriseBackgroundProcessor:
  resources:
    requests:
      memory: 6Gi (1)
    limits:
      memory: 6Gi (1)

1	If you have already set a custom value here, instead increase it by `2Gi`.

B. Create Unattended Configuration

Develocity must now be configured to use S3. To do this, you must use the unattended configuration mechanism.

Develocity can store Build Scan data in either the configured database or in the configured object store.

The unattended configuration mechanism lets you configure which of these is used to store Build Scan data as part of a configuration file, which can be embedded in your Helm values file as described in the unattended configuration guide.

This section will describe how to extend your Helm values file to include the correct unattended configuration block for S3 Build Scan storage.

First, we need to create a minimal unattended configuration file. This requires you to choose a password for the system user and hash it. To do this, install Develocityctl.

The following command will prompt you to enter a password and write the hash into the secret.txt. We will refer to the hashed password as «hashed-system-password»

develocityctl config-file hash -o secret.txt

C. Update your Helm values file

The superuser credentials are only required to set up the database and create the migrator and application users. IAM authentication does not work with the superuser without the role rds_iam. For the sake of simplicity, we still use password authentication for the superuser in this tutorial. Consider setting up the database yourself, as described in the Database options section of Develocity’s installation manual, to avoid superuser usage. For this option to work, you must follow the instructions above to enable and configure IAM database authentication for the migrator and application users.

values.yaml

global:
  unattended:
    configuration:
      version: 12 (1)
      systemPassword: "«hashed-system-password»" (2)
      buildScans:
        incomingStorageType: objectStorage

enterprise:
  resources:
    requests:
      memory: 8Gi (3)
    limits:
      memory: 8Gi (3)
  serviceAccount:
    annotations:
      eks.amazonaws.com/role-arn: "arn:aws:iam::«account-id»:role/Develocity_Application_Role" (4)

enterpriseBackgroundProcessor:
  serviceAccount:
    annotations:
      eks.amazonaws.com/role-arn: "arn:aws:iam::«account-id»:role/Develocity_Application_Role" (4)

monitoring:
  serviceAccount:
    annotations:
      eks.amazonaws.com/role-arn: "arn:aws:iam::«account-id»:role/Develocity_Monitoring_Role" (5)

operator:
  serviceAccount:
    annotations:
      eks.amazonaws.com/role-arn: "arn:aws:iam::«account-id»:role/Develocity_Monitoring_Role" (5)

testDistribution:
  serviceAccount:
    annotations:
      eks.amazonaws.com/role-arn: "arn:aws:iam::«account-id»:role/Develocity_Database_Role"

authenticationBroker:
  serviceAccount:
    annotations:
      eks.amazonaws.com/role-arn: "arn:aws:iam::«account-id»:role/Develocity_Database_Role"

database:
  serviceAccount:
    annotations:
      "eks.amazonaws.com/role-arn": "arn:aws:iam::«account-id»:role/Develocity_Database_Role" (6)
  location: user-managed
  provider: aws-rds
  connection:
    host: «database-hostname»
    databaseName: gradle_enterprise
  credentials:
    type: irsa
    superuser:
      username: «db-root-username» (7)
      password: «db-root-password» (7)

objectStorage:
  type: s3
  s3:
    bucket: develocity-application-data-«account-id» (8)
    region: «region» (8)
    credentials:
      type: irsa (10)
    monitoring:
      bucket: develocity-monitoring-data-«account-id» (9)
      region: «region» (9)
      credentials:
        type: irsa (10)

1	The version of the unattended configuration.
2	Your hashed system password.
3	If you have already set a custom value here, instead increase it by `2Gi`.
4	The ARN of the IAM role you created for the application data and database access.
5	The ARN of the IAM role you created for the monitoring data access.
6	The ARN of the IAM role you created for the database access.
7	The RDS root credentials you chose earlier.
8	The name and region of the S3 bucket you created for application data.
9	The name and region of the S3 bucket you created for monitoring data.
10	The type of AWS credentials, in this example, the IAM Roles for Service Account, as described in IAM Roles for Service Account credentials configuration (IRSA).

Once you have updated your Helm values file as described above, you need to reapply it using the method described in Changing Configuration Values. This will update your Develocity installation to use the unattended configuration you created above, and Develocity will restart.

Switching between embedded Object Storage and user-managed Object Storage is not supported, starting with S3 is recommended as a more scalable solution, as data migration will not be possible later on.

D. Verify S3 Storage is Used

Develocity will start even if your S3 configuration is incorrect.

To confirm that Develocity is storing incoming Build Scans in S3 and also able to read Build Scan data from S3, you should first upload a new Build Scan to your Develocity instance. Second, confirm that you can view the Build Scan. Finally, confirm that the Build Scan is stored in your S3 bucket, by running:

ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text)

aws s3 ls s3://develocity-application-data-${ACCOUNT_ID}/build-scans/ \(1)
  --recursive --human-readable --summarize

1	If you used a custom prefix, use it here instead of `build-scans`.

Output

2025-05-27 19:11:06    6.6 KiB build-scans/2025/05/27/aprvi3bnnxyzm

Total Objects: 1
   Total Size: 6.6 KiB

If you have any questions or need any assistance don’t hesitate to get in touch with the Develocity support team or your customer success representative.