fix(manifests): fix full CRDs and update tests to use them. Fixes #8532 #14044
+33,545
−17,145
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,108 +1,107 @@ | ||
| package main | ||
|
|
||
| import "fmt" | ||
|
|
||
| // cleanCRD does post-processing of the CRDs generated by kubebuilder to workaround limitations | ||
| // (e.g. https://github.com/kubernetes-sigs/controller-tools/issues/461) | ||
| func cleanCRD(filename string) { | ||
| crd := ParseYaml(Read(filename)) | ||
| crd.RemoveNestedField("status") | ||
| crd.RemoveNestedField("metadata", "annotations") | ||
| crd.RemoveNestedField("metadata", "creationTimestamp") | ||
| schema := crd.OpenAPIV3Schema() | ||
| switch crd.Name() { | ||
| case "cronworkflows.argoproj.io": | ||
| patchMetadata(&schema, "spec", "properties", "workflowMetadata", "properties") | ||
| patchWorkflowSpecTemplateFields(&schema, "spec", "properties", "workflowSpec", "properties") | ||
| case "clusterworkflowtemplates.argoproj.io", "workflowtemplates.argoproj.io": | ||
| patchWorkflowSpecTemplateFields(&schema, "spec", "properties") | ||
| case "workflows.argoproj.io": | ||
| patchWorkflowSpecTemplateFields(&schema, "spec", "properties") | ||
| patchWorkflowSpecTemplateFields(&schema, "status", "properties", "storedWorkflowTemplateSpec", "properties") | ||
| patchTemplateFields(&schema, "status", "properties", "storedTemplates", "additionalProperties", "properties") | ||
| patchEphemeralVolumeFields(&schema, "status", "properties", "persistentVolumeClaims", "items", "properties") | ||
| case "workfloweventbindings.argoproj.io": | ||
| patchMetadata(&schema, "spec", "properties", "submit", "properties", "metadata", "properties") | ||
| case "workflowtasksets.argoproj.io": | ||
| patchVolumeFields(&schema, "spec", "properties", "tasks", "additionalProperties", "properties") | ||
|
|
||
| } | ||
| crd.WriteYaml(filename) | ||
| } | ||
|
|
||
| func patchWorkflowSpecTemplateFields(schema *obj, baseFields ...string) { | ||
| patchTemplateFields(schema, append(baseFields, "templateDefaults", "properties")...) | ||
| patchTemplateFields(schema, append(baseFields, "templates", "items", "properties")...) | ||
| patchVolumeFields(schema, baseFields...) | ||
| patchMetadata(schema, append(baseFields, "volumeClaimTemplates", "items", "properties", "metadata", "properties")...) | ||
| } | ||
|
|
||
| // Workaround for missing generateName (see https://github.com/kubernetes-sigs/controller-tools/pull/640) | ||
| func patchMetadata(schema *obj, baseFields ...string) { | ||
| schema.SetNestedField(map[string]string{"type": "string"}, append(baseFields, "generateName")...) | ||
|
|
||
| } | ||
|
|
||
| func patchEphemeralVolumeFields(schema *obj, baseFields ...string) { | ||
| patchMetadata(schema, append(baseFields, "ephemeral", "properties", "volumeClaimTemplate", "properties", "metadata", "properties")...) | ||
| } | ||
|
|
||
| func patchVolumeFields(schema *obj, baseFields ...string) { | ||
| patchEphemeralVolumeFields(schema, append(baseFields, "volumes", "items", "properties")...) | ||
| } | ||
|
|
||
| func patchTemplateFields(schema *obj, baseFields ...string) { | ||
| patchVolumeFields(schema, baseFields...) | ||
| // "container" and "script" templates embed the k8s.io/api/core/v1/Container | ||
| // struct, which requires the "name" field to be specified, but it's not actually required, | ||
| // and there's no easy way to override validating rules for embedded structs in kubebuilder. | ||
| schema.RemoveNestedField(append(baseFields, "container", "required")...) | ||
| schema.RemoveNestedField(append(baseFields, "script", "required")...) | ||
|
|
||
| // Hack to transform "steps" from an array of objects, e.g. | ||
| // steps: | ||
| // - steps: | ||
| // - name: foo | ||
| // template: bar | ||
| // to an array of arrays, e.g.: | ||
| // steps: | ||
| // - - name: foo | ||
| // template: bar | ||
| // | ||
| // The reason it's represented as an array of objects in "workflow_types.go" | ||
| // is because that's the only way to get kubebuilder to generate the spec | ||
| // without breaking API compatibility. | ||
| stepFields := append(baseFields, "steps", "items") | ||
| schema.CopyNestedField(append(stepFields, "properties", "steps"), stepFields) | ||
| } | ||
|
|
||
| // minimizeCRD generates a stripped-down CRD as a workaround for "Request entity too large: limit is 3145728" errors due to https://github.com/kubernetes/kubernetes/issues/82292. | ||
| // This isn't an issue if you use server-side apply, but not everyone has that available. | ||
| func minimizeCRD(filename string) { | ||
| data := Read(filename) | ||
| shouldMinimize := false | ||
| // TODO: The 512KB limit is just to avoid changing too much in https://github.com/argoproj/argo-workflows/pull/14044 | ||
| // Increase this back to 1MB after that's merged. | ||
| if len(data) > 512*1024 { | ||
| fmt.Printf("Minimizing %s due to CRD size (%d) exceeding 512KB\n", filename, len(data)) | ||
| shouldMinimize = true | ||
| } | ||
| if !shouldMinimize { | ||
| return | ||
| } | ||
| crd := ParseYaml(data) | ||
| stripSpecAndStatusFields(crd) | ||
| crd.WriteYaml(filename) | ||
| } | ||
|
|
||
| // stripSpecAndStatusFields strips the "spec" and "status" fields from the CRD, as those are usually the largest. | ||
| func stripSpecAndStatusFields(crd *obj) { | ||
| schema := crd.OpenAPIV3Schema() | ||
| preserveMarker := obj{"type": "object", "x-kubernetes-preserve-unknown-fields": true, "x-kubernetes-map-type": "atomic"} | ||
| if _, ok := schema["spec"]; ok { | ||
| schema["spec"] = preserveMarker | ||
| } | ||
| if _, ok := schema["status"]; ok { | ||
| schema["status"] = preserveMarker | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" | ||
| "sigs.k8s.io/yaml" | ||
| ) | ||
|
|
||
| type obj map[string]interface{} | ||
|
|
||
| func (o *obj) RemoveNestedField(fields ...string) { | ||
| unstructured.RemoveNestedField(*o, fields...) | ||
| } | ||
|
|
||
| func (o *obj) SetNestedField(value interface{}, fields ...string) { | ||
| parentField := nestedFieldNoCopy[map[string]interface{}](o, fields[:len(fields)-1]...) | ||
| parentField[fields[len(fields)-1]] = value | ||
| } | ||
|
|
||
| func (o *obj) CopyNestedField(sourceFields []string, targetFields []string) { | ||
| value := nestedFieldNoCopy[any](o, sourceFields...) | ||
| o.SetNestedField(value, targetFields...) | ||
| } | ||
|
|
||
| func (o *obj) Name() string { | ||
| return nestedFieldNoCopy[string](o, "metadata", "name") | ||
| } | ||
|
|
||
| func (o *obj) OpenAPIV3Schema() obj { | ||
| versions := nestedFieldNoCopy[[]interface{}](o, "spec", "versions") | ||
| version := obj(versions[0].(map[string]interface{})) | ||
| return nestedFieldNoCopy[map[string]interface{}](&version, "schema", "openAPIV3Schema", "properties") | ||
| } | ||
|
|
||
| func nestedFieldNoCopy[T any](o *obj, fields ...string) T { | ||
| value, found, err := unstructured.NestedFieldNoCopy(*o, fields...) | ||
| if !found { | ||
| panic(fmt.Sprintf("failed to find field %v", fields)) | ||
| } | ||
| if err != nil { | ||
| panic(err.Error()) | ||
| } | ||
| return value.(T) | ||
| } | ||
|
|
||
| func (o *obj) WriteYaml(filename string) { | ||
| data, err := yaml.Marshal(o) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| err = os.WriteFile(filename, data, 0o600) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| } | ||
|
|
||
| func Read(filename string) []byte { | ||
| data, err := os.ReadFile(filepath.Clean(filename)) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| return data | ||
| } | ||
|
|
||
| func ParseYaml(data []byte) *obj { | ||
| crd := make(obj) | ||
| err := yaml.Unmarshal(data, &crd) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| return &crd | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Full CRDs | ||
|
|
||
| These CRDs have the full schema and must be applied using [server-side apply](https://kubernetes.io/docs/reference/using-api/server-side-apply/) to avoid hitting size limits. | ||
| See [Full CRDs](https://argo-workflows.readthedocs.io/en/latest/installation/#full-crds) for more details. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this doesn't go out as part of 3.7, I'll remove this before it's merged
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍