Bug 2054073

Summary: Route [route.openshift.io/v1] Description of .spec.tls.insecureEdgeTerminationPolicy is not correct
Product: OpenShift Container Platform Reporter: Vincent Shen <wenshen>
Component: DocumentationAssignee: Servesha <sdudhgao>
Status: CLOSED CURRENTRELEASE QA Contact: Hongan Li <hongli>
Severity: low Docs Contact: Latha S <lmurthy>
Priority: low    
Version: 4.10CC: aos-bugs, kalexand, sdudhgao
Target Milestone: ---Keywords: Reopened
Target Release: 4.6.z   
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: 2022-03-23 10:23:12 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:
Embargoed:

Description Vincent Shen 2022-02-14 06:48:28 UTC
Document URL: 

https://docs.openshift.com/container-platform/4.9/rest_api/network_apis/route-route-openshift-io-v1.html

Section Number and Name: 

Under `insecureEdgeTerminationPolicy` property of `.spec.tls`

Describe the issue: 

The description there is not correct; it has 
```
* Allow - traffic is sent to the server on the insecure port (default) * Disable - no traffic is allowed on the insecure port. * Redirect - clients are redirected to the secure port.
```
Which does not match with:
https://github.com/openshift/api/blob/31ffd77a8f025c73b5d19b390af353f9775e7ef1/route/v1/types.go#L270


Suggestions for improvement: 

It should be:

```
None disables insecure connections for an edge-terminated route.
Allow allows insecure connections for an edge-terminated route.
Redirect redirects insecure connections for an edge-terminated route.
```

Additional information: 

None

Comment 3 Hongan Li 2022-02-16 07:04:37 UTC
The doc PR looks good, moving to verified.