Getting Help

Version 8 (eric sorenson, 01/19/2011 07:20 pm)

1 1
# Getting Help
2 1
3 5 eric sorenson
Puppet has a healthy community full of people who are happy to help you get unstuck, but the community works best if you know how it works. If you run into trouble with puppet, here's a guide to getting help. These steps are listed more or less in order of how your troubleshooting flow should go.
4 1
5 5 eric sorenson
## Self-directed Troubleshooting
6 1
7 5 eric sorenson
Puppet has a relatively long history and open development process for an open-source project, so there is a ton of information returned from google searches for various problems. To narrow down your results to the most relevant, try these google tips:
8 1
9 5 eric sorenson
* restrict your search to `site:projects.puppetlabs.com` - this will cut out the old Trac / reductivelabs wiki and get you more recent hits
10 5 eric sorenson
* join the [puppet-users google group](http://groups.google.com/group/puppet-users) and use the search box on the group page to search the mailing list. this eliminates duplicate hits from ML mirrors like nabble and lets you order results by date so you aren't getting confused by a bug that was fixed three versions ago.
11 5 eric sorenson
* use correct Puppet-specific terminology for your problem like `yum provider`, `file resource`, and `manifest`
12 1
13 7 James Turnbull
Many general questions about Puppet and Puppet Labs are answered in the [[Frequently Asked Questions]] . Otherwise, the [[Documentation Start]] is the place to go.  There are a number of presentations and articles about Puppet
14 8 eric sorenson
available on the [[Publications]] page. Also available is ["Pulling Strings with Puppet"](http://www.amazon.com/gp/product/1590599780?ie=UTF8&tag=puppet0e-20&linkCode=as2&camp=1789&creative=9325&creativeASIN=1590599780) by James Turnbull which is the first book to be written about Puppet and its sequel ["Pro Puppet"](http://www.amazon.com/gp/product/1430230576?ie=UTF8&tag=puppet0e-20&linkCode=as2&camp=1789&creative=390957&creativeASIN=1430230576).
15 1
16 5 eric sorenson
## IRC (Internet Relay Chat)
17 1
18 5 eric sorenson
A great place to get real-time help with Puppet is our IRC channel: [#puppet on irc.freenode.net](irc://irc.freenode.net/puppet). There are usually many helpful people there in addition to some of the Puppetlabs staff.
19 1
20 6 eric sorenson
Please read and understand this [fantastic guide to getting help for open-source projects on irc](http://workaround.org/getting-help-on-irc) before diving in.  All of the points there apply to #puppet, especially "Don't repeat yourself", "Don't ask to ask", and "Stick around". #puppet in particular has heavy concentrations of people in UK (GMT) and West-coast US (PST), so asking your question when those time zones are in business hours is more likely to get a good result.
21 1
22 5 eric sorenson
Be aware that the IRC channel is *not an official support channel*, it's an ad hoc group of people (some of whom work on puppet for a living) self-organizing to help each other out.  If you do not receive an answer to your question, (especially if you have not followed the [getting help on irc best practices](http://workaround.org/getting-help-on-irc)!!), that doesn't mean you are out of options, the software is hopelessly broken, or your problem is insoluble. It just means you need to keep troubleshooting.
23 1
24 5 eric sorenson
## Mailing lists
25 1
26 5 eric sorenson
-   [Puppet User](http://groups.google.com/group/puppet-users): The Puppet users mailing list, for any and all Puppet discussion. 
27 5 eric sorenson
-   [Puppet Developer](http://groups.google.com/group/puppet-dev): The Puppet-dev mailing list, for all public discussions related to the development of the puppet codebase.
28 5 eric sorenson
-   [Puppet Announcements](http://groups.google.com/group/puppet-announce):  A read-only list containing announcements related to Puppet, e.g.;  major version releases
29 1
-   [Puppet Bugs](http://groups.google.com/group/puppet-bugs): A read-only list that gets a copy of all project ticket activity.
30 1
-   [Puppet Commits](http://groups.google.com/group/puppet-commit):  A (defunct? appears to have stopped updating Sep 2010) read-only list that gets a copy of all git source code commits.
31 1
32 7 James Turnbull
To subscribe to any of these lists from a normal (i.e., non-Google) account, just email the list address with +subscribe tacked onto the list name (e.g. puppet-users+subscribe@googlegroups.com).
33 1
34 5 eric sorenson
## Ticketing and Bug Tracking
35 5 eric sorenson
36 5 eric sorenson
You can lodge bug reports and support tickets for Puppet at the [Redmine ticketing system](http://projects.puppetlabs.com/projects/show/puppet). In order to cut down on ticket spam, the tracker requires you to register and log in before the "New issue" link appears in the UI:
37 5 eric sorenson
38 5 eric sorenson
![New issue](new_issue.jpg)
39 5 eric sorenson
40 5 eric sorenson
All of the general [How to File a Good Bug Report](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) guidelines apply here. 
41 5 eric sorenson
42 5 eric sorenson
## Commercial Support
43 5 eric sorenson
44 5 eric sorenson
Puppet Labs continues the development of Puppet by providing commercial [services](http://puppetlabs.com/services.html) for it. These services include commercial support, installation consulting, training, and developer support. Please [contact us](mailto:info@puppetlabs.com) for more information. If you have a significant feature enhancement or a bug that is non-trivial to fix and/or highly specific to your environment, paid-for support is an excellent way to get your voice heard.  Ultimately, this is the only option for getting help that has a "Service Level Agreement" type of guarantee attached to it.