Bug 1312237

Summary: [docs] 3.1 architecture - annotations mixed up
Product: OpenShift Container Platform Reporter: Evgheni Dereveanchin <ederevea>
Component: DocumentationAssignee: brice <bfallonf>
Status: CLOSED CURRENTRELEASE QA Contact: Vikram Goyal <vigoyal>
Severity: low Docs Contact: Vikram Goyal <vigoyal>
Priority: high    
Version: 3.1.0CC: aos-bugs, jokerman, mmccomas
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
URL: https://access.redhat.com/documentation/en/openshift-enterprise/3.1/architecture/chapter-3-core-concepts#edge-termination
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-05-17 01:30:42 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 Evgheni Dereveanchin 2016-02-26 08:18:47 UTC 
Document URL: 
 https://access.redhat.com/documentation/en/openshift-enterprise/3.1/architecture/chapter-3-core-concepts#edge-termination
Section Number and Name: 
 3.7.7. Secured Routes
  Edge Termination
   Example 3.11. A Secured Route Using Edge Termination
Describe the issue: 
 parameters have these numbers:
  termination: edge              1
    key: |-                      2
    ...
    certificate: |-              3
    ...
    caCertificate: |-            4

 annotations are mismatched for key and certificate:
  1 The termination field is edge for edge termination.
  2 The certificate field is the contents of the PEM format certificate file.
  3 The key field is the contents of the PEM format key file.
  4 An optional CA certificate may be required to establish a certificate chain for validation.

Suggestions for improvement: 
 annotations 2 and 3 are mixed up, this has to be fixed
Additional information:
Comment 1 brice 2016-04-20 03:58:10 UTC 
Evgheni,

This is a simple fix. I've made a PR:

https://github.com/openshift/openshift-docs/pull/1924

It should be ok to merge by one of the other docs writers, but let me know if there's anything else. Thanks!
Comment 2 openshift-github-bot 2016-04-21 23:29:50 UTC 
Commit pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/dd2f9787b7ce77c07b7ca020401910d4ff3f8cd4
Merge pull request #1924 from bfallonf/bz1312237

Bug 1312237 : Switched values in the edge termination example
Comment 3 brice 2016-05-17 01:30:42 UTC 
Verified to be in the 3.2 docs:

https://access.redhat.com/documentation/en/openshift-enterprise/version-3.2/architecture/#secured-routes