Bug 1312237 - [docs] 3.1 architecture - annotations mixed up
Summary: [docs] 3.1 architecture - annotations mixed up
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.1.0
Hardware: Unspecified
OS: Unspecified
high
low
Target Milestone: ---
: ---
Assignee: brice
QA Contact: Vikram Goyal
Vikram Goyal
URL: https://access.redhat.com/documentati...
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-02-26 08:18 UTC by Evgheni Dereveanchin
Modified: 2016-05-17 01:30 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-05-17 01:30:42 UTC
Target Upstream Version:


Attachments (Terms of Use)

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


Note You need to log in before you can comment on or make changes to this bug.