x/powervc-driver
Code Issues Proposed changes

Add document for new host-maintenance-mode feature

Browse Source 
Add document for new host-maintenance-mode feature. For detail,
please refer to the host_maintenance_mode.rst.

Change-Id: I0d61ba75a2c7b551fbced54d1a8a297fa58fdb4f
Closes-Bug: 1381325
This commit is contained in:
Jerry Cai 2014-10-15 13:52:09 +08:00
parent d2d4e304be
commit acb5f369b8
1 changed files with 61 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
nova-powervc/doc/host_maintenance_mode.rst Normal file
View File

@ -0,0 +1,61 @@
New Host Maintenance mode restAPI documentation for PowerVC Driver
===================================
Included documents:
- How to call restAPI to enable/disable the Host Maintenance mode
Where is the source code:
Source code is located in powervc/nova/extension/host_maintenance_mode.py
How to enable the restAPI:
Create a link from this source file to nova api folder:
# ln -s powervc/nova/extension/host_maintenance_mode.py nova/api/openstack/compute/contrib/host_maintenance_mode.py
How to verify if the restAPI is installed properly:
# nova list-extensions | grep maintenance
The result should be like the following:
| Host-maintenance-mode | Get and enable/disable Host maintenance mode, and evacuate all...
How to get the Host Maintenance mode:
Method: Get
URL: /v2/{tenant-id}/os-host-maintenance-mode/{host_name}
Request parameters:
1. tenant-id: The tenant ID in a multi-tenancy cloud.
2. host_name: The name of a host.
Sample:
/v2/ae1c0ea86c95432d95995617022e4c96/os-host-maintenance-mode/789522X_067E30B
How to enable the Host Maintenance mode:
Method: Put
URL: /v2/{tenant-id}/os-host-maintenance-mode/{host_name}
Request parameters:
1. tenant-id: The tenant ID in a multi-tenancy cloud.
2. host_name: The name of a host.
Request Body:
{
"status":"enable",
"migrate":"active-only"/"none"
}
Request Body Description:
1. Set "status" to "enable" to enable the Host Maintenance mode.
2. Set "migrate" to "active-only" that could evacuate all the VMs to another host during the process.
Set "migrate" to "none" or just ignore this parameter that will not evacuate VMs.
How to disable the Host Maintenance mode:
Method: Put
URL: /v2/{tenant-id}/os-host-maintenance-mode/{host_name}
Request parameters:
1. tenant-id: The tenant ID in a multi-tenancy cloud.
2. host_name: The name of a host.
Request Body:
{
"status":"disable"
}
Request Body Description:
1. Set "status" to "disable" to enable the Host Maintenance mode.