-
Notifications
You must be signed in to change notification settings - Fork 3.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(manifests): fix full CRDs and update tests to use them. Fixes #8532 #14044
Merged
Merged
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
57ba14a
fix(manifests): fix full CRDs and update tests to use them
MasonM c89b8f0
fix(manifests): add missing generateName to embedded ObjectMetadata
MasonM 346a3cf
fix(ci): workaround kit bug https://github.com/kitproj/kit/commit/46f…
MasonM a4e8807
Merge branch 'main' into full-crds2
MasonM c15274b
Merge branch 'main' into full-crds2
MasonM 67eefb2
Merge branch 'main' into full-crds2
MasonM 63d6790
Merge branch 'main' into full-crds2
MasonM 0a52e51
Merge branch 'main' into full-crds2
MasonM d3f2ee7
test: update TestMalformedCronWorkflow to skip testing a valid CronWo…
MasonM 987bb2e
docs: more comments in workflow_types.go explaining decisions
MasonM 1234cc0
Merge remote-tracking branch 'upstream/main' into full-crds2
MasonM bf07fa9
test: increase sleep time due to race condition
MasonM b6516da
test: revert increase since that didn't fix it
MasonM File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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,84 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "sigs.k8s.io/yaml" | ||
| ) | ||
| import "fmt" | ||
|
|
||
| // cleanCRD does post-processing of the CRDs generated by kubebuilder to workaround limitations | ||
| // (see https://github.com/kubernetes-sigs/controller-tools/issues/461) | ||
| func cleanCRD(filename string) { | ||
| data, err := os.ReadFile(filepath.Clean(filename)) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| crd := make(obj) | ||
| err = yaml.Unmarshal(data, &crd) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| delete(crd, "status") | ||
| metadata := crd["metadata"].(obj) | ||
| delete(metadata, "annotations") | ||
| delete(metadata, "creationTimestamp") | ||
| spec := crd["spec"].(obj) | ||
| versions := spec["versions"].([]interface{}) | ||
| version := versions[0].(obj) | ||
| schema := version["schema"].(obj)["openAPIV3Schema"].(obj) | ||
| name := crd["metadata"].(obj)["name"].(string) | ||
| switch name { | ||
| 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": | ||
| properties := schema["properties"].(obj)["spec"].(obj)["properties"].(obj)["workflowSpec"].(obj)["properties"].(obj)["templates"].(obj)["items"].(obj)["properties"] | ||
| properties.(obj)["container"].(obj)["required"] = []string{"image"} | ||
| properties.(obj)["script"].(obj)["required"] = []string{"image", "source"} | ||
| patchWorkflowSpecTemplateFields(&schema, "spec", "properties", "workflowSpec", "properties") | ||
| case "clusterworkflowtemplates.argoproj.io", "workflows.argoproj.io", "workflowtemplates.argoproj.io": | ||
| properties := schema["properties"].(obj)["spec"].(obj)["properties"].(obj)["templates"].(obj)["items"].(obj)["properties"] | ||
| properties.(obj)["container"].(obj)["required"] = []string{"image"} | ||
| properties.(obj)["script"].(obj)["required"] = []string{"image", "source"} | ||
| patchWorkflowSpecTemplateFields(&schema, "spec", "properties") | ||
| } | ||
| data, err = yaml.Marshal(crd) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| err = os.WriteFile(filename, data, 0o600) | ||
| if err != nil { | ||
| panic(err) | ||
| if crd.Name() == "workflows.argoproj.io" { | ||
| patchTemplateFields(&schema, "status", "properties", "storedTemplates", "additionalProperties") | ||
| patchWorkflowSpecTemplateFields(&schema, "status", "properties", "storedWorkflowTemplateSpec", "properties") | ||
| } | ||
| crd.WriteYaml(filename) | ||
| } | ||
|
|
||
| // minimizeCRD is a workaround for two separate issues: | ||
| // 1. "Request entity too large: limit is 3145728" errors due to https://github.com/kubernetes/kubernetes/issues/82292 | ||
| // 2. "spec.validation.openAPIV3Schema.properties[spec].properties[tasks].additionalProperties.properties[steps].items.items: Required value: must be specified" due to kubebuilder issues (https://github.com/argoproj/argo-workflows/pull/3809#discussion_r472383090) | ||
| func minimizeCRD(filename string) { | ||
| data, err := os.ReadFile(filepath.Clean(filename)) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| func patchWorkflowSpecTemplateFields(schema *obj, baseFields ...string) { | ||
| patchTemplateFields(schema, append(baseFields, "templateDefaults")...) | ||
| patchTemplateFields(schema, append(baseFields, "templates", "items")...) | ||
| } | ||
|
|
||
| shouldMinimize := false | ||
| if len(data) > 1024*1024 { | ||
| fmt.Printf("Minimizing %s due to CRD size (%d) exceeding 1MB\n", filename, len(data)) | ||
| shouldMinimize = true | ||
| } | ||
| func patchTemplateFields(schema *obj, baseFields ...string) { | ||
| // "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, "properties", "container", "required")...) | ||
| schema.RemoveNestedField(append(baseFields, "properties", "script", "required")...) | ||
|
|
||
| crd := make(obj) | ||
| err = yaml.Unmarshal(data, &crd) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| // 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, "properties", "steps", "items") | ||
| schema.CopyNestedField(append(stepFields, "properties", "steps"), stepFields) | ||
| } | ||
|
|
||
| if !shouldMinimize { | ||
| name := crd["metadata"].(obj)["name"].(string) | ||
| switch name { | ||
| case "cronworkflows.argoproj.io", "clusterworkflowtemplates.argoproj.io", "workflows.argoproj.io", "workflowtemplates.argoproj.io", "workflowtasksets.argoproj.io": | ||
| fmt.Printf("Minimizing %s due to kubebuilder issues\n", filename) | ||
| shouldMinimize = true | ||
| } | ||
| // 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 = stripSpecAndStatusFields(crd) | ||
|
|
||
| data, err = yaml.Marshal(crd) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| err = os.WriteFile(filename, data, 0o600) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| 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) obj { | ||
| spec := crd["spec"].(obj) | ||
| versions := spec["versions"].([]interface{}) | ||
| version := versions[0].(obj) | ||
| properties := version["schema"].(obj)["openAPIV3Schema"].(obj)["properties"].(obj) | ||
| for k := range properties { | ||
| if k == "spec" || k == "status" { | ||
| properties[k] = obj{"type": "object", "x-kubernetes-preserve-unknown-fields": true, "x-kubernetes-map-type": "atomic"} | ||
| } | ||
| 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 | ||
| } | ||
| 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 |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| 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) CopyNestedField(sourceFields []string, targetFields []string) { | ||
| value := nestedFieldNoCopy[any](o, sourceFields...) | ||
| parentField := nestedFieldNoCopy[map[string]interface{}](o, targetFields[:len(targetFields)-1]...) | ||
| parentField[targetFields[len(targetFields)-1]] = value | ||
| } | ||
|
|
||
| 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 was deleted.
Oops, something went wrong.
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. | ||
| As a result, they are large and probably not suitable to be used in your cluster due to [kubernetes/kubernetes#82292](https://github.com/kubernetes/kubernetes/issues/82292). | ||
| 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.
👍