Bug 1463225 - Improve openshift-logging documentation
Summary: Improve openshift-logging documentation
Keywords:
Status: CLOSED EOL
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.5.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: ---
Assignee: Vikram Goyal
QA Contact: Vikram Goyal
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-06-20 12:05 UTC by Mauricio Magnani
Modified: 2019-08-10 06:46 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-08-10 06:46:21 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

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.


Note You need to log in before you can comment on or make changes to this bug.