NovaAdminServiceAPI
- Launchpad Entry: NovaSpec:admin-service-actions
- Created: 18 August 2011
- Contributors: GlenCampbell
Contents
Summary
Nova cloud administrators need to perform actions on specific services. For example, a compute node on a host with a failing disk may be placed into "maintenance mode" where actions can be taken to move active instances off the host while not permitting any new instances to be created. This blueprint defines a number of such functions and an API for retrieving information about the Nova services.
Release Note
"Service Actions" is an admin API extension that permits the retrieval and management of Nova services in a cloud deployment.
Rationale
User stories
As a Nova administrator, I need to have information on the currently-running services and be able to perform management actions on them such as starting, stopping, and suspending them.
Assumptions
These are implemented as extensions to the OS API 1.1 and may be moved into core in a future release of the API.
Design
/services
The /services resource manages information on a collection of services for the current zone. (See the documentation for the multi-zone support for more details; in essence, the "current" zone is the one identified by the API endpoint used.)
| Method | Returns |
| GET | A collection of all services in the current zone |
| PUT | Not allowed |
| POST | Not allowed. |
| DELETE | Not allowed |
/services/{service_id}
Manages information on a single host, identified by service_id.
| Method | Returns |
| GET | Consolidated metadata on a single service |
/services/{service_id}/actions
Like the other "…/actions" URLs defined elsewhere, this accepts a message in the POST body that specifies the action to perform.
| Service | Action | |
| Compute | PAUSE | restricts the compute node from accepting new instance creation requests, but permits all other requests. Also prevents any user actions from taking place. |
| Compute | RESUME | returns the compute node to full operation |
Implementation
This section should describe a plan of action (the "how") to implement the changes discussed. Could include subsections like:
UI Changes
Should cover changes required to the UI, or specific UI that is required to implement this
Code Changes
Code changes should include an overview of what needs to change, and in some cases even the specific details.
Migration
Include:
- data migration, if any
- redirects from old URLs to new ones, if any
- how users will be pointed to the new way of doing things, if necessary.
Test/Demo Plan
This need not be added or completed until the specification is nearing beta.
Unresolved issues
This should highlight any issues that should be addressed in further specifications, and not problems with the specification itself; since any specification with problems cannot be approved.
BoF agenda and discussion
Use this section to take notes during the BoF; if you keep it in the approved spec, use it for summarising what was discussed and note any options that were rejected.
