Merge pull request #1448 from alexbarbato/builder-additional-labels

Add in the initial configuration to add the image labels

api/openapi-spec/swagger.json

@@ -5879,6 +5879,13 @@
     "kpack.build.v1alpha2.BuilderSpec": {
       "type": "object",
       "properties": {
+        "additionalLabels": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string",
+            "default": ""
+          }
+        },
         "order": {
           "type": "array",
           "items": {
@@ -6115,6 +6122,13 @@
     "kpack.build.v1alpha2.ClusterBuilderSpec": {
       "type": "object",
       "properties": {
+        "additionalLabels": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string",
+            "default": ""
+          }
+        },
         "order": {
           "type": "array",
           "items": {
@@ -6804,6 +6818,13 @@
     "kpack.build.v1alpha2.NamespacedBuilderSpec": {
       "type": "object",
       "properties": {
+        "additionalLabels": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string",
+            "default": ""
+          }
+        },
         "order": {
           "type": "array",
           "items": {
@@ -7181,8 +7202,7 @@
       "properties": {
         "lastTransitionTime": {
           "description": "LastTransitionTime is the last time the condition transitioned from one status to another. We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic differences (all other things held constant).",
-          "type": "string",
-          "default": {}
+          "type": "string"
         },
         "message": {
           "description": "A human readable message indicating details about the transition.",
@@ -7440,7 +7460,6 @@
       ],
       "properties": {
         "inner": {
-          "default": {},
           "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
         }
       }

docs/builders.md

@@ -50,6 +50,8 @@ spec:
       kind: ClusterBuildpack
       id: paketo-buildpacks/nodejs
       version: 1.2.3
+  additionalLabels:
+    custom-label: custom-value
 ```
 
 * `tag`: The tag to save the builder image. You must have access via the referenced service account.
@@ -60,6 +62,7 @@ spec:
 * `store`: If using ClusterStore, then the reference to the ClusterStore. See the [Resolving Buildpack IDs](#resolving-buildpack-ids) section below.
   * `name`: The name of the ClusterStore resource in kubernetes.
   * `kind`: The type as defined in kubernetes. This will always be ClusterStore.
+* `additionalLabels`: The custom labels that are desired to be on the Builder/ClusterBuilder images.
 
 ### <a id='cluster-builders'></a>Cluster Builders
 

pkg/apis/build/v1alpha2/builder_types.go

@@ -36,7 +36,8 @@ type BuilderSpec struct {
 	Stack corev1.ObjectReference `json:"stack,omitempty"`
 	Store corev1.ObjectReference `json:"store,omitempty"`
 	// +listType
-	Order []BuilderOrderEntry `json:"order,omitempty"`
+	Order            []BuilderOrderEntry `json:"order,omitempty"`
+	AdditionalLabels map[string]string   `json:"additionalLabels,omitempty"`
 }
 
 // +k8s:openapi-gen=true

pkg/cnb/builder_builder.go

@@ -51,6 +51,7 @@ type builderBlder struct {
 	runImage          string
 	mixins            []string
 	os                string
+	additionalLabels  map[string]string
 }
 
 func newBuilderBldr(kpackVersion string) *builderBlder {
@@ -93,6 +94,10 @@ func (bb *builderBlder) AddGroup(buildpacks ...RemoteBuildpackRef) {
 	bb.order = append(bb.order, corev1alpha1.OrderEntry{Group: group})
 }
 
+func (bb *builderBlder) AddAdditionalLabels(additionalLabels map[string]string) {
+	bb.additionalLabels = additionalLabels
+}
+
 func (bb *builderBlder) WriteableImage() (v1.Image, error) {
 	buildpacks := bb.buildpacks()
 
@@ -151,6 +156,11 @@ func (bb *builderBlder) WriteableImage() (v1.Image, error) {
 		return nil, err
 	}
 
+	image, err = imagehelpers.SetStringLabels(image, bb.additionalLabels)
+	if err != nil {
+		return nil, err
+	}
+
 	return imagehelpers.SetLabels(image, map[string]interface{}{
 		buildpackOrderLabel:  bb.order,
 		buildpackLayersLabel: buildpackLayerMetadata,

pkg/cnb/create_builder.go

@@ -65,6 +65,8 @@ func (r *RemoteBuilderCreator) CreateBuilder(ctx context.Context, builderKeychai
 		builderBldr.AddGroup(buildpacks...)
 	}
 
+	builderBldr.AddAdditionalLabels(spec.AdditionalLabels)
+
 	writeableImage, err := builderBldr.WriteableImage()
 	if err != nil {
 		return buildapi.BuilderRecord{}, err

pkg/cnb/create_builder_test.go

@@ -168,6 +168,10 @@ func testCreateBuilderOs(os string, t *testing.T, when spec.G, it spec.S) {
 					},
 				},
 			},
+			AdditionalLabels: map[string]string{
+				"os":         "special",
+				"importance": "high",
+			},
 		}
 
 		lifecycleProvider = &fakeLifecycleProvider{}
@@ -639,6 +643,13 @@ func testCreateBuilderOs(os string, t *testing.T, when spec.G, it spec.S) {
   }
 }`, buildpackLayers)
 
+			// Assure the loose coupling of the number of labels that should be there
+			assert.Equal(t, len(clusterBuilderSpec.AdditionalLabels), 2)
+			for key, value := range clusterBuilderSpec.AdditionalLabels {
+				additionalLabel, err := imagehelpers.GetStringLabel(savedImage, key)
+				assert.NoError(t, err)
+				assert.Equal(t, value, additionalLabel)
+			}
 		})
 
 		it("creates images deterministically ", func() {