Bug 1372086

Summary: The Docs don't explain route for SSO well
Product: Red Hat xPaaS Reporter: Eric Rich <erich>
Component: DocumentationAssignee: Andrew Burden <aburden>
Status: CLOSED CURRENTRELEASE QA Contact: Tomas Schlosser <tschloss>
Severity: high Docs Contact: Vikram Goyal <vigoyal>
Priority: medium    
Version: unspecified   
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-05-22 02:17:59 UTC 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 Eric Rich 2016-08-31 21:07:53 UTC
Description of problem:

https://access.redhat.com/documentation/en/red-hat-xpaas/version-0/red-hat-xpaas-sso-image/#deploying_the_sso_application_template

We explain that a template is used, however at the end of this section we only state how to access the application (but don't explain how the routing to this application was setup).

The only note's (context) we have on this are provided in: 

> The SSO web console can be accessed at https://secure-sso-<sso-app-demo>.<openshift32.example.com>/auth/admin using the admin user.

> Note
>This example workflow uses a self-generated CA to provide an end-to-end workflow for demonstration purposes. Accessing the SSO web console will prompt an insecure connection warning.
>For production environments, Red Hat recommends that you use an SSL certificate purchased from a verified Certificate Authority. 

However this does not explain that "Passthrough Termination"[0] is used, and that the template deploys this route: 

--- from: oc get templates -n openshift sso70-basic -o yaml ---
>- apiVersion: v1
>  id: ${APPLICATION_NAME}-https
>  kind: Route
>  metadata:
>    annotations:
>      description: Route for application's https service.
>    labels:
>      application: ${APPLICATION_NAME}
>    name: secure-${APPLICATION_NAME}
>  spec:
>    host: ${HOSTNAME_HTTPS}
>    tls:
>      termination: passthrough
>    to:
>      name: secure-${APPLICATION_NAME}

This makes understanding the understanding of the SSL configurations (components) in: 

>https://access.redhat.com/documentation/en/red-hat-xpaas/version-0/red-hat-xpaas-sso-image/#preparing_sso_authentication_for_openshift_deployment

almost impossible, as: 

> https://access.redhat.com/documentation/en/red-hat-xpaas/version-0/red-hat-xpaas-sso-image/#configuring_openshift_master_for_single_sign_on_authentication

tries to explain how "OpenShift" might use SSO as an authentication provider. 

[0] https://docs.openshift.com/enterprise/3.2/architecture/core_concepts/routes.html#route-types

Comment 2 Andrew Burden 2017-03-28 03:10:18 UTC
New section added to the SSO Getting Started chapter to explain that templates use TLS passthrough termination and the effect of this. 

Changes awaiting MR review.