Bug 1302881 - [sme] Logging aggregation setup of project incorrect
Summary: [sme] Logging aggregation setup of project incorrect
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.1.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Vikram Goyal
QA Contact: Vikram Goyal
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-01-28 21:30 UTC by Peter Larsen
Modified: 2017-12-30 14:30 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-12-30 14:30:38 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Peter Larsen 2016-01-28 21:30:43 UTC
Document URL: https://docs.openshift.com/enterprise/3.1/install_config/aggregate_logging.html

Section Number and Name: Pre-deployment (https://docs.openshift.com/enterprise/3.1/install_config/aggregate_logging.html#pre-deployment-configuration)

Describe the issue: 

The whole manual fails on several points by using vague and no guiding descriptions (such as saying "sufficient volumes for elasticsearch cluster storage) - what is sufficient? How would a user know?

The guide creates a projec which uses a --node-selector and has the following note:

"The selector in the example is optional. It can be used to specify a region or other selector you would like to use to restrict where the logging infrastructure deploys."

This does not significantly explain the purpose of the selector. The selector limits the nodes fluentd can use, ergo what nodes logging can be done on. The selector in other words, needs to select every node that will run pods which needs logging. Assuming a customer would understand at this point, that fluentd needs to run on every node that needs to aggregate logs is false.

Suggestions for improvement: 
Provide use cases for use of a selector. Ie. separate logging implementations, one for dev, one for prod etc. Or otherwise show why a selector would come in play. Otherwise, the default should be NOT to use a selector.

Additional information: 

The customer also needs to execute "oc project logging" after running the command. The following sections around service accounts and deployments needs to be tied to the namespace for logging.

Comment 1 Vikram Goyal 2017-12-30 14:30:38 UTC
Many updates have been made to this section, even in the 3.1 docs to address some of the concerns. I can no longer find the quoted texts.

If the issues persist, please create a new bug.

[1] https://docs.openshift.com/enterprise/3.1/install_config/aggregate_logging.html


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