From d0e64c661727d151abd5f3d9a3fb38c4092df7b5 Mon Sep 17 00:00:00 2001 From: Brian Haley Date: Fri, 13 Jan 2023 17:42:34 -0500 Subject: [PATCH] Add auto-allocated-topology delete example to docs There was not an example of how to delete an auto allocated topology (get me a network), so add one. Only a partial fix as it seems the api-ref doc in neutron-lib is incorrect as there is only create and delete operations on this resource, not show. Change-Id: Iaa797b7e0c1c9bac25ff00659a74286173297206 Partial-bug: #1617548 --- doc/source/admin/config-auto-allocation.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/doc/source/admin/config-auto-allocation.rst b/doc/source/admin/config-auto-allocation.rst index 1b8ad4a0f29..775c1a8233a 100644 --- a/doc/source/admin/config-auto-allocation.rst +++ b/doc/source/admin/config-auto-allocation.rst @@ -131,7 +131,7 @@ Get Me A Network ---------------- In a deployment where the operator has set up the resources as described above, -they can get their auto-allocated network topology as follows: +they can get or create their auto-allocated network topology as follows: .. code-block:: console @@ -140,17 +140,16 @@ they can get their auto-allocated network topology as follows: | Field | Value | +------------+--------------------------------------+ | id | a380c780-d6cd-4510-a4c0-1a6ec9b85a29 | - | name | None | | project_id | cfd1889ac7d64ad891d4f20aef9f8d7c | +------------+--------------------------------------+ .. note:: When the ``--or-show`` option is used the command returns the topology - information if it already exists. + information if it already exists, or creates it if it does not. -Operators (and users with admin role) can get the auto-allocated topology for a -project by specifying the project ID: +Operators (and users with admin role) can get or create the auto-allocated +topology for a project by specifying the project ID: .. code-block:: console @@ -160,7 +159,6 @@ project by specifying the project ID: | Field | Value | +------------+--------------------------------------+ | id | a380c780-d6cd-4510-a4c0-1a6ec9b85a29 | - | name | None | | project_id | cfd1889ac7d64ad891d4f20aef9f8d7c | +------------+--------------------------------------+ @@ -179,6 +177,12 @@ network available, the Compute service will invoke the API behind ``auto allocated topology create``, fetch the network UUID, and pass it on during the boot process. +Alternately one can delete their auto-allocated network topology as follows: + +.. code-block:: console + + $ openstack network auto allocated topology delete + Validating the requirements for auto-allocation -----------------------------------------------