Gradle Build Cache Node

Gradle Build Cache Node configuration

Type object
File match *build-cache-node-config.yml *build-cache-node-config.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/gradle-build-cache-node/latest.json
Source https://docs.gradle.com/downloads/build-cache-node-config-schema/build-cache-node-config-schema-5.json

Versions

4.0 5.0

Validate with Lintel

npx @lintel/lintel check
Type: object

The configuration format for build cache nodes

Properties

version const: 5 required

The version of the config file model (must be 5).

Constant: 5
cache
All of: object object, variant
registration
All of: object | null object | null, variant
uiAccess object
All of: variant, variant, variant, variant
1 nested properties
type enum required
Values: "disabled" "open" "secure" "generated"

Definitions

Entry(String,NodeCacheUser) object
key string required
value object required

A user of the build cache

3 nested properties
level string required

The level of the access for the build cache user

Values: "read" "readwrite"
password required
All of: Sha256HashedSecretString string, variant
note string | null

Some optional free text

hashCode() integer required
NodeCacheUser object

A user of the build cache

level string required

The level of the access for the build cache user

Values: "read" "readwrite"
password required
All of: Sha256HashedSecretString string, variant
note string | null

Some optional free text

Sha256HashedSecretString string
TargetSizeFixed object

Use a fixed target cache size

type const: "fixed"
Constant: "fixed"
size integer

The total available size of the cache in MiB

min=1
TargetSizeMaxAvailable object

Set the target cache size dynamically based on the disk volume's capacity

type const: "maxAvailable"
Constant: "maxAvailable"
UiAccessDisabled object

Access to the build cache node UI is disabled

type const: "disabled"
Constant: "disabled"
UiAccessGenerated object

Generated as startup credentials used for secure access to cache node UI

type const: "generated"
Constant: "generated"
UiAccessOpen object

Access to the build cache node UI is open for anyone

type const: "open"
Constant: "open"
UiAccessSecure object

Credentials used for secure access to cache node UI

password required
All of: Sha256HashedSecretString string, variant
username string required

The username for securing the cache node UI

type const: "secure"
Constant: "secure"