Bug 1380740

Summary: [RFE] Write a troubleshooting guide for Satellite 6
Product: Red Hat Satellite Reporter: Stefan Nemeth <snemeth>
Component: DocumentationAssignee: Marie Hornickova <mdolezel>
Documentation sub component: default QA Contact:
Status: CLOSED WONTFIX Docs Contact:
Severity: medium    
Priority: low CC: adahms, ahumbe, aperotti, bkearney, daniele, dconsoli, dvoss, mawerner, mdolezel, mmccune, ryandeussing, sjalgaon, snemeth
Version: 6.2.2Keywords: FutureFeature, Triaged
Target Milestone: UnspecifiedFlags: bkearney: needinfo? (mmccune)
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: multiple-titles
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2022-08-08 20:46:21 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:
Bug Depends On:    
Bug Blocks: 1353215, 1399395    

Description Stefan Nemeth 2016-09-30 12:48:51 UTC
Describe the issue: 

write a troubleshooting guide for satellite 6 with best practices, describe components and their logs. 

some basic troubleshooting practices, guidelines to follow...

Comment 1 Andrew Dahms 2016-12-08 04:03:03 UTC
Assigning to Russell for review.

Comment 12 Steve Bream 2017-12-11 22:13:02 UTC
Hi Russell,

To try to answer your questions:

* I think that the scale should be relatively modest. We already have a large set of articles to help customers troubleshoot their issues. A troubleshooting guide would necessarily be a distillation of those articles into a a subset of common problems that present themselves similarly and have an established resolution that's simple enough for customers to do it unaided.
* I think that it makes more sense to include a "troubleshooting" section in each guide, to help users fix the problems they've encountered during one process before moving to the next. This also lets us start small by adding troubleshooting for one process at a time (I suggest the virtualization guide as a start)
* I think that we need to keep the troubleshooting work relatively low-effort. I see it as working with GSS to identify the kinds of issues I mentioned in the first bullet and including the symptoms and resolution steps, not as a comprehensive guide to what can go wrong with Satellite and how to fix it.

Does that make sense?

Thanks,
Steve

Comment 13 Daniele Palumbo 2017-12-11 22:29:46 UTC
Hi Steve,

I do not have full visibility over the bug, seems.

I think that the two main topic has to be addressed:
1) a list of common commands to be performed in case of issue (like katello-service restart, df -h, ...);
2) a set of command that, with a positive match, will address to the solution already written.

My 2 cents,
Daniele

Comment 14 Andrew Dahms 2018-10-02 09:50:10 UTC
Returning to the default assignee and status 'NEW' to be triaged again as the schedule and priorities allow.