Bug 1704873

Summary: [DOCS] 'Verify the install' does not appear to be complete
Product: OpenShift Container Platform Reporter: rvanderp
Component: DocumentationAssignee: Michael Burke <mburke>
Status: CLOSED CURRENTRELEASE QA Contact: Anping Li <anli>
Severity: low Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: 4.1.0CC: aos-bugs, jokerman, mmccomas, vigoyal
Target Milestone: ---   
Target Release: 4.1.0   
Hardware: Unspecified   
OS: Unspecified   
URL: https://docs.openshift.com/container-platform/4.1/logging/efk-logging-deploying.html
Whiteboard: 4.0_Readiness_Feedback
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2019-05-06 15:07:40 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:
Bug Depends On:    
Bug Blocks: 1664187    

Description rvanderp 2019-04-30 17:35:00 UTC
Document URL: https://docs.openshift.com/container-platform/4.1/logging/efk-logging-deploying.html

Section Number and Name: 

'Verify the install'

Describe the issue: 

The section 'Verify the install' does not appear to be complete.  

`oc get pods -n openshift-logging` does show the desired pods but steps a/b/c appear to be demonstrating a workflow in the UI, not an interaction with oc.

Suggestions for improvement: 

Additional information:

Comment 1 Michael Burke 2019-05-01 17:41:24 UTC
Richard --

You are correct. In the docs, I used CLI output for show the list of pods that should appear in a properly deployed cluster logging environment. It seemed to me that screenshot of the pods at this point in the procedure would be too large. The screenshot would be more than one screen length long and quite wide to capture all of the information; where the list in the CLI is significantly smaller.

I added a disclaimer of sorts before the CLI output: "You should see pods for cluster logging, Elasticsearch, and Fluentd, as shown in the following CLI output"

I wonder if a simple list would be less confusing? 

You should see pods similar to the following list:
* cluster-logging-operator-cb795f8dc-xkckc
* elasticsearch-cdm-b3nqzchd-1-5c6797-67kfz
* elasticsearch-cdm-b3nqzchd-2-6657f4-wtprv
* elasticsearch-cdm-b3nqzchd-3-588c65-clg7g
* fluentd-2c7dg
* fluentd-9z7kk
* fluentd-br7r2
* fluentd-fn2sb
* fluentd-pb2f8
* fluentd-zqgqx
* kibana-7fb4fd4cc9-bvt4p

cc Vikram

Comment 2 Vikram Goyal 2019-05-02 02:51:34 UTC
Agree - we don't need screenshot but the description as is is confusing. The list with a text of the content that users can expect should work.

Comment 3 rvanderp 2019-05-02 16:49:13 UTC
Hi Michael -

OK, that makes sense to me.  I like the change you are proposing.

Richard