Bug 1463225 - Improve openshift-logging documentation
Improve openshift-logging documentation
Status: NEW
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation (Show other bugs)
3.5.0
Unspecified Unspecified
unspecified Severity low
: ---
: ---
Assigned To: Vikram Goyal
Vikram Goyal
Vikram Goyal
:
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2017-06-20 08:05 EDT by Mauricio Magnani
Modified: 2018-01-25 16:49 EST (History)
3 users (show)

See Also:
Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of:
Environment:
Last Closed:
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---


Attachments (Terms of Use)

  None (edit)
Description Mauricio Magnani 2017-06-20 08:05:49 EDT
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.