diff options
| -rw-r--r-- | documentation/Rakefile | 4 | ||||
| -rw-r--r-- | documentation/reference/configref.page | 16 | ||||
| -rw-r--r-- | documentation/reference/functions.page | 6 | ||||
| -rw-r--r-- | documentation/reference/reports.page | 5 | ||||
| -rw-r--r-- | documentation/reference/typedocs.page | 28 |
5 files changed, 32 insertions, 27 deletions
diff --git a/documentation/Rakefile b/documentation/Rakefile index 640a7cf5d..6bfe4d239 100644 --- a/documentation/Rakefile +++ b/documentation/Rakefile @@ -38,14 +38,14 @@ docs.each do |doc| task doc do docs = %x{puppetdoc --mode #{doc}} - header = "documentation/reference/%s.header" % doc + header = "reference/%s.header" % doc if FileTest.exists?(header) headertext = File.read(header) else headertext = "" end - file = "documentation/reference/%s.page" % doc + file = "reference/%s.page" % doc puts "Creating %s" % file File.open(file, "w") do |f| diff --git a/documentation/reference/configref.page b/documentation/reference/configref.page index c554f0bd3..d3081fe0c 100644 --- a/documentation/reference/configref.page +++ b/documentation/reference/configref.page @@ -184,6 +184,10 @@ The configuration file for puppetdoc. ``/etc/puppet/puppetdoc.conf`` Print the value of a specific configuration parameter. If a parameter is provided for this, then the value is printed and puppet exits. Comma-separate multiple values. For a list of all values, specify 'all'. This feature is only available in Puppet versions higher than 0.18.4. +#### <a name="configtimeout">configtimeout</a> (<em>puppetd</em>) + +How long the client should wait for the configuration to be retrieved before considering it a failure. This can help reduce flapping if too many clients contact the server at one time. ``30`` + #### <a name="csrdir">csrdir</a> (<em>ca</em>) Where the CA stores certificate requests ``/etc/puppet/ssl/ca/requests`` @@ -216,6 +220,10 @@ The database server for Client caching. Only used when networked databases are u The database user for Client caching. Only used when networked databases are used. ``puppet`` +#### <a name="downcasefacts">downcasefacts</a> (<em>puppetd</em>) + +Whether facts should be made all lowercase when sent to the server. + #### <a name="evaltrace">evaltrace</a> (<em>transaction</em>) Whether each resource should log when it is being evaluated. This allows you to interactively see exactly what is being done. @@ -356,10 +364,6 @@ Where each client stores the CA certificate. ``/etc/puppet/ssl/certs/ca.pem`` Where puppetd caches the local configuration. An extension indicating the cache format is added automatically. ``/etc/puppet/localconfig`` -#### <a name="lockdir">lockdir</a> (<em>puppet</em>) - -Where lock files are kept. ``/var/puppet/locks`` - #### <a name="logdir">logdir</a> (<em>puppet</em>) The Puppet log directory. ``/var/puppet/log`` @@ -494,7 +498,7 @@ How often RRD should expect data. This should match how often the hosts report b #### <a name="rundir">rundir</a> (<em>puppet</em>) -Where Puppet PID files are kept. ``/var/puppet/run`` +Where Puppet PID files are kept. ``/var/run/puppet`` #### <a name="runinterval">runinterval</a> (<em>puppetd</em>) @@ -569,4 +573,4 @@ Where Puppet stores dynamic and growing data. ``/var/puppet`` ---------------- -*This page autogenerated on Fri Jan 05 16:38:58 CST 2007* +*This page autogenerated on Fri Jan 26 16:40:43 CST 2007* diff --git a/documentation/reference/functions.page b/documentation/reference/functions.page index b926b75c3..ad2c03f5a 100644 --- a/documentation/reference/functions.page +++ b/documentation/reference/functions.page @@ -19,7 +19,7 @@ Here are the functions available in Puppet: * **debug** (*statement*): Log a message on the server at level debug. -* **defined** (*rvalue*): Determine whether a given type is defined, either as a native type or a defined type. +* **defined** (*rvalue*): Determine whether a given type is defined, either as a native type or a defined type, or whether a resource has been specified. If you are checking with a resource is defined, use the normal resource reference syntax, e.g., ``File['/etc/passwd']``. * **emerg** (*statement*): Log a message on the server at level emerg. @@ -39,7 +39,7 @@ Here are the functions available in Puppet: * **tagged** (*rvalue*): A boolean function that tells you whether the current container is tagged with the specified tags. The tags are ANDed, so thta all of the specified tags must be included for the function to return true. -* **template** (*rvalue*): Evaluate a template and return its value. See [the templating docs](../advanced/templating.html) for more information. Note that if multiple templates are specified, their output is all concatenated and returned as the output of the function. +* **template** (*rvalue*): Evaluate a template and return its value. See [the templating docs](/trac/puppet/wiki/PuppetTemplating) for more information. Note that if multiple templates are specified, their output is all concatenated and returned as the output of the function. * **warning** (*statement*): Log a message on the server at level warning. @@ -48,4 +48,4 @@ Here are the functions available in Puppet: ---------------- -*This page autogenerated on Fri Jan 05 16:39:02 CST 2007* +*This page autogenerated on Fri Jan 26 16:40:49 CST 2007* diff --git a/documentation/reference/reports.page b/documentation/reference/reports.page index 5b0f2b3b7..0319589ae 100644 --- a/documentation/reference/reports.page +++ b/documentation/reference/reports.page @@ -50,7 +50,8 @@ default report). This report sends specific log messages to specific email addresses based on the tags in the log messages. See the -[tag documentation](../advanced/tags.html) for more information on tags. +[tag documentation](/trac/puppet/wiki/UsingTags) for more information +on tags. To use this report, you must create a ``tagmail.conf`` (in the location specified by ``tagmap``). This is a simple file that maps tags to @@ -78,4 +79,4 @@ webservers that are not also from mailservers to ``httpadmins@domain.com``. ---------------- -*This page autogenerated on Fri Jan 05 16:39:01 CST 2007* +*This page autogenerated on Fri Jan 26 16:40:48 CST 2007* diff --git a/documentation/reference/typedocs.page b/documentation/reference/typedocs.page index 18d7d3163..3fff7ff70 100644 --- a/documentation/reference/typedocs.page +++ b/documentation/reference/typedocs.page @@ -566,7 +566,7 @@ for file copying, but it can also be used to monitor files somewhat like Tripwire without managing the file contents in any way. You can specify that a file's checksum should be monitored and then subscribe to the file from another object and receive events to signify -checksum changes, for instance. Valid values are ``time``, ``timestamp``, ``md5lite``, ``md5``, ``mtime``, ``nosum``. Values can also match ``(?-mix:^\{md5|md5lite|timestamp|mtime|time\})``. +checksum changes, for instance. Valid values are ``time``, ``md5lite``, ``nosum``, ``timestamp``, ``md5``, ``mtime``. Values can also match ``(?-mix:^\{md5|md5lite|timestamp|mtime|time\})``. #### content Specify the contents of a file as a string. Newlines, tabs, and @@ -587,7 +587,7 @@ kind of limited templating: } This attribute is especially useful when used with - [templating](templating.html). + [templating](/trac/puppet/wiki/PuppetTemplating). #### ensure Whether to create files that don't currently exist. @@ -823,7 +823,7 @@ seldom need to specify this -- Puppet will usually discover the appropriate provider for your platform. Available providers are: * **groupadd**: Group management via ``groupadd`` and its ilk. The default - for most platforms Required binaries: ``groupadd``, ``groupdel``, ``groupmod``. + for most platforms Required binaries: ``groupadd``, ``groupmod``, ``groupdel``. * **netinfo**: Group management using NetInfo. Default for ``operatingsystem`` == ``darwin``. Required binaries: ``nireport``, ``niutil``. * **pw**: Group management via ``pw``. Only works on FreeBSD. Default for ``operatingsystem`` == ``freebsd``. Required binaries: ``/usr/sbin/pw``. @@ -862,7 +862,7 @@ seldom need to specify this -- Puppet will usually discover the appropriate provider for your platform. Available providers are: * **netinfo**: Host management in NetInfo. This provider is highly experimental and is known - not to work currently. Default for ``operatingsystem`` == ``darwin``. Required binaries: ``nireport``, ``mount``, ``niutil``, ``umount``, ``df``. + not to work currently. Default for ``operatingsystem`` == ``darwin``. Required binaries: ``nireport``, ``mount``, ``niutil``, ``df``, ``umount``. * **parsed**: #### target @@ -932,8 +932,8 @@ seldom need to specify this -- Puppet will usually discover the appropriate provider for your platform. Available providers are: * **netinfo**: Mount management in NetInfo. This provider is highly experimental and is known - not to work currently. Default for ``operatingsystem`` == ``darwin``. Required binaries: ``nireport``, ``mount``, ``niutil``, ``umount``, ``df``. -* **parsed**: Required binaries: ``mount``, ``umount``, ``df``. + not to work currently. Default for ``operatingsystem`` == ``darwin``. Required binaries: ``nireport``, ``mount``, ``niutil``, ``df``, ``umount``. +* **parsed**: Required binaries: ``mount``, ``df``, ``umount``. #### target The file in which to store the mount table. Only used by @@ -1070,24 +1070,24 @@ appropriate provider for your platform. Available providers are: extremely quirky packaging system, in that it freely mixes between ports and packages. Apparently all of the tools are written in Ruby, so there are plans to rewrite this support to directly use those - libraries. Required binaries: ``/usr/sbin/pkg_add``, ``/usr/sbin/pkg_delete``, ``/usr/sbin/pkg_info``. + libraries. Required binaries: ``/usr/sbin/pkg_info``, ``/usr/sbin/pkg_add``, ``/usr/sbin/pkg_delete``. * **gem**: Ruby Gem support. By default uses remote gems, but you can specify the path to a local gem via ``source``. Required binaries: ``gem``. -* **openbsd**: OpenBSD's form of ``pkg_add`` support. Default for ``operatingsystem`` == ``openbsd``. Required binaries: ``pkg_add``, ``pkg_delete``, ``pkg_info``. -* **pkgdmg**: Package management based on Apple's Installer.app and DiskUtility.app Required binaries: ``/usr/sbin/installer``, ``/usr/bin/hdiutil``. +* **openbsd**: OpenBSD's form of ``pkg_add`` support. Default for ``operatingsystem`` == ``openbsd``. Required binaries: ``pkg_info``, ``pkg_add``, ``pkg_delete``. +* **pkgdmg**: Package management based on Apple's Installer.app and DiskUtility.app Required binaries: ``/usr/sbin/installer``, ``/usr/bin/hdiutil``, ``/usr/bin/curl``. * **portage**: Provides packaging support for Gentoo's portage system. Default for ``operatingsystem`` == ``gentoo``. Required binaries: ``/usr/bin/emerge``, ``/usr/bin/eix``. * **ports**: Support for FreeBSD's ports. Again, this still mixes packages - and ports. Default for ``operatingsystem`` == ``freebsd``. Required binaries: ``/usr/local/sbin/portversion``, ``/usr/local/sbin/pkg_deinstall``, ``/usr/sbin/pkg_info``, ``/usr/local/sbin/portupgrade``. + and ports. Default for ``operatingsystem`` == ``freebsd``. Required binaries: ``/usr/local/sbin/portupgrade``, ``/usr/local/sbin/portversion``, ``/usr/local/sbin/pkg_deinstall``, ``/usr/sbin/pkg_info``. * **rpm**: RPM packaging support; should work anywhere with a working ``rpm`` binary. Required binaries: ``rpm``. * **sun**: Sun's packaging system. Requires that you specify the source for - the packages you're managing. Default for ``operatingsystem`` == ``solaris``. Required binaries: ``/usr/sbin/pkgadd``, ``/usr/bin/pkginfo``, ``/usr/sbin/pkgrm``. + the packages you're managing. Default for ``operatingsystem`` == ``solaris``. Required binaries: ``/usr/bin/pkginfo``, ``/usr/sbin/pkgrm``, ``/usr/sbin/pkgadd``. * **sunfreeware**: Package management using sunfreeware.com's ``pkg-get`` command on Solaris. At this point, support is exactly the same as ``blastwave`` support and has not actually been tested. Required binaries: ``pkg-get``. * **up2date**: Support for Red Hat's proprietary ``up2date`` package update mechanism. Default for ``operatingsystem`` == ``redhat``. Required binaries: ``/usr/sbin/up2date-nox``. -* **yum**: Support via ``yum``. Default for ``operatingsystem`` == ``fedora``. Required binaries: ``yum``, ``rpm``. +* **yum**: Support via ``yum``. Default for ``operatingsystem`` == ``fedoracentos``. Required binaries: ``yum``, ``rpm``. #### responsefile A file containing any necessary answers to questions asked by @@ -1568,7 +1568,7 @@ appropriate provider for your platform. Available providers are: * **netinfo**: User management in NetInfo. Default for ``operatingsystem`` == ``darwin``. Required binaries: ``nireport``, ``niutil``. * **pw**: User management via ``pw`` on FreeBSD. Default for ``operatingsystem`` == ``freebsd``. Required binaries: ``pw``. -* **useradd**: User management via ``useradd`` and its ilk. Required binaries: ``useradd``, ``userdel``, ``usermod``. +* **useradd**: User management via ``useradd`` and its ilk. Required binaries: ``useradd``, ``usermod``, ``userdel``. #### shell The user's login shell. The shell must exist and be @@ -1772,4 +1772,4 @@ so Puppet only checks for it at that time. ---------------- -*This page autogenerated on Fri Jan 05 16:38:59 CST 2007* +*This page autogenerated on Fri Jan 26 16:40:46 CST 2007* |