Network Attachment Definition CRD name with dashes

[maze88]

The Network Attachment Definition CRD name (and singular/plural names) network-attachment-definitions.k8s.cni.cncf.io contains dashes, something that I don't believe is common in Kubernetes resource type naming (just try running kubectl api-resources | cut -d ' ' -f 1 and then look for items with dashes...).

The obvious fix would be to change the actual CRD names.

However, it's important to keep in mind that such a change could potentially break various things downstream (if they're "delicate" enough)... This could be partially mitigated by adding pseudo-backwards-compatibility by supporting the "old" (with dashes) plural/singular names via the shortNames list.

Here is my suggested implementation in the YAML:

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: networkattachmentdefinitions.k8s.cni.cncf.io  # removed dashes
spec:
  group: k8s.cni.cncf.io
  scope: Namespaced
  names:
    plural: networkattachmentdefinitions   # removed dashes
    singular: networkattachmentdefinition  # removed dashes
    kind: NetworkAttachmentDefinition
    shortNames:
    - net-attach-def
    - network-attachment-definition   # pseudo-backwards-compatibility
    - network-attachment-definitions  # pseudo-backwards-compatibility
    - nad                             # additional *shorter* short name, worth adding too ;)
# ...

This is far from a critical issue, but still worth bringing up IMHO...

Some additional info on CRD naming conventions and defaults can be reviewed in these reference docs.

[pstefka]

I second this.

Found about this dashed name, and was pretty amazed, as I didn't even know this is possible. Definitely not a standard way of naming CRDs.

Whats even more frustrating, when you see a YAML manifest, you can't use the kind (NetworkAttachmentDefinition) to query the actual cluster resources! You need to "convert" it to the dashed form, which is not very user / beginner friendly.