Bug 1339444

Summary: [Docs] [Networking] Document the new 'neutron purge' command
Product: Red Hat OpenStack Reporter: Andrew Dahms <adahms>
Component: documentationAssignee: Martin Lopes <mlopes>
Status: CLOSED CURRENTRELEASE QA Contact: Radek Bíba <rbiba>
Severity: medium Docs Contact:
Priority: medium    
Version: 9.0 (Mitaka)CC: amuller, srevivo
Target Milestone: gaKeywords: Documentation
Target Release: 9.0 (Mitaka)   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-08-29 00:22:20 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 1325678    
Bug Blocks:    

Description Andrew Dahms 2016-05-25 04:02:13 UTC
In Red Hat OpenStack Platform 9, a new command 'neutron purge' has been added that allows users to clean up networking resources associated with a given tenant.

From the engineering bug:

The addition of the 'neutron purge' command allows cloud admins to conveniently delete multiple neutron resources associated with a given tenant.

The command will delete all supported resources provided that they can be deleted (not in use, etc) and feedback the amount of each resource deleted to the user. A completion percentage is also given to keep the user informed of progress.

Currently supports deletion of:

*Networks
*Subnets (implicitly)
*Routers
*Ports (including router interfaces)
*Floating IPs
*Security Groups

Comment 1 Andrew Dahms 2016-05-25 04:03:03 UTC
While this change will be covered in the CLI guide, it may also be a good idea to add a procedure to the Networking Guide to call out this change and provide a conceptual introduction as to why this command is useful.

Comment 2 Assaf Muller 2016-05-25 22:40:02 UTC
Check out the upstream network guide content:

https://review.openstack.org/#/c/321012/1/doc/networking-guide/source/misc-neutron-purge.rst

Comment 3 Andrew Dahms 2016-05-26 02:54:40 UTC
Assigning to Martin for review.