Skip to content

Document CRD versioning #936

@pleshakov

Description

@pleshakov

Our project is introducing CRDs. We'd like to make we use a consistent process of introducing CRDs and versioning them, which both our users and developers understand.

Add a document that answers the following questions:

  • What version to use when adding a new CRD?
  • How a CRD will get to the GA stage?
  • After hitting the GA state, how will we be able to extend it? Are we going to introduce any more versions?
  • How changes in CRD versions affect the version of NGF itself.

Related -- https://gateway-api.sigs.k8s.io/geps/gep-922/

Also, see the Kubernetes doc on api-versioning for inspiration: https://kubernetes.io/docs/reference/using-api/#api-versioning

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationrefinedRequirements are refined and the issue is ready to be implemented.size/mediumEstimated to be completed within a week

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions