Merge pull request #16 from oracle-devrel/build-caching

RahulMR42 · web-flow · commit 0ff9f7f2d305 · 2022-05-19T19:33:29.000+05:30
OCI DevOps Build Caching Example
diff --git a/oci-build-examples/README.md b/oci-build-examples/README.md
@@ -8,6 +8,12 @@ All about OCI devops build samples ..
 
 </details>
 
+<details>
+  <summary>Build Caching - click to expand</summary>
+
+* [Speed up builds with caching](./oci-build-caching/)
+
+</details>
 
 
 ### Back to examples.
diff --git a/oci-build-examples/oci-build-caching/Dockerfile b/oci-build-examples/oci-build-caching/Dockerfile
@@ -0,0 +1,25 @@
+# Maven build container 
+
+FROM maven:3.8.5-openjdk-11 AS maven_build
+
+COPY pom.xml /tmp/
+
+COPY src /tmp/src/
+
+WORKDIR /tmp/
+
+RUN --mount=type=cache,target=/root/.m2 mvn package
+
+#pull base image
+
+FROM openjdk
+
+#expose port 8080
+EXPOSE 8080
+
+#default command
+CMD java -jar /data/hello-world-0.1.0.jar
+
+#copy hello world to docker image from builder image
+
+COPY --from=maven_build /tmp/target/hello-world-0.1.0.jar /data/hello-world-0.1.0.jar
diff --git a/oci-build-examples/oci-build-caching/README.md b/oci-build-examples/oci-build-caching/README.md
@@ -0,0 +1,106 @@
+# OCI DevOps - Speed up builds with caching
+
+In most cases, the build time is consumed in downloading or preparing certain build dependancies like maven dependencies, node_modules, pip dependancies, etc... This procedure talks about on how to reduce time by caching those dependencies for the subsequent runs. 
+
+In this way, the first run would take full time to download and setup build dependancies. But the subsequent runs will be more efficient through the cache.
+
+For this, sample java maven-based application is used to demonstrate build caching.
+
+### Prerequisites/Assumptions
+* Assumed you are already familiar with OCI DevOps. Please refer [Documentation](https://www.oracle.com/devops/devops-service/)
+* To know how to run the this maven project in your local. Please refer [this](./SETUP-PROJECT.md)
+* Assumed that you are using docker build inside your `build_spec.yaml`
+* As OCI Object storage is used to store the cache, Please create a bucket and set right access policies for the same. [Click here](https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/objectstorageoverview.htm) to know more about Object Storage.
+
+### References
+* [OCI DevOps CICD Reference Architecture](https://docs.oracle.com/en/solutions/ci-cd-pipe-oci-devops/index.html)
+* [OCI DevOps Documentation](https://docs.oracle.com/en-us/iaas/Content/devops/using/home.htm)
+* [Creating DevOps Project](https://docs.oracle.com/en-us/iaas/Content/devops/using/create_project.htm)
+* [Creating Repository](https://docs.oracle.com/en-us/iaas/Content/devops/using/managing_coderepo.htm)
+* [Creating Build Pipeline](https://docs.oracle.com/en-us/iaas/Content/devops/using/managing_build_pipelines.htm)
+* [Creating Deploy Pipeline](https://docs.oracle.com/en-us/iaas/Content/devops/using/deployment_pipelines.htm)
+
+
+### Overview of Changes
+For any project, you may tweek `build_spec.yaml` to enable build cache.
+
+#### Step 1
+* Create OCI Object Storage bucket `build-cache`
+* Create Policies, for build to access Object Storage bucket.
+```
+Allow dynamic-group <dg-devops-build-pipeline> to read buckets in compartment <compartment-name>
+
+Allow dynamic-group <dg-devops-build-pipeline> to manage objects in compartment <compartment-name> where all {target.bucket.name='build-cache'}
+```
+
+#### Step 2
+Docker BuildKit is installed to enable few advanced docker build commands for caching.
+```
+  - type: Command
+    name: "Docker BuildKit Setup"
+    timeoutInSeconds: 140
+    command: |
+      wget https://github.com/docker/buildx/releases/download/v0.8.2/buildx-v0.8.2.linux-amd64 -O docker-buildx
+      mkdir -p ~/.docker/cli-plugins
+      mv docker-buildx ~/.docker/cli-plugins/
+      chmod +x ~/.docker/cli-plugins/docker-buildx
+      docker buildx install
+```
+#### Step 3
+`Build Cache Restore` stage is used to download the pre-uploaded cache from OCI Object Storage.
+
+```
+  - type: Command
+    name: "Build Cache Restore"
+    timeoutInSeconds: 140
+    command: |
+      oci os object get --bucket-name build-cache --file ${BUILD_CACHE_OS_FILE_NAME} --name ${BUILD_CACHE_OS_FILE_NAME} && unzip ${BUILD_CACHE_OS_FILE_NAME}
+      echo "Done..."
+```
+
+#### Step 4
+In actual build stage, below comands are used in the place of regular `docker build`.
+```
+  - type: Command
+    name: "Docker build"
+    command: |
+      export DOCKER_BUILDKIT=1
+      export DOCKER_CLI_EXPERIMENTAL=enabled
+      docker buildx create --use
+      docker buildx build -t="hello-world-java" --cache-from=type=local,src=./cache --cache-to=type=local,dest=./cache --load .
+      echo "DONE"
+```
+
+#### Step 5
+`Build Cache Upload` stage is added to collect the generated build cache and upload to OCI Object Storage bucket. This is used for subsequent builds.
+
+```
+  - type: Command
+    name: "Build Cache Upload"
+    timeoutInSeconds: 140
+    command: |
+      rm ${BUILD_CACHE_OS_FILE_NAME} && zip -r ${BUILD_CACHE_OS_FILE_NAME} cache/*
+      oci os object put --bucket-name build-cache --file ${BUILD_CACHE_OS_FILE_NAME} --force
+```
+
+#### Step 6
+In `Dockerfile`, We need to pass `--mount` argument to `RUN` command to use cache for the specific build command as below.
+
+```
+RUN --mount=type=cache,target=/root/.m2 mvn package
+```
+
+### Results
+
+#### Before OCI Build Cache
+![6m 33s](images/BeforeOCIBuildCache.png "Before Caching")
+
+#### After OCI Build Cache
+![0m 49s](images/AfterOCIBuildCache.png "After Caching")
+
+### Contributors 
+
+- Author : Ashok CM
+- Collaborators : NA
+- Last release : May 2022
+
diff --git a/oci-build-examples/oci-build-caching/SETUP-PROJECT.md b/oci-build-examples/oci-build-caching/SETUP-PROJECT.md
@@ -0,0 +1,72 @@
+Hello World sample shows how to deploy [SpringBoot](http://projects.spring.io/spring-boot/) RESTful web service application with [Docker](https://www.docker.com/)
+
+#### Prerequisite 
+
+Installed:   
+[Docker](https://www.docker.com/)   
+[git](https://www.digitalocean.com/community/tutorials/how-to-contribute-to-open-source-getting-started-with-git)   
+
+Optional:   
+[Docker-Compose](https://docs.docker.com/compose/install/)   
+[Java 1.8 or 11.1](https://www.oracle.com/technetwork/java/javase/overview/index.html)   
+[Maven 3.x](https://maven.apache.org/install.html)
+
+#### Steps
+
+##### Clone source code from git
+```
+$  git clone https://github.com/dstar55/docker-hello-world-spring-boot .
+```
+
+##### Build Docker image
+```
+$ docker build -t="hello-world-java" .
+```
+Maven build will be executes during creation of the docker image.
+
+>Note:if you run this command for first time it will take some time in order to download base image from [DockerHub](https://hub.docker.com/)
+
+##### Run Docker Container
+```
+$ docker run -p 8080:8080 -it --rm hello-world-java
+```
+
+##### Test application
+
+```
+$ curl localhost:8080
+```
+
+the respone should be:
+```
+Hello World
+```
+
+#####  Stop Docker Container:
+```
+docker stop `docker container ls | grep "hello-world-java:*" | awk '{ print $1 }'`
+```
+
+## Run with docker-compose 
+
+Build and start the container by running 
+
+```
+$ docker-compose up -d 
+```
+
+##### Test application with ***curl*** command
+
+```
+$ curl localhost:8080
+```
+
+the respone should be:
+```
+Hello World
+```
+
+##### Stop Docker Container:
+```
+docker-compose down
+```
diff --git a/oci-build-examples/oci-build-caching/build_spec.yaml b/oci-build-examples/oci-build-caching/build_spec.yaml
@@ -0,0 +1,63 @@
+version: 0.1
+component: build
+timeoutInSeconds: 1000
+shell: bash
+env:
+  # these are local variables to the build config
+  variables:
+    BUILD_CACHE_OS_BUCKET_NAME: build-cache
+    BUILD_CACHE_OS_FILE_NAME: cache.zip
+    BUILDX_VERSION: 0.8.2
+
+  # exportedVariables are made available to use as parameters in sucessor Build Pipeline stages
+  # For this Build to run, the Build Pipeline needs to have a BUILDRUN_HASH parameter set
+  exportedVariables:
+    - BUILDRUN_HASH
+
+steps:
+  - type: Command
+    name: "Define unique image tag"
+    timeoutInSeconds: 140
+    command: |
+      echo "OCI_BUILD_RUN_ID: ${OCI_BUILD_RUN_ID}"
+      export BUILDRUN_HASH=`echo ${OCI_BUILD_RUN_ID} | rev | cut -c 1-7`
+      echo "BUILDRUN_HASH: " $BUILDRUN_HASH
+  - type: Command
+    name: "Docker BuildKit Setup"
+    timeoutInSeconds: 140
+    command: |
+      wget https://github.com/docker/buildx/releases/download/v${BUILDX_VERSION}/buildx-v${BUILDX_VERSION}.linux-amd64 -O docker-buildx
+      mkdir -p ~/.docker/cli-plugins
+      mv docker-buildx ~/.docker/cli-plugins/
+      chmod +x ~/.docker/cli-plugins/docker-buildx
+      docker buildx install
+  - type: Command
+    name: "Build Cache Restore"
+    timeoutInSeconds: 140
+    command: |
+      oci os object get --bucket-name build-cache --file ${BUILD_CACHE_OS_FILE_NAME} --name ${BUILD_CACHE_OS_FILE_NAME} && unzip ${BUILD_CACHE_OS_FILE_NAME}
+      echo "Done..."
+  - type: Command
+    name: "Docker build"
+    command: |
+      export DOCKER_BUILDKIT=1
+      export DOCKER_CLI_EXPERIMENTAL=enabled
+      docker buildx create --use
+      docker buildx build -t="hello-world-java" --cache-from=type=local,src=./cache --cache-to=type=local,dest=./cache --load .
+      echo "DONE"
+    onFailure:
+      - type: Command
+        command: |
+          echo "Handling Failure"
+          build_result=FAILURE
+          echo "Failure successfully handled"
+  - type: Command
+    name: "Build Cache Upload"
+    timeoutInSeconds: 140
+    command: |
+      rm ${BUILD_CACHE_OS_FILE_NAME} && zip -r ${BUILD_CACHE_OS_FILE_NAME} cache/*
+      oci os object put --bucket-name build-cache --file ${BUILD_CACHE_OS_FILE_NAME} --force
+outputArtifacts:
+  - name: Build_output_image
+    type: DOCKER_IMAGE
+    location: "hello-world-java"
diff --git a/oci-build-examples/oci-build-caching/images/AfterOCIBuildCache.png b/oci-build-examples/oci-build-caching/images/AfterOCIBuildCache.png
diff --git a/oci-build-examples/oci-build-caching/images/BeforeOCIBuildCache.png b/oci-build-examples/oci-build-caching/images/BeforeOCIBuildCache.png
diff --git a/oci-build-examples/oci-build-caching/pom.xml b/oci-build-examples/oci-build-caching/pom.xml
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>com.dockerforjavadevelopers</groupId>
+    <artifactId>hello-world</artifactId>
+    <version>0.1.0</version>
+
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.6.6</version>
+    </parent>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+
+		<dependency>
+		    <groupId>junit</groupId>
+		    <artifactId>junit</artifactId>
+		    <version>4.13.1</version>
+		    <scope>test</scope>
+		</dependency>
+        
+    </dependencies>
+
+    <properties>
+        <start-class>com.dockerforjavadevelopers.hello.Application</start-class>
+		<log4j2.version>2.17.0</log4j2.version>
+    </properties>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>
diff --git a/oci-build-examples/oci-build-caching/src/main/java/com/dockerforjavadevelopers/hello/Application.java b/oci-build-examples/oci-build-caching/src/main/java/com/dockerforjavadevelopers/hello/Application.java
@@ -0,0 +1,20 @@
+package com.dockerforjavadevelopers.hello;
+
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@EnableAutoConfiguration
+@ComponentScan
+public class Application {
+    
+    public static void main(String[] args) {
+        ApplicationContext ctx = SpringApplication.run(Application.class, args);
+        
+    }
+
+}
diff --git a/oci-build-examples/oci-build-caching/src/main/java/com/dockerforjavadevelopers/hello/HelloController.java b/oci-build-examples/oci-build-caching/src/main/java/com/dockerforjavadevelopers/hello/HelloController.java
@@ -0,0 +1,15 @@
+package com.dockerforjavadevelopers.hello;
+
+
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.RequestMapping;
+
+@RestController
+public class HelloController {
+    
+    @RequestMapping("/")
+    public String index() {
+        return "Hello World123\n";
+    }
+    
+}
diff --git a/oci-build-examples/oci-build-caching/src/test/java/com/dockerforjavadevelopers/hello/DummyTest.java b/oci-build-examples/oci-build-caching/src/test/java/com/dockerforjavadevelopers/hello/DummyTest.java
@@ -0,0 +1,13 @@
+package com.dockerforjavadevelopers.hello;
+
+import static org.junit.Assert.*;
+
+import org.junit.Test;
+
+public class DummyTest {
+
+  @Test
+  public void aTest() {
+    assertEquals(true, true);
+  }
+}
