GeodeGradleBuildCache

Allows Gradle to connect to an Apache Geode cluster and use it as a remote Gradle Build Cache. Currently GeodeGradleBuildCache needs to be built and installed into our local Maven repo.

---

Prerequisites:

Assume you have Apache Geode installed. See the user guide here

---

Start Apache Geode Cluster

First we start a small one locator and one server cluster.

 1. ./gfsh 
 2. start locator --name=locator1
 3. start server --name=server1 

Create the region where we will store the Gradle task output

 4. create region --name='gradleRegionName' 

---

Using GeodeGradleBuildCache

1. Change your project's settings.gradle with the following:

buildscript {
   repositories {
       maven {
         url "https://dl.bintray.com/jasonhuynh/jhuynh1-maven/"
       }
       jcenter()
     }
     dependencies {
       classpath 'com.github.jhuynh1.geode.gradle.build.cache:geode-gradle-build-cache:0.1'
     }
 }
 
 import com.github.jhuynh1.geode.gradle.build.cache.GeodeGradleBuildCache
 import com.github.jhuynh1.geode.gradle.build.cache.GeodeGradleBuildCacheServiceFactory
 
 buildCache {
   local {
     //this is set to false to hilite usage of remote cache
     //this setting will impact your performance
     enabled = false 
   }

   // Register custom build cache implementation
   registerBuildCacheService(GeodeGradleBuildCache.class, GeodeGradleBuildCacheServiceFactory.class)
 
   remote(GeodeGradleBuildCache) {
     enabled = true 
     //this is set to allow pushing to the remote cache
     //the type of system will probably affect this setting (ci vs dev)
     push = true
     //optional settings.  The defaults are listed below
     //locatorHost = 'localhost'
     //locatorPort = 10334
     //gradleRegionName = 'gradleRegionName'
   }
 }

2. Run a build with --build-cache or add org.gradle.caching=true to gradle.properties

---

Configuration Options:

Options	Default Value
locatorHost	"localhost"
locatorPort	10334
gradleRegionName	"gradleRegionName"

---

Remote and Local cache:

There are different ways to configure the remote and local cache relationship in Gradle to get optimal performance. These settings were not configured to get the best performance but to show the usage of the remote cache. More resources can be found online for creating ci and developer specific configurations. More info here.