Support resource configuration for imagebuilder

api/cmd/api/setup.go

@@ -133,15 +133,16 @@ func initImageBuilder(cfg *config.Config) (webserviceBuilder imagebuilder.ImageB
 	}
 
 	webServiceConfig := imagebuilder.Config{
-		BaseImages:           cfg.ImageBuilderConfig.BaseImages,
-		BuildNamespace:       cfg.ImageBuilderConfig.BuildNamespace,
-		DockerRegistry:       cfg.ImageBuilderConfig.DockerRegistry,
-		ContextSubPath:       cfg.ImageBuilderConfig.ContextSubPath,
-		BuildTimeoutDuration: timeout,
-		KanikoImage:          cfg.ImageBuilderConfig.KanikoImage,
-		Tolerations:          cfg.ImageBuilderConfig.Tolerations,
-		NodeSelectors:        cfg.ImageBuilderConfig.NodeSelectors,
-		MaximumRetry:         cfg.ImageBuilderConfig.MaximumRetry,
+		BaseImages:             cfg.ImageBuilderConfig.BaseImages,
+		BuildNamespace:         cfg.ImageBuilderConfig.BuildNamespace,
+		DockerRegistry:         cfg.ImageBuilderConfig.DockerRegistry,
+		ContextSubPath:         cfg.ImageBuilderConfig.ContextSubPath,
+		BuildTimeoutDuration:   timeout,
+		KanikoImage:            cfg.ImageBuilderConfig.KanikoImage,
+		ResourceRequestsLimits: cfg.ImageBuilderConfig.ResourceRequestsLimits,
+		Tolerations:            cfg.ImageBuilderConfig.Tolerations,
+		NodeSelectors:          cfg.ImageBuilderConfig.NodeSelectors,
+		MaximumRetry:           cfg.ImageBuilderConfig.MaximumRetry,
 
 		ClusterName: cfg.ImageBuilderConfig.ClusterName,
 		GcpProject:  cfg.ImageBuilderConfig.GcpProject,
@@ -151,15 +152,16 @@ func initImageBuilder(cfg *config.Config) (webserviceBuilder imagebuilder.ImageB
 	webserviceBuilder = imagebuilder.NewModelServiceImageBuilder(kubeClient, webServiceConfig)
 
 	predJobConfig := imagebuilder.Config{
-		BaseImages:           cfg.ImageBuilderConfig.PredictionJobBaseImages,
-		BuildNamespace:       cfg.ImageBuilderConfig.BuildNamespace,
-		DockerRegistry:       cfg.ImageBuilderConfig.DockerRegistry,
-		ContextSubPath:       cfg.ImageBuilderConfig.PredictionJobContextSubPath,
-		BuildTimeoutDuration: timeout,
-		KanikoImage:          cfg.ImageBuilderConfig.KanikoImage,
-		Tolerations:          cfg.ImageBuilderConfig.Tolerations,
-		NodeSelectors:        cfg.ImageBuilderConfig.NodeSelectors,
-		MaximumRetry:         cfg.ImageBuilderConfig.MaximumRetry,
+		BaseImages:             cfg.ImageBuilderConfig.PredictionJobBaseImages,
+		BuildNamespace:         cfg.ImageBuilderConfig.BuildNamespace,
+		DockerRegistry:         cfg.ImageBuilderConfig.DockerRegistry,
+		ContextSubPath:         cfg.ImageBuilderConfig.PredictionJobContextSubPath,
+		BuildTimeoutDuration:   timeout,
+		KanikoImage:            cfg.ImageBuilderConfig.KanikoImage,
+		ResourceRequestsLimits: cfg.ImageBuilderConfig.ResourceRequestsLimits,
+		Tolerations:            cfg.ImageBuilderConfig.Tolerations,
+		NodeSelectors:          cfg.ImageBuilderConfig.NodeSelectors,
+		MaximumRetry:           cfg.ImageBuilderConfig.MaximumRetry,
 
 		ClusterName: cfg.ImageBuilderConfig.ClusterName,
 		GcpProject:  cfg.ImageBuilderConfig.GcpProject,

api/config/config.go

@@ -135,21 +135,34 @@ type DatabaseConfig struct {
 	MaxOpenConns    int           `envconfig:"DATABASE_MAX_OPEN_CONNS" default:"0"`
 }
 
+// Resource contains the Kubernetes resource request and limits
+type Resource struct {
+	CPU    string `validate:"required"`
+	Memory string `validate:"required"`
+}
+
+// ResourceRequestsLimits contains the Kubernetes resource request and limits for kaniko
+type ResourceRequestsLimits struct {
+	Requests Resource `validate:"required"`
+	Limits   Resource `validate:"required"`
+}
+
 type ImageBuilderConfig struct {
-	ClusterName                  string           `envconfig:"IMG_BUILDER_CLUSTER_NAME"`
-	GcpProject                   string           `envconfig:"IMG_BUILDER_GCP_PROJECT"`
-	BuildContextURI              string           `envconfig:"IMG_BUILDER_BUILD_CONTEXT_URI"`
-	ContextSubPath               string           `envconfig:"IMG_BUILDER_CONTEXT_SUB_PATH"`
-	DockerfilePath               string           `envconfig:"IMG_BUILDER_DOCKERFILE_PATH" default:"./Dockerfile"`
-	BaseImages                   BaseImageConfigs `envconfig:"IMG_BUILDER_BASE_IMAGES"`
-	PredictionJobBuildContextURI string           `envconfig:"IMG_BUILDER_PREDICTION_JOB_BUILD_CONTEXT_URI"`
-	PredictionJobContextSubPath  string           `envconfig:"IMG_BUILDER_PREDICTION_JOB_CONTEXT_SUB_PATH"`
-	PredictionJobDockerfilePath  string           `envconfig:"IMG_BUILDER_PREDICTION_JOB_DOCKERFILE_PATH" default:"./Dockerfile"`
-	PredictionJobBaseImages      BaseImageConfigs `envconfig:"IMG_BUILDER_PREDICTION_JOB_BASE_IMAGES"`
-	BuildNamespace               string           `envconfig:"IMG_BUILDER_NAMESPACE" default:"mlp"`
-	DockerRegistry               string           `envconfig:"IMG_BUILDER_DOCKER_REGISTRY"`
-	BuildTimeout                 string           `envconfig:"IMG_BUILDER_TIMEOUT" default:"10m"`
-	KanikoImage                  string           `envconfig:"IMG_BUILDER_KANIKO_IMAGE" default:"gcr.io/kaniko-project/executor:v1.6.0"`
+	ClusterName                  string                 `envconfig:"IMG_BUILDER_CLUSTER_NAME"`
+	GcpProject                   string                 `envconfig:"IMG_BUILDER_GCP_PROJECT"`
+	BuildContextURI              string                 `envconfig:"IMG_BUILDER_BUILD_CONTEXT_URI"`
+	ContextSubPath               string                 `envconfig:"IMG_BUILDER_CONTEXT_SUB_PATH"`
+	DockerfilePath               string                 `envconfig:"IMG_BUILDER_DOCKERFILE_PATH" default:"./Dockerfile"`
+	BaseImages                   BaseImageConfigs       `envconfig:"IMG_BUILDER_BASE_IMAGES"`
+	PredictionJobBuildContextURI string                 `envconfig:"IMG_BUILDER_PREDICTION_JOB_BUILD_CONTEXT_URI"`
+	PredictionJobContextSubPath  string                 `envconfig:"IMG_BUILDER_PREDICTION_JOB_CONTEXT_SUB_PATH"`
+	PredictionJobDockerfilePath  string                 `envconfig:"IMG_BUILDER_PREDICTION_JOB_DOCKERFILE_PATH" default:"./Dockerfile"`
+	PredictionJobBaseImages      BaseImageConfigs       `envconfig:"IMG_BUILDER_PREDICTION_JOB_BASE_IMAGES"`
+	BuildNamespace               string                 `envconfig:"IMG_BUILDER_NAMESPACE" default:"mlp"`
+	DockerRegistry               string                 `envconfig:"IMG_BUILDER_DOCKER_REGISTRY"`
+	BuildTimeout                 string                 `envconfig:"IMG_BUILDER_TIMEOUT" default:"10m"`
+	KanikoImage                  string                 `envconfig:"IMG_BUILDER_KANIKO_IMAGE" default:"gcr.io/kaniko-project/executor:v1.6.0"`
+	ResourceRequestsLimits       ResourceRequestsLimits `envconfig:"IMG_BUILDER_RESOURCE_REQUESTS_LIMITS"`
 	// How long to keep the image building job resource in the Kubernetes cluster. Default: 2 days (48 hours).
 	Retention     time.Duration        `envconfig:"IMG_BUILDER_RETENTION" default:"48h"`
 	Tolerations   Tolerations          `envconfig:"IMG_BUILDER_TOLERATIONS"`

api/pkg/imagebuilder/common.go

@@ -0,0 +1,48 @@
+// Copyright 2020 The Merlin Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package imagebuilder
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
+)
+
+// RequestLimitResources is a Kubernetes resource request and limits
+type RequestLimitResources struct {
+	Request Resource
+	Limit   Resource
+}
+
+// Build converts the spec into a Kubernetes spec
+func (r *RequestLimitResources) Build() corev1.ResourceRequirements {
+	return corev1.ResourceRequirements{
+		Requests: r.Request.Build(),
+		Limits:   r.Limit.Build(),
+	}
+}
+
+// Resource is a Kubernetes resource
+type Resource struct {
+	CPU    resource.Quantity
+	Memory resource.Quantity
+}
+
+// Build converts the spec into a Kubernetes spec
+func (r *Resource) Build() corev1.ResourceList {
+	return corev1.ResourceList{
+		corev1.ResourceCPU:    r.CPU,
+		corev1.ResourceMemory: r.Memory,
+	}
+}

api/pkg/imagebuilder/common_test.go

@@ -0,0 +1,57 @@
+// Copyright 2020 The Merlin Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package imagebuilder
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
+)
+
+var (
+	cpu    = resource.MustParse("500m")
+	memory = resource.MustParse("500Mi")
+)
+
+func CreateRequestLimitResources() RequestLimitResources {
+	return RequestLimitResources{
+		Request: Resource{
+			CPU:    cpu,
+			Memory: memory,
+		},
+		Limit: Resource{
+			CPU:    cpu,
+			Memory: memory,
+		},
+	}
+}
+
+func TestContainer(t *testing.T) {
+	expected := corev1.ResourceRequirements{
+		Requests: corev1.ResourceList{
+			corev1.ResourceCPU:    cpu,
+			corev1.ResourceMemory: memory,
+		},
+		Limits: corev1.ResourceList{
+			corev1.ResourceCPU:    cpu,
+			corev1.ResourceMemory: memory,
+		},
+	}
+	c := CreateRequestLimitResources()
+
+	assert.Equal(t, expected, c.Build())
+}

api/pkg/imagebuilder/config.go

@@ -35,6 +35,8 @@ type Config struct {
 	BuildTimeoutDuration time.Duration
 	// Kaniko docker image
 	KanikoImage string
+	// Kubernetes resource request and limits for kaniko
+	ResourceRequestsLimits cfg.ResourceRequestsLimits
 	// Tolerations for Jobs Specification
 	Tolerations []v1.Toleration
 	// Node Selectors for Jobs Specification

api/pkg/imagebuilder/imagebuilder.go

@@ -79,10 +79,6 @@ var (
 	jobCompletions            int32 = 1
 )
 
-var defaultResourceRequests = v1.ResourceList{
-	v1.ResourceCPU: resource.MustParse("1"),
-}
-
 func newImageBuilder(kubeClient kubernetes.Interface, config Config, nameGenerator nameGenerator) ImageBuilder {
 	return &imageBuilder{
 		kubeClient:    kubeClient,
@@ -365,6 +361,25 @@ func (c *imageBuilder) createKanikoJobSpec(project mlp.Project, model *models.Mo
 
 	activeDeadlineSeconds := int64(c.config.BuildTimeoutDuration / time.Second)
 
+	resourceRequirements := RequestLimitResources{
+		Request: Resource{
+			CPU: resource.MustParse(
+				c.config.ResourceRequestsLimits.Requests.CPU,
+			),
+			Memory: resource.MustParse(
+				c.config.ResourceRequestsLimits.Requests.Memory,
+			),
+		},
+		Limit: Resource{
+			CPU: resource.MustParse(
+				c.config.ResourceRequestsLimits.Limits.CPU,
+			),
+			Memory: resource.MustParse(
+				c.config.ResourceRequestsLimits.Limits.Memory,
+			),
+		},
+	}
+
 	return &batchv1.Job{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      kanikoPodName,
@@ -400,9 +415,7 @@ func (c *imageBuilder) createKanikoJobSpec(project mlp.Project, model *models.Mo
 									Value: saFilePath,
 								},
 							},
-							Resources: v1.ResourceRequirements{
-								Requests: defaultResourceRequests,
-							},
+							Resources:                resourceRequirements.Build(),
 							TerminationMessagePolicy: v1.TerminationMessageFallbackToLogsOnError,
 						},
 					},