chore: updates after code review

garethjevans · garethjevans · commit 72b7a50f172a · 2019-03-25T12:05:38.000Z
diff --git a/docs/content/en/schemas/v1beta7.json b/docs/content/en/schemas/v1beta7.json
@@ -616,11 +616,6 @@
           "x-intellij-html-description": "name of the Kubernetes secret for pulling the files from the build context and pushing the final image.",
           "default": "kaniko-secret"
         },
-        "resources": {
-          "$ref": "#/definitions/ResourceRequirements",
-          "description": "define the resource requirements for the kaniko pod.",
-          "x-intellij-html-description": "define the resource requirements for the kaniko pod."
-        },
         "timeout": {
           "type": "string",
           "description": "amount of time (in seconds) that this build is allowed to run. Defaults to 20 minutes (`20m`).",
@@ -632,8 +627,7 @@
         "pullSecretName",
         "namespace",
         "timeout",
-        "dockerConfig",
-        "resources"
+        "dockerConfig"
       ],
       "additionalProperties": false,
       "description": "*beta* describes how to do an on-cluster build.",
@@ -1597,54 +1591,6 @@
       "description": "*beta* profiles are used to override any `build`, `test` or `deploy` configuration.",
       "x-intellij-html-description": "<em>beta</em> profiles are used to override any <code>build</code>, <code>test</code> or <code>deploy</code> configuration."
     },
-    "ResourceRequirement": {
-      "properties": {
-        "cpu": {
-          "type": "string",
-          "description": "the number cores to be used.",
-          "x-intellij-html-description": "the number cores to be used.",
-          "examples": [
-            "2`, `2.0` or `200m"
-          ]
-        },
-        "memory": {
-          "type": "string",
-          "description": "the amount of memory to allocate to the pod.",
-          "x-intellij-html-description": "the amount of memory to allocate to the pod.",
-          "examples": [
-            "1Gi` or `1000Mi"
-          ]
-        }
-      },
-      "preferredOrder": [
-        "cpu",
-        "memory"
-      ],
-      "additionalProperties": false,
-      "description": "stores the CPU/Memory requirements for the pod.",
-      "x-intellij-html-description": "stores the CPU/Memory requirements for the pod."
-    },
-    "ResourceRequirements": {
-      "properties": {
-        "limits": {
-          "$ref": "#/definitions/ResourceRequirement",
-          "description": "resource limits for the Kaniko pod. [More on limits](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container).",
-          "x-intellij-html-description": "resource limits for the Kaniko pod. <a href=\"https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container\">More on limits</a>."
-        },
-        "requests": {
-          "$ref": "#/definitions/ResourceRequirement",
-          "description": "resource requests for the Kaniko pod. [More on requests](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container).",
-          "x-intellij-html-description": "resource requests for the Kaniko pod. <a href=\"https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container\">More on requests</a>."
-        }
-      },
-      "preferredOrder": [
-        "requests",
-        "limits"
-      ],
-      "additionalProperties": false,
-      "description": "describes the resource requirements for the kaniko pod.",
-      "x-intellij-html-description": "describes the resource requirements for the kaniko pod."
-    },
     "ShaTagger": {
       "description": "*beta* tags images with their sha256 digest.",
       "x-intellij-html-description": "<em>beta</em> tags images with their sha256 digest."
diff --git a/docs/content/en/schemas/v1beta8.json b/docs/content/en/schemas/v1beta8.json
@@ -616,6 +616,11 @@
           "x-intellij-html-description": "name of the Kubernetes secret for pulling the files from the build context and pushing the final image.",
           "default": "kaniko-secret"
         },
+        "resources": {
+          "$ref": "#/definitions/ResourceRequirements",
+          "description": "define the resource requirements for the kaniko pod.",
+          "x-intellij-html-description": "define the resource requirements for the kaniko pod."
+        },
         "timeout": {
           "type": "string",
           "description": "amount of time (in seconds) that this build is allowed to run. Defaults to 20 minutes (`20m`).",
@@ -627,7 +632,8 @@
         "pullSecretName",
         "namespace",
         "timeout",
-        "dockerConfig"
+        "dockerConfig",
+        "resources"
       ],
       "additionalProperties": false,
       "description": "*beta* describes how to do an on-cluster build.",
@@ -1591,6 +1597,54 @@
       "description": "*beta* profiles are used to override any `build`, `test` or `deploy` configuration.",
       "x-intellij-html-description": "<em>beta</em> profiles are used to override any <code>build</code>, <code>test</code> or <code>deploy</code> configuration."
     },
+    "ResourceRequirement": {
+      "properties": {
+        "cpu": {
+          "type": "string",
+          "description": "the number cores to be used.",
+          "x-intellij-html-description": "the number cores to be used.",
+          "examples": [
+            "2`, `2.0` or `200m"
+          ]
+        },
+        "memory": {
+          "type": "string",
+          "description": "the amount of memory to allocate to the pod.",
+          "x-intellij-html-description": "the amount of memory to allocate to the pod.",
+          "examples": [
+            "1Gi` or `1000Mi"
+          ]
+        }
+      },
+      "preferredOrder": [
+        "cpu",
+        "memory"
+      ],
+      "additionalProperties": false,
+      "description": "stores the CPU/Memory requirements for the pod.",
+      "x-intellij-html-description": "stores the CPU/Memory requirements for the pod."
+    },
+    "ResourceRequirements": {
+      "properties": {
+        "limits": {
+          "$ref": "#/definitions/ResourceRequirement",
+          "description": "[resource limits](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the Kaniko pod.",
+          "x-intellij-html-description": "<a href=\"https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container\">resource limits</a> for the Kaniko pod."
+        },
+        "requests": {
+          "$ref": "#/definitions/ResourceRequirement",
+          "description": "[resource requests](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the Kaniko pod.",
+          "x-intellij-html-description": "<a href=\"https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container\">resource requests</a> for the Kaniko pod."
+        }
+      },
+      "preferredOrder": [
+        "requests",
+        "limits"
+      ],
+      "additionalProperties": false,
+      "description": "describes the resource requirements for the kaniko pod.",
+      "x-intellij-html-description": "describes the resource requirements for the kaniko pod."
+    },
     "ShaTagger": {
       "description": "*beta* tags images with their sha256 digest.",
       "x-intellij-html-description": "<em>beta</em> tags images with their sha256 digest."
diff --git a/pkg/skaffold/build/kaniko/sources/sources_test.go b/pkg/skaffold/build/kaniko/sources/sources_test.go
@@ -30,15 +30,15 @@ import (
 
 func TestPodTemplate(t *testing.T) {
 	tests := []struct {
-		name     string
-		initial  *latest.ClusterDetails
-		image    string
-		args     []string
-		expected *v1.Pod
+		description string
+		initial     *latest.ClusterDetails
+		image       string
+		args        []string
+		expected    *v1.Pod
 	}{
 		{
-			name:    "basic pod",
-			initial: &latest.ClusterDetails{},
+			description: "basic pod",
+			initial:     &latest.ClusterDetails{},
 			expected: &v1.Pod{
 				ObjectMeta: metav1.ObjectMeta{
 					GenerateName: "kaniko-",
@@ -77,7 +77,7 @@ func TestPodTemplate(t *testing.T) {
 			},
 		},
 		{
-			name: "with docker config",
+			description: "with docker config",
 			initial: &latest.ClusterDetails{
 				DockerConfig: &latest.DockerConfig{
 					SecretName: "docker-cfg",
@@ -133,7 +133,7 @@ func TestPodTemplate(t *testing.T) {
 			},
 		},
 		{
-			name: "with resource constraints",
+			description: "with resource constraints",
 			initial: &latest.ClusterDetails{
 				Resources: &latest.ResourceRequirements{
 					Requests: &latest.ResourceRequirement{
@@ -195,23 +195,22 @@ func TestPodTemplate(t *testing.T) {
 	})
 
 	for _, test := range tests {
-		t.Run(test.name, func(t *testing.T) {
+		t.Run(test.description, func(t *testing.T) {
 			actual := podTemplate(test.initial, test.image, test.args)
 			testutil.CheckDeepEqual(t, test.expected, actual, opt)
 		})
 	}
 }
 
 func createResourceRequirements(cpuLimit resource.Quantity, memoryLimit resource.Quantity, cpuRequest resource.Quantity, memoryRequest resource.Quantity) v1.ResourceRequirements {
-	req := v1.ResourceRequirements{}
-	req.Limits = v1.ResourceList{}
-	req.Limits[v1.ResourceCPU] = cpuLimit
-	req.Limits[v1.ResourceMemory] = memoryLimit
-
-	req.Requests = v1.ResourceList{}
-	req.Requests[v1.ResourceCPU] = cpuRequest
-	req.Requests[v1.ResourceMemory] = memoryRequest
-
-	return req
-
+	return v1.ResourceRequirements{
+		Limits: v1.ResourceList{
+			v1.ResourceCPU:    cpuLimit,
+			v1.ResourceMemory: memoryLimit,
+		},
+		Requests: v1.ResourceList{
+			v1.ResourceCPU:    cpuRequest,
+			v1.ResourceMemory: memoryRequest,
+		},
+	}
 }
diff --git a/pkg/skaffold/schema/latest/config.go b/pkg/skaffold/schema/latest/config.go
@@ -270,10 +270,10 @@ type DockerConfig struct {
 
 // ResourceRequirements describes the resource requirements for the kaniko pod.
 type ResourceRequirements struct {
-	// Requests resource requests for the Kaniko pod. [More on requests](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container).
+	// Requests [resource requests](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the Kaniko pod.
 	Requests *ResourceRequirement `yaml:"requests,omitempty"`
 
-	// Limits resource limits for the Kaniko pod. [More on limits](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container).
+	// Limits [resource limits](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the Kaniko pod.
 	Limits *ResourceRequirement `yaml:"limits,omitempty"`
 }
 
