ratify icon indicating copy to clipboard operation
ratify copied to clipboard

Switch `name` field in CRDs to `type`

Open akashsinghal opened this issue 1 year ago • 1 comments

What would you like to be added?

Ratify has introduced new type field for CLI scenarios of verifier allowing for multiple instances of same verifier with unique config to exist at once. Right now, the type field used in CLI maps to the name field in CRD and the uniquely identifier name in CLI is equivalent to CRDs metadata.name. Moving forward, we should switch name field to type in CRDs.

This will require:

  • introducing Type field to all CRD spec of store, verifier, and policy
  • support both Name and Type field until v2.0
  • update all docs spec to use type and add deprecation warning in spec to name field.

Anything else you would like to add?

No response

Are you willing to submit PRs to contribute to this feature?

  • [ ] Yes, I am willing to implement it.

akashsinghal avatar Jan 30 '24 02:01 akashsinghal

Hi @junczhu , we discussed in community meeting. Please help us understand if both property is available now, the plan is to deprecate "name" in ratify v2.0.0

susanshi avatar Aug 01 '24 00:08 susanshi

Hi @junczhu , we discussed in community meeting. Please help us understand if both property is available now, the plan is to deprecate "name" in ratify v2.0.0

Property is currently not available in CRDs, we may need to introducing the Type field as mentioned above

junczhu avatar Aug 26 '24 07:08 junczhu

not critical for 1.3 , may spill over to 1.4

susanshi avatar Aug 27 '24 00:08 susanshi

add related: https://github.com/ratify-project/ratify/issues/1284

junczhu avatar Sep 03 '24 09:09 junczhu