Changes between Version 3 and Version 4 of Reporting_sssd_bugs


Ignore:
Timestamp:
09/03/15 13:47:56 (19 months ago)
Author:
pcech
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Reporting_sssd_bugs

    v3 v4  
    1 == How to file a useful SSSD bug report == 
     1[[PageOutline]] 
    22 
    3 Unfortunately, SSSD is not perfect and sometimes, you might encounter a bug. 
    4 This document describes how to file an SSSD bug report or an enhancement 
    5 request. Providing accurate and well formed information might help us find 
    6 the bug and ultimately fix it. As a bug reporter, you should work with us 
    7 on pinpointing the bug - we should then work with you on fixing the bug. 
     3= How to file a useful SSSD bug report = 
     4Unfortunately, SSSD is not perfect and sometimes, you might encounter a bug. This document describes how to file an SSSD bug report or an enhancement request. Providing accurate and well formed information might help us find the bug and ultimately fix it. As a bug reporter, you should work with us on pinpointing the bug - we should then work with you on fixing the bug. 
    85 
    9 === Where to file the bugs? === 
    10 You'll need a [https://admin.fedoraproject.org/accounts/ Fedora Account System] 
    11 login to file a bug. When you have one, navigate to 
    12 [https://fedorahosted.org/sssd/newticket the new ticket form]. 
     6== Where to file the bugs? == 
     7You'll need a [https://admin.fedoraproject.org/accounts/ Fedora Account System] login to file a bug. When you have one, navigate to [https://fedorahosted.org/sssd/newticket the new ticket form]. 
    138 
    14 === Help us reproduce the bug === 
    15 The easier for us is to see the flaw in our environment, the easier it is 
    16 to fix the bug. If we can't conclusively see the bug exist, it might even 
    17 be closed as NOTABUG. If the bug can't be reproduced easily, describe your 
    18 environment in detail and allow us more time to analyze your problem. 
     9Some bugs will be automatically cloned from distribution bug-trackers, such as ​http://bugzilla.redhat.com. People working with upstream code should file bugs directly in Trac.  
    1910 
    20 === Include necessary debugging data === 
     11== Help us reproduce the bug == 
     12The easier for us is to see the flaw in our environment, the easier it is to fix the bug. If we can't conclusively see the bug exist, it might even be closed as NOTABUG. If the bug can't be reproduced easily, describe your environment in detail and allow us more time to analyze your problem. 
     13 
     14== Include necessary debugging data == 
    2115For both bug reports and feature requests, select the type of the ticket to indicate if it's a bug report or an enhancement. 
    2216 
     
    2418    * One bug report per ticket. If you think you found multiple problems, file each one in a separate ticket 
    2519    * Search the ticket database for possible duplicates. If you find a duplicate, please add a comment saying that you encountered the problem as well. 
     20    * Is this a defect or an enhancement? (Tasks should be reserved for internal development tasks, such as creating unit tests.) 
     21    * Short summary. Good example is: "The LDAP provider segfaults when an invalid TLS certificate is specified". 
     22    * Component. Please select the SSSD component most accurate for your issue. This will ensure that the default assignee is set correctly. 
     23    * CC (optional). If there are other parties interested in a particular bug, please include their Fedora usernames here. 
    2624    * What platform are you on? Please provide operating system version and architecture. 
    27     * The SSSD version. On an RPM-based system, you can just run `rpm -q sssd`. 
     25    * The SSSD version. On an RPM-based system, you can just run `rpm -q sssd`. (If the bug is in the current working tree, select the most recent released version.) 
    2826    * The SSSD config file. Typically this would be located at `/etc/sssd/sssd.conf` 
    2927    * The SSSD log files with a high debug level Please see the [wiki:Troubleshooting troubleshooting page] on information on how to gather them and other 
     
    4240    * What are the results you expect? What were the results you see instead? Please be specific. A bad example is "My logins are slow". A much better example is "When a user who is a member of 100 groups logs in, his login takes 50 seconds even though a `kinit` and `id -G` for the same user are fast." 
    4341 
    44 Some data in the SSSD tickets are handled by the SSSD team members. Please leave Priority, Milestone and Assignee to their defaults. 
     42Some data in the SSSD tickets are handled by the SSSD team members. Please leave Priority, Milestone, Keywords and Assignee to their defaults. 
    4543 
    46 ==== Providing SSSD crash data ==== 
    47 In addition to the data described above, please also provide the coredump 
    48 and backtrace along with the bug report.  
     44=== Providing SSSD crash data === 
     45In addition to the data described above, please also provide the coredump and backtrace along with the bug report.  
    4946 
    50 If you are on a Fedora or RHEL system, abrt is a great tool for gathering 
    51 crash info. If abrt is not available, you can retrieve the core file and 
    52 backtrace manually. First, find out which sssd process is crashing. Please 
    53 always make sure you have the exact matching debuginfo package version 
    54 on your system. On Fedora and RHEL, you can easily install the debuginfo 
    55 packages with `debuginfo-install sssd`. Then, connect to the faulty process 
    56 with gdb and resume it: 
     47If you are on a Fedora or RHEL system, abrt is a great tool for gathering crash info. If abrt is not available, you can retrieve the core file and backtrace manually. First, find out which sssd process is crashing. Please always make sure you have the exact matching debuginfo package version on your system. On Fedora and RHEL, you can easily install the debuginfo packages with `debuginfo-install sssd`. Then, connect to the faulty process with gdb and resume it: 
    5748{{{ 
    5849    # gdb program $(pidof sssd_be) 
     
    7061Then attach the core file and the backtrace. 
    7162 
    72 ==== Mind your privacy ==== 
    73 Both the SSSD log files and the coredumps might include confidential 
    74 information. If you don't like them to be exposed in the SSSD Trac instance, 
    75 please contact some of the SSSD developers on the `#sssd` channel on !FreeNode 
    76 or on the [https://lists.fedorahosted.org/mailman/listinfo/sssd-users sssd-users] mailing list. 
     63=== Mind your privacy === 
     64Both the SSSD log files and the coredumps might include confidential information. If you don't like them to be exposed in the SSSD Trac instance, please contact some of the SSSD developers on the `#sssd` channel on !FreeNode or on the [https://lists.fedorahosted.org/mailman/listinfo/sssd-users sssd-users] mailing list. 
    7765 
    78 === Always test the latest available version === 
    79 SSSD moves at a rapid pace. It's not useful to file a bug report against 
    80 an old version, please upgrade to the latest release in the branch you're 
    81 running, if the branch is still active. You can find the tarballs on 
    82 our [wiki:Releases releases page]. If you're running an Enterprise or 
    83 Long-Term-Maintenance distribution and can't update to a newer version, 
    84 consider filing a bug report in your distribution bug tracker instead. 
     66== Always test the latest available version == 
     67SSSD moves at a rapid pace. It's not useful to file a bug report against an old version, please upgrade to the latest release in the branch you're running, if the branch is still active. You can find the tarballs on our [wiki:Releases releases page]. If you're running an Enterprise or Long-Term-Maintenance distribution and can't update to a newer version, consider filing a bug report in your distribution bug tracker instead. 
    8568 
    86 Alternatively, ask on the `#sssd` channel on !FreeNode. Several SSSD or 
    87 FreeIPA developers maintain private repositories with custom builds for 
    88 stable platforms. 
     69Alternatively, ask on the `#sssd` channel on !FreeNode. Several SSSD or FreeIPA developers maintain private repositories with custom builds for stable platforms. 
    8970 
    90 === Consider if the bug has security consequences === 
    91 If you think you found a bug that has security impact (allows an unprivileged 
    92 user to take down SSSD or elevate privileges for instance), '''don't''' 
    93 file the bug in a public bug tracker. Instead, e-mail any of the SSSD developers instead. 
    94  
     71== Consider if the bug has security consequences == 
     72If you think you found a bug that has security impact (allows an unprivileged user to take down SSSD or elevate privileges for instance), '''don't''' file the bug in a public bug tracker. Instead, e-mail any of the SSSD developers instead.