Merge pull request #3715 from natasha41575/SpeedUpCustomParsing

Speed up custom parsing
2026-05-17 18:25:26 +00:00 · 2021-03-15 22:26:27 -07:00
parent 5247aa5750 2f6a611e62
commit 831f99c95b
6 changed files with 287 additions and 92456 deletions
--- a/12
+++ b/12
@@ -26,8 +26,7 @@ verify-kustomize: \
 	lint-kustomize \
 	test-unit-kustomize-all \
 	test-examples-kustomize-against-HEAD \
-	test-examples-kustomize-against-4.0 \
-	test-examples-kustomize-against-3.10
+	test-examples-kustomize-against-4.0

 # The following target referenced by a file in
 # https://github.com/kubernetes/test-infra/tree/master/config/jobs/kubernetes-sigs/kustomize
@@ -39,8 +38,7 @@ prow-presubmit-check: \
 	test-unit-cmd-all \
 	test-go-mod \
 	test-examples-kustomize-against-HEAD \
-	test-examples-kustomize-against-4.0 \
-	test-examples-kustomize-against-3.10
+	test-examples-kustomize-against-4.0

 .PHONY: verify-kustomize-e2e
 verify-kustomize-e2e: test-examples-e2e-kustomize
@@ -282,11 +280,7 @@ test-examples-kustomize-against-HEAD: $(MYGOBIN)/kustomize $(MYGOBIN)/mdrip

 .PHONY:
 test-examples-kustomize-against-4.0: $(MYGOBIN)/mdrip
-	./hack/testExamplesAgainstKustomize.sh v4@v4.0.1
-
-.PHONY:
-test-examples-kustomize-against-3.10: $(MYGOBIN)/mdrip
-	./hack/testExamplesAgainstKustomize.sh v3@v3.10.0
+	./hack/testExamplesAgainstKustomize.sh v4@v4.0.5

 # linux only.
 # This is for testing an example plugin that
--- a/api/krusty/openapicustomschema_test.go
+++ b/api/krusty/openapicustomschema_test.go
@@ -1,3 +1,6 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
 package krusty_test

 import (
@@ -183,6 +186,7 @@ openapi:

 func TestCustomOpenApiFieldOverlayTakesPrecedence(t *testing.T) {
 	th := kusttest_test.MakeHarness(t)
+	openapi.ResetOpenAPI()
 	th.WriteK("base", `
 resources:
 - mycrd.yaml
--- a/api/krusty/openapiversion_test.go
+++ b/api/krusty/openapiversion_test.go
@@ -1,3 +1,6 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
 package krusty_test

 import (
--- a/api/krusty/testdata/customschema.json
+++ b/api/krusty/testdata/customschema.json
--- a/examples/customOpenAPIschema.md
+++ b/examples/customOpenAPIschema.md
@@ -0,0 +1,244 @@
+# Using a Custom OpenAPI schema
+
+For more details regarding this feature you can read the
+[Kustomize OpenAPI Features KEP](https://github.com/kubernetes/enhancements/tree/master/keps/sig-cli/2206-openapi-features-in-kustomize).
+
+A kustomization file supports adding your own
+OpenAPI schema to define merge keys and patch
+strategy.
+
+Make a place to work:
+
+<!-- @placeToWork @testAgainstLatestRelease -->
+```
+DEMO_HOME=$(mktemp -d)
+```
+
+We'll be editing our own [custom resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
+
+<!-- @customOpenAPI @testAgainstLatestRelease -->
+```
+cat <<EOF >$DEMO_HOME/my_resource.yaml
+apiVersion: example.com/v1alpha1
+kind: MyResource
+metadata:
+  name: service
+spec:
+  template:
+    spec:
+      containers:
+      - name: server
+        image: server
+        command: example
+        ports:
+        - name: grpc
+          protocol: TCP
+          containerPort: 8080
+EOF
+```
+
+This resource has an image field. Let's change its value from server 
+to nginx with a patch. 
+
+Kustomize gets its merge key information from the OpenAPI data
+provided by the kubernetes API server. It doesn't have information
+about custom resources, so we will have to provide our own 
+schema file. 
+
+Note: CRDs support declarative validation using an OpenAPI v3 schema.
+See https://book.kubebuilder.io/reference/generating-crd.html#validation.
+
+You can get an OpenAPI document like this by fetching the OpenAPI
+document from your locally favored cluster with the command
+`kustomize openapi fetch`. Kustomize will use the OpenAPI extensions
+`x-kubernetes-patch-merge-key` and `x-kubernetes-patch-strategy` to
+perform a strategic merge. `x-kubernetes-patch-strategy` should be set
+to "merge", and you can set your merge key to whatever you like. Below,
+our custom resource inherits merge keys from `PodTemplateSpec`. 
+
+<!-- @addCustomSchema @testAgainstLatestRelease -->
+```
+cat <<EOF >>$DEMO_HOME/mycr_schema.json
+{
+  "definitions": {
+    "v1alpha1.MyResource": {
+      "properties": {
+        "apiVersion": {
+          "type": "string"
+        },
+        "kind": {
+          "type": "string"
+        },
+        "metadata": {
+          "type": "object"
+        },
+        "spec": {
+          "properties": {
+            "template": {
+              "\$ref": "#/definitions/io.k8s.api.core.v1.PodTemplateSpec"
+            }
+          },
+          "type": "object"
+        },
+        "status": {
+           "properties": {
+            "success": {
+              "type": "boolean"
+            }
+          },
+          "type": "object"
+        }
+      },
+      "type": "object",
+      "x-kubernetes-group-version-kind": [
+        {
+          "group": "example.com",
+          "kind": "MyResource",
+          "version": "v1alpha1"
+        }
+      ]
+    },
+    "io.k8s.api.core.v1.PodTemplateSpec": {
+      "properties": {
+        "metadata": {
+          "\$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+        },
+        "spec": {
+          "\$ref": "#/definitions/io.k8s.api.core.v1.PodSpec"
+        }
+      },
+      "type": "object"
+    },
+    "io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta": {
+      "properties": {
+        "name": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "io.k8s.api.core.v1.PodSpec": {
+      "properties": {
+        "containers": {
+          "items": {
+            "\$ref": "#/definitions/io.k8s.api.core.v1.Container"
+          },
+          "type": "array",
+          "x-kubernetes-patch-merge-key": "name",
+          "x-kubernetes-patch-strategy": "merge"
+        }
+      },
+      "type": "object"
+    },
+    "io.k8s.api.core.v1.Container": {
+      "properties": {
+        "command": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "image": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "ports": {
+         "items": {
+            "\$ref": "#/definitions/io.k8s.api.core.v1.ContainerPort"
+          },
+          "type": "array",
+          "x-kubernetes-list-map-keys": [
+            "containerPort",
+            "protocol"
+          ],
+          "x-kubernetes-list-type": "map",
+          "x-kubernetes-patch-merge-key": "containerPort",
+          "x-kubernetes-patch-strategy": "merge"
+        }
+      },
+      "type": "object"
+    },
+    "io.k8s.api.core.v1.ContainerPort": {
+     "properties": {
+        "containerPort": {
+          "format": "int32",
+          "type": "integer"
+        },
+        "name": {
+          "type": "string"
+        },
+        "protocol": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  }
+}
+
+EOF
+```
+
+We'll of course need a `kustomization` file
+referring to the custom resource, and containing our patch:
+
+<!-- @openAPIkustomization @testAgainstLatestRelease -->
+```
+cat <<EOF >$DEMO_HOME/kustomization.yaml
+resources:
+- my_resource.yaml
+
+openapi:
+  path: mycr_schema.json
+
+patchesStrategicMerge:
+- |-
+  apiVersion: example.com/v1alpha1
+  kind: MyResource
+  metadata:
+    name: service
+  spec:
+    template:
+      spec:
+        containers:
+        - name: server
+          image: nginx
+EOF
+```
+
+Define the expected output:
+<!-- @expected @testAgainstLatestRelease -->
+```
+cat <<EOF >$DEMO_HOME/out_expected.yaml
+apiVersion: example.com/v1alpha1
+kind: MyResource
+metadata:
+  name: service
+spec:
+  template:
+    spec:
+      containers:
+      - command: example
+        image: nginx
+        name: server
+        ports:
+        - containerPort: 8080
+          name: grpc
+          protocol: TCP
+EOF
+```
+
+Run the build:
+<!-- @runExample @testAgainstLatestRelease -->
+```
+kustomize build $DEMO_HOME >$DEMO_HOME/out_actual.yaml
+```
+
+Confirm they match:
+
+<!-- @diffShouldBeEmpty @testAgainstLatestRelease -->
+```
+diff $DEMO_HOME/out_actual.yaml $DEMO_HOME/out_expected.yaml
+```
--- a/kyaml/openapi/openapi.go
+++ b/kyaml/openapi/openapi.go
@@ -44,10 +44,9 @@ type openapiData struct {
 	// Kubernetes schema as part of the global schema
 	noUseBuiltInSchema bool

-	// currentOpenAPIVersion stores the version if the kubernetes openapi data
-	// that is currently stored as the schema, so that we only reparse the
-	// schema when necessary (to speed up performance)
-	currentOpenAPIVersion string
+	// schemaInit stores whether or not we've parsed the schema already,
+	// so that we only reparse the when necessary (to speed up performance)
+	schemaInit bool
 }

 // ResourceSchema wraps the OpenAPI Schema.
@@ -477,27 +476,28 @@ func GetSchemaVersion() string {

 // initSchema parses the json schema
 func initSchema() {
+	if globalSchema.schemaInit {
+		return
+	}
+	globalSchema.schemaInit = true
+
 	if customSchema != nil {
-		ResetOpenAPI()
 		err := parse(customSchema)
 		if err != nil {
 			panic("invalid schema file")
 		}
-		if err := parse(kustomizationapi.MustAsset(kustomizationAPIAssetName)); err != nil {
+		if err = parse(kustomizationapi.MustAsset(kustomizationAPIAssetName)); err != nil {
 			// this should never happen
 			panic(err)
 		}
 		return
 	}

-	currentVersion := kubernetesOpenAPIVersion
-	if currentVersion == "" {
-		currentVersion = kubernetesOpenAPIDefaultVersion
+	if kubernetesOpenAPIVersion == "" {
+		parseBuiltinSchema(kubernetesOpenAPIDefaultVersion)
+	} else {
+		parseBuiltinSchema(kubernetesOpenAPIVersion)
 	}
-	if globalSchema.currentOpenAPIVersion != currentVersion {
-		parseBuiltinSchema(currentVersion)
-	}
-	globalSchema.currentOpenAPIVersion = currentVersion
 }

 // parseBuiltinSchema calls parse to parse the json schemas