Bug 1255906

Summary: The field end points is not available which is mentioned as per https://docs.openshift.com/enterprise/3.0/dev_guide/integrating_external_services.html#setting-the-endpoints
Product: OpenShift Container Platform Reporter: Miheer Salunke <misalunk>
Component: DocumentationAssignee: brice <bfallonf>
Status: CLOSED CURRENTRELEASE QA Contact: Vikram Goyal <vigoyal>
Severity: medium Docs Contact: Vikram Goyal <vigoyal>
Priority: urgent    
Version: 3.0.0CC: adellape, jokerman, misalunk, mmccomas
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2015-09-21 06:21:56 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 Miheer Salunke 2015-08-21 20:38:08 UTC
Document URL: 

https://docs.openshift.com/enterprise/3.0/dev_guide/integrating_external_services.html#setting-the-endpoints

Section Number and Name: 
Setting the Endpoints

Describe the issue: 
There's an bug in the documentation. 

The kind is Endpoints, but it cannot have a field 'endpoints' and that field will be ignored.
Comparing https://github.com/kubernetes/kubernetes/blob/master/docs/user-guide/services.md#services-without-selectors with the endpoint.json here: https://docs.openshift.com/enterprise/3.0/dev_guide/integrating_external_services.html#setting-the-endpoints
cant have this:
 "endpoints": [ 
     "my-instance.external-mysql.com:3306"
   ]

You need to have "subsets".


Suggestions for improvement: 
You can refer json files for service and endpoint from 
https://github.com/kubernetes/kubernetes/blob/master/docs/user-guide/services.md#services-without-selectors

Additional information:

Comment 2 brice 2015-08-24 01:11:03 UTC
Miheer,

I've corrected the field in the docs. You can see the work here:

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

Is there any suggestions, or anything else for this BZ?

Thanks.

Comment 3 Miheer Salunke 2015-08-24 07:29:28 UTC
Hi,

It looks good.

Thanks and regards,
Miheer

Comment 4 Alex Dellapenta 2015-08-24 21:43:25 UTC
LGTM. Consider linking to https://github.com/kubernetes/kubernetes/blob/master/docs/user-guide/services.md#services-without-selectors in callout 3 as a reference?

Comment 5 brice 2015-08-26 04:39:50 UTC
Done. And Merged.