Support custom images for Jib on GCB

Signed-off-by: David Gageot <[email protected]>
VibrentHealth · Jan 18, 2019 · 9b06a7c · 9b06a7c
1 parent 1ffece5
commit 9b06a7c
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 19 deletions.
diff --git a/integration/examples/annotated-skaffold.yaml b/integration/examples/annotated-skaffold.yaml
@@ -113,6 +113,8 @@ build:
   #   machineType: "N1_HIGHCPU_8"|"N1_HIGHCPU_32"
   #   timeout: 10000s
   #   dockerImage: gcr.io/cloud-builders/docker
+  #   mavenImage: gcr.io/cloud-builders/mvn
+  #   gradleImage: gcr.io/cloud-builders/gradle
 
   # Docker artifacts can be built on a Kubernetes cluster with Kaniko.
   # Exactly one buildContext must be specified to use kaniko

diff --git a/pkg/skaffold/build/gcb/jib.go b/pkg/skaffold/build/gcb/jib.go
@@ -23,18 +23,16 @@ import (
 )
 
 // TODO(dgageot): check that `package` is bound to `jib:build`
-// TODO(dgageot): let users configure the mvn image
 func (b *Builder) jibMavenBuildSteps(imageName string, artifact *latest.JibMavenArtifact) []*cloudbuild.BuildStep {
 	return []*cloudbuild.BuildStep{{
-		Name: "gcr.io/cloud-builders/mvn",
+		Name: b.MavenImage,
 		Args: jib.GenerateMavenArgs("dockerBuild", imageName, artifact),
 	}}
 }
 
-// TODO(dgageot): let users configure the gradle image
 func (b *Builder) jibGradleBuildSteps(imageName string, artifact *latest.JibGradleArtifact) []*cloudbuild.BuildStep {
 	return []*cloudbuild.BuildStep{{
-		Name: "gcr.io/cloud-builders/gradle",
+		Name: b.GradleImage,
 		Args: jib.GenerateGradleArgs("jibDockerBuild", imageName, artifact),
 	}}
 }
diff --git a/pkg/skaffold/build/gcb/jib_test.go b/pkg/skaffold/build/gcb/jib_test.go
@@ -28,12 +28,14 @@ func TestJibMavenBuildSteps(t *testing.T) {
 	artifact := &latest.JibMavenArtifact{}
 
 	builder := Builder{
-		GoogleCloudBuild: &latest.GoogleCloudBuild{},
+		GoogleCloudBuild: &latest.GoogleCloudBuild{
+			MavenImage: "maven:3.6.0",
+		},
 	}
 	steps := builder.jibMavenBuildSteps("img", artifact)
 
 	expected := []*cloudbuild.BuildStep{{
-		Name: "gcr.io/cloud-builders/mvn",
+		Name: "maven:3.6.0",
 		Args: []string{"--non-recursive", "prepare-package", "jib:dockerBuild", "-Dimage=img"},
 	}}
 
@@ -44,12 +46,14 @@ func TestJibGradleBuildSteps(t *testing.T) {
 	artifact := &latest.JibGradleArtifact{}
 
 	builder := Builder{
-		GoogleCloudBuild: &latest.GoogleCloudBuild{},
+		GoogleCloudBuild: &latest.GoogleCloudBuild{
+			GradleImage: "gradle:5.1.1",
+		},
 	}
 	steps := builder.jibGradleBuildSteps("img", artifact)
 
 	expected := []*cloudbuild.BuildStep{{
-		Name: "gcr.io/cloud-builders/gradle",
+		Name: "gradle:5.1.1",
 		Args: []string{":jibDockerBuild", "--image=img"},
 	}}
 

diff --git a/pkg/skaffold/constants/constants.go b/pkg/skaffold/constants/constants.go
@@ -61,6 +61,8 @@ const (
 	UpdateCheckEnvironmentVariable = "SKAFFOLD_UPDATE_CHECK"
 
 	DefaultCloudBuildDockerImage = "gcr.io/cloud-builders/docker"
+	DefaultCloudBuildMavenImage  = "gcr.io/cloud-builders/mvn"
+	DefaultCloudBuildGradleImage = "gcr.io/cloud-builders/gradle"
 
 	// A regex matching valid repository names (https://github.com/docker/distribution/blob/master/reference/reference.go)
 	RepositoryComponentRegex string = `^[a-z\d]+(?:(?:[_.]|__|-+)[a-z\d]+)*$`

diff --git a/pkg/skaffold/schema/defaults/defaults.go b/pkg/skaffold/schema/defaults/defaults.go
@@ -19,24 +19,30 @@ package defaults
 import (
 	"fmt"
 
-	homedir "github.com/mitchellh/go-homedir"
-	"github.com/pkg/errors"
-	"github.com/sirupsen/logrus"
-
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/constants"
 	kubectx "github.com/GoogleContainerTools/skaffold/pkg/skaffold/kubernetes/context"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest"
+	homedir "github.com/mitchellh/go-homedir"
+	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
 )
 
 // Set makes sure default values are set on a SkaffoldPipeline.
 func Set(c *latest.SkaffoldPipeline) error {
 	defaultToLocalBuild(c)
 	defaultToKubectlDeploy(c)
-	setDefaultCloudBuildDockerImage(c)
 	setDefaultTagger(c)
 	setDefaultKustomizePath(c)
 	setDefaultKubectlManifests(c)
 
+	if err := withCloudBuildConfig(c,
+		setDefaultCloudBuildDockerImage,
+		setDefaultCloudBuildMavenImage,
+		setDefaultCloudBuildGradleImage,
+	); err != nil {
+		return err
+	}
+
 	if err := withKanikoConfig(c,
 		setDefaultKanikoTimeout,
 		setDefaultKanikoImage,
@@ -75,13 +81,31 @@ func defaultToKubectlDeploy(c *latest.SkaffoldPipeline) {
 	c.Deploy.DeployType.KubectlDeploy = &latest.KubectlDeploy{}
 }
 
-func setDefaultCloudBuildDockerImage(c *latest.SkaffoldPipeline) {
-	cloudBuild := c.Build.BuildType.GoogleCloudBuild
-	if cloudBuild == nil {
-		return
+func withCloudBuildConfig(c *latest.SkaffoldPipeline, operations ...func(kaniko *latest.GoogleCloudBuild) error) error {
+	if gcb := c.Build.GoogleCloudBuild; gcb != nil {
+		for _, operation := range operations {
+			if err := operation(gcb); err != nil {
+				return err
+			}
+		}
 	}
 
-	cloudBuild.DockerImage = valueOrDefault(cloudBuild.DockerImage, constants.DefaultCloudBuildDockerImage)
+	return nil
+}
+
+func setDefaultCloudBuildDockerImage(gcb *latest.GoogleCloudBuild) error {
+	gcb.DockerImage = valueOrDefault(gcb.DockerImage, constants.DefaultCloudBuildDockerImage)
+	return nil
+}
+
+func setDefaultCloudBuildMavenImage(gcb *latest.GoogleCloudBuild) error {
+	gcb.MavenImage = valueOrDefault(gcb.MavenImage, constants.DefaultCloudBuildMavenImage)
+	return nil
+}
+
+func setDefaultCloudBuildGradleImage(gcb *latest.GoogleCloudBuild) error {
+	gcb.GradleImage = valueOrDefault(gcb.GradleImage, constants.DefaultCloudBuildGradleImage)
+	return nil
 }
 
 func setDefaultTagger(c *latest.SkaffoldPipeline) {

diff --git a/pkg/skaffold/schema/latest/config.go b/pkg/skaffold/schema/latest/config.go
@@ -97,6 +97,8 @@ type GoogleCloudBuild struct {
 	MachineType string `yaml:"machineType,omitempty"`
 	Timeout     string `yaml:"timeout,omitempty"`
 	DockerImage string `yaml:"dockerImage,omitempty"`
+	MavenImage  string `yaml:"mavenImage,omitempty"`
+	GradleImage string `yaml:"gradleImage,omitempty"`
 }
 
 // LocalDir represents the local directory kaniko build context

diff --git a/pkg/skaffold/schema/v1beta2/upgrade.go b/pkg/skaffold/schema/v1beta2/upgrade.go
@@ -26,7 +26,9 @@ import (
 
 // Upgrade upgrades a configuration to the next version.
 // Config changes from v1beta2 to v1beta3
-// 1. No additions
+// 1. Additions:
+// gcb builder mvn image
+// gcb builder gradle image
 // 2. No removals
 // 3. No updates
 func (config *SkaffoldPipeline) Upgrade() (util.VersionedConfig, error) {

diff --git a/pkg/skaffold/schema/versions_test.go b/pkg/skaffold/schema/versions_test.go
@@ -241,6 +241,8 @@ func withGoogleCloudBuild(id string, ops ...func(*latest.BuildConfig)) func(*lat
 		b := latest.BuildConfig{BuildType: latest.BuildType{GoogleCloudBuild: &latest.GoogleCloudBuild{
 			ProjectID:   id,
 			DockerImage: "gcr.io/cloud-builders/docker",
+			MavenImage:  "gcr.io/cloud-builders/mvn",
+			GradleImage: "gcr.io/cloud-builders/gradle",
 		}}}
 		for _, op := range ops {
 			op(&b)