update docs for stdattr tag support

Tag support was extended to all resources that support the std attr
mechanism. This patch handles a few remaining updates in the docs.

This one is also a candidate for backport to pike if warranted.

Change-Id: I7dfc7a371e6af64dde09c0e712424b8e647d7027
Closes-Bug: #1706307
This commit is contained in:
Boden R 2017-08-29 14:04:34 -06:00
parent 5d98e30e5c
commit d3c560b788
15 changed files with 83 additions and 1 deletions

View File

@ -127,6 +127,7 @@ allow simple routing for project networks with the same subnet pools.
| project_id | 098429d072d34d3596c88b7dbf7e91b6 |
| revision_number | 1 |
| shared | True |
| tags | [] |
| updated_at | 2016-12-13T22:53:30Z |
+-------------------+--------------------------------------+
@ -154,6 +155,7 @@ allow simple routing for project networks with the same subnet pools.
| project_id | 098429d072d34d3596c88b7dbf7e91b6 |
| revision_number | 1 |
| shared | True |
| tags | [] |
| updated_at | 2016-12-13T22:55:09Z |
+-------------------+--------------------------------------+
@ -187,6 +189,7 @@ allow simple routing for project networks with the same subnet pools.
| segment_id | None |
| service_types | |
| subnetpool_id | a59ff52b-0367-41ff-9781-6318b927dd0e |
| tags | [] |
| updated_at | 2016-12-10T21:36:04Z |
+-------------------+------------------------------------------+
@ -216,6 +219,7 @@ allow simple routing for project networks with the same subnet pools.
| segment_id | None |
| service_types | |
| subnetpool_id | d02af70b-d622-426f-8e60-ed9df2a8301f |
| tags | [] |
| updated_at | 2016-12-10T21:35:52Z |
+-------------------+--------------------------------------+
@ -319,6 +323,7 @@ route straight to an external network without NAT.
| revision_number | 2 |
| service_types | |
| subnetpool_id | None |
| tags | [] |
| updated_at | 2016-12-13T23:24:16Z |
+-------------------+--------------------------------------+
@ -351,6 +356,7 @@ route straight to an external network without NAT.
| revision_number | 2 |
| service_types | |
| subnetpool_id | None |
| tags | [] |
| updated_at | 2016-12-13T23:28:28Z |
+-------------------+-----------------------------------------+
@ -384,6 +390,7 @@ route straight to an external network without NAT.
| revision_number | 2 |
| service_types | |
| subnetpool_id | d02af70b-d622-426f-8e60-ed9df2a8301f |
| tags | [] |
| updated_at | 2016-12-13T23:32:12Z |
+-------------------+--------------------------------------+
@ -415,6 +422,7 @@ route straight to an external network without NAT.
| revision_number | 2 |
| service_types | |
| subnetpool_id | a59ff52b-0367-41ff-9781-6318b927dd0e |
| tags | [] |
| updated_at | 2016-12-13T23:31:17Z |
+-------------------+--------------------------------------+

View File

@ -97,6 +97,7 @@ topology creation. To perform this task, proceed with the following steps:
| project_id | 86acdbd1d72745fd8e8320edd7543400 |
| revision_number | 1 |
| shared | True |
| tags | [] |
| updated_at | 2017-01-12T15:10:34Z |
+-------------------+--------------------------------------+
@ -123,6 +124,7 @@ topology creation. To perform this task, proceed with the following steps:
| project_id | 86acdbd1d72745fd8e8320edd7543400 |
| revision_number | 1 |
| shared | True |
| tags | [] |
| updated_at | 2017-01-12T15:14:35Z |
+-------------------+--------------------------------------+

View File

@ -198,6 +198,7 @@ hosted:
| revision_number | 3 |
| routes | |
| status | ACTIVE |
| tags | [] |
| updated_at | 2016-12-14T06:25:40Z |
+-------------------------+--------------------------------------+
@ -285,6 +286,7 @@ which zone the resource is hosted:
| revision_number | 3 |
| routes | |
| status | ACTIVE |
| tags | [] |
| updated_at | 2016-12-14T06:25:40Z |
+-------------------------+--------------------------------------+

View File

@ -170,6 +170,7 @@ Create the address scope and subnet pools
| project_id | 86acdbd1d72745fd8e8320edd7543400 |
| revision_number | 1 |
| shared | False |
| tags | [] |
| updated_at | 2017-01-12T14:58:57Z |
+-------------------+--------------------------------------+
@ -200,6 +201,7 @@ Create the address scope and subnet pools
| project_id | 86acdbd1d72745fd8e8320edd7543400 |
| revision_number | 1 |
| shared | True |
| tags | [] |
| updated_at | 2017-01-12T15:02:31Z |
+-------------------+--------------------------------------+
@ -269,6 +271,7 @@ Create the provider and self-service networks
| name | provider |
| network_id | 68ec148c-181f-4656-8334-8f4eb148689d |
| subnetpool_id | 3771c0e7-7096-46d3-a3bd-699c58e70259 |
| tags | [] |
| tenant_id | b3ac05ef10bf441fbf4aa17f16ae1e6d |
| updated_at | 2016-03-17T23:17:16 |
+-------------------+---------------------------------------------------+
@ -398,6 +401,7 @@ Create the provider and self-service networks
| name | selfservice1 |
| network_id | be79de1e-5f56-11e6-9dfb-233e41cec48c |
| subnetpool_id | c7e9737a-cfd3-45b5-a861-d1cee1135a92 |
| tags | [] |
| tenant_id | b3ac05ef10bf441fbf4aa17f16ae1e6d |
| updated_at | 2016-03-17T23:20:20 |
+-------------------+----------------------------------------------------+
@ -423,6 +427,7 @@ Create the provider and self-service networks
| name | selfservice2 |
| network_id | c1fd9846-5f56-11e6-a8ac-0f998d9cc0a2 |
| subnetpool_id | c7e9737a-cfd3-45b5-a861-d1cee1135a92 |
| tags | [] |
| tenant_id | b3ac05ef10bf441fbf4aa17f16ae1e6d |
| updated_at | 2016-03-17T23:20:20 |
+-------------------+------------------------------------------------+
@ -452,6 +457,7 @@ Create the provider and self-service networks
| name | selfservice3 |
| network_id | c283dc1c-5f56-11e6-bfb6-efc30e1eb73b |
| subnetpool_id | |
| tags | [] |
| tenant_id | b3ac05ef10bf441fbf4aa17f16ae1e6d |
| updated_at | 2016-03-17T23:20:20 |
+-------------------+----------------------------------------------------+
@ -483,6 +489,7 @@ Create and configure the routers
| revision_number | 1 |
| routes | |
| status | ACTIVE |
| tags | [] |
| updated_at | 2017-01-10T13:15:19Z |
+-------------------------+--------------------------------------+
@ -506,6 +513,7 @@ Create and configure the routers
| revision_number | 1 |
| routes | |
| status | ACTIVE |
| tags | [] |
| updated_at | 2017-01-10T13:15:19Z |
+-------------------------+--------------------------------------+
@ -529,6 +537,7 @@ Create and configure the routers
| revision_number | 1 |
| routes | |
| status | ACTIVE |
| tags | [] |
| updated_at | 2017-01-10T13:15:19Z |
+-------------------------+--------------------------------------+

View File

@ -175,6 +175,7 @@ The following is an example of an instance creation, showing how its
| port_security_enabled | True |
| security_groups | 1f0ddd73-7e3c-48bd-a64c-7ded4fe0e635 |
| status | ACTIVE |
| tags | [] |
| tenant_id | d5660cb1e6934612a01b4fb2fb630725 |
+-----------------------+---------------------------------------------------------------------------------------+
@ -281,6 +282,7 @@ external DNS service. This is an example:
| status | ACTIVE |
| subnets | eab47748-3f0a-4775-a09f-b0c24bb64bc4 |
| | 277eca5d-9869-474b-960e-6da5951d09f7 |
| tags | [] |
| tenant_id | 04fc2f83966245dba907efb783f8eab9 |
+---------------------------+--------------------------------------+
@ -314,6 +316,7 @@ external DNS service. This is an example:
| port_security_enabled | True |
| security_groups | 1f0ddd73-7e3c-48bd-a64c-7ded4fe0e635 |
| status | DOWN |
| tags | [] |
| tenant_id | d5660cb1e6934612a01b4fb2fb630725 |
+-----------------------+---------------------------------------------------------------------------------------+
@ -444,6 +447,7 @@ Following is an example of these steps:
| status | ACTIVE |
| subnets | 43414c53-62ae-49bc-aa6c-c9dd7705818a |
| | 5b9282a1-0be1-4ade-b478-7868ad2a16ff |
| tags | [] |
| tenant_id | d5660cb1e6934612a01b4fb2fb630725 |
+-------------------------+--------------------------------------+
@ -518,6 +522,7 @@ Following is an example of these steps:
| port_security_enabled | True |
| security_groups | 1f0ddd73-7e3c-48bd-a64c-7ded4fe0e635 |
| status | ACTIVE |
| tags | [] |
| tenant_id | d5660cb1e6934612a01b4fb2fb630725 |
+-----------------------+-------------------------------------------------------------------------------------------------------------+
@ -544,6 +549,7 @@ Following is an example of these steps:
| port_id | da0b1f75-c895-460f-9fc1-4d6ec84cf85f |
| router_id | 970ebe83-c4a3-4642-810e-43ab7b0c2b5f |
| status | DOWN |
| tags | [] |
| tenant_id | d5660cb1e6934612a01b4fb2fb630725 |
+---------------------+--------------------------------------+
@ -604,6 +610,7 @@ allocated for the instance:
| status | ACTIVE |
| subnets | 43414c53-62ae-49bc-aa6c-c9dd7705818a |
| | 5b9282a1-0be1-4ade-b478-7868ad2a16ff |
| tags | [] |
| tenant_id | d5660cb1e6934612a01b4fb2fb630725 |
+-------------------------+--------------------------------------+
@ -678,6 +685,7 @@ allocated for the instance:
| port_security_enabled | True |
| security_groups | 1f0ddd73-7e3c-48bd-a64c-7ded4fe0e635 |
| status | ACTIVE |
| tags | [] |
| tenant_id | d5660cb1e6934612a01b4fb2fb630725 |
+-----------------------+-------------------------------------------------------------------------------------------------------------+
@ -704,6 +712,7 @@ allocated for the instance:
| port_id | |
| router_id | |
| status | DOWN |
| tags | [] |
| tenant_id | d5660cb1e6934612a01b4fb2fb630725 |
+---------------------+--------------------------------------+

View File

@ -655,6 +655,7 @@ First, create a network and IPv6 subnet:
| revision_number | 2 |
| service_types | |
| subnetpool_id | prefix_delegation |
| tags | [] |
| updated_at | 2017-01-25T19:31:53Z |
| use_default_subnetpool | True |
+------------------------+--------------------------------------+
@ -701,6 +702,7 @@ to all ports:
| revision_number | 4 |
| service_types | |
| subnetpool_id | prefix_delegation |
| tags | [] |
| updated_at | 2017-01-25T19:35:26Z |
+-------------------+--------------------------------------+

View File

@ -193,6 +193,7 @@ First, create a QoS policy and its bandwidth limit rule:
| project_id | 4db7c1ed114a4a7fb0f077148155c500 |
| rules | [] |
| shared | False |
| tags | [] |
+-------------+--------------------------------------+
$ openstack network qos rule create --type bandwidth-limit --max-kbps 3000 \
@ -284,6 +285,7 @@ Ports can be created with a policy attached to them too.
| security_group_ids | 0531cc1a-19d1-4cc7-ada5-49f8b08245be |
| status | DOWN |
| subnet_id | None |
| tags | [] |
| updated_at | 2017-05-15T08:43:00Z |
+-----------------------+--------------------------------------------------+
@ -341,6 +343,7 @@ be used.
| project_id | 4db7c1ed114a4a7fb0f077148155c500 |
| rules | [] |
| shared | False |
| tags | [] |
+-------------+--------------------------------------+
$ openstack network qos policy set --no-default bw-limiter
@ -356,6 +359,7 @@ be used.
| project_id | 4db7c1ed114a4a7fb0f077148155c500 |
| rules | [] |
| shared | False |
| tags | [] |
+-------------+--------------------------------------+
@ -409,6 +413,7 @@ Just like with bandwidth limiting, create a policy for DSCP marking rule:
| project_id | 4db7c1ed114a4a7fb0f077148155c500 |
| rules | [] |
| shared | False |
| tags | [] |
+-------------+--------------------------------------+
You can create, update, list, delete, and show DSCP markings
@ -470,6 +475,7 @@ You can also include minimum bandwidth rules in your policy:
| project_id | 7cc5a84e415d48e69d2b06aa67b317d8 |
| rules | [] |
| shared | False |
| tags | [] |
+-------------+--------------------------------------+
$ openstack network qos rule create \
@ -523,4 +529,5 @@ It is also possible to combine several rules in one policy:
| | u'id': u'da858b32-44bc-43c9-b92b-cf6e2fa836ab', |
| | u'qos_policy_id': u'8491547e-add1-4c6c-a50e-42121237256c'}] |
| shared | False |
| tags | [] |
+-------------+-------------------------------------------------------------------+

View File

@ -62,6 +62,7 @@ Create a network to share:
| shared | False |
| status | ACTIVE |
| subnets | |
| tags | [] |
| updated_at | 2017-01-25T20:16:40Z |
+---------------------------+--------------------------------------+
@ -137,6 +138,7 @@ Create a QoS policy to share:
| project_id | 61b7eba037fd41f29cfba757c010faff |
| rules | [] |
| shared | False |
| tags | [] |
+-------------+--------------------------------------+
@ -232,6 +234,7 @@ This is accomplished using the ``shared`` flag on the supported object:
| shared | True |
| status | ACTIVE |
| subnets | |
| tags | [] |
| updated_at | 2017-01-25T20:32:07Z |
+---------------------------+--------------------------------------+
@ -331,6 +334,7 @@ rather than all projects, use the ``access_as_external`` action.
| shared | False |
| status | ACTIVE |
| subnets | |
| tags | [] |
| updated_at | 2017-01-25T20:36:59Z |
+---------------------------+--------------------------------------+
@ -423,6 +427,7 @@ previous behavior before this feature was added.
| shared | False |
| status | ACTIVE |
| subnets | |
| tags | [] |
| updated_at | 2017-01-25T20:41:44Z |
+---------------------------+--------------------------------------+

View File

@ -261,6 +261,7 @@ segment contains one IPv4 subnet and one IPv6 subnet.
| network_type | vlan |
| physical_network | provider2 |
| segmentation_id | 2016 |
| tags | [] |
+------------------+--------------------------------------+
#. Verify that the network contains the ``segment1`` and ``segment2`` segments.
@ -296,6 +297,7 @@ segment contains one IPv4 subnet and one IPv6 subnet.
| name | multisegment1-segment1-v4 |
| network_id | 6ab19caa-dda9-4b3d-abc4-5b8f435b98d9 |
| segment_id | 43e16869-ad31-48e4-87ce-acf756709e18 |
| tags | [] |
+-------------------+--------------------------------------+
$ openstack subnet create \
@ -316,6 +318,7 @@ segment contains one IPv4 subnet and one IPv6 subnet.
| name | multisegment1-segment1-v6 |
| network_id | 6ab19caa-dda9-4b3d-abc4-5b8f435b98d9 |
| segment_id | 43e16869-ad31-48e4-87ce-acf756709e18 |
| tags | [] |
+-------------------+------------------------------------------------------+
.. note::
@ -345,6 +348,7 @@ segment contains one IPv4 subnet and one IPv6 subnet.
| name | multisegment1-segment2-v4 |
| network_id | 6ab19caa-dda9-4b3d-abc4-5b8f435b98d9 |
| segment_id | 053b7925-9a89-4489-9992-e164c8cc8763 |
| tags | [] |
+-------------------+--------------------------------------+
$ openstack subnet create \
@ -365,6 +369,7 @@ segment contains one IPv4 subnet and one IPv6 subnet.
| name | multisegment1-segment2-v6 |
| network_id | 6ab19caa-dda9-4b3d-abc4-5b8f435b98d9 |
| segment_id | 053b7925-9a89-4489-9992-e164c8cc8763 |
| tags | [] |
+-------------------+--------------------------------------------------------+
#. Verify that each IPv4 subnet associates with at least one DHCP agent.
@ -449,4 +454,5 @@ segment contains one IPv4 subnet and one IPv6 subnet.
| port_security_enabled | True |
| security_groups | e4fcef0d-e2c5-40c3-a385-9c33ac9289c5 |
| status | DOWN |
| tags | [] |
+-----------------------+--------------------------------------+

View File

@ -102,6 +102,7 @@ to allow users to experiment with configuring service subnets.
| name | demo-subnet1 |
| network_id | b5b729d8-31cc-4d2c-8284-72b3291fec02 |
| service_types | ['compute:nova'] |
| tags | [] |
| tenant_id | a8b3054cc1214f18b1186b291525650f |
+-------------------+--------------------------------------+
@ -121,6 +122,7 @@ to allow users to experiment with configuring service subnets.
| name | demo-subnet2 |
| network_id | b5b729d8-31cc-4d2c-8284-72b3291fec02 |
| service_types | ['compute:foo'] |
| tags | [] |
| tenant_id | a8b3054cc1214f18b1186b291525650f |
+-------------------+--------------------------------------+
@ -289,6 +291,7 @@ This example uses again the private network, ``demo-net1``
| project_id | d44c19e056674381b86430575184b167 |
| router_id | 5a8ca19f-3703-4f81-bc29-db6bc2f528d6 |
| status | ACTIVE |
| tags | [] |
+---------------------+--------------------------------------+
#. As the `admin` user, verify the neutron routers are allocated IP
@ -314,6 +317,7 @@ This example uses again the private network, ``demo-net1``
| network_id | 02d236d5-dad9-4082-bb6b-5245f9f84d13 |
| project_id | |
| status | ACTIVE |
| tags | [] |
+-----------------------+--------------------------------------------------------------------------+
Second, the router floating IP agent gateway external port:
@ -335,4 +339,5 @@ This example uses again the private network, ``demo-net1``
| network_id | 02d236d5-dad9-4082-bb6b-5245f9f84d13 |
| project_id | |
| status | ACTIVE |
| tags | [] |
+-----------------------+--------------------------------------------------------------------------+

View File

@ -140,6 +140,7 @@ First, as admin, create a shared subnet pool:
| | 7c |
| revision_number | 1 |
| shared | True |
| tags | [] |
| updated_at | 2016-12-14T07:21:26Z |
+-------------------+--------------------------------+
@ -192,6 +193,7 @@ Now, use them. It is easy to create a subnet from a pool:
| revision_number | 2 |
| service_types | |
| subnetpool_id | d3aefb76-2527-43d4-bc21-0ec253908545 |
| tags | [] |
| updated_at | 2016-12-14T07:33:13Z |
+-------------------+--------------------------------------+
@ -227,6 +229,7 @@ from the subnet pool.
| revision_number | 2 |
| service_types | |
| subnetpool_id | d3aefb76-2527-43d4-bc21-0ec253908545 |
| tags | [] |
| updated_at | 2016-12-14T07:27:40Z |
+-------------------+--------------------------------------+
@ -256,6 +259,7 @@ If the pool becomes exhausted, load some more prefixes:
| project_id | cfd1889ac7d64ad891d4f20aef9f8d7c |
| revision_number | 2 |
| shared | True |
| tags | [] |
| updated_at | 2016-12-14T07:30:32Z |
+-------------------+--------------------------------------+

View File

@ -112,6 +112,7 @@ Create the trunk
| mac_address | fa:16:3e:dd:c4:d1 |
| name | trunk-parent |
| network_id | 1b47d3e7-cda5-48e4-b0c8-d20bd7e35f55 |
| tags | [] |
+-------------------+-------------------------------------------------------------------------+
* Create the trunk using ``--parent-port`` to reference the port from
@ -155,6 +156,7 @@ or adding subports to an existing trunk.
| mac_address | fa:16:3e:dd:c4:d1 |
| name | trunk-parent |
| network_id | 1b47d3e7-cda5-48e4-b0c8-d20bd7e35f55 |
| tags | [] |
+-------------------+-------------------------------------------------------------------------+
$ openstack port create --network trunked-net subport1
@ -169,6 +171,7 @@ or adding subports to an existing trunk.
| mac_address | fa:16:3e:ba:f0:4d |
| name | subport1 |
| network_id | aef78ec5-16e3-4445-b82d-b2b98c6a86d9 |
| tags | [] |
+-------------------+----------------------------------------------------------------------------+
$ openstack network trunk create \
@ -183,6 +186,7 @@ or adding subports to an existing trunk.
| name | trunk1 |
| port_id | 73fb9d54-43a7-4bb1-a8dc-569e0e0a0a38 |
| sub_ports | port_id='73fb9d54-43a7-4bb1-a8dc-569e0e0a0a38', segmentation_id='100', segmentation_type='vlan' |
| tags | [] |
+----------------+-------------------------------------------------------------------------------------------------+
* Add subports to an existing trunk:
@ -211,6 +215,7 @@ or adding subports to an existing trunk.
| name | trunk1 |
| port_id | 73fb9d54-43a7-4bb1-a8dc-569e0e0a0a38 |
| sub_ports | port_id='73fb9d54-43a7-4bb1-a8dc-569e0e0a0a38', segmentation_id='100', segmentation_type='vlan' |
| tags | [] |
+----------------+-------------------------------------------------------------------------------------------------+
Launch an instance on the trunk
@ -229,6 +234,7 @@ Launch an instance on the trunk
| name | trunk |
| port_id | 73fb9d54-43a7-4bb1-a8dc-569e0e0a0a38 |
| sub_ports | |
| tags | [] |
+----------------+--------------------------------------+
* Launch the instance by specifying ``port-id`` using the value of ``port_id``

View File

@ -188,6 +188,7 @@ supports adding distributed routing to existing routers.
| router:external | Internal |
| shared | False |
| status | ACTIVE |
| tags | [] |
+-------------------------+--------------+
#. Create a IPv4 subnet on the self-service network.
@ -206,6 +207,7 @@ supports adding distributed routing to existing routers.
| gateway_ip | 192.0.2.1 |
| ip_version | 4 |
| name | selfservice2-v4 |
| tags | [] |
+-------------------+---------------------------+
#. Create a IPv6 subnet on the self-service network.
@ -227,6 +229,7 @@ supports adding distributed routing to existing routers.
| ipv6_address_mode | slaac |
| ipv6_ra_mode | slaac |
| name | selfservice2-v6 |
| tags | [] |
+-------------------+------------------------------------------------------+
#. Create a router.
@ -240,6 +243,7 @@ supports adding distributed routing to existing routers.
| admin_state_up | UP |
| name | router2 |
| status | ACTIVE |
| tags | [] |
+-----------------------+---------+
#. Add the IPv4 and IPv6 subnets as interfaces on the router.
@ -344,6 +348,7 @@ Verify network operation
| instance_id | None |
| ip | 203.0.113.17 |
| pool | provider1 |
| tags | [] |
+-------------+--------------------------------------+
#. Associate the floating IPv4 address with the instance.

View File

@ -51,6 +51,7 @@ Here is the router we have used in our demonstration:
| project_id | bb8b84ab75be4e19bd0dfe02f6c3f5c1 |
| routes | |
| status | ACTIVE |
| tags | [] |
+-------------------------+-------------------------------------------+
#. Source the administrative project credentials.
@ -91,6 +92,7 @@ Here is the router we have used in our demonstration:
| project_id | bb8b84ab75be4e19bd0dfe02f6c3f5c1 |
| routes | |
| status | ACTIVE |
| tags | [] |
+-------------------------+-------------------------------------------+
@ -123,6 +125,7 @@ Here is the router we have used in our demonstration:
| project_id | bb8b84ab75be4e19bd0dfe02f6c3f5c1 |
| routes | |
| status | ACTIVE |
| tags | [] |
+-------------------------+-------------------------------------------+
#. Source the administrative project credentials.
@ -163,4 +166,5 @@ Here is the router we have used in our demonstration:
| project_id | bb8b84ab75be4e19bd0dfe02f6c3f5c1 |
| routes | |
| status | ACTIVE |
| tags | [] |
+-------------------------+-------------------------------------------+

View File

@ -7,13 +7,21 @@ Resource tags
Various virtual networking resources support tags for use by external
systems or any other clients of the Networking service API.
The currently supported resources are:
All resources that support standard attributes are applicable for tagging.
This includes:
* networks
* subnets
* subnetpools
* ports
* routers
* floatingips
* logs
* security-groups
* security-group-rules
* segments
* policies
* trunks
Use cases
~~~~~~~~~