This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
nova-rdp [2013/12/23 03:13] admin |
nova-rdp [2014/06/12 19:37] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Nova RDP Support====== | + | ====== Nova RDP Support |
Nova currently provides support for [[http:// | Nova currently provides support for [[http:// | ||
+ | [[http:// | ||
- | ---- | ||
- | |||
- | |||
- | ===== Getting an RDP console URL ===== | ||
- | |||
- | This requires a public API which is symmetric with the VNC and SPICE ones. | ||
- | |||
- | |||
- | ==== Get an RDP console URL: V2 API ==== | ||
- | |||
- | ^Verb ^URI ^Description ^ | ||
- | |GET |/ | ||
- | |||
- | Normal Response Code(s): 200 | ||
- | |||
- | Error Response Code(s): badRequest (400), itemNotFound (404), buildInProgress (409) | ||
- | |||
- | |||
- | === Example. Get RDP console URL request: XML === | ||
- | |||
- | <code xml> | ||
- | <?xml version=" | ||
- | < | ||
- | </ | ||
- | |||
- | === Example. Get RDP console URL request: JSON === | ||
- | |||
- | <code javascript> | ||
- | { | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | === Example. Get RDP console URL response: XML === | ||
- | |||
- | <code xml> | ||
- | <?xml version=' | ||
- | < | ||
- | < | ||
- | < | ||
- | </ | ||
- | </ | ||
- | |||
- | === Example. Get RDP console URL response: JSON === | ||
- | |||
- | <code javascript> | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | </ | ||
---- | ---- | ||
+ | ===== Configuring Nova for RDP support ===== | ||
- | ==== Get an RDP console | + | RDP console |
- | ^Verb ^URI ^Description ^ | + | [rdp] |
- | |GET |/v3/servers/{id}/ | + | |
+ | html5_proxy_base_url=http: | ||
+ | |||
+ | Where the url specified in the **html5_proxy_base_url** setting is provided by the FreeRDP HTML5 proxy as detailed in the next section. | ||
- | Normal Response Code(s): 200 | + | ===== Installing and configuring the FreeRDP HTML5 proxy ===== |
- | Error Response Code(s): badRequest (400), itemNotFound (404), buildInProgress (409) | + | The FreeRDP HTML5 proxy can be installed on various Linux distributions |
- | === Example. Get RDP console URL request: XML === | + | ==== Ubuntu 12.04 and above ==== |
- | <code xml> | + | A shell script is provided to simplify the installation of the application and the dependencies, |
- | <?xml version=" | + | |
- | < | + | |
- | </ | + | |
- | === Example. Get RDP console URL request: JSON === | + | sudo apt-get install -y git |
+ | git clone https:// | ||
+ | cd FreeRDP-WebConnect | ||
+ | sudo ./setup_all.sh -f -i | ||
+ | |||
+ | At this point the proxy, called **wsgate** can be installed by running: | ||
- | <code javascript> | + | sudo make install |
- | { | + | |
- | " | + | |
- | " | + | |
- | } | + | |
- | } | + | |
- | </ | + | |
- | === Example. Get RDP console URL response: XML === | + | ==== wsgate configuration ==== |
- | Same output as in the [[nova-rdp# | + | The default configuration file is located here: |
- | === Example. Get RDP console URL response: JSON === | + | |
- | + | ||
- | Same output as in the [[nova-rdp# | + | Change the following options to match your environment configuration: |
- | + | ||
- | ---- | + | |
- | + | ||
- | ===== Getting console connection details ===== | + | |
- | + | ||
- | Nova includes internally the required proxy solutions for VNC (novnc, xvpvnc) and SPICE, but this is not the case for RDP. Beside that, it's also desirable to leave to third party the ability to choose a custom graphical console UI solution not necessarily included with Nova. A public API has been provided to retrieve the relevant information by providing a valid console authentication token. | + | |
- | + | ||
- | ==== Get console connection info: V2 API ==== | + | |
- | + | ||
- | ^Verb ^URI ^Description ^ | + | |
- | |GET |/console-auth-tokens/{token_id}/action |Gets the connection info for the specified console authentication token. | | + | |
- | + | ||
- | Normal Response Code(s): 200 | + | |
- | + | ||
- | Error Response Code(s): badRequest (400), itemNotFound (404) | + | |
- | + | ||
- | + | ||
- | === Example. Get console connection request: XML === | + | |
- | + | ||
- | <code xml> | + | |
- | <?xml version=" | + | |
- | < | + | |
- | </ | + | |
- | + | ||
- | === Example. Get console connection request: JSON === | + | |
- | + | ||
- | <code javascript> | + | |
- | { | + | |
- | | + | |
- | } | + | |
- | </ | + | |
- | + | ||
- | === Example. Get console connection response: XML === | + | |
- | + | ||
- | <code xml> | + | |
- | <?xml version=' | + | |
- | < | + | |
- | < | + | |
- | < | + | |
- | < | + | |
- | < | + | |
- | </ | + | |
- | </ | + | |
- | + | ||
- | === Example. Get console connection response: JSON === | + | |
- | + | ||
- | <code javascript> | + | |
- | { | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | " | + | |
- | } | + | |
- | } | + | |
- | </ | + | |
- | + | ||
- | ---- | + | |
- | ==== Get console connection info: V3 API ==== | + | [global] |
+ | port = 8000 | ||
- | ^Verb ^URI ^Description ^ | + | Note: make sure to open the port in your operating system firewall. |
- | |GET |/ | + | |
- | Normal Response Code(s): 200 | + | [openstack] |
+ | authurl = http:// | ||
+ | username = admin | ||
+ | password = secret | ||
+ | tenantname = admin | ||
- | Error Response Code(s): badRequest (400), itemNotFound (404) | + | [hyperv] |
+ | # Credentials used to connect to the Hyper-V hosts when accessing | ||
+ | # OpenStack instances consoles | ||
- | === Example. Get console connection request: XML === | + | hostusername |
+ | hostpassword | ||
- | <code xml> | + | It is also strongly recommended to encrypt the traffic using HTTPS. Here are the relevant parameters, including a PEM file containing both the certificate and the private key. |
- | <?xml version=" | + | |
- | < | + | |
- | </ | + | |
- | === Example. Get console connection request: JSON === | + | [ssl] |
+ | port = 4430 | ||
+ | certfile | ||
+ | certpass | ||
- | <code javascript> | + | HTML, CSS and Javascript files are available at the following location for further customization: |
- | { | + | |
- | " | + | |
- | } | + | |
- | </ | + | |
- | === Example. Get console connection response: XML === | + | / |
- | Same output | + | ==== Running wsgate ==== |
+ | |||
+ | wsgate can be executed | ||
- | === Example. Get console connection response: JSON === | + | wsgate -c / |
- | Same output as in the [[nova-rdp# | + | In case you should prefer to execute wsgate |
+ | [global] | ||
+ | daemon = false | ||