Bug 1700592 - NetworkAttachmentDefinition plural resource name should match convention of other resource names
Summary: NetworkAttachmentDefinition plural resource name should match convention of o...
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Networking
Version: 4.1.0
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: 4.1.0
Assignee: Dan Williams
QA Contact: Meng Bo
URL:
Whiteboard:
Depends On:
Blocks: 1664187
TreeView+ depends on / blocked
 
Reported: 2019-04-16 23:33 UTC by Robert Bost
Modified: 2019-04-24 16:45 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-04-24 16:45:39 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Robert Bost 2019-04-16 23:33:30 UTC
The NetworkAttachmentDefinition plural form is currently 'network-attachment-definitions' but this should match the camelCase convention of all other resources in OCP4 cluster. 

$ oc describe crd network-attachment-definitions.k8s.cni.cncf.io | grep -A5 'Accepted Names:'
  Accepted Names:
    Kind:       NetworkAttachmentDefinition
    List Kind:  NetworkAttachmentDefinitionList
    Plural:     network-attachment-definitions
    Short Names:
      net-attach-def
$ oc version
Client Version: version.Info{Major:"4", Minor:"0+", GitVersion:"v4.0.22", GitCommit:"219bbe2f0c", GitTreeState:"", BuildDate:"2019-03-10T22:23:11Z", GoVersion:"", Compiler:"", Platform:""}
Server Version: version.Info{Major:"1", Minor:"12+", GitVersion:"v1.12.4+0ba401e", GitCommit:"0ba401e", GitTreeState:"clean", BuildDate:"2019-03-31T22:28:12Z", GoVersion:"go1.10.8", Compiler:"gc", Platform:"linux/amd64"}

I believe this will need to be changed in the image resources: https://github.com/openshift/multus-cni/tree/master/images

Marking low severity since this doesn't prevent any real behaviours.

Comment 1 Casey Callendrello 2019-04-17 14:00:05 UTC
Nevertheless, this is a 4.1 blocker since we need to release this before we release.

dcbw, can you take care of this?

Comment 2 Dan Williams 2019-04-18 15:10:02 UTC
Looks like convention would be "networkattachmentdefinitions" (eg without hyphens), not camelCase.

But in the end, this would deviate from the upstream NPWG Specification section 3.1:

https://github.com/K8sNetworkPlumbingWG/multi-net-spec/blob/master/%5Bv1%5D%20Kubernetes%20Network%20Custom%20Resource%20Definition%20De-facto%20Standard.md

We can either (or both):

1) change that in openshift locally and add some short names
2) propose that change upstream

Comment 3 Dan Williams 2019-04-18 15:55:23 UTC
CNO PR: https://github.com/openshift/cluster-network-operator/pull/148

Comment 4 Casey Callendrello 2019-04-24 16:45:39 UTC
We've decided to just stick with the upstream spec, even though it doesn't match the convention.


Note You need to log in before you can comment on or make changes to this bug.