Bug 1297724

Summary:	Document that the API is available on the Capsule on port 8443
Product:	Red Hat Satellite	Reporter:	Evgeni Golov <egolov>
Component:	Docs API Guide	Assignee:	David O'Brien <daobrien>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Peter Ondrejka <pondrejk>
Severity:	medium	Docs Contact:
Priority:	medium
Version:	6.1.5	CC:	adahms
Target Milestone:	Unspecified
Target Release:	Unused
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2016-04-28 00:07:02 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 Evgeni Golov 2016-01-12 10:20:59 UTC

Document URL: 
https://access.redhat.com/documentation/en-US/Red_Hat_Satellite/6.1/html/API_Guide/chap-Red_Hat_Satellite-API_Guide-Introduction_to_Red_Hat_Satellite.html

Section Number and Name: 
wherever fits best

Describe the issue: 
The docs currently only talk about talking HTTPS to the Satellite machine if one needs the API and do not mention how the API can be accessed via the Capsule. The naïve user would try to talk HTTPS (on port 443) to the Capsule too and fail as the proxy is on port 8443.

Suggestions for improvement:
Document the API ports for Satellite as being 443 and Capsule as being 8443. 

Additional information: 
Another solution could be to proxy the API on 443, not sure what's best here.

Comment 1 Andrew Dahms 2016-02-01 03:14:58 UTC

Assigning to David for review.

Comment 2 Andrew Dahms 2016-02-01 03:15:24 UTC

Assigning Peter as the QA contact.

Comment 6 Evgeni Golov 2016-02-15 18:09:00 UTC

JFTR for everyone implementing this (and this probably should also go to the docs). You can read the correct port needed from /etc/rhsm/rhsm.conf* in "port" of the "server" section. Thus this can be fully automated and does not need any guessing about "who to speak to".

*obviously, only if the machine is subscribed to Satellite/Capsule

Comment 7 David O'Brien 2016-02-16 03:04:09 UTC

commit 0fffd9c8800e4e1af9ce06e838844498553e369d
Author: David O'Brien <daobrien>
Date:   Tue Feb 16 12:49:07 2016 +1000

    bz1297724 Expand example and description on API access.

    Included #c5 in BZ about modifying URL to include port number.

    Included #c6 about determining port numbers from rhsm.conf file.

Comment 10 David O'Brien 2016-02-18 04:07:18 UTC

Thanks Peter and Evgeni. I've made that minor patch and merged it all into master.

Comment 12 Andrew Dahms 2016-04-28 00:07:02 UTC

This content is now live on the Customer Portal.

Closing.