Full vs Minimal CRD

[ramanNarasimhan77]

I was looking at the CRD manifests. Noticed that there is a minimal version and a full version.

Minimal CRD
Full CRD

README.md for Minimal CRDs says These CRDs omit schema validation.
README.md for Full CRD says These CRDs have full schema validation. As a result, they are large and probably not suitable to be used in your cluster.

I also noticed that in the Argo Helm community chart crds are based on the minimal CRDs.

Are there any specific cases where one would require the Full CRD installation or is it good enough to always use the Minimal version?

[terrytangyuan]

It should be good enough unless you want schema validation.

[ramanNarasimhan77]

Hello @terrytangyuan
I tried replacing minimal with full in this file https://github.com/argoproj/argo-workflows/blob/master/manifests/base/crds/kustomization.yaml and tried the cluster install, some of the crds failed to be applied with some openapi v3 errors, and some due to size of annotations.

Pasted full error as a separate comment.

How can I fix these issues?

The community chart only has the minimal version and this doesn't catch syntax issues. If at all there are sections having mistakes in the submitted workflow, they get removed and user won't even notice unless he carefully inspects.

For example if you intended to add sidecars to a task in the workflow, and if you make a typo and omit the final s, there is no error thrown if I use the minimal crd. I hoped that using the full crds would alleviate such issues.

I'm trying understand this because I'm building a custom Argo workflows chart wherein I want to include both the minimal and full crds and enable either one of those based on a boolean flag that could be set in the values file at install time.

[ramanNarasimhan77]

I made the following change

 git diff manifests/base/crds/kustomization.yaml
diff --git a/manifests/base/crds/kustomization.yaml b/manifests/base/crds/kustomization.yaml
index 3ccdade18..4bc23b6ee 100644
--- a/manifests/base/crds/kustomization.yaml
+++ b/manifests/base/crds/kustomization.yaml

@@ -2,4 +2,4 @@ apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization

 resources:
-  - minimal
+  - full

Then did

kubectl create ns argo
kubectl apply -k manifests/cluster-install

Following are the errors:

Error from server (Invalid): error when creating "manifests/cluster-install": CustomResourceDefinition.apiextensions.k8s.io "clusterworkflowtemplates.argoproj.io" is invalid: [spec.validation.openAPIV3Schema.properties[spec].properties[templateDefaults].properties[dag].properties[tasks].items.properties[inline].type: Required value: must not be empty for specified object fields, spec.validation.openAPIV3Schema.properties[spec].properties[templateDefaults].properties[steps].items.items: Required value: must be specified, spec.validation.openAPIV3Schema.properties[spec].properties[templates].items.properties[dag].properties[tasks].items.properties[inline].type: Required value: must not be empty for specified object fields, spec.validation.openAPIV3Schema.properties[spec].properties[templates].items.properties[steps].items.items: Required value: must be specified]


Error from server (Invalid): error when creating "manifests/cluster-install": CustomResourceDefinition.apiextensions.k8s.io "workflows.argoproj.io" is invalid: [metadata.annotations: Too long: must have at most 262144 bytes, spec.validation.openAPIV3Schema.properties[spec].properties[templateDefaults].properties[dag].properties[tasks].items.properties[inline].type: Required value: must not be empty for specified object fields, spec.validation.openAPIV3Schema.properties[spec].properties[templateDefaults].properties[steps].items.items: Required value: must be specified, spec.validation.openAPIV3Schema.properties[spec].properties[templates].items.properties[dag].properties[tasks].items.properties[inline].type: Required value: must not be empty for specified object fields, spec.validation.openAPIV3Schema.properties[spec].properties[templates].items.properties[steps].items.items: Required value: must be specified, spec.validation.openAPIV3Schema.properties[status].properties[storedTemplates].additionalProperties.properties[dag].properties[tasks].items.properties[inline].type: Required value: must not be empty for specified object fields, spec.validation.openAPIV3Schema.properties[status].properties[storedTemplates].additionalProperties.properties[steps].items.items: Required value: must be specified, spec.validation.openAPIV3Schema.properties[status].properties[storedWorkflowTemplateSpec].properties[templateDefaults].properties[dag].properties[tasks].items.properties[inline].type: Required value: must not be empty for specified object fields, spec.validation.openAPIV3Schema.properties[status].properties[storedWorkflowTemplateSpec].properties[templateDefaults].properties[steps].items.items: Required value: must be specified, spec.validation.openAPIV3Schema.properties[status].properties[storedWorkflowTemplateSpec].properties[templates].items.properties[dag].properties[tasks].items.properties[inline].type: Required value: must not be empty for specified object fields, spec.validation.openAPIV3Schema.properties[status].properties[storedWorkflowTemplateSpec].properties[templates].items.properties[steps].items.items: Required value: must be specified]


Error from server (Invalid): error when creating "manifests/cluster-install": CustomResourceDefinition.apiextensions.k8s.io "workflowtasksets.argoproj.io" is invalid: [spec.validation.openAPIV3Schema.properties[spec].properties[tasks].additionalProperties.properties[dag].properties[tasks].items.properties[inline].type: Required value: must not be empty for specified object fields, spec.validation.openAPIV3Schema.properties[spec].properties[tasks].additionalProperties.properties[steps].items.items: Required value: must be specified]
Error from server (Invalid): error when creating "manifests/cluster-install": CustomResourceDefinition.apiextensions.k8s.io "workflowtemplates.argoproj.io" is invalid: [spec.validation.openAPIV3Schema.properties[spec].properties[templateDefaults].properties[dag].properties[tasks].items.properties[inline].type: Required value: must not be empty for specified object fields, spec.validation.openAPIV3Schema.properties[spec].properties[templateDefaults].properties[steps].items.items: Required value: must be specified, spec.validation.openAPIV3Schema.properties[spec].properties[templates].items.properties[dag].properties[tasks].items.properties[inline].type: Required value: must not be empty for specified object fields, spec.validation.openAPIV3Schema.properties[spec].properties[templates].items.properties[steps].items.items: Required value: must be specified]```

[agilgur5]

Yes, per the Full CRD README, that is expected, as they are very large and may exceed k8s/etcd limits as such

[ramanNarasimhan77]

Also see: #11266