Note: This is a beta release of Red Hat Bugzilla 5.0. The data contained within is a snapshot of the live data so any changes you make will not be reflected in the production Bugzilla. Also email is disabled so feel free to test any aspect of the site that you want. File any problems you find or give feedback here.
Bug 1684448 - Curator pod shouldn't be displayed in output of oc get pods
Summary: Curator pod shouldn't be displayed in output of oc get pods
Keywords:
Status: NEW
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.11.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: ---
Assignee: Vikram Goyal
QA Contact: Xiaoli Tian
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-03-01 10:02 UTC by Jan Zmeskal
Modified: 2019-03-01 10:02 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Target Upstream Version:


Attachments (Terms of Use)

Description Jan Zmeskal 2019-03-01 10:02:03 UTC
Document URL: https://docs.openshift.com/container-platform/3.11/install_config/aggregate_logging.html#deploying-the-efk-stack

Section Number and Name: Deploying the EFK Stack

Describe the issue: In the referenced section, the is a figure with output of command "oc get pods -w". One of the pods that's visible in the output is logging-curator-1541129400-l5h77. This is however quite misleading. The reason is that curator pod is not created alongside other pods of EFK stack by design. Instead, the pod is controlled by OpenShift cronjob that can be acquired like this: oc get cronjob -n openshift-logging -l component=curator.
By default, the actual pod is only created once a day at 3:30 AM and does its thing. Then it stays in the pod listing with Completed status until deleted. So, to bottom line it: It would be very big coincidence if the user actually saw what the documentation displays. They will see such output only if they run their deployment around 3:30 AM. In all the other cases, they won't see the curator pod at all and might be confused why that happens.

Suggestions for improvement: I think it would be good to remove the curator pod from the output and ideally also explain that user should not worry if they don't see it, since it's controlled by a cronjob. We could also reference section about curator where the implementation is explained: https://docs.openshift.com/container-platform/3.11/install_config/aggregate_logging.html#configuring-curator

Additional information: I am reporting this bug after experienced such troubles myself. You can see BZ1684053 for reference.


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