Eric Fried cd6c285cc6 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-11-01 14:24:30 -05:00

29 lines
841 B
ReStructuredText

================
network qos rule
================
A **Network QoS rule** specifies a rule defined in a Network QoS policy; its
type is defined by the parameter 'type'. Can be assigned, within a Network QoS
policy, to a port or a network. Each Network QoS policy can contain several
rules, each of them
Network v2
.. NOTE(efried): have to list these out one by one; 'network qos rule *' pulls
network qos rule type *.
.. autoprogram-cliff:: openstack.network.v2
:command: network qos rule create
.. autoprogram-cliff:: openstack.network.v2
:command: network qos rule delete
.. autoprogram-cliff:: openstack.network.v2
:command: network qos rule list
.. autoprogram-cliff:: openstack.network.v2
:command: network qos rule set
.. autoprogram-cliff:: openstack.network.v2
:command: network qos rule show