Take feedback into account

Signed-off-by: David Gageot <david@gageot.net>
GoogleContainerTools · Oct 22, 2018 · d75a792 · d75a792
1 parent d114f70
commit d75a792
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 3 deletions.
diff --git a/examples/annotated-skaffold.yaml b/examples/annotated-skaffold.yaml
@@ -63,7 +63,7 @@ build:
 
     # jibMaven builds containers using the Jib plugin for Maven.
     # jibMaven:
-    #  module: modulename     # selects which maven module to build
+    #  module: modulename     # selects which maven module to build, for a multimodule project
     #  profile: profilename   # selects which maven profile to activate
 
     # jibGradle builds containers using the Jib plugin for Gradle.

diff --git a/examples/jib/README.adoc b/examples/jib/README.adoc
@@ -16,6 +16,11 @@ build:
        jibMaven: {}
 ----
 
+Please note that this example is for a standalone Maven project, where
+all dependencies are resolved from outside. The Jib builder requires
+that the projects are configured to use the Jib plugins for Maven or Gradle.
+Multi-module builds require a bit additional configuration.
+
 ifndef::env-github[]
 ==== link:{github-repo-tree}/examples/jib[Example files icon:github[]]
 

diff --git a/examples/jib/pom.xml b/examples/jib/pom.xml
@@ -39,6 +39,8 @@
                     <container>
                         <jvmFlags>
                             <jvmFlag>-Djava.security.egd=file:/dev/./urandom</jvmFlag>
+                            <jvmFlag>-XX:+UnlockExperimentalVMOptions</jvmFlag>
+                            <jvmFlag>-XX:+UseCGroupMemoryLimitForHeap</jvmFlag>
                         </jvmFlags>
                     </container>
                 </configuration>

diff --git a/integration/examples/annotated-skaffold.yaml b/integration/examples/annotated-skaffold.yaml
@@ -63,7 +63,7 @@ build:
 
     # jibMaven builds containers using the Jib plugin for Maven.
     # jibMaven:
-    #  module: modulename     # selects which maven module to build
+    #  module: modulename     # selects which maven module to build, for a multimodule project
     #  profile: profilename   # selects which maven profile to activate
 
     # jibGradle builds containers using the Jib plugin for Gradle.

diff --git a/integration/examples/jib/README.adoc b/integration/examples/jib/README.adoc
@@ -11,11 +11,16 @@ The way you configure it in `skaffold.yaml` is the following build stanza:
 ----
 build:
      artifacts:
-     - image: gcr.io/k8s-skaffold/skaffold-jib
+     - image: gcr.io/k8s-skaffold/skaffold-example
        context: .
        jibMaven: {}
 ----
 
+Please note that this example is for a standalone Maven project, where
+all dependencies are resolved from outside. The Jib builder requires
+that the projects are configured to use the Jib plugins for Maven or Gradle.
+Multi-module builds require a bit additional configuration.
+
 ifndef::env-github[]
 ==== link:{github-repo-tree}/examples/jib[Example files icon:github[]]
 

diff --git a/integration/examples/jib/pom.xml b/integration/examples/jib/pom.xml
@@ -39,6 +39,8 @@
                     <container>
                         <jvmFlags>
                             <jvmFlag>-Djava.security.egd=file:/dev/./urandom</jvmFlag>
+                            <jvmFlag>-XX:+UnlockExperimentalVMOptions</jvmFlag>
+                            <jvmFlag>-XX:+UseCGroupMemoryLimitForHeap</jvmFlag>
                         </jvmFlags>
                     </container>
                 </configuration>