Quantum CLI not consistent with other CLIs

[Ian Wells]

Everything seems to be settling on noun-verb:

Glance: image-list, image-create, ...
Nova: volume-attach, dns-create, ... (but with exceptions: add-fixed-ip)
Keystone: endpoint-create, role-get, ...

But quantum uses verb_noun
Quantum: list_nets, create_nets, update_port, plug_iface

Note also that verb_noun means that the noun is also occasionally in the plural, making the commands slightly more annoying.

Fine, it's fairly pedantic, but I thought if I got in early this could be fixed before the commands become standardised and less likely to change.

[dan wendlandt (danwent)]

Hi Ian,

I definitely agree that we want to be consistent and this is already in the work, please see comment on new CLI review here: https://review.openstack.org/#/c/7596/5/quantumclient/quantum/v2_0/network.py

Unfortunately, I've even found examples where nova itself is inconsistent (for example: add-floating-ip, add-fixed-ip).

I believe there are some folks working on user experience consistency guidelines for openstack CLIs (and even a single CLI to rule them all...). If this is something you're interested in exploring, I can put you in touch (or you can just send an email to openstack list yourself).

Adding Yong, who is working on improved CLI.

[yong sheng gong (gongysh)]

Hi Dan,
Looking at python_openstackclient, all the commands are in the verb-noun format, do you think we need to change to noun-verb format?

[dan wendlandt (danwent)]

At this point, its not clear whether the main use pattern for openstack will be a single CLI, or per-service CLIs. I prefer the former, but status quo is always a powerful force.

My preference would be for the stand-alone quantum CLI to match the stand-alone CLIs for other projects (nova, glance, keystone) which at a glance seem to be noun-verb. But if you feel strongly in the other direction, that's OK.

I also would like to see underscores switched to dashes for similar consistency reasons.

Ideally the --help output of our client would look very similar to the other clients, with the exception of what nouns can be operated on.

[yong sheng gong (gongysh)]

OK, commands use dash, options use underscore

[yong sheng gong (gongysh)]

fixed in https://review.openstack.org/#/c/9347/, but I don't know why it is not updated auto here.