Sync the MaxItems constraints between the Go & JSON schemas #759
Conversation
|
/test-examples="examples/network/v1beta2/routefilter.yaml" |
|
/test-examples="examples/network/v1beta2/subnet.yaml" |
|
/test-examples="examples/cdn/v1beta2/endpoint.yaml" |
|
/test-examples="examples/compute/v1beta2/sharedimage.yaml" |
|
/test-examples="examples/network/v1beta2/profile.yaml" |
There was a problem hiding this comment.
Thanks @ulucinar LGTM. I left two nit comments that are proposing the removal of the functions that are no longer functional after the change. Also, checked the diffs in the apis and package to ensure that the configuration changes do not affect the APIs. It seems that all changes are related-to generation of SecretRefs in InitProvider blocks.
- Generate the secret references for the sensitive fields under the spec.initProvider API tree. Signed-off-by: Alper Rifat Ulucinar <[email protected]>
- We are introducing a schema traverser in upjet that's capable of synching the MaxItems constraints from the Go resource schema to the JSON schema. So we switch from manual configuration to automatic constraint syncing (for now, only MaxItems constraints are synced). - We would like to get rid of the JSON schema completely with a major version bump. - Automatic syncing will also help with the new resources as we will not need to consider syncing the MaxItems constraints on their fields. Signed-off-by: Alper Rifat Ulucinar <[email protected]>
from the Go resource schema to the JSON schema. Signed-off-by: Alper Rifat Ulucinar <[email protected]>
Signed-off-by: Alper Rifat Ulucinar <[email protected]>
|
/test-examples="examples/network/v1beta2/profile.yaml" |
|
/test-examples="examples/compute/v1beta2/sharedimage.yaml" |
|
/test-examples="examples/cdn/v1beta2/endpoint.yaml" |
|
/test-examples="examples/network/v1beta2/subnet.yaml" |
|
/test-examples="examples/network/v1beta2/routefilter.yaml" |
Description of your changes
Depends on: crossplane/upjet#411
When replacing the singleton lists with embedded objects in the MR APIs, we had figured out that the MaxItems constraints in the JSON resource schema were not in-sync with the constraints declared in the Go schema. For more context, please see the description of #745.
We've previously addressed this issue by manually configuring the
MaxItemsconstraints for the affected resources in #745. This also implies that if the constraints are not in sync for any future resources, then we will also need to manually configure them.With crossplane/upjet#411, we introduce a new schema traverser,
traverser.maxItemsSync, that syncs theMaxItemsconstraints from a source schema to a target schema.This PR removes the manual
MaxItemsconfigurations and usestraverser.maxItemsSyncto sync theMaxItemsconstraints from the Go resource schema to the JSON resource schema. This will also help us with any future resources for which theMaxItemsconstraints are not in sync. We could in theory sync the other constraints thanMaxItemsbut currently it's the only known constraint with inconsistencies causing us trouble.With a major version bump of the provider, we would also like to get rid of the JSON resource schema that we only use during the code generation, as a long term strategy.
Note:
As we bump the upjet version with this PR to be able to use the
traverser.maxItemsSync, we also generate the secret references for sensitive fields under thespec.initProviderAPI tree. This has been implemented in a separate initial commit before the manualMaxItemsconstraints are removed, so that it becomes easy for the reviewers to observe how the schema traverser behaves and whether it can effective replace the current manual configuration.I have:
make reviewableto ensure this PR is ready for review.backport release-x.ylabels to auto-backport this PR if necessary.How has this code been tested
Via the uptest runs of the resources tested in #745:
Also, please observe that commit
9d9d45022022d3ae4d641ba8b46de615a654812c(which invokes thesyncMaxItemsschema traverser) on top of the commita228c35e0527fc9fb2f5997369747f9fee67f356(which removes theMaxItemsconfiguration) produces no diff in the generated code.