Launchpad Entry: NovaSpec: admin-server-actions
Created: 18 August 2011
Contributors: GlenCampbell
Summary
This specification defines a minimal set of functions that can be performed by administrators on servers.
Release Note
Admin API: server actions permits administrators to suspend/unsuspend servers (for example, if they are found to be sending spam).
Rationale
User stories
As a Nova administrator (particularly the administrator of a public cloud), I need to have the ability to suspend a specific server so that it cannot consume too many resources or used for spam or abuse.
Assumptions
These actions are implemented as API extensions initially.
Design
/servers/{server_id}/action
This resource provides a mechanism for performing specific actions on a server (a compute instance). For management purposes, there are several extensions beyond those actions provided in the Nova API 1.1 specification.
Action |
Description |
SUSPEND_SERVER |
Causes the server to be unusable by the user. Typically performed to halt abuse for investigation. It does not deallocate or delete the associated virtual machine. |
UNSUSPEND_SERVER |
Restores the server to normal 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.