官术网_书友最值得收藏!

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:

主站蜘蛛池模板: 大庆市| 齐河县| 达尔| 葫芦岛市| 岱山县| 公主岭市| 阿鲁科尔沁旗| 崇明县| 中阳县| 古浪县| 灵石县| 崇州市| 京山县| 图们市| 宁强县| 孟津县| 乌兰察布市| 南开区| 云霄县| 乌鲁木齐县| 登封市| 大荔县| 抚顺市| 礼泉县| 石台县| 共和县| 溧阳市| 彰武县| 穆棱市| 和林格尔县| 罗山县| 晋江市| 桂阳县| 金堂县| 舒城县| 汽车| 北宁市| 蓝田县| 射洪县| 济南市| 高邑县|