Bug 1036425

Summary: [Docs][Install] Description of spice proxy configuration is wrong with regards to supported protocols
Product: Red Hat Enterprise Virtualization Manager Reporter: Luca Villa <luvilla>
Component: DocumentationAssignee: Andrew Dahms <adahms>
Status: CLOSED CURRENTRELEASE QA Contact: ecs-bugs
Severity: high Docs Contact:
Priority: unspecified    
Version: 3.3.0CC: acathrow, gklein, yeylon
Target Milestone: ---   
Target Release: 3.3.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Build Name: 20666, Installation Guide-3.2-6 Build Date: 06-11-2013 17:23:58 Topic ID: 21950-498117 [Specified]
Last Closed: Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Luca Villa 2013-12-01 23:38:06 UTC
Title: Description of spice proxy configuration is wrong with regards to supported protocols

Describe the issue:
Documentation section "B.6.3. Turning on SPICE Proxy" is misleading with regard to supported protocols where it says:

"
The proxy must have this form:

protocol://[host]:[port]

For example:

https://proxyname.example.com:8080

Note
Different protocols can be specified with the protocol:// prefix. If no protocol is specified in the proxy string (or if the proxy string doesn't match a supported proxy), the proxy is treated as an HTTP proxy. 
"

Suggestions for improvement:
- remove the example about the usage of https
- specify clearly that only http is supported and functioning at moment.

Additional information:
It is my understanding that currently only http protocol is supported by spice clients (although this is not stated anywhere to my knowledge). If https is specified the client tries to connect directly to the hypervisor, so ignoring completely the proxy setting.

Comment 1 Zac Dover 2013-12-08 13:06:11 UTC
To close this bug:

1. Remove the following from the Installation Guide:

  For example:

  https://proxyname.example.com:8080


2. Change this:

    Different protocols can be specified with the protocol:// prefix. If no
    protocol is specified in the proxy string (or if the proxy string doesn't 
    match a supported proxy), the proxy is treated as an HTTP proxy.

   To this:

    Only the http protocol is supported by SPICE clients. If https is 
    specified, the client attempts to connect to the hypervisor and thereby
    ignores the proxy setting.

Comment 2 Andrew Dahms 2014-01-08 00:07:26 UTC
Documentation Link
------------------------------
http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.3/html-single/Installation_Guide/index.html#Activating_and_Deactivating_SPICE_Proxy

What Changed
------------------------------
The following topic was edited:

Turning on SPICE Proxy    [ 21950-571016 ]

Changed -

    Different protocols can be specified with the protocol:// prefix. If no
    protocol is specified in the proxy string (or if the proxy string doesn't 
    match a supported proxy), the proxy is treated as an HTTP proxy.

To -

    Only the http protocol is supported by SPICE clients. If https is 
    specified, the client attempts to connect to the hypervisor and thereby 
    ignores the proxy setting. 

Updated revision history: [ 21134-571017 ]

NVR
------------------------------
Red_Hat_Enterprise_Virtualization-Installation_Guide-3.3-en-US-3.3-31

Moving to ON_QA.