Merge "Reorder and capitalize the list of extensions in ports, networks and routers"
This commit is contained in:
Zuul
Gerrit Code Review
commit
8e9b419169
@ -9,22 +9,51 @@ Networks
|
||||
|
||||
Lists, shows details for, creates, updates, and deletes networks.
|
||||
|
||||
provider extended attributes
|
||||
============================
|
||||
Auto Allocated Topology
|
||||
=======================
|
||||
|
||||
The ``provider`` extension allows administrative users to define a physical
|
||||
binding of a logical network. This extension provides three additional
|
||||
attributes: ``provider:network_type``, ``provider:physical_network`` and
|
||||
``provider:segmentation_id``. The validation rules for these attributes
|
||||
vary across ``provider:network_type``. For example, ``vlan`` and ``flat``
|
||||
network types require ``provider:physical_network`` attribute, but ``vxlan``
|
||||
network type does not.
|
||||
The ``auto-allocated-topology`` extension adds the ``is_default`` boolean
|
||||
attribute to networks. This value indicates the network should be used when
|
||||
auto allocating topologies.
|
||||
|
||||
Most Networking plug-ins (e.g. ML2 Plugin) and drivers do not support updating
|
||||
any provider related attributes. Check your plug-in whether it supports
|
||||
updating.
|
||||
DNS integration
|
||||
===============
|
||||
|
||||
multiple provider extension
|
||||
The ``dns-integration`` extension adds the ``dns_domain`` attribute to networks.
|
||||
The ``dns_domain`` of a network in conjunction with the ``dns_name`` attribute
|
||||
of its ports will be published in an external DNS service when Neutron is
|
||||
configured to integrate with such a service.
|
||||
|
||||
External network
|
||||
================
|
||||
|
||||
The ``external-net`` extension adds the ``router:external`` attribute to
|
||||
networks. This boolean attribute indicates the network has an external
|
||||
routing facility that's not managed by the networking service.
|
||||
|
||||
L2 adjacency extension
|
||||
======================
|
||||
|
||||
The ``l2_adjacency`` extension provides display of L2 Adjacency
|
||||
for ``networks`` by adding the read-only ``l2_adjacency`` attribute.
|
||||
This is a boolean value where ``true`` means that you can expect
|
||||
L2 connectivity throughout the Network and ``false`` means that there
|
||||
is no guarantee of L2 connectivity.
|
||||
This value is read-only and is derived from the current state of
|
||||
``segments`` within the ``network``.
|
||||
|
||||
MTU extensions
|
||||
==============
|
||||
|
||||
The ``net-mtu`` extension allows plug-ins to expose the MTU that is guaranteed
|
||||
to pass through the data path of the segments in the network. This extension
|
||||
introduces a read-only ``mtu`` attribute.
|
||||
|
||||
A newer ``net-mtu-writable`` extension enhances ``net-mtu`` in that now the
|
||||
``mtu`` attribute is available for write (both when creating as well as
|
||||
updating networks).
|
||||
|
||||
Multiple provider extension
|
||||
===========================
|
||||
|
||||
The ``multi-provider`` extension allows administrative users to define multiple
|
||||
@ -40,27 +69,6 @@ validation rules are applied to each element in the ``segments`` list.
|
||||
Note that you cannot use the provider extension and the multiple provider
|
||||
extension for a single logical network.
|
||||
|
||||
VLAN transparency extension
|
||||
===========================
|
||||
|
||||
The ``vlan-transparent`` extension enables plug-ins that support VLAN
|
||||
transparency to deliver VLAN transparent trunk networks.
|
||||
This extension introduces a ``vlan_transparent`` attribute to control
|
||||
the VLAN transparency of the network. If the service does not support VLAN
|
||||
transparency and a user requests a VLAN transparent network,
|
||||
the plug-in refuses to create one and returns an appropriate error to the user.
|
||||
|
||||
MTU extensions
|
||||
==============
|
||||
|
||||
The ``net-mtu`` extension allows plug-ins to expose the MTU that is guaranteed
|
||||
to pass through the data path of the segments in the network. This extension
|
||||
introduces a read-only ``mtu`` attribute.
|
||||
|
||||
A newer ``net-mtu-writable`` extension enhances ``net-mtu`` in that now the
|
||||
``mtu`` attribute is available for write (both when creating as well as
|
||||
updating networks).
|
||||
|
||||
Network availability zone extension
|
||||
===================================
|
||||
|
||||
@ -68,25 +76,6 @@ The ``network_availability_zone`` extension provides support of availability
|
||||
zone for networks, exposing ``availability_zone_hints``
|
||||
and ``availability_zones`` attributes.
|
||||
|
||||
L2 adjacency extension
|
||||
======================
|
||||
|
||||
The ``l2_adjacency`` extension provides display of L2 Adjacency
|
||||
for ``networks`` by adding the read-only ``l2_adjacency`` attribute.
|
||||
This is a boolean value where ``true`` means that you can expect
|
||||
L2 connectivity throughout the Network and ``false`` means that there
|
||||
is no guarantee of L2 connectivity.
|
||||
This value is read-only and is derived from the current state of
|
||||
``segments`` within the ``network``.
|
||||
|
||||
DNS integration
|
||||
===============
|
||||
|
||||
The ``dns-integration`` extension adds the ``dns_domain`` attribute to networks.
|
||||
The ``dns_domain`` of a network in conjunction with the ``dns_name`` attribute
|
||||
of its ports will be published in an external DNS service when Neutron is
|
||||
configured to integrate with such a service.
|
||||
|
||||
Port security
|
||||
=============
|
||||
|
||||
@ -99,19 +88,30 @@ explicitly set on the port itself. While the default value for
|
||||
respective network. Note that changing a value of ``port_security_enabled``
|
||||
on a network, does not cascade the value to ports attached to the network.
|
||||
|
||||
External network
|
||||
================
|
||||
Provider extended attributes
|
||||
============================
|
||||
|
||||
The ``external-net`` extension adds the ``router:external`` attribute to
|
||||
networks. This boolean attribute indicates the network has an external
|
||||
routing facility that's not managed by the networking service.
|
||||
The ``provider`` extension allows administrative users to define a physical
|
||||
binding of a logical network. This extension provides three additional
|
||||
attributes: ``provider:network_type``, ``provider:physical_network`` and
|
||||
``provider:segmentation_id``. The validation rules for these attributes
|
||||
vary across ``provider:network_type``. For example, ``vlan`` and ``flat``
|
||||
network types require ``provider:physical_network`` attribute, but ``vxlan``
|
||||
network type does not.
|
||||
|
||||
Auto Allocated Topology
|
||||
=======================
|
||||
Most Networking plug-ins (e.g. ML2 Plugin) and drivers do not support updating
|
||||
any provider related attributes. Check your plug-in whether it supports
|
||||
updating.
|
||||
|
||||
The ``auto-allocated-topology`` extension adds the ``is_default`` boolean
|
||||
attribute to networks. This value indicates the network should be used when
|
||||
auto allocating topologies.
|
||||
VLAN transparency extension
|
||||
===========================
|
||||
|
||||
The ``vlan-transparent`` extension enables plug-ins that support VLAN
|
||||
transparency to deliver VLAN transparent trunk networks.
|
||||
This extension introduces a ``vlan_transparent`` attribute to control
|
||||
the VLAN transparency of the network. If the service does not support VLAN
|
||||
transparency and a user requests a VLAN transparent network,
|
||||
the plug-in refuses to create one and returns an appropriate error to the user.
|
||||
|
||||
Show network details
|
||||
====================
|
||||
|
||||
@ -6,14 +6,17 @@ Ports
|
||||
|
||||
Lists, shows details for, creates, updates, and deletes ports.
|
||||
|
||||
Port binding extended attributes
|
||||
================================
|
||||
Allowed address pairs
|
||||
=====================
|
||||
|
||||
The port binding extension (``binding``) allows administrative users
|
||||
to specify and retrieve physical binding information of ports.
|
||||
The extension defines several attributes whose names have a prefix
|
||||
``binding:`` including ``binding:host_id``, ``binding:vnic_type``,
|
||||
``binding:vif_type``, ``binding:vif_details``, and ``binding:profile``.
|
||||
The ``allowed-address-pairs`` extension adds an ``allowed_address_pairs``
|
||||
attribute to ports. The value of ``allowed_address_pairs`` is an array of
|
||||
allowed address pair objects, each having an ``ip_address`` and a
|
||||
``mac_address``. The set of allowed address pairs defines IP and MAC address
|
||||
that the port can use when sending packets if ``port_security_enabled`` is
|
||||
``true`` (see the ``port-security`` extension). Note that while the
|
||||
``ip_address`` is required in each allowed address pair, the ``mac_address``
|
||||
is optional and will be taken from the port if not specified.
|
||||
|
||||
Data plane status extension
|
||||
===========================
|
||||
@ -30,6 +33,20 @@ Supported data plane status values:
|
||||
- ``ACTIVE``: the underlying data plane is up and running
|
||||
- ``DOWN``: no traffic can flow from/to the port
|
||||
|
||||
DNS integration
|
||||
===============
|
||||
|
||||
The ``dns-integration`` extension adds the ``dns_name`` and ``dns_assignment``
|
||||
attributes to port resources. While the ``dns_name`` can be set on create and
|
||||
update operations, the ``dns_assignment`` is read-only and shows the
|
||||
``hostname``, ``ip_address`` and ``fqdn`` for the port's internal DNS
|
||||
assignment.
|
||||
|
||||
To enable the ``dns_domain`` on port resources, the ``dns-domain-ports``
|
||||
extension must be used in conjunction with the ``dns-integration`` extension.
|
||||
When enabled and set, a port level ``dns_domain`` take precedence over a
|
||||
``dns_domain`` specified in the port's network allowing per-port DNS domains.
|
||||
|
||||
Extra DHCP option (``extra_dhcp_opt``) extension
|
||||
================================================
|
||||
|
||||
@ -48,19 +65,20 @@ The IP allocation extension (``ip_allocation``) adds a new read-only attribute
|
||||
``ip_allocation`` that indicates when ports use deferred, immediate or
|
||||
no IP allocation.
|
||||
|
||||
DNS integration
|
||||
===============
|
||||
IP Substring Filtering
|
||||
======================
|
||||
|
||||
The ``dns-integration`` extension adds the ``dns_name`` and ``dns_assignment``
|
||||
attributes to port resources. While the ``dns_name`` can be set on create and
|
||||
update operations, the ``dns_assignment`` is read-only and shows the
|
||||
``hostname``, ``ip_address`` and ``fqdn`` for the port's internal DNS
|
||||
assignment.
|
||||
The ``ip-substring-filtering`` extension adds support for filtering ports by
|
||||
using part of an IP address.
|
||||
|
||||
To enable the ``dns_domain`` on port resources, the ``dns-domain-ports``
|
||||
extension must be used in conjunction with the ``dns-integration`` extension.
|
||||
When enabled and set, a port level ``dns_domain`` take precedence over a
|
||||
``dns_domain`` specified in the port's network allowing per-port DNS domains.
|
||||
Port binding extended attributes
|
||||
================================
|
||||
|
||||
The port binding extension (``binding``) allows administrative users
|
||||
to specify and retrieve physical binding information of ports.
|
||||
The extension defines several attributes whose names have a prefix
|
||||
``binding:`` including ``binding:host_id``, ``binding:vnic_type``,
|
||||
``binding:vif_type``, ``binding:vif_details``, and ``binding:profile``.
|
||||
|
||||
Port security
|
||||
=============
|
||||
@ -70,24 +88,6 @@ attribute to ports. If a ``port-security`` value is not specified during
|
||||
port creation, a port will inherit the ``port_security_enabled`` from the
|
||||
network its connected to.
|
||||
|
||||
Allowed address pairs
|
||||
=====================
|
||||
|
||||
The ``allowed-address-pairs`` extension adds an ``allowed_address_pairs``
|
||||
attribute to ports. The value of ``allowed_address_pairs`` is an array of
|
||||
allowed address pair objects, each having an ``ip_address`` and a
|
||||
``mac_address``. The set of allowed address pairs defines IP and MAC address
|
||||
that the port can use when sending packets if ``port_security_enabled`` is
|
||||
``true`` (see the ``port-security`` extension). Note that while the
|
||||
``ip_address`` is required in each allowed address pair, the ``mac_address``
|
||||
is optional and will be taken from the port if not specified.
|
||||
|
||||
IP Substring Filtering
|
||||
======================
|
||||
|
||||
The ``ip-substring-filtering`` extension adds support for filtering ports by
|
||||
using part of an IP address.
|
||||
|
||||
Show port details
|
||||
=================
|
||||
|
||||
|
||||
@ -10,26 +10,27 @@ appropriate external gateway.
|
||||
|
||||
This resource is provided when ``router`` extension is enabled.
|
||||
|
||||
Extra routes extension (``extraroute``)
|
||||
=======================================
|
||||
Distributed virtual router extension
|
||||
====================================
|
||||
|
||||
The ``dvr`` extension enables the functionality of configuring a router as a
|
||||
distributed virtual router, adding ``distributed`` parameter.
|
||||
|
||||
Extra routes extension
|
||||
======================
|
||||
|
||||
The extra route extension (``extraroute``) extends ``router`` resources adding
|
||||
a ``routes`` attribute that contains an array of route objects. Each route
|
||||
object has a ``destination`` and ``nexthop`` attribute representing the route.
|
||||
|
||||
Router availability zone extension (``router_availability_zones``)
|
||||
==================================================================
|
||||
Router availability zone extension
|
||||
==================================
|
||||
|
||||
The ``router_availability_zone`` extension adds the ``availability_zones``
|
||||
and ``availability_zone_hints`` attributes to ``routers``, allowing scheduling
|
||||
based on availability zones and hints.
|
||||
This extension requires ``router`` and ``availability_zone`` extensions.
|
||||
|
||||
Distributed virtual router extension (``dvr``)
|
||||
==============================================
|
||||
The ``dvr`` extension enables the functionality of configuring a router as a
|
||||
distributed virtual router, adding ``distributed`` parameter.
|
||||
|
||||
List routers
|
||||
============
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user