Diagnostic snapshot doesn't include instructions on how to navigate its contents

Bug #1401661 reported by Dmitry Borodaenko
12
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Fuel for OpenStack
Confirmed
Medium
Fuel Sustaining
Mitaka
Won't Fix
Medium
Fuel Python (Deprecated)
Newton
Confirmed
Medium
Fuel Sustaining

Bug Description

At the top level of the diagnostic snapshot there should be a plain text README that explains the directory structure of the snapshot, provides locations of most important information such as Fuel version, environment settings (astute.yaml), and basic troubleshooting hints such as how to identify nodes with specific roles in a given environment, how to correlate deployment logs, etc.

summary: Diagnostic snapshot doesn't include instructions on how to navigate its
- contens
+ contents
Changed in fuel:
status: New → Confirmed
Dmitry Pyzhov (dpyzhov)
tags: added: module-shotgun
removed: shotgun
Dmitry Pyzhov (dpyzhov)
Changed in fuel:
milestone: 6.1 → 7.0
Revision history for this message
Alexander Bozhenko (alexbozhenko) wrote :

@Dmitriy(Borodaenko), should we create note about snapshot in operations guide, instead of instruction in the snapshot itself?

Basically, to understand what snapshot contains one should look at template that is used for creating snapshot:
https://github.com/stackforge/fuel-web/blob/b1cb2f73c147c394fd6a7d91667f61859e6bc20a/nailgun/nailgun/settings.yaml#L643

tags: added: qa-agree-7.0
Revision history for this message
Alexander Bozhenko (alexbozhenko) wrote :

It probably should be assigned to documentation team, not "Fuel Python Team".

Revision history for this message
Aleksey Kasatkin (alekseyk-ru) wrote :

Documentation issue. Moved to 8.0.

tags: added: docs
Changed in fuel:
status: Confirmed → Won't Fix
Dmitry Pyzhov (dpyzhov)
no longer affects: fuel/8.0.x
Changed in fuel:
milestone: 7.0 → 8.0
status: Won't Fix → Confirmed
tags: added: tech-debt
Dmitry Pyzhov (dpyzhov)
tags: added: area-python
Dmitry Pyzhov (dpyzhov)
Changed in fuel:
milestone: 8.0 → 9.0
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.