- Puppet 2.7 Cookbook
- John Arundel
- 252字
- 2021-04-02 18:19:59
Producing automatic HTML documentation
"An expert is someone who is one page ahead of you in the manual."—David Knight
Like most engineers, I never read the manual, unless and until the product actually catches fire. However, as your manifests get bigger and more complex, it can be helpful to create HTML documentation for your nodes and classes using Puppet's automatic documentation tool, puppet doc
.
How to do it…
Run puppet doc
over your manifest as follows:
puppet doc --all --outputdir=/var/www/html/puppet --mode rdoc --manifestdir=/etc/puppet/manifests/

How it works…
puppet doc
creates a structured HTML documentation tree in /var/www/html/puppet
similar to that produced by RDoc, the popular Ruby documentation generator. This makes it easier to understand how different parts of the manifest relate to one another, as you can click on an included class name and see its definition.
There's more…
puppet doc
will generate basic documentation of your manifests as they are at present. However, you can include more useful information by adding comments to your manifest files, using the standard RDoc syntax. Here's an example of some documentation comments added to a class:
class puppet { # This class sets up the Puppet client. # # ==Actions # Install a cron job to run Puppet. # # ==Requires # * Package["puppet"] # cron { "run-puppet": command => "/usr/sbin/puppet agent --test >/dev/null 2>&1", minute => inline_template("<%= hostname.hash.abs % 60 %>"), } }
Your comments are added to the documentation for each class in the resulting HTML files as shown in the following screenshot:

- Adobe創意大學After Effects CS5 產品專家認證標準教材
- EJB 3.0 Database Persistence with Oracle Fusion Middleware 11g
- Spring Web Flow 2 Web Development
- Authorware應用案例教程
- Excel 2013電子表格處理
- 中文版Maya 2014案例教程
- Cinema 4D電商美工與視覺設計案例教程(培訓教材版)
- WordPress Theme Design
- MATLAB 2022a從入門到精通
- 網店美工設計:Photoshop CC案例教程(視頻指導版)
- Midjourney商業設計完全教程
- 音樂制作7天速成:Cubase編曲教程
- Photoshop CC圖像處理案例教程(第2版)
- AI寫實人物繪畫關鍵詞圖鑒(Stable Diffusion版)
- AI純美人物繪畫關鍵詞圖鑒(Midjourney版)