openstack/python-openstackclient
Code Issues Proposed changes
0a7f2692c6
python-openstackclient/doc/source/cli/command-objects/network.rst

34 lines
1.0 KiB
ReStructuredText
Raw Normal View History

Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
=======
network
=======
Doc: Add network resource descriptions Add descriptions to the network resource command documentation. Change-Id: I547ffb48f8950311a5ee65d6b535846f2aca0efc
2016-04-24 19:17:36 -05:00
A **network** is an isolated Layer 2 networking segment. There are two types
of networks, project and provider networks. Project networks are fully isolated
and are not shared with other projects. Provider networks map to existing
physical networks in the data center and provide external network access for
servers and other resources. Only an OpenStack administrator can create
provider networks. Networks can be connected via routers.
Support "network list" command in nova network "network list" command is not implemented in nova network. This patch implements it. The Network object in novaclient is quite different from the one in sdk. And the output of "network list" using Nova network is also quite different from using Neutron. It is like this: # openstack network list +--------------------------------------+---------+-------------+ | ID | Name | Subnet | +--------------------------------------+---------+-------------+ | 96a98ec4-31f6-45f6-99e6-9384569b3bb5 | private | 10.0.0.0/24 | +--------------------------------------+---------+-------------+ --long and --external options have not been implemented because the attrs in Network object in novaclient is too much different. This patch also introduces a new FakeNetwork class in compute/v2/fake.py to fake nova network. Change-Id: Id1fdf81fb2fa8b39f2c76b7bae37ac4fecafd0f7 Depends-On: I1b59264cd40aaf1062f4e8db233ccb7fd0e95f0e partial-Bug: 1543672
2016-02-10 11:49:15 +08:00
Compute v2, Network v2
Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
neutron: autogenerate docs $namespace = openstack.network.v2 The subcommand documents for $namespace were hardcoded and thus prone to drift over time. This commit removes the hardcoded content and uses the autoprogram-cliff directive to generate them automatically from the subcommand configuration classes. This one turned out to be quite involved, because we support both neutron and nova-network. When running in a real cloud, the command classes detect whether the neutron service is present, assume nova-network if that service is not found, and only add parser options relevant to the detected service. But the docs need to present both sets of options. This was easy enough when they were hardcoded, but required a bit of additional infrastructure for generated docs. Change-Id: I426261eb1d86bcc68656aabd61f10b7f082da402
2019-10-28 17:27:38 -05:00
.. NOTE(efried): have to list these out one by one; 'network *' pulls in
... flavor *, ... qos policy *, etc.
Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
neutron: autogenerate docs $namespace = openstack.network.v2 The subcommand documents for $namespace were hardcoded and thus prone to drift over time. This commit removes the hardcoded content and uses the autoprogram-cliff directive to generate them automatically from the subcommand configuration classes. This one turned out to be quite involved, because we support both neutron and nova-network. When running in a real cloud, the command classes detect whether the neutron service is present, assume nova-network if that service is not found, and only add parser options relevant to the detected service. But the docs need to present both sets of options. This was easy enough when they were hardcoded, but required a bit of additional infrastructure for generated docs. Change-Id: I426261eb1d86bcc68656aabd61f10b7f082da402
2019-10-28 17:27:38 -05:00
.. autoprogram-cliff:: openstack.network.v2
:command: network create
Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
neutron: autogenerate docs $namespace = openstack.network.v2 The subcommand documents for $namespace were hardcoded and thus prone to drift over time. This commit removes the hardcoded content and uses the autoprogram-cliff directive to generate them automatically from the subcommand configuration classes. This one turned out to be quite involved, because we support both neutron and nova-network. When running in a real cloud, the command classes detect whether the neutron service is present, assume nova-network if that service is not found, and only add parser options relevant to the detected service. But the docs need to present both sets of options. This was easy enough when they were hardcoded, but required a bit of additional infrastructure for generated docs. Change-Id: I426261eb1d86bcc68656aabd61f10b7f082da402
2019-10-28 17:27:38 -05:00
.. autoprogram-cliff:: openstack.network.v2
:command: network delete
Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
neutron: autogenerate docs $namespace = openstack.network.v2 The subcommand documents for $namespace were hardcoded and thus prone to drift over time. This commit removes the hardcoded content and uses the autoprogram-cliff directive to generate them automatically from the subcommand configuration classes. This one turned out to be quite involved, because we support both neutron and nova-network. When running in a real cloud, the command classes detect whether the neutron service is present, assume nova-network if that service is not found, and only add parser options relevant to the detected service. But the docs need to present both sets of options. This was easy enough when they were hardcoded, but required a bit of additional infrastructure for generated docs. Change-Id: I426261eb1d86bcc68656aabd61f10b7f082da402
2019-10-28 17:27:38 -05:00
.. autoprogram-cliff:: openstack.network.v2
:command: network list
Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
neutron: autogenerate docs $namespace = openstack.network.v2 The subcommand documents for $namespace were hardcoded and thus prone to drift over time. This commit removes the hardcoded content and uses the autoprogram-cliff directive to generate them automatically from the subcommand configuration classes. This one turned out to be quite involved, because we support both neutron and nova-network. When running in a real cloud, the command classes detect whether the neutron service is present, assume nova-network if that service is not found, and only add parser options relevant to the detected service. But the docs need to present both sets of options. This was easy enough when they were hardcoded, but required a bit of additional infrastructure for generated docs. Change-Id: I426261eb1d86bcc68656aabd61f10b7f082da402
2019-10-28 17:27:38 -05:00
.. autoprogram-cliff:: openstack.network.v2
:command: network set
Add project and domain params to network create Without this patch, openstackclient has no way to specify to which project a network belongs upon creation. Instead, it uses the project ID that the user is authenticating with to fill the tenant_id column. This is a problem because an admin user is unable to specify a project for a non-admin network. To fix this and to improve feature parity with the neutron client, this patch adds project and domain parameters to the network create command and uses the given project name to look up the project ID. Neutron does not allow the project to be changed after creation, so no such parameter has been added to the neutron set command. Neutron calls the field 'tenant_id', but this change exposes the parameter as '--project' to support the newer terminology. If no project is specified, the client defaults to the previous behavior of using the auth project. Change-Id: Ia33ff7d599542c5b88baf2a69b063a23089a3cc4
2015-02-16 23:21:00 -08:00
neutron: autogenerate docs $namespace = openstack.network.v2 The subcommand documents for $namespace were hardcoded and thus prone to drift over time. This commit removes the hardcoded content and uses the autoprogram-cliff directive to generate them automatically from the subcommand configuration classes. This one turned out to be quite involved, because we support both neutron and nova-network. When running in a real cloud, the command classes detect whether the neutron service is present, assume nova-network if that service is not found, and only add parser options relevant to the detected service. But the docs need to present both sets of options. This was easy enough when they were hardcoded, but required a bit of additional infrastructure for generated docs. Change-Id: I426261eb1d86bcc68656aabd61f10b7f082da402
2019-10-28 17:27:38 -05:00
.. autoprogram-cliff:: openstack.network.v2
:command: network show
Doc: Fix network command documentation issues Fix the following network command documentation issues: - Fix format of subnet pool positional arguments - Update port set options to match help - Fix network command documentation for Network v2 versus Compute v2 options and commands - Fix subnet command documentation errors and formatting problems in help text Change-Id: I808c2a70ca62eafc9e42d6873539cdd142ffe50c Related-Bug: #1558677
2016-04-01 16:16:08 -05:00
neutron: autogenerate docs $namespace = openstack.network.v2 The subcommand documents for $namespace were hardcoded and thus prone to drift over time. This commit removes the hardcoded content and uses the autoprogram-cliff directive to generate them automatically from the subcommand configuration classes. This one turned out to be quite involved, because we support both neutron and nova-network. When running in a real cloud, the command classes detect whether the neutron service is present, assume nova-network if that service is not found, and only add parser options relevant to the detected service. But the docs need to present both sets of options. This was easy enough when they were hardcoded, but required a bit of additional infrastructure for generated docs. Change-Id: I426261eb1d86bcc68656aabd61f10b7f082da402
2019-10-28 17:27:38 -05:00
.. autoprogram-cliff:: openstack.network.v2
:command: network unset
Copy Permalink