Bug 1326560

Summary:	[Docs] [Op-Tools] RHOS8-OpTools guide needs guidance on dashboard viewing
Product:	Red Hat OpenStack	Reporter:	Summer Long <slong>
Component:	documentation	Assignee:	Radek Bíba <rbiba>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Suyog Sainkar <ssainkar>
Severity:	medium	Docs Contact:
Priority:	medium
Version:	8.0 (Liberty)	CC:	adahms, srevivo, ssainkar
Target Milestone:	ga	Keywords:	Documentation, ZStream
Target Release:	8.0 (Liberty)
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2016-05-30 11:26:28 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:

Description Summer Long 2016-04-13 04:20:42 UTC

Description of problem:
https://access.redhat.com/documentation/en/red-hat-openstack-platform/version-8/red-hat-openstack-platform-operational-tools

End of Chapter 2:
"You should now be able to access Kibana running at http://$FQDN_OF_LOGGING_SERVER/ and see logs start to populate. "

Except that you don't. With first access, you see the default Kibana page.
To use the logstash dashboard, you have to click on the 'here' link:
http://192.168.100.142/index.html#dashboard/file/logstash.json

Otherwise, you need to design your own dashboard. 

Actual results:
Default Kibana dashboard with Kibana branding, and no stats.

Expected results:
RH OpenStack dashboard with 'logs starting to populate'.  (Until this happens, when it's no longer tech preview?, we at least need to tell readers where to go and what to expect.)

Comment 2 Andrew Dahms 2016-04-13 04:30:26 UTC

Hi Summer,

Thank you for raising this bug.

Now assigning this bug to Radek for review.

Kind regards,

Andrew

Comment 3 Radek Bíba 2016-04-14 12:00:21 UTC

Yeah, right. The page reads:

===
Did you just upgrade? Not expecting this screen?

If you were using the old default page you might not be expecting this screen. I understand, change can be awkward. Let me explain.
Setting a global default dashboard

Kibana has always shipped with an interface for Logstash, still does! You can access it here. However, if you want to make it your default again, all you need to do is rename a file! In your Kibana installation directory:

Rename logstash.json to default.json and refresh. Should be all set.
===

So there are two options: change the URL to open, or add a penultimate step in which the user will be instructed to rename the file.

Comment 5 Summer Long 2016-04-15 22:36:24 UTC

Perfect, except for 'sadditional' :)
You might have them keep the originals just in case:
cp /usr/share/kibana/app/dashboards/default.json /usr/share/kibana/app/dashboards/default.json.orig
cp /usr/share/kibana/app/dashboards/logstash.json /usr/share/kibana/app/dashboards/default.json

Comment 6 Radek Bíba 2016-04-18 07:04:50 UTC

(In reply to Summer Long from comment #5)
> Perfect, except for 'sadditional' :)

I noticed that, too, and already fixed that. (That's what happens when you move words around in vim using p/P and fail to check where the words were actually pasted. :) )

> You might have them keep the originals just in case:
> cp /usr/share/kibana/app/dashboards/default.json
> /usr/share/kibana/app/dashboards/default.json.orig
> cp /usr/share/kibana/app/dashboards/logstash.json
> /usr/share/kibana/app/dashboards/default.json

Good point. I'll add that.

Thanks!

Comment 8 Andrew Dahms 2016-04-20 06:16:30 UTC

Changing the QA contact to Suyog.

Suyog - could you take a look at the changes for this bug?

Comment 10 Radek Bíba 2016-05-30 11:26:28 UTC

Content is already live at the Portal.