Bug 1704873 - [DOCS] 'Verify the install' does not appear to be complete
Summary: [DOCS] 'Verify the install' does not appear to be complete
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.1.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: 4.1.0
Assignee: Michael Burke
QA Contact: Anping Li
Vikram Goyal
URL: https://docs.openshift.com/container-...
Whiteboard: 4.0_Readiness_Feedback
Depends On:
Blocks: 1664187
TreeView+ depends on / blocked
 
Reported: 2019-04-30 17:35 UTC by rvanderp
Modified: 2019-05-06 15:07 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-05-06 15:07:40 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

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


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