Project

General

Profile

Puppet class browser » History » Version 4

Paul Kelly, 09/22/2010 11:41 AM

1 1 Paul Kelly
h1. Puppet class browser
2
3
There are links labeled "Documentation" on the *settings/puppet classes* page, which will direct your browser to the html documentation for a particular puppet module.
4
5
The documentation is generated by a rake task that uses the puppetdoc utility and may need some customization to work at a particular site.
6
7
h2. Configuration
8
9
h3. Document root
10
11 3 Paul Kelly
There is an optional entry in the config/settings.yaml which overrides the location of the generated HTML pages. The default value is *RAILS_ROOT/public* which relies upon the rails built-in web server.
12 1 Paul Kelly
<pre>
13
:document_root: /var/www
14
</pre>
15
16 3 Paul Kelly
The documentation will be written into *document_root*/puppet/rdoc and this location must be in an area that is served by a web server. Any location that is served by apache or webrick/mongrel will do, and foreman's *public* directory is the default.
17 1 Paul Kelly
18
h3. manifest cleanup
19
20 4 Paul Kelly
The puppetdoc utility is sensitive to the layout of the manifests and modules directories. In particular, it cannot handle circular or broken symlinks. If you have problems running puppetdoc then move *extras/rdoc/rdoc_prepare_script.rb* to *scripts/rdoc_prepare_script.rb* and then edit it to suit your site. Most sites will not require a *scripts/rdoc_prepare_script.rb* file.
21 1 Paul Kelly
22
h2. Generating the documentation.
23
24
h3. Simple case
25
26
This is performed by running
27
28
 rake puppet:rdoc:generate
29
30
h3. Complex case
31
32 2 Paul Kelly
If the puppetdoc utility fails to process your manifests then you will have to sanitize your puppet modules directory. The rake puppet:rdoc:generate task will check for the existence of *scripts/rdoc_prepare_script.rb*, and runs this before the the puppetdoc command is executed. This script is expected to copy the source files for your modules to another location, fix any issues and then terminate, passing back the location of the copied directory tree. 
33 1 Paul Kelly
34
A fairly complex example is provided in *extras/rdoc/rdoc_prepare_script.rb*. 
35
36
The final command to generate the documentation is then the same as for the simple case
37
38
 rake puppet:rdoc:generate
39 4 Paul Kelly
40
h3. Automation
41
42
This rake task is suitable for placing in a cron job and can be added with
43
44
  sudo cron -e -u root
45
46
and a line added like this
47
48
  22 2 * * * (cd /var/rails/foreman; rake puppet:rdoc:generate)
49
50
Note that this command assumes that root has write permissions to */var/rails/foreman/public/puppet/rdoc* or wherever you have set *document_root* to in config/settings.yml
51
52
h3. Running the command as a non root user
53
54
You may experience some problems when running this command, (or other puppet commands,) as a non root user as puppet will change its default values for several key parameters to a location in the user's home directory.
55
56
If you run 
57
58
  puppet --genconfig | egrep $USER
59
60
you will see what I mean. 
61
62
Running
63
64
 ln -s /etc/puppet/puppet.conf ~/.puppet/puppet.conf 
65
66
helps somewhat but beware of this feature