net and network commands appear to be redundant

[Rafi Khardalian]

Below is a list of nova client commands which begin with "net". Note that net-create and network-create, as an example, have the same description. They appear to be different functions but it's completely unclear what the difference actually is. Like commands should probably be merged but at the very least the help should be updated to clarify the differences.

    network-associate-host
                        Associate host with network.
    network-associate-project
                        Associate project with network.
    network-create Create a network.
    network-disassociate
                        network.
    network-list Print a list of available networks.
    network-show Show details about the given network.
                        Add a network interface to a baremetal node
                        List network interfaces associated with a baremetal
                        Remove a network interface from a baremetal node
    net Show a network
    net-create Create a network
    net-delete Delete a network
    net-list List networks

[Rafi Khardalian (rkhardalian)]

Some suggestions:

rename net-delete to network-delete
merge net with network-show
merge net-create with network-create
merge net-list with network-list

[Lorin Hochstein (lorinh)]

They're not actually redundant, they do different things! I suggest just dropping net-create, net-list and net. Will propose a patch.

[melanie witt (melwitt)]

Hi Lorin, are you still working on this bug? If not, I can unassign and triage. Thanks!

[Lorin Hochstein (lorinh)]

No, I'm not still working on this bug, please go ahead and triage it.

[Mike Spreitzer (mike-spreitzer)]

I am also told that they do something different. For example, I think `nova net-list` calls Nova's /os-tenant-networks while `nova network-list` calls Nova's /os-networks.

The CLI should be documented well enough that a reader can tell that the two sets of commands are different, and understand the difference. I am not sure whether this is a matter for the End User Guide or the Admin User Guide or somehow divided between them, but it should be one of those three choices.

[Mike Spreitzer (mike-spreitzer)]

Also, I do not see documentation for nova's /os-tenant-networks call in the API reference.

[Mike Spreitzer (mike-spreitzer)]

I am not sure, but I suppose Nova's /os-tenant-networks calls are implemented by nova/api/openstack/compute/contrib/os_tenant_networks.py's NetworkController class.

Similarly, I suppose Nova's /os-networks calls are implementedby nova/api/openstack/compute/contrib/os_networks.py's NetworkController class.

The index metohds of those two classes are similar but not identical.

[Mike Spreitzer (mike-spreitzer)]

Looking at the code, it appears to me that /os-tenant-networks differs from /os-networks when Neutron is used, and the difference is that the former includes the networks of the Neutron default tenant.

[Mike Spreitzer (mike-spreitzer)]

There is deficiency in the API documentation as well: /os-tenant-networks is not documented at all; in addition to being a problem in and of itself this implies that a developer does not know how that is related to /os-networks.

[Mike Spreitzer (mike-spreitzer)]

See https://bugs.launchpad.net/nova/+bug/1327406 for evidence that some developers of merged code were confused.

[Anne Gentle (annegentle)]

Let's work on the API documentation in addition. Copying bug to openstack-api-site.

[Michael Still (mikal)]

There is no code proposed for python-novaclient for this bug.

[melanie witt (melwitt)]

I think this should be improved sooner than later, at the very least with better explanations in the help messages.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/148159
Committed: https://git.openstack.org/cgit/openstack/python-novaclient/commit/?id=dfc752d725fac9580a01452334aeb610e34198ad
Submitter: Jenkins
Branch: master

commit dfc752d725fac9580a01452334aeb610e34198ad
Author: Haiwei Xu <email address hidden>
Date: Mon Jan 19 10:45:35 2015 +0900

    Change commands name from net-* to tenant-network-*

    Currently the commands of os-tenant-network API use net-*
    which may confuse users sometime. This patch changes commands
    to tenant-network-*, and marks net-* commands as DEPRECATED.

    Closes-Bug: #1152862
    Change-Id: I8c3a0be08763a6f626d7fc7cf84811ac61ccc526

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/185248

[Diane Fleming (diane-fleming)]

https://review.openstack.org/185248

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/185248
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=f1bb6e05a0a07759be3c97f88382e6bc07096f09
Submitter: Jenkins
Branch: master

commit f1bb6e05a0a07759be3c97f88382e6bc07096f09
Author: Diane Fleming <email address hidden>
Date: Sat May 23 17:07:47 2015 -0500

    Add os-networks and os-tenant-networks extensions to Compute v3

    Change-Id: I490b8529a92af532b832de5db9ff9a535cc93c50
    Closes-Bug: #1152862

[Tom Fifield (fifieldt)]

This would have been picked up in the CLI reference update for Kilo