Bug 1285509

Summary:	Missing link to example?
Product:	OpenShift Container Platform	Reporter:	Eric Jones <erjones>
Component:	Documentation	Assignee:	brice <bfallonf>
Status:	CLOSED NOTABUG	QA Contact:	Vikram Goyal <vigoyal>
Severity:	low	Docs Contact:	Vikram Goyal <vigoyal>
Priority:	low
Version:	3.1.0	CC:	aos-bugs, bfallonf, jokerman, lmeyer, 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:	2017-12-22 13:10:57 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 Eric Jones 2015-11-25 19:31:41 UTC

Document URL: 
https://access.redhat.com/documentation/en/openshift-enterprise/3.1/installation-and-configuration/chapter-14-aggregating-container-logs

Section Number and Name: 
14.2 Pre-Deployment Configuration

Describe the issue: 
Customer feels that there needs to be an example for the server-tls.json file but it is not there. The upstream docs [0] have an example at [1] but we do not have anything. The customer is concerned the example [1] is not enough or might not be correct.

[0] https://github.com/openshift/origin-aggregated-logging/blob/master/deployment/README.md
[1] https://github.com/openshift/origin-aggregated-logging/blob/master/deployment/conf/server-tls.json

Suggestions for improvement: 
Include this link, internally hosted, or provide new examples on our own site.

Comment 3 Luke Meyer 2015-11-26 05:39:49 UTC

(In reply to Eric Jones from comment #0)
 
> Customer feels that there needs to be an example for the server-tls.json
> file but it is not there.

I agree.

> The upstream docs [0] have an example at [1] but
> we do not have anything. The customer is concerned the example [1] is not
> enough or might not be correct.

It is exactly what we shipped in OSE 3.1 (and if there are changes later, I would expect them to stay in close sync - I can't think of anything that would make this version-specific). Probably better to call this "the default" rather than an example.

The customer doesn't need to wait on docs to verify this, though. Everything is entered in base64 encoding in the secrets in the project. You can have a look at all of them with:

    $ oc get secrets -o yaml

You have to decode them (echo <value> | base64 -d) and if you want to 'oc edit' in your changes you have to encode the values you want (cat <file> | base64), so it's kind of painful, but everything is mutable. "Have fun with that" isn't where we want to leave customers indefinitely, and at some point we'll need docs on what exactly all the secret values are for and how to modify them.