API: Consolidate the APIs for getting consoles

Registered by Radoslav Gerganov on 2014-12-11

In the moment (Kilo cycle) we have four different kinds of VM consoles: VNC, SPICE, RDP and serial. There is a separate public API for getting each type of console and we need to keep adding new APIs for new types of consoles.

The proposal is to consolidate all APIs for getting a console into one which specifies everything needed. For example:

POST /server/id/consoles
{
    "protocol": ["vnc"|"rdp"|"serial"|"spice"],
    "type": ["novnc"|"xpvnc"|"rdp-html5"|"spice-html5"]
}

If the requested console is supported by the underlying virt driver, the response will be contain a URL for accessing the console.

Blueprint information

Status:
Complete
Approver:
John Garbutt
Priority:
Low
Drafter:
Radoslav Gerganov
Direction:
Approved
Assignee:
Radoslav Gerganov
Definition:
Approved
Series goal:
Accepted for liberty
Implementation:
Implemented
Milestone target:
milestone icon 12.0.0
Started by
Radoslav Gerganov on 2015-01-20
Completed by
Radoslav Gerganov on 2015-07-06

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.openstack.org/#q,topic:bp/vmware-webmks-console,n,z

Addressed by: https://review.openstack.org/141065
    Consolidate the APIs for getting consoles

Addressed by: https://review.openstack.org/163790
    Consolidate the APIs for getting consoles

You should not set a milestone target unless the blueprint has been properly prioritized by the project drivers.
(This is an automated message)

Marked as good progress, as this is almost merged now --johnthetubaguy

Sorry, we have now hit the non-priority feature freeze for kilo. Please resubmit your spec for the L release. --johnthetubaguy 5th Feb 2015

Approved for liberty --johnthetubaguy 15th May 2015

Gerrit topic: https://review.openstack.org/#q,topic:bp/consolidate-console-api,n,z

Addressed by: https://review.openstack.org/148509
    Consolidate the APIs for getting consoles

Addressed by: https://review.openstack.org/185844
    Correct resource name for consolidate console API

Gerrit topic: https://review.openstack.org/#q,topic:api-ref,n,z

Addressed by: https://review.openstack.org/402138
    api-ref: Deprecate the server actions to get consoles in v2.25

(?)

Work Items

Dependency tree

* Blueprints in grey have been implemented.

This blueprint contains Public information 
Everyone can see this information.