Bug 1463225

Summary: Improve openshift-logging documentation
Product: OpenShift Container Platform Reporter: Mauricio Magnani <mmagnani>
Component: DocumentationAssignee: Vikram Goyal <vigoyal>
Status: CLOSED EOL QA Contact: Vikram Goyal <vigoyal>
Severity: low Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: 3.5.0CC: aos-bugs, jokerman, mmccomas
Target Milestone: ---   
Target Release: ---   
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: 2019-08-10 06:46:21 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 Mauricio Magnani 2017-06-20 12:05:49 UTC 
Document URL: https://docs.openshift.com/container-platform/3.5/install_config/aggregate_logging.html#aggregate-logging-ansible-variables

Section Number and Name: Specifying Logging Ansible Variables

Suggestions for improvement: Listing the expected data type for each parameter would be a useful addition to the documentation.

Ex: Customer switched the following variable from:

openshift_logging_es_nodeselector=os-node.example.com

to:

openshift_logging_es_nodeselector={"kubernetes.io/hostname":"os-node.example.com"}


The documentation didn't clearly indicate that this was the expected data type.