diff options
| author | James Turnbull <james@lovedthanlost.net> | 2010-08-12 09:28:36 +1000 |
|---|---|---|
| committer | Markus Roberts <Markus@reality.com> | 2010-08-11 22:19:35 -0700 |
| commit | 1157e8dbaf310cca6f56dda3fa9f100b458662ee (patch) | |
| tree | d81cf0c9e21d99cc2d0ed24cbaddd23de9d7462d /lib/puppet | |
| parent | fef8800acaddd54659602b65bd9fdc728d187c67 (diff) | |
| download | puppet-1157e8dbaf310cca6f56dda3fa9f100b458662ee.tar.gz puppet-1157e8dbaf310cca6f56dda3fa9f100b458662ee.tar.xz puppet-1157e8dbaf310cca6f56dda3fa9f100b458662ee.zip | |
Updated all types to Markdown output
Updated defaults.rb to Markdown
Migrated report documentation to Markdown
Migrated Naginator doco to Markdown
Updated provider documentation to Markdown
Diffstat (limited to 'lib/puppet')
68 files changed, 410 insertions, 445 deletions
diff --git a/lib/puppet/defaults.rb b/lib/puppet/defaults.rb index 028f9118c..318ff416b 100644 --- a/lib/puppet/defaults.rb +++ b/lib/puppet/defaults.rb @@ -2,11 +2,11 @@ module Puppet setdefaults(:main, :confdir => [Puppet.run_mode.conf_dir, "The main Puppet configuration directory. The default for this parameter is calculated based on the user. If the process - is running as root or the user that ``puppet master`` is supposed to run as, it defaults to a system directory, but if it's running as any other user, - it defaults to being in ``~``."], + is running as root or the user that `puppet master` is supposed to run as, it defaults to a system directory, but if it's running as any other user, + it defaults to being in `~`."], :vardir => [Puppet.run_mode.var_dir, "Where Puppet stores dynamic and growing data. The default for this parameter is calculated specially, like `confdir`_."], :name => [Puppet.application_name.to_s, "The name of the application, if we are running as one. The - default is essentially $0 without the path or ``.rb``."], + default is essentially $0 without the path or `.rb`."], :run_mode => [Puppet.run_mode.name.to_s, "The effective 'run mode' of the application: master, agent, or user."] ) @@ -44,8 +44,8 @@ module Puppet specify 'all'. This feature is only available in Puppet versions higher than 0.18.4."], :color => ["ansi", "Whether to use colors when logging to the console. - Valid values are ``ansi`` (equivalent to ``true``), ``html`` (mostly - used during testing with TextMate), and ``false``, which produces + Valid values are `ansi` (equivalent to `true`), `html` (mostly + used during testing with TextMate), and `false`, which produces no color."], :mkusers => [false, "Whether to create the necessary user and group that puppet agent will @@ -92,18 +92,18 @@ module Puppet :authconfig => [ "$confdir/namespaceauth.conf", "The configuration file that defines the rights to the different namespaces and methods. This can be used as a coarse-grained - authorization system for both ``puppet agent`` and ``puppet master``." + authorization system for both `puppet agent` and `puppet master`." ], :environment => {:default => "production", :desc => "The environment Puppet is running in. For clients - (e.g., ``puppet agent``) this determines the environment itself, which - is used to find modules and much more. For servers (i.e., ``puppet master``) this provides the default environment for nodes + (e.g., `puppet agent`) this determines the environment itself, which + is used to find modules and much more. For servers (i.e., `puppet master`) this provides the default environment for nodes we know nothing about." }, :diff_args => ["-u", "Which arguments to pass to the diff command when printing differences between files."], :diff => ["diff", "Which diff command to use when printing differences between files."], :show_diff => [false, "Whether to print a contextual diff when files are being replaced. The diff is printed on stdout, so this option is meaningless unless you are running Puppet interactively. - This feature currently requires the ``diff/lcs`` Ruby library."], + This feature currently requires the `diff/lcs` Ruby library."], :daemonize => { :default => true, :desc => "Send the process into the background. This is the default.", :short => "D" @@ -135,7 +135,7 @@ module Puppet :queue_source => ["stomp://localhost:61613/", "Which type of queue to use for asynchronous processing. If your stomp server requires authentication, you can include it in the URI as long as your stomp client library is at least 1.1.1"], :async_storeconfigs => {:default => false, :desc => "Whether to use a queueing system to provide asynchronous database integration. - Requires that ``puppetqd`` be running and that 'PSON' support for ruby be installed.", + Requires that `puppetqd` be running and that 'PSON' support for ruby be installed.", :hook => proc do |value| if value # This reconfigures the terminii for Node, Facts, and Catalog @@ -266,7 +266,6 @@ module Puppet to all clients. If enabled, CA chaining will almost definitely not work."] ) - setdefaults( :ca, :ca_name => ["$certname", "The name to use the Certificate Authority certificate."], @@ -385,7 +384,7 @@ module Puppet :manifestdir => ["$confdir/manifests", "Where puppet master looks for its manifests."], :manifest => ["$manifestdir/site.pp", "The entry-point manifest for puppet master."], :code => ["", "Code to parse directly. This is essentially only used - by ``puppet``, and should only be set if you're writing your own Puppet + by `puppet`, and should only be set if you're writing your own Puppet executable"], :masterlog => { :default => "$logdir/puppetmaster.log", :owner => "service", @@ -419,7 +418,7 @@ module Puppet :rest_authconfig => [ "$confdir/auth.conf", "The configuration file that defines the rights to the different rest indirections. This can be used as a fine-grained - authorization system for ``puppet master``." + authorization system for `puppet master`." ], :ca => [true, "Wether the master should function as a certificate authority."], :modulepath => {:default => "$confdir/modules:/usr/share/puppet/modules", @@ -427,7 +426,7 @@ module Puppet directories.", :type => :setting }, # We don't want this to be considered a file, since it's multiple files. :ssl_client_header => ["HTTP_X_CLIENT_DN", "The header containing an authenticated client's SSL DN. Only used with Mongrel. This header must be set by the proxy - to the authenticated client's SSL DN (e.g., ``/CN=puppet.puppetlabs.com``). + to the authenticated client's SSL DN (e.g., `/CN=puppet.puppetlabs.com`). See http://projects.puppetlabs.com/projects/puppet/wiki/Using_Mongrel for more information."], :ssl_client_verify_header => ["HTTP_X_CLIENT_VERIFY", "The header containing the status message of the client verification. Only used with Mongrel. This header must be set by the proxy @@ -441,7 +440,7 @@ module Puppet :desc => "The directory in which serialized data is stored, usually in a subdirectory."}, :reports => ["store", "The list of reports to generate. All reports are looked for - in puppet/reports/name.rb, and multiple report names should be + in `puppet/reports/name.rb`, and multiple report names should be comma-separated (whitespace is okay)." ], :reportdir => {:default => "$vardir/reports", @@ -488,7 +487,7 @@ module Puppet :mode => 0644, :desc => "The file in which puppet agent stores a list of the classes associated with the retrieved configuration. Can be loaded in - the separate ``puppet`` executable using the ``--loadclasses`` + the separate `puppet` executable using the `--loadclasses` option."}, :puppetdlog => { :default => "$logdir/puppetd.log", :owner => "root", @@ -505,8 +504,8 @@ module Puppet "How often puppet agent applies the client configuration; in seconds."], :listen => [false, "Whether puppet agent should listen for connections. If this is true, then by default only the - ``runner`` server is started, which allows remote authorized - and authenticated nodes to connect and trigger ``puppet agent`` + `runner` server is started, which allows remote authorized + and authenticated nodes to connect and trigger `puppet agent` runs."], :ca_server => ["$server", "The server to use for certificate authority requests. It's a separate server because it cannot @@ -604,7 +603,7 @@ module Puppet "Where Puppet should store plugins that it pulls down from the central server."], :pluginsource => ["puppet://$server/plugins", - "From where to retrieve plugins. The standard Puppet ``file`` type + "From where to retrieve plugins. The standard Puppet `file` type is used for retrieval, so anything that is a valid file source can be used here."], :pluginsync => [false, "Whether plugins should be synced with the central server."], @@ -627,7 +626,7 @@ module Puppet "Where Puppet should store facts that it pulls down from the central server."], :factsource => ["puppet://$server/facts/", - "From where to retrieve facts. The standard Puppet ``file`` type + "From where to retrieve facts. The standard Puppet `file` type is used for retrieval, so anything that is a valid file source can be used here."], :factsync => [false, "Whether facts should be synced with the central server."], @@ -644,7 +643,6 @@ module Puppet :smtpserver => ["none", "The server through which to send email reports."] ) - setdefaults( :rails, :dblocation => { :default => "$statedir/clientconfigs.sqlite3", @@ -678,18 +676,16 @@ module Puppet }, :rails_loglevel => ["info", "The log level for Rails connections. The value must be - a valid log level within Rails. Production environments normally use ``info`` - and other environments normally use ``debug``."] + a valid log level within Rails. Production environments normally use `info` + and other environments normally use `debug`."] ) - setdefaults( :couchdb, :couchdb_url => ["http://127.0.0.1:5984/puppet", "The url where the puppet couchdb database will be created"] ) - setdefaults( :transaction, :tags => ["", "Tags to use to find resources. If this is set, then @@ -704,21 +700,19 @@ module Puppet ] ) - setdefaults( :main, :external_nodes => ["none", "An external command that can produce node information. The output must be a YAML dump of a hash, and that hash must have one or both of - ``classes`` and ``parameters``, where ``classes`` is an array and - ``parameters`` is a hash. For unknown nodes, the commands should + `classes` and `parameters`, where `classes` is an array and + `parameters` is a hash. For unknown nodes, the commands should exit with a non-zero exit code. This command makes it straightforward to store your node mapping information in other data sources like databases."]) - setdefaults( :ldap, :ldapnodes => [false, @@ -733,9 +727,9 @@ module Puppet Defaults to false because TLS usually requires certificates to be set up on the client side."], :ldapserver => ["ldap", - "The LDAP server. Only used if ``ldapnodes`` is enabled."], + "The LDAP server. Only used if `ldapnodes` is enabled."], :ldapport => [389, - "The LDAP port. Only used if ``ldapnodes`` is enabled."], + "The LDAP port. Only used if `ldapnodes` is enabled."], :ldapstring => ["(&(objectclass=puppetClient)(cn=%s))", "The search string used to find an LDAP node."], diff --git a/lib/puppet/provider/group/groupadd.rb b/lib/puppet/provider/group/groupadd.rb index e661ddd7f..82ed4c0c7 100644 --- a/lib/puppet/provider/group/groupadd.rb +++ b/lib/puppet/provider/group/groupadd.rb @@ -1,7 +1,7 @@ require 'puppet/provider/nameservice/objectadd' Puppet::Type.type(:group).provide :groupadd, :parent => Puppet::Provider::NameService::ObjectAdd do - desc "Group management via ``groupadd`` and its ilk. + desc "Group management via `groupadd` and its ilk. The default for most platforms diff --git a/lib/puppet/provider/group/ldap.rb b/lib/puppet/provider/group/ldap.rb index 2737feea6..86c72a5d3 100644 --- a/lib/puppet/provider/group/ldap.rb +++ b/lib/puppet/provider/group/ldap.rb @@ -1,11 +1,11 @@ require 'puppet/provider/ldap' Puppet::Type.type(:group).provide :ldap, :parent => Puppet::Provider::Ldap do - desc "Group management via ``ldap``. + desc "Group management via `ldap`. This provider requires that you have valid values for all of the - ldap-related settings, including ``ldapbase``. You will also almost - definitely need settings for ``ldapuser`` and ``ldappassword``, so that + ldap-related settings, including `ldapbase`. You will also almost + definitely need settings for `ldapuser` and `ldappassword`, so that your clients can write to ldap. Note that this provider will automatically generate a GID for you if you do diff --git a/lib/puppet/provider/group/pw.rb b/lib/puppet/provider/group/pw.rb index e3dd714ee..a054d1ff1 100644 --- a/lib/puppet/provider/group/pw.rb +++ b/lib/puppet/provider/group/pw.rb @@ -1,7 +1,7 @@ require 'puppet/provider/nameservice/pw' Puppet::Type.type(:group).provide :pw, :parent => Puppet::Provider::NameService::PW do - desc "Group management via ``pw``. + desc "Group management via `pw`. Only works on FreeBSD. diff --git a/lib/puppet/provider/package/apple.rb b/lib/puppet/provider/package/apple.rb index 0946de47f..b5bb9102f 100755 --- a/lib/puppet/provider/package/apple.rb +++ b/lib/puppet/provider/package/apple.rb @@ -5,7 +5,7 @@ Puppet::Type.type(:package).provide :apple, :parent => Puppet::Provider::Package desc "Package management based on OS X's builtin packaging system. This is essentially the simplest and least functional package system in existence -- it only supports installation; no deletion or upgrades. The provider will - automatically add the ``.pkg`` extension, so leave that off when specifying + automatically add the `.pkg` extension, so leave that off when specifying the package name." confine :operatingsystem => :darwin diff --git a/lib/puppet/provider/package/apt.rb b/lib/puppet/provider/package/apt.rb index d055e7552..b6ded39fd 100755 --- a/lib/puppet/provider/package/apt.rb +++ b/lib/puppet/provider/package/apt.rb @@ -2,7 +2,7 @@ Puppet::Type.type(:package).provide :apt, :parent => :dpkg, :source => :dpkg do # Provide sorting functionality include Puppet::Util::Package - desc "Package management via ``apt-get``." + desc "Package management via `apt-get`." has_feature :versionable diff --git a/lib/puppet/provider/package/aptitude.rb b/lib/puppet/provider/package/aptitude.rb index 557e657a4..8bdf984e6 100755 --- a/lib/puppet/provider/package/aptitude.rb +++ b/lib/puppet/provider/package/aptitude.rb @@ -1,5 +1,5 @@ Puppet::Type.type(:package).provide :aptitude, :parent => :apt, :source => :dpkg do - desc "Package management via ``aptitude``." + desc "Package management via `aptitude`." has_feature :versionable diff --git a/lib/puppet/provider/package/aptrpm.rb b/lib/puppet/provider/package/aptrpm.rb index d7842089f..2eb33c72b 100644 --- a/lib/puppet/provider/package/aptrpm.rb +++ b/lib/puppet/provider/package/aptrpm.rb @@ -2,7 +2,7 @@ Puppet::Type.type(:package).provide :aptrpm, :parent => :rpm, :source => :rpm do # Provide sorting functionality include Puppet::Util::Package - desc "Package management via ``apt-get`` ported to ``rpm``." + desc "Package management via `apt-get` ported to `rpm`." has_feature :versionable diff --git a/lib/puppet/provider/package/blastwave.rb b/lib/puppet/provider/package/blastwave.rb index 9f1f1ec19..e9c84845f 100755 --- a/lib/puppet/provider/package/blastwave.rb +++ b/lib/puppet/provider/package/blastwave.rb @@ -1,6 +1,6 @@ # Packaging using Blastwave's pkg-get program. Puppet::Type.type(:package).provide :blastwave, :parent => :sun, :source => :sun do - desc "Package management using Blastwave.org's ``pkg-get`` command on Solaris." + desc "Package management using Blastwave.org's `pkg-get` command on Solaris." pkgget = "pkg-get" pkgget = "/opt/csw/bin/pkg-get" if FileTest.executable?("/opt/csw/bin/pkg-get") diff --git a/lib/puppet/provider/package/dpkg.rb b/lib/puppet/provider/package/dpkg.rb index bee63bfba..7b34b09af 100755 --- a/lib/puppet/provider/package/dpkg.rb +++ b/lib/puppet/provider/package/dpkg.rb @@ -1,8 +1,8 @@ require 'puppet/provider/package' Puppet::Type.type(:package).provide :dpkg, :parent => Puppet::Provider::Package do - desc "Package management via ``dpkg``. Because this only uses ``dpkg`` - and not ``apt``, you must specify the source of any packages you want + desc "Package management via `dpkg`. Because this only uses `dpkg` + and not `apt`, you must specify the source of any packages you want to manage." has_feature :holdable diff --git a/lib/puppet/provider/package/fink.rb b/lib/puppet/provider/package/fink.rb index 5cf47860e..db991397a 100755 --- a/lib/puppet/provider/package/fink.rb +++ b/lib/puppet/provider/package/fink.rb @@ -2,7 +2,7 @@ Puppet::Type.type(:package).provide :fink, :parent => :dpkg, :source => :dpkg do # Provide sorting functionality include Puppet::Util::Package - desc "Package management via ``fink``." + desc "Package management via `fink`." commands :fink => "/sw/bin/fink" commands :aptget => "/sw/bin/apt-get" diff --git a/lib/puppet/provider/package/gem.rb b/lib/puppet/provider/package/gem.rb index 8d70b756f..19414cec4 100755 --- a/lib/puppet/provider/package/gem.rb +++ b/lib/puppet/provider/package/gem.rb @@ -3,7 +3,7 @@ require 'uri' # Ruby gems support. Puppet::Type.type(:package).provide :gem, :parent => Puppet::Provider::Package do - desc "Ruby Gem support. If a URL is passed via ``source``, then that URL is used as the + desc "Ruby Gem support. If a URL is passed via `source`, then that URL is used as the remote gem repository; if a source is present but is not a valid URL, it will be interpreted as the path to a local gem file. If source is not present at all, the gem will be installed from the default gem repositories." diff --git a/lib/puppet/provider/package/openbsd.rb b/lib/puppet/provider/package/openbsd.rb index ca477e56a..22df14d62 100755 --- a/lib/puppet/provider/package/openbsd.rb +++ b/lib/puppet/provider/package/openbsd.rb @@ -3,7 +3,7 @@ require 'puppet/provider/package' # Packaging on OpenBSD. Doesn't work anywhere else that I know of. Puppet::Type.type(:package).provide :openbsd, :parent => Puppet::Provider::Package do include Puppet::Util::Execution - desc "OpenBSD's form of ``pkg_add`` support." + desc "OpenBSD's form of `pkg_add` support." commands :pkginfo => "pkg_info", :pkgadd => "pkg_add", :pkgdelete => "pkg_delete" diff --git a/lib/puppet/provider/package/rpm.rb b/lib/puppet/provider/package/rpm.rb index d33a4f2f3..72dc260a4 100755 --- a/lib/puppet/provider/package/rpm.rb +++ b/lib/puppet/provider/package/rpm.rb @@ -1,7 +1,7 @@ require 'puppet/provider/package' # RPM packaging. Should work anywhere that has rpm installed. Puppet::Type.type(:package).provide :rpm, :source => :rpm, :parent => Puppet::Provider::Package do - desc "RPM packaging support; should work anywhere with a working ``rpm`` + desc "RPM packaging support; should work anywhere with a working `rpm` binary." has_feature :versionable diff --git a/lib/puppet/provider/package/rug.rb b/lib/puppet/provider/package/rug.rb index 7028cc9e5..28729952d 100644 --- a/lib/puppet/provider/package/rug.rb +++ b/lib/puppet/provider/package/rug.rb @@ -1,5 +1,5 @@ Puppet::Type.type(:package).provide :rug, :parent => :rpm do - desc "Support for suse ``rug`` package manager." + desc "Support for suse `rug` package manager." has_feature :versionable diff --git a/lib/puppet/provider/package/sunfreeware.rb b/lib/puppet/provider/package/sunfreeware.rb index 53f03ed6e..4745ea1eb 100755 --- a/lib/puppet/provider/package/sunfreeware.rb +++ b/lib/puppet/provider/package/sunfreeware.rb @@ -1,7 +1,7 @@ # At this point, it's an exact copy of the Blastwave stuff. Puppet::Type.type(:package).provide :sunfreeware, :parent => :blastwave, :source => :sun do - desc "Package management using sunfreeware.com's ``pkg-get`` command on Solaris. - At this point, support is exactly the same as ``blastwave`` support and + desc "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." commands :pkgget => "pkg-get" diff --git a/lib/puppet/provider/package/up2date.rb b/lib/puppet/provider/package/up2date.rb index 5ff32bedc..243bc6c6b 100644 --- a/lib/puppet/provider/package/up2date.rb +++ b/lib/puppet/provider/package/up2date.rb @@ -1,5 +1,5 @@ Puppet::Type.type(:package).provide :up2date, :parent => :rpm, :source => :rpm do - desc "Support for Red Hat's proprietary ``up2date`` package update + desc "Support for Red Hat's proprietary `up2date` package update mechanism." commands :up2date => "/usr/sbin/up2date-nox" diff --git a/lib/puppet/provider/package/urpmi.rb b/lib/puppet/provider/package/urpmi.rb index 88a17ccb4..425d77849 100644 --- a/lib/puppet/provider/package/urpmi.rb +++ b/lib/puppet/provider/package/urpmi.rb @@ -1,5 +1,5 @@ Puppet::Type.type(:package).provide :urpmi, :parent => :rpm, :source => :rpm do - desc "Support via ``urpmi``." + desc "Support via `urpmi`." commands :urpmi => "urpmi", :urpmq => "urpmq", :rpm => "rpm" if command('rpm') diff --git a/lib/puppet/provider/package/yum.rb b/lib/puppet/provider/package/yum.rb index 07f68ddb1..fcda5ba8c 100755 --- a/lib/puppet/provider/package/yum.rb +++ b/lib/puppet/provider/package/yum.rb @@ -1,5 +1,5 @@ Puppet::Type.type(:package).provide :yum, :parent => :rpm, :source => :rpm do - desc "Support via ``yum``." + desc "Support via `yum`." has_feature :versionable diff --git a/lib/puppet/provider/package/zypper.rb b/lib/puppet/provider/package/zypper.rb index d56c72549..f129ef6e6 100644 --- a/lib/puppet/provider/package/zypper.rb +++ b/lib/puppet/provider/package/zypper.rb @@ -1,5 +1,5 @@ Puppet::Type.type(:package).provide :zypper, :parent => :rpm do - desc "Support for SuSE ``zypper`` package manager. Found in SLES10sp2+ and SLES11" + desc "Support for SuSE `zypper` package manager. Found in SLES10sp2+ and SLES11" has_feature :versionable diff --git a/lib/puppet/provider/service/base.rb b/lib/puppet/provider/service/base.rb index 70d764187..211e7f964 100755 --- a/lib/puppet/provider/service/base.rb +++ b/lib/puppet/provider/service/base.rb @@ -5,7 +5,7 @@ Puppet::Type.type(:service).provide :base do minimum you can specify is a binary for starting the process, and this same binary will be searched for in the process table to stop the service. It is preferable to specify start, stop, and status commands, - akin to how you would do so using ``init``. + akin to how you would do so using `init`. " diff --git a/lib/puppet/provider/service/bsd.rb b/lib/puppet/provider/service/bsd.rb index 2e00c33f1..e2a0e35f7 100644 --- a/lib/puppet/provider/service/bsd.rb +++ b/lib/puppet/provider/service/bsd.rb @@ -1,8 +1,8 @@ # Manage FreeBSD services. Puppet::Type.type(:service).provide :bsd, :parent => :init do - desc "FreeBSD's (and probably NetBSD?) form of ``init``-style service management. + desc "FreeBSD's (and probably NetBSD?) form of `init`-style service management. - Uses ``rc.conf.d`` for service enabling and disabling. + Uses `rc.conf.d` for service enabling and disabling. " diff --git a/lib/puppet/provider/service/debian.rb b/lib/puppet/provider/service/debian.rb index 4379f1b59..3d09e2849 100755 --- a/lib/puppet/provider/service/debian.rb +++ b/lib/puppet/provider/service/debian.rb @@ -1,10 +1,10 @@ # Manage debian services. Start/stop is the same as InitSvc, but enable/disable # is special. Puppet::Type.type(:service).provide :debian, :parent => :init do - desc "Debian's form of ``init``-style management. + desc "Debian's form of `init`-style management. The only difference is that this supports service enabling and disabling - via ``update-rc.d`` and determines enabled status via ``invoke-rc.d``. + via `update-rc.d` and determines enabled status via `invoke-rc.d`. " diff --git a/lib/puppet/provider/service/gentoo.rb b/lib/puppet/provider/service/gentoo.rb index 08250a06a..382c74267 100644 --- a/lib/puppet/provider/service/gentoo.rb +++ b/lib/puppet/provider/service/gentoo.rb @@ -1,9 +1,9 @@ # Manage gentoo services. Start/stop is the same as InitSvc, but enable/disable # is special. Puppet::Type.type(:service).provide :gentoo, :parent => :init do - desc "Gentoo's form of ``init``-style service management. + desc "Gentoo's form of `init`-style service management. - Uses ``rc-update`` for service enabling and disabling. + Uses `rc-update` for service enabling and disabling. " diff --git a/lib/puppet/provider/service/init.rb b/lib/puppet/provider/service/init.rb index 6abff12db..447c01aa5 100755 --- a/lib/puppet/provider/service/init.rb +++ b/lib/puppet/provider/service/init.rb @@ -3,9 +3,9 @@ Puppet::Type.type(:service).provide :init, :parent => :base do desc "Standard init service management. - This provider assumes that the init script has no ``status`` command, + This provider assumes that the init script has no `status` command, because so few scripts do, so you need to either provide a status - command or specify via ``hasstatus`` that one already exists in the + command or specify via `hasstatus` that one already exists in the init script. " diff --git a/lib/puppet/provider/service/redhat.rb b/lib/puppet/provider/service/redhat.rb index 3ca67d66f..e851a488d 100755 --- a/lib/puppet/provider/service/redhat.rb +++ b/lib/puppet/provider/service/redhat.rb @@ -1,9 +1,9 @@ # Manage Red Hat services. Start/stop uses /sbin/service and enable/disable uses chkconfig Puppet::Type.type(:service).provide :redhat, :parent => :init, :source => :init do - desc "Red Hat's (and probably many others) form of ``init``-style service management: + desc "Red Hat's (and probably many others) form of `init`-style service management: - Uses ``chkconfig`` for service enabling and disabling. + Uses `chkconfig` for service enabling and disabling. " diff --git a/lib/puppet/provider/user/ldap.rb b/lib/puppet/provider/user/ldap.rb index df082c569..75a9667b3 100644 --- a/lib/puppet/provider/user/ldap.rb +++ b/lib/puppet/provider/user/ldap.rb @@ -1,10 +1,10 @@ require 'puppet/provider/ldap' Puppet::Type.type(:user).provide :ldap, :parent => Puppet::Provider::Ldap do - desc "User management via ``ldap``. This provider requires that you + desc "User management via `ldap`. This provider requires that you have valid values for all of the ldap-related settings, - including ``ldapbase``. You will also almost definitely need settings - for ``ldapuser`` and ``ldappassword``, so that your clients can write + including `ldapbase`. You will also almost definitely need settings + for `ldapuser` and `ldappassword`, so that your clients can write to ldap. Note that this provider will automatically generate a UID for you if diff --git a/lib/puppet/provider/user/pw.rb b/lib/puppet/provider/user/pw.rb index 345d924bf..a5988cad1 100644 --- a/lib/puppet/provider/user/pw.rb +++ b/lib/puppet/provider/user/pw.rb @@ -1,7 +1,7 @@ require 'puppet/provider/nameservice/pw' Puppet::Type.type(:user).provide :pw, :parent => Puppet::Provider::NameService::PW do - desc "User management via ``pw`` on FreeBSD." + desc "User management via `pw` on FreeBSD." commands :pw => "pw" has_features :manages_homedir, :allows_duplicates diff --git a/lib/puppet/provider/user/user_role_add.rb b/lib/puppet/provider/user/user_role_add.rb index ea1b01b3b..c13125925 100644 --- a/lib/puppet/provider/user/user_role_add.rb +++ b/lib/puppet/provider/user/user_role_add.rb @@ -2,7 +2,7 @@ require 'puppet/util/user_attr' Puppet::Type.type(:user).provide :user_role_add, :parent => :useradd, :source => :useradd do - desc "User management inherits ``useradd`` and adds logic to manage roles on Solaris using roleadd." + desc "User management inherits `useradd` and adds logic to manage roles on Solaris using roleadd." defaultfor :operatingsystem => :solaris diff --git a/lib/puppet/provider/user/useradd.rb b/lib/puppet/provider/user/useradd.rb index ec87694d7..7ef217d9e 100644 --- a/lib/puppet/provider/user/useradd.rb +++ b/lib/puppet/provider/user/useradd.rb @@ -1,7 +1,7 @@ require 'puppet/provider/nameservice/objectadd' Puppet::Type.type(:user).provide :useradd, :parent => Puppet::Provider::NameService::ObjectAdd do - desc "User management via ``useradd`` and its ilk. Note that you will need to install the ``Shadow Password`` Ruby library often known as ruby-libshadow to manage user passwords." + desc "User management via `useradd` and its ilk. Note that you will need to install the `Shadow Password` Ruby library often known as ruby-libshadow to manage user passwords." commands :add => "useradd", :delete => "userdel", :modify => "usermod" diff --git a/lib/puppet/reports/http.rb b/lib/puppet/reports/http.rb index f1a74195d..7ac54dfbd 100644 --- a/lib/puppet/reports/http.rb +++ b/lib/puppet/reports/http.rb @@ -5,7 +5,7 @@ require 'uri' Puppet::Reports.register_report(:http) do desc <<-DESC - Send report information via HTTP to the ``reporturl``. Each host sends + Send report information via HTTP to the `reporturl`. Each host sends its report as a YAML dump and this sends this YAML to a client via HTTP POST. The YAML is the `report` parameter of the request." DESC diff --git a/lib/puppet/reports/rrdgraph.rb b/lib/puppet/reports/rrdgraph.rb index 9fbeb60e8..2357e233e 100644 --- a/lib/puppet/reports/rrdgraph.rb +++ b/lib/puppet/reports/rrdgraph.rb @@ -1,12 +1,11 @@ Puppet::Reports.register_report(:rrdgraph) do desc "Graph all available data about hosts using the RRD library. You must have the Ruby RRDtool library installed to use this report, which - you can get from `the RubyRRDTool RubyForge page`_. This package may also - be available as ``ruby-rrd`` or ``rrdtool-ruby`` in your distribution's package - management system. The library and/or package will both require the binary - ``rrdtool`` package from your distribution to be installed. - - .. _the RubyRRDTool RubyForge page: http://rubyforge.org/projects/rubyrrdtool/ + you can get from + [the RubyRRDTool RubyForge page](http://rubyforge.org/projects/rubyrrdtool/). + This package may also be available as `ruby-rrd` or `rrdtool-ruby` in your + distribution's package management system. The library and/or package will both + require the binary `rrdtool` package from your distribution to be installed. This report will create, manage, and graph RRD database files for each of the metrics generated during transactions, and it will create a @@ -14,12 +13,12 @@ Puppet::Reports.register_report(:rrdgraph) do point, it will not create a common index file to display links to all hosts. - All RRD files and graphs get created in the ``rrddir`` directory. If + All RRD files and graphs get created in the `rrddir` directory. If you want to serve these publicly, you should be able to just alias that directory in a web server. - If you really know what you're doing, you can tune the ``rrdinterval``, - which defaults to the ``runinterval``." + If you really know what you're doing, you can tune the `rrdinterval`, + which defaults to the `runinterval`." def hostdir @hostdir ||= File.join(Puppet[:rrddir], self.host) diff --git a/lib/puppet/reports/store.rb b/lib/puppet/reports/store.rb index 65159fc07..30f24591c 100644 --- a/lib/puppet/reports/store.rb +++ b/lib/puppet/reports/store.rb @@ -2,7 +2,7 @@ require 'puppet' Puppet::Reports.register_report(:store) do desc "Store the yaml report on disk. Each host sends its report as a YAML dump - and this just stores the file on disk, in the ``reportdir`` directory. + and this just stores the file on disk, in the `reportdir` directory. These files collect quickly -- one every half hour -- so it is a good idea to perform some maintenance on them if you use this report (it's the only @@ -19,7 +19,7 @@ Puppet::Reports.register_report(:store) do :owner => 'service', :group => 'service' }, - + :noop => [false, "Used by settings internally."] ) diff --git a/lib/puppet/reports/tagmail.rb b/lib/puppet/reports/tagmail.rb index 652104096..71bafb2da 100644 --- a/lib/puppet/reports/tagmail.rb +++ b/lib/puppet/reports/tagmail.rb @@ -6,12 +6,12 @@ require 'time' Puppet::Reports.register_report(:tagmail) do desc "This report sends specific log messages to specific email addresses - based on the tags in the log messages. See the - `UsingTags tag documentation`:trac: for more information - on tags. + based on the tags in the log messages. - 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 + See the [UsingTags tag documentation](http://projects.puppetlabs.com/projects/puppet/wiki/Using_Tags) 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 email addresses: Any log messages in the report that match the specified tags will be sent to the specified email addresses. @@ -20,21 +20,20 @@ Puppet::Reports.register_report(:tagmail) do the email addresses by a colon, and the email addresses should also be comma-separated. - Lastly, there is an ``all`` tag that will always match all log messages. + Lastly, there is an `all` tag that will always match all log messages. - Here is an example tagmail.conf:: + Here is an example `tagmail.conf`: - all: me@domain.com - webserver, !mailserver: httpadmins@domain.com + all: me@domain.com + webserver, !mailserver: httpadmins@domain.com - This will send all messages to ``me@domain.com``, and all messages from - webservers that are not also from mailservers to ``httpadmins@domain.com``. + This will send all messages to `me@domain.com`, and all messages from + webservers that are not also from mailservers to `httpadmins@domain.com`. If you are using anti-spam controls, such as grey-listing, on your mail - server you should whitelist the sending email (controlled by ``reportform`` configuration option) to ensure your email is not discarded as spam. + server you should whitelist the sending email (controlled by `reportform` configuration option) to ensure your email is not discarded as spam. " - # Find all matching messages. def match(taglists) matching_logs = [] diff --git a/lib/puppet/type/augeas.rb b/lib/puppet/type/augeas.rb index 7fcfdd7a3..d29bda648 100644 --- a/lib/puppet/type/augeas.rb +++ b/lib/puppet/type/augeas.rb @@ -28,27 +28,28 @@ Puppet::Type.newtype(:augeas) do via the augeas tool. Requires: - - augeas to be installed (http://www.augeas.net) - - ruby-augeas bindings - Sample usage with a string:: + - augeas to be installed (http://www.augeas.net) + - ruby-augeas bindings - augeas{\"test1\" : - context => \"/files/etc/sysconfig/firstboot\", - changes => \"set RUN_FIRSTBOOT YES\", - onlyif => \"match other_value size > 0\", - } + Sample usage with a string: - Sample usage with an array and custom lenses:: + augeas{\"test1\" : + context => \"/files/etc/sysconfig/firstboot\", + changes => \"set RUN_FIRSTBOOT YES\", + onlyif => \"match other_value size > 0\", + } - augeas{\"jboss_conf\": - context => \"/files\", - changes => [ - \"set /etc/jbossas/jbossas.conf/JBOSS_IP $ipaddress\", - \"set /etc/jbossas/jbossas.conf/JAVA_HOME /usr\" - ], - load_path => \"$/usr/share/jbossas/lenses\", - } + Sample usage with an array and custom lenses: + + augeas{\"jboss_conf\": + context => \"/files\", + changes => [ + \"set /etc/jbossas/jbossas.conf/JBOSS_IP $ipaddress\", + \"set /etc/jbossas/jbossas.conf/JAVA_HOME /usr\" + ], + load_path => \"$/usr/share/jbossas/lenses\", + } " @@ -71,23 +72,23 @@ Puppet::Type.newtype(:augeas) do newparam (:onlyif) do desc "Optional augeas command and comparisons to control the execution of this type. - Supported onlyif syntax:: - - get [AUGEAS_PATH] [COMPARATOR] [STRING] - match [MATCH_PATH] size [COMPARATOR] [INT] - match [MATCH_PATH] include [STRING] - match [MATCH_PATH] not_include [STRING] - match [MATCH_PATH] == [AN_ARRAY] - match [MATCH_PATH] != [AN_ARRAY] - - where:: - - AUGEAS_PATH is a valid path scoped by the context - MATCH_PATH is a valid match synatx scoped by the context - COMPARATOR is in the set [> >= != == <= <] - STRING is a string - INT is a number - AN_ARRAY is in the form ['a string', 'another']" + Supported onlyif syntax: + + get [AUGEAS_PATH] [COMPARATOR] [STRING] + match [MATCH_PATH] size [COMPARATOR] [INT] + match [MATCH_PATH] include [STRING] + match [MATCH_PATH] not_include [STRING] + match [MATCH_PATH] == [AN_ARRAY] + match [MATCH_PATH] != [AN_ARRAY] + + where: + + AUGEAS_PATH is a valid path scoped by the context + MATCH_PATH is a valid match synatx scoped by the context + COMPARATOR is in the set [> >= != == <= <] + STRING is a string + INT is a number + AN_ARRAY is in the form ['a string', 'another']" defaultto "" end @@ -95,16 +96,14 @@ Puppet::Type.newtype(:augeas) do newparam(:changes) do desc "The changes which should be applied to the filesystem. This can be either a string which contains a command or an array of commands. - Commands supported are:: + Commands supported are: - set [PATH] [VALUE] Sets the value VALUE at loction PATH - rm [PATH] Removes the node at location PATH - remove [PATH] Synonym for rm - clear [PATH] Keeps the node at PATH, but removes the value. - ins [LABEL] [WHERE] [PATH] - Inserts an empty node LABEL either [WHERE={before|after}] PATH. - insert [LABEL] [WHERE] [PATH] - Synonym for ins + set [PATH] [VALUE] Sets the value VALUE at loction PATH + rm [PATH] Removes the node at location PATH + remove [PATH] Synonym for rm + clear [PATH] Keeps the node at PATH, but removes the value. + ins [LABEL] [WHERE] [PATH] Inserts an empty node LABEL either [WHERE={before|after}] PATH. + insert [LABEL] [WHERE] [PATH] Synonym for ins If the parameter 'context' is set that value is prepended to PATH" end @@ -136,11 +135,11 @@ Puppet::Type.newtype(:augeas) do end newparam(:lens) do - desc "Use a specific lens, e.g. 'Hosts.lns'. When this parameter is set, you must also set the incl parameter to indicate which file to load. Only that file will be loaded, which greatly speeds up execution of the type" + desc "Use a specific lens, e.g. `Hosts.lns`. When this parameter is set, you must also set the incl parameter to indicate which file to load. Only that file will be loaded, which greatly speeds up execution of the type" end newparam(:incl) do - desc "Load only a specific file, e.g. '/etc/hosts'. When this parameter is set, you must also set the lens parameter to indicate which lens to use." + desc "Load only a specific file, e.g. `/etc/hosts`. When this parameter is set, you must also set the lens parameter to indicate which lens to use." end validate do diff --git a/lib/puppet/type/computer.rb b/lib/puppet/type/computer.rb index 86a30be27..89a0692bf 100644 --- a/lib/puppet/type/computer.rb +++ b/lib/puppet/type/computer.rb @@ -10,7 +10,7 @@ Puppet::Type.newtype(:computer) do This provider only manages Computer objects in the local directory service domain, not in remote directories. - If you wish to manage /etc/hosts on Mac OS X, then simply use the host + If you wish to manage `/etc/hosts` file on Mac OS X, then simply use the host type as per other platforms. This type primarily exists to create localhost Computer objects that MCX @@ -31,7 +31,7 @@ Puppet::Type.newtype(:computer) do newproperty(:ensure, :parent => Puppet::Property::Ensure) do desc "Control the existences of this computer record. Set this attribute to - ``present`` to ensure the computer record exists. Set it to ``absent`` + `present` to ensure the computer record exists. Set it to `absent` to delete any computer records with this name" newvalue(:present) do provider.create diff --git a/lib/puppet/type/cron.rb b/lib/puppet/type/cron.rb index ebbef72a1..9d827df78 100755 --- a/lib/puppet/type/cron.rb +++ b/lib/puppet/type/cron.rb @@ -15,32 +15,32 @@ Puppet::Type.newtype(:cron) do association is made and synced to disk, you can then manage the job normally (e.g., change the schedule of the job). - Example + Example: - cron { logrotate: - command => \"/usr/sbin/logrotate\", - user => root, - hour => 2, - minute => 0 - } + cron { logrotate: + command => \"/usr/sbin/logrotate\", + user => root, + hour => 2, + minute => 0 + } - Note that all cron values can be specified as an array of values + Note that all cron values can be specified as an array of values: - cron { logrotate: - command => \"/usr/sbin/logrotate\", - user => root, - hour => [2, 4] - } + cron { logrotate: + command => \"/usr/sbin/logrotate\", + user => root, + hour => [2, 4] + } Or using ranges, or the step syntax `*/2` (although there's no guarantee that - your `cron` daemon supports it) - - cron { logrotate: - command => \"/usr/sbin/logrotate\", - user => root, - hour => ['2-4'], - minute => '*/10' - } + your `cron` daemon supports it): + + cron { logrotate: + command => \"/usr/sbin/logrotate\", + user => root, + hour => ['2-4'], + minute => '*/10' + } " ensurable diff --git a/lib/puppet/type/exec.rb b/lib/puppet/type/exec.rb index bfeaaad34..dd57ec231 100755 --- a/lib/puppet/type/exec.rb +++ b/lib/puppet/type/exec.rb @@ -6,51 +6,51 @@ module Puppet @doc = "Executes external commands. It is critical that all commands executed using this mechanism can be run multiple times without harm, i.e., they are *idempotent*. One useful way to create idempotent - commands is to use the checks like ``creates`` to avoid running the + commands is to use the checks like `creates` to avoid running the command unless some condition is met. - Note also that you can restrict an ``exec`` to only run when it receives - events by using the ``refreshonly`` parameter; this is a useful way to + Note also that you can restrict an `exec` to only run when it receives + events by using the `refreshonly` parameter; this is a useful way to have your configuration respond to events with arbitrary commands. - It is worth noting that ``exec`` is special, in that it is not - currently considered an error to have multiple ``exec`` instances + It is worth noting that `exec` is special, in that it is not + currently considered an error to have multiple `exec` instances with the same name. This was done purely because it had to be this way in order to get certain functionality, but it complicates things. - In particular, you will not be able to use ``exec`` instances that + In particular, you will not be able to use `exec` instances that share their commands with other instances as a dependency, since Puppet has no way of knowing which instance you mean. - For example:: + For example: - # defined in the production class - exec { \"make\": - cwd => \"/prod/build/dir\", - path => \"/usr/bin:/usr/sbin:/bin\" - } + # defined in the production class + exec { \"make\": + cwd => \"/prod/build/dir\", + path => \"/usr/bin:/usr/sbin:/bin\" + } - . etc. . + . etc. . - # defined in the test class - exec { \"make\": - cwd => \"/test/build/dir\", - path => \"/usr/bin:/usr/sbin:/bin\" - } + # defined in the test class + exec { \"make\": + cwd => \"/test/build/dir\", + path => \"/usr/bin:/usr/sbin:/bin\" + } Any other type would throw an error, complaining that you had the same instance being managed in multiple places, but these are - obviously different images, so ``exec`` had to be treated specially. + obviously different images, so `exec` had to be treated specially. It is recommended to avoid duplicate names whenever possible. - Note that if an ``exec`` receives an event from another resource, - it will get executed again (or execute the command specified in ``refresh``, if there is one). + Note that if an `exec` receives an event from another resource, + it will get executed again (or execute the command specified in `refresh`, if there is one). - There is a strong tendency to use ``exec`` to do whatever work Puppet + There is a strong tendency to use `exec` to do whatever work Puppet can't already do; while this is obviously acceptable (and unavoidable) - in the short term, it is highly recommended to migrate work from ``exec`` + in the short term, it is highly recommended to migrate work from `exec` to native Puppet types as quickly as possible. If you find that - you are doing a lot of work with ``exec``, please at least notify + you are doing a lot of work with `exec`, please at least notify us at Puppet Labs what you are doing, and hopefully we can work with you to get a native resource type for the work you are doing." @@ -159,9 +159,9 @@ module Puppet desc "The actual command to execute. Must either be fully qualified or a search path for the command must be provided. If the command succeeds, any output produced will be logged at the instance's - normal log level (usually ``notice``), but if the command fails + normal log level (usually `notice`), but if the command fails (meaning its return code does not match the specified code) then - any output is logged at the ``err`` log level." + any output is logged at the `err` log level." end newparam(:path) do @@ -223,7 +223,7 @@ module Puppet newparam(:logoutput) do desc "Whether to log output. Defaults to logging output at the - loglevel for the ``exec`` resource. Use *on_failure* to only + loglevel for the `exec` resource. Use *on_failure* to only log the output when the command reports an error. Values are **true**, *false*, *on_failure*, and any legal log level." @@ -253,7 +253,7 @@ module Puppet newparam(:environment) do desc "Any additional environment variables you want to set for a command. Note that if you use this to set PATH, it will override - the ``path`` attribute. Multiple environment variables should be + the `path` attribute. Multiple environment variables should be specified as an array." validate do |values| @@ -330,22 +330,22 @@ module Puppet desc "The command should only be run as a refresh mechanism for when a dependent object is changed. It only makes sense to use this option when this command depends on some - other object; it is useful for triggering an action:: - - # Pull down the main aliases file - file { \"/etc/aliases\": - source => \"puppet://server/module/aliases\" - } - - # Rebuild the database, but only when the file changes - exec { newaliases: - path => [\"/usr/bin\", \"/usr/sbin\"], - subscribe => File[\"/etc/aliases\"], - refreshonly => true - } + other object; it is useful for triggering an action: + + # Pull down the main aliases file + file { \"/etc/aliases\": + source => \"puppet://server/module/aliases\" + } + + # Rebuild the database, but only when the file changes + exec { newaliases: + path => [\"/usr/bin\", \"/usr/sbin\"], + subscribe => File[\"/etc/aliases\"], + refreshonly => true + } - Note that only ``subscribe`` and ``notify`` can trigger actions, not ``require``, - so it only makes sense to use ``refreshonly`` with ``subscribe`` or ``notify``." + Note that only `subscribe` and `notify` can trigger actions, not `require`, + so it only makes sense to use `refreshonly` with `subscribe` or `notify`." newvalues(:true, :false) @@ -364,13 +364,13 @@ module Puppet newcheck(:creates) do desc "A file that this command creates. If this parameter is provided, then the command will only be run - if the specified file does not exist:: + if the specified file does not exist: - exec { \"tar xf /my/tar/file.tar\": - cwd => \"/var/tmp\", - creates => \"/var/tmp/myfile\", - path => [\"/usr/bin\", \"/usr/sbin\"] - } + exec { \"tar xf /my/tar/file.tar\": + cwd => \"/var/tmp\", + creates => \"/var/tmp/myfile\", + path => [\"/usr/bin\", \"/usr/sbin\"] + } " @@ -396,16 +396,16 @@ module Puppet end newcheck(:unless) do - desc "If this parameter is set, then this ``exec`` will run unless - the command returns 0. For example:: + desc "If this parameter is set, then this `exec` will run unless + the command returns 0. For example: - exec { \"/bin/echo root >> /usr/lib/cron/cron.allow\": - path => \"/usr/bin:/usr/sbin:/bin\", - unless => \"grep root /usr/lib/cron/cron.allow 2>/dev/null\" - } + exec { \"/bin/echo root >> /usr/lib/cron/cron.allow\": + path => \"/usr/bin:/usr/sbin:/bin\", + unless => \"grep root /usr/lib/cron/cron.allow 2>/dev/null\" + } - This would add ``root`` to the cron.allow file (on Solaris) unless - ``grep`` determines it's already there. + This would add `root` to the cron.allow file (on Solaris) unless + `grep` determines it's already there. Note that this command follows the same rules as the main command, which is to say that it must be fully qualified if the path is not set. @@ -433,22 +433,22 @@ module Puppet end newcheck(:onlyif) do - desc "If this parameter is set, then this ``exec`` will only run if - the command returns 0. For example:: + desc "If this parameter is set, then this `exec` will only run if + the command returns 0. For example: - exec { \"logrotate\": - path => \"/usr/bin:/usr/sbin:/bin\", - onlyif => \"test `du /var/log/messages | cut -f1` -gt 100000\" - } + exec { \"logrotate\": + path => \"/usr/bin:/usr/sbin:/bin\", + onlyif => \"test `du /var/log/messages | cut -f1` -gt 100000\" + } - This would run ``logrotate`` only if that test returned true. + This would run `logrotate` only if that test returned true. Note that this command follows the same rules as the main command, which is to say that it must be fully qualified if the path is not set. - Also note that onlyif can take an array as its value, eg:: + Also note that onlyif can take an array as its value, e.g.: - onlyif => [\"test -f /tmp/file1\", \"test -f /tmp/file2\"] + onlyif => [\"test -f /tmp/file1\", \"test -f /tmp/file2\"] This will only run the exec if /all/ conditions in the array return true. " @@ -683,4 +683,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/file/ensure.rb b/lib/puppet/type/file/ensure.rb index c74a1d47a..967e06aee 100755 --- a/lib/puppet/type/file/ensure.rb +++ b/lib/puppet/type/file/ensure.rb @@ -3,27 +3,27 @@ module Puppet require 'etc' desc "Whether to create files that don't currently exist. Possible values are *absent*, *present*, *file*, and *directory*. - Specifying ``present`` will match any form of file existence, and + Specifying `present` will match any form of file existence, and if the file is missing will create an empty file. Specifying - ``absent`` will delete the file (and directory if recurse => true). + `absent` will delete the file (and directory if recurse => true). Anything other than those values will be considered to be a symlink. - For instance, the following text creates a link:: + For instance, the following text creates a link: - # Useful on solaris - file { \"/etc/inetd.conf\": - ensure => \"/etc/inet/inetd.conf\" - } + # Useful on solaris + file { \"/etc/inetd.conf\": + ensure => \"/etc/inet/inetd.conf\" + } - You can make relative links:: + You can make relative links: - # Useful on solaris - file { \"/etc/inetd.conf\": - ensure => \"inet/inetd.conf\" - } + # Useful on solaris + file { \"/etc/inetd.conf\": + ensure => \"inet/inetd.conf\" + } If you need to make a relative link to a file named the same - as one of the valid values, you must prefix it with ``./`` or + as one of the valid values, you must prefix it with `./` or something similar. You can also make recursive symlinks, which will create a diff --git a/lib/puppet/type/file/mode.rb b/lib/puppet/type/file/mode.rb index 9abf56d26..1ce56c843 100755 --- a/lib/puppet/type/file/mode.rb +++ b/lib/puppet/type/file/mode.rb @@ -13,14 +13,14 @@ module Puppet entries in a directory, and search/traverse allows you to access (read/write/execute) those entries.) Because of this feature, you can recursively make a directory and all of the files in it - world-readable by setting e.g.:: + world-readable by setting e.g.: - file { '/some/dir': - mode => 644, - recurse => true, - } + file { '/some/dir': + mode => 644, + recurse => true, + } - In this case all of the files underneath ``/some/dir`` will have + In this case all of the files underneath `/some/dir` will have mode 644, and all of the directories will have mode 755." @event = :file_changed diff --git a/lib/puppet/type/file/selcontext.rb b/lib/puppet/type/file/selcontext.rb index edcfb83b2..a33c6a000 100644 --- a/lib/puppet/type/file/selcontext.rb +++ b/lib/puppet/type/file/selcontext.rb @@ -56,7 +56,7 @@ module Puppet Puppet::Type.type(:file).newproperty(:seluser, :parent => Puppet::SELFileContext) do desc "What the SELinux user component of the context of the file should be. - Any valid SELinux user component is accepted. For example ``user_u``. + Any valid SELinux user component is accepted. For example `user_u`. If not specified it defaults to the value returned by matchpathcon for the file, if any exists. Only valid on systems with SELinux support enabled." @@ -67,7 +67,7 @@ module Puppet Puppet::Type.type(:file).newproperty(:selrole, :parent => Puppet::SELFileContext) do desc "What the SELinux role component of the context of the file should be. - Any valid SELinux role component is accepted. For example ``role_r``. + Any valid SELinux role component is accepted. For example `role_r`. If not specified it defaults to the value returned by matchpathcon for the file, if any exists. Only valid on systems with SELinux support enabled." @@ -78,7 +78,7 @@ module Puppet Puppet::Type.type(:file).newproperty(:seltype, :parent => Puppet::SELFileContext) do desc "What the SELinux type component of the context of the file should be. - Any valid SELinux type component is accepted. For example ``tmp_t``. + Any valid SELinux type component is accepted. For example `tmp_t`. If not specified it defaults to the value returned by matchpathcon for the file, if any exists. Only valid on systems with SELinux support enabled." @@ -89,8 +89,8 @@ module Puppet Puppet::Type.type(:file).newproperty(:selrange, :parent => Puppet::SELFileContext) do desc "What the SELinux range component of the context of the file should be. - Any valid SELinux range component is accepted. For example ``s0`` or - ``SystemHigh``. If not specified it defaults to the value returned by + Any valid SELinux range component is accepted. For example `s0` or + `SystemHigh`. If not specified it defaults to the value returned by matchpathcon for the file, if any exists. Only valid on systems with SELinux support enabled and that have support for MCS (Multi-Category Security)." diff --git a/lib/puppet/type/file/source.rb b/lib/puppet/type/file/source.rb index 2eaf4a33f..0e7aac72d 100755 --- a/lib/puppet/type/file/source.rb +++ b/lib/puppet/type/file/source.rb @@ -12,7 +12,7 @@ module Puppet include Puppet::Util::Diff attr_accessor :source, :local - desc "Copy a file over the current file. Uses ``checksum`` to + desc "Copy a file over the current file. Uses `checksum` to determine when a file should be copied. Valid values are either fully qualified paths to files, or URIs. Currently supported URI types are *puppet* and *file*. @@ -20,47 +20,47 @@ module Puppet This is one of the primary mechanisms for getting content into applications that Puppet does not directly support and is very useful for those configuration files that don't change much across - sytems. For instance:: + sytems. For instance: - class sendmail { - file { \"/etc/mail/sendmail.cf\": - source => \"puppet://server/modules/module_name/sendmail.cf\" + class sendmail { + file { \"/etc/mail/sendmail.cf\": + source => \"puppet://server/modules/module_name/sendmail.cf\" + } } - } - You can also leave out the server name, in which case ``puppet agent`` - will fill in the name of its configuration server and ``puppet apply`` + You can also leave out the server name, in which case `puppet agent` + will fill in the name of its configuration server and `puppet apply` will use the local filesystem. This makes it easy to use the same configuration in both local and centralized forms. - Currently, only the ``puppet`` scheme is supported for source + Currently, only the `puppet` scheme is supported for source URL's. Puppet will connect to the file server running on - ``server`` to retrieve the contents of the file. If the - ``server`` part is empty, the behavior of the command-line - interpreter (``puppet apply``) and the client demon (``puppet agent``) differs - slightly: ``apply`` will look such a file up on the module path - on the local host, whereas ``agent`` will connect to the + `server` to retrieve the contents of the file. If the + `server` part is empty, the behavior of the command-line + interpreter (`puppet apply`) and the client demon (`puppet agent`) differs + slightly: `apply` will look such a file up on the module path + on the local host, whereas `agent` will connect to the puppet server that it received the manifest from. - See the `FileServingConfiguration fileserver configuration documentation`:trac: for information on how to configure + See the [fileserver configuration documentation](http://projects.puppetlabs.com/projects/puppet/wiki/File_Serving_Configuration) for information on how to configure and use file services within Puppet. If you specify multiple file sources for a file, then the first source that exists will be used. This allows you to specify - what amount to search paths for files:: - - file { \"/path/to/my/file\": - source => [ - \"/modules/nfs/files/file.$host\", - \"/modules/nfs/files/file.$operatingsystem\", - \"/modules/nfs/files/file\" - ] - } + what amount to search paths for files: + + file { \"/path/to/my/file\": + source => [ + \"/modules/nfs/files/file.$host\", + \"/modules/nfs/files/file.$operatingsystem\", + \"/modules/nfs/files/file\" + ] + } This will use the first found file as the source. - You cannot currently copy links using this mechanism; set ``links`` - to ``follow`` if any remote sources are links. + You cannot currently copy links using this mechanism; set `links` + to `follow` if any remote sources are links. " validate do |sources| diff --git a/lib/puppet/type/filebucket.rb b/lib/puppet/type/filebucket.rb index 65ff88411..7fd2ef46b 100755 --- a/lib/puppet/type/filebucket.rb +++ b/lib/puppet/type/filebucket.rb @@ -16,13 +16,13 @@ module Puppet undo transactions. You will normally want to define a single filebucket for your - whole network and then use that as the default backup location:: + whole network and then use that as the default backup location: - # Define the bucket - filebucket { main: server => puppet } + # Define the bucket + filebucket { main: server => puppet } - # Specify it as the default target - File { backup => main } + # Specify it as the default target + File { backup => main } Puppetmaster servers create a filebucket by default, so this will work in a default configuration." @@ -92,4 +92,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/group.rb b/lib/puppet/type/group.rb index 19753d15b..cde1cfd65 100755 --- a/lib/puppet/type/group.rb +++ b/lib/puppet/type/group.rb @@ -97,4 +97,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/host.rb b/lib/puppet/type/host.rb index 7169d12c4..8ab750459 100755 --- a/lib/puppet/type/host.rb +++ b/lib/puppet/type/host.rb @@ -14,10 +14,8 @@ module Puppet end newproperty(:host_aliases) do - desc 'Any aliases the host might have. Multiple values must be - specified as an array. Note that this property is not the same as - the "alias" metaparam; use this property to add aliases to a host - on disk, and "alias" to aliases for use in your Puppet scripts.' + desc "Any aliases the host might have. Multiple values must be + specified as an array." def insync?(is) is == @should @@ -98,4 +96,3 @@ module Puppet will have different solutions." end end - diff --git a/lib/puppet/type/k5login.rb b/lib/puppet/type/k5login.rb index 850e37733..a343e9e5c 100644 --- a/lib/puppet/type/k5login.rb +++ b/lib/puppet/type/k5login.rb @@ -3,15 +3,15 @@ # Plug-in type for handling k5login files Puppet::Type.newtype(:k5login) do - @doc = "Manage the .k5login file for a user. Specify the full path to - the .k5login file as the name and an array of principals as the + @doc = "Manage the `.k5login` file for a user. Specify the full path to + the `.k5login` file as the name and an array of principals as the property principals." ensurable # Principals that should exist in the file newproperty(:principals, :array_matching => :all) do - desc "The principals present in the .k5login file." + desc "The principals present in the `.k5login` file." end # The path/name of the k5login file diff --git a/lib/puppet/type/macauthorization.rb b/lib/puppet/type/macauthorization.rb index 9b17c279d..ef6fbb6c1 100644 --- a/lib/puppet/type/macauthorization.rb +++ b/lib/puppet/type/macauthorization.rb @@ -1,8 +1,7 @@ Puppet::Type.newtype(:macauthorization) do @doc = "Manage the Mac OS X authorization database. - See: - http://developer.apple.com/documentation/Security/Conceptual/Security_Overview/Security_Services/chapter_4_section_5.html for more information." + See the [Apple developer site](http://developer.apple.com/documentation/Security/Conceptual/Security_Overview/Security_Services/chapter_4_section_5.html) for more information." ensurable diff --git a/lib/puppet/type/mailalias.rb b/lib/puppet/type/mailalias.rb index 5534fdf25..ce7ca790b 100755 --- a/lib/puppet/type/mailalias.rb +++ b/lib/puppet/type/mailalias.rb @@ -46,4 +46,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/maillist.rb b/lib/puppet/type/maillist.rb index 7ac0e4e4f..732fbf09f 100755 --- a/lib/puppet/type/maillist.rb +++ b/lib/puppet/type/maillist.rb @@ -60,4 +60,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/mcx.rb b/lib/puppet/type/mcx.rb index e56b11938..4f0a6c3c5 100644 --- a/lib/puppet/type/mcx.rb +++ b/lib/puppet/type/mcx.rb @@ -21,8 +21,6 @@ Puppet::Type.newtype(:mcx) do @doc = "MCX object management using DirectoryService on OS X. -Original Author: Jeff McCune <mccune.jeff@gmail.com> - The default provider of this type merely manages the XML plist as reported by the dscl -mcxexport command. This is similar to the content property of the file type in Puppet. @@ -51,13 +49,13 @@ to other machines. newparam(:name) do desc "The name of the resource being managed. - The default naming convention follows Directory Service paths:: + The default naming convention follows Directory Service paths: - /Computers/localhost - /Groups/admin - /Users/localadmin + /Computers/localhost + /Groups/admin + /Users/localadmin - The ds_type and ds_name type parameters are not necessary if the + The `ds_type` and `ds_name` type parameters are not necessary if the default naming convention is followed." isnamevar end @@ -80,8 +78,10 @@ to other machines. newproperty(:content, :required_features => :manages_content) do desc "The XML Plist. The value of MCXSettings in DirectoryService. This is the standard output from the system command: - dscl localhost -mcxexport /Local/Default/<ds_type>/ds_name - Note that ds_type is capitalized and plural in the dscl command." + + dscl localhost -mcxexport /Local/Default/<ds_type>/ds_name + + Note that `ds_type` is capitalized and plural in the dscl command." end # JJM Yes, this is not DRY at all. Because of the code blocks diff --git a/lib/puppet/type/mount.rb b/lib/puppet/type/mount.rb index 78bb5002f..d048c90f1 100755 --- a/lib/puppet/type/mount.rb +++ b/lib/puppet/type/mount.rb @@ -222,4 +222,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/notify.rb b/lib/puppet/type/notify.rb index 97935e270..a6ec1dc8b 100644 --- a/lib/puppet/type/notify.rb +++ b/lib/puppet/type/notify.rb @@ -42,4 +42,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/package.rb b/lib/puppet/type/package.rb index f25464db5..51a866332 100644 --- a/lib/puppet/type/package.rb +++ b/lib/puppet/type/package.rb @@ -8,12 +8,12 @@ module Puppet @doc = "Manage packages. There is a basic dichotomy in package support right now: Some package types (e.g., yum and apt) can retrieve their own package files, while others (e.g., rpm and sun) cannot. For those package formats that cannot retrieve - their own files, you can use the ``source`` parameter to point to + their own files, you can use the `source` parameter to point to the correct file. Puppet will automatically guess the packaging format that you are using based on the platform you are on, but you can override it - using the ``provider`` parameter; each provider defines what it + using the `provider` parameter; each provider defines what it requires in order to function, and you must meet those requirements to use a given provider." @@ -22,7 +22,7 @@ module Puppet feature :uninstallable, "The provider can uninstall packages.", :methods => [:uninstall] feature :upgradeable, "The provider can upgrade to the latest version of a - package. This feature is used by specifying ``latest`` as the + package. This feature is used by specifying `latest` as the desired value for the package.", :methods => [:update, :latest] feature :purgeable, "The provider can purge packages. This generally means @@ -104,7 +104,6 @@ module Puppet end end - defaultto :installed # Override the parent method, because we've got all kinds of @@ -181,35 +180,35 @@ module Puppet system uses internally, which is sometimes (especially on Solaris) a name that is basically useless to humans. If you want to abstract package installation, then you can use aliases to provide - a common name to packages:: - - # In the 'openssl' class - $ssl = $operatingsystem ? { - solaris => SMCossl, - default => openssl - } - - # It is not an error to set an alias to the same value as the - # object name. - package { $ssl: - ensure => installed, - alias => openssl - } - - . etc. . - - $ssh = $operatingsystem ? { - solaris => SMCossh, - default => openssh - } - - # Use the alias to specify a dependency, rather than - # having another selector to figure it out again. - package { $ssh: - ensure => installed, - alias => openssh, - require => Package[openssl] - } + a common name to packages: + + # In the 'openssl' class + $ssl = $operatingsystem ? { + solaris => SMCossl, + default => openssl + } + + # It is not an error to set an alias to the same value as the + # object name. + package { $ssl: + ensure => installed, + alias => openssl + } + + . etc. . + + $ssh = $operatingsystem ? { + solaris => SMCossh, + default => openssh + } + + # Use the alias to specify a dependency, rather than + # having another selector to figure it out again. + package { $ssh: + ensure => installed, + alias => openssh, + require => Package[openssl] + } " isnamevar @@ -228,7 +227,7 @@ module Puppet end newparam(:type) do - desc "Deprecated form of ``provider``." + desc "Deprecated form of `provider`." munge do |value| warning "'type' is deprecated; use 'provider' instead" @@ -243,7 +242,7 @@ module Puppet This is currently only used on Solaris. The value will be validated according to system rules, which in the case of Solaris means that it should either be a fully qualified path - or it should be in /var/sadm/install/admin." + or it should be in `/var/sadm/install/admin`." end newparam(:responsefile) do @@ -320,4 +319,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/resources.rb b/lib/puppet/type/resources.rb index 34382e067..ae41b883b 100644 --- a/lib/puppet/type/resources.rb +++ b/lib/puppet/type/resources.rb @@ -1,12 +1,9 @@ -# Created by Luke Kanies on 2006-12-12. -# Copyright (c) 2006. All rights reserved. - require 'puppet' Puppet::Type.newtype(:resources) do @doc = "This is a metatype that can manage other resource types. Any metaparams specified here will be passed on to any generated resources, - so you can purge umanaged resources but set ``noop`` to true so the + so you can purge umanaged resources but set `noop` to true so the purging is only logged and does not actually happen." @@ -132,4 +129,3 @@ Puppet::Type.newtype(:resources) do %w{root nobody bin noaccess daemon sys} end end - diff --git a/lib/puppet/type/schedule.rb b/lib/puppet/type/schedule.rb index bedf1e536..ff3fba8eb 100755 --- a/lib/puppet/type/schedule.rb +++ b/lib/puppet/type/schedule.rb @@ -196,17 +196,17 @@ module Puppet Note that the period defines how often a given resource will get applied but not when; if you would like to restrict the hours that a given resource can be applied (e.g., only at night during - a maintenance window) then use the ``range`` attribute. + a maintenance window) then use the `range` attribute. If the provided periods are not sufficient, you can provide a value to the *repeat* attribute, which will cause Puppet to schedule the affected resources evenly in the period the - specified number of times. Take this schedule:: + specified number of times. Take this schedule: - schedule { veryoften: - period => hourly, - repeat => 6 - } + schedule { veryoften: + period => hourly, + repeat => 6 + } This can cause Puppet to apply that resource up to every 10 minutes. @@ -215,7 +215,7 @@ module Puppet internal factors might prevent it from actually running that often (e.g., long-running Puppet runs will squash conflictingly scheduled runs). - See the ``periodmatch`` attribute for tuning whether to match + See the `periodmatch` attribute for tuning whether to match times by their distance apart or by their specific value." newvalues(:hourly, :daily, :weekly, :monthly, :never) @@ -307,10 +307,10 @@ module Puppet Puppet.debug "Creating default schedules" result << self.new( - + :name => "puppet", :period => :hourly, - + :repeat => "2" ) @@ -318,9 +318,7 @@ module Puppet @parameters.find { |p| p.name == :period }.value_collection.values.each { |value| result << self.new( - :name => value.to_s, - :period => value ) } @@ -349,4 +347,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/selboolean.rb b/lib/puppet/type/selboolean.rb index cf873e987..204b89056 100644 --- a/lib/puppet/type/selboolean.rb +++ b/lib/puppet/type/selboolean.rb @@ -1,11 +1,7 @@ -# -# Simple module for manageing SELinux booleans -# - module Puppet newtype(:selboolean) do @doc = "Manages SELinux booleans on systems with SELinux support. The supported booleans - are any of the ones found in /selinux/booleans/." + are any of the ones found in `/selinux/booleans/`." newparam(:name) do desc "The name of the SELinux boolean to be managed." @@ -20,7 +16,7 @@ module Puppet newparam(:persistent) do desc "If set true, SELinux booleans will be written to disk and persist accross reboots. - The default is ``false``." + The default is `false`." defaultto :false newvalues(:true, :false) @@ -28,4 +24,3 @@ module Puppet end end - diff --git a/lib/puppet/type/selmodule.rb b/lib/puppet/type/selmodule.rb index 240d6e6d1..60be8a855 100644 --- a/lib/puppet/type/selmodule.rb +++ b/lib/puppet/type/selmodule.rb @@ -18,7 +18,7 @@ Puppet::Type.newtype(:selmodule) do newparam(:selmoduledir) do desc "The directory to look for the compiled pp module file in. - Currently defaults to /usr/share/selinux/targeted. If selmodulepath + Currently defaults to `/usr/share/selinux/targeted`. If selmodulepath is not specified the module will be looked for in this directory in a in a file called NAME.pp, where NAME is the value of the name parameter." @@ -34,9 +34,9 @@ Puppet::Type.newtype(:selmodule) do newproperty(:syncversion) do - desc "If set to ``true``, the policy will be reloaded if the + desc "If set to `true`, the policy will be reloaded if the version found in the on-disk file differs from the loaded - version. If set to ``false`` (the default) the the only check + version. If set to `false` (the default) the the only check that will be made is if the policy is loaded at all or not." newvalue(:true) @@ -51,4 +51,3 @@ Puppet::Type.newtype(:selmodule) do end end end - diff --git a/lib/puppet/type/service.rb b/lib/puppet/type/service.rb index 8f5c6ee37..c00f02789 100644 --- a/lib/puppet/type/service.rb +++ b/lib/puppet/type/service.rb @@ -17,10 +17,10 @@ module Puppet can provide the better behaviour you will get. Or, you can just use a platform that has very good service support. - Note that if a ``service`` receives an event from another resource, + Note that if a `service` receives an event from another resource, the service will get restarted. The actual command to restart the service depends on the platform. You can provide a special command - for restarting with the ``restart`` attribute." + for restarting with the `restart` attribute." feature :refreshable, "The provider can restart the service.", :methods => [:restart] @@ -83,7 +83,7 @@ module Puppet newparam(:binary) do desc "The path to the daemon. This is only used for systems that do not support init scripts. This binary will be - used to start the service if no ``start`` parameter is + used to start the service if no `start` parameter is provided." end @@ -94,7 +94,7 @@ module Puppet not support any kind of status command; thus, you must specify manually whether the service you are running has such a command (or you can specify a specific command using the - ``status`` parameter). + `status` parameter). If you do not specify anything, then the service name will be looked for in the process table." @@ -140,7 +140,7 @@ module Puppet end newparam(:start) do desc "Specify a *start* command manually. Most service subsystems - support a ``start`` command, so this will not need to be + support a `start` command, so this will not need to be specified." end newparam(:status) do @@ -156,14 +156,14 @@ module Puppet newparam(:control) do desc "The control variable used to manage services (originally for HP-UX). - Defaults to the upcased service name plus ``START`` replacing dots with - underscores, for those providers that support the ``controllable`` feature." + Defaults to the upcased service name plus `START` replacing dots with + underscores, for those providers that support the `controllable` feature." defaultto { resource.name.gsub(".","_").upcase + "_START" if resource.provider.controllable? } end newparam :hasrestart do - desc "Specify that an init script has a ``restart`` option. Otherwise, - the init script's ``stop`` and ``start`` methods are used." + desc "Specify that an init script has a `restart` option. Otherwise, + the init script's `stop` and `start` methods are used." newvalues(:true, :false) end diff --git a/lib/puppet/type/ssh_authorized_key.rb b/lib/puppet/type/ssh_authorized_key.rb index 2bfa87b0f..e3320140e 100644 --- a/lib/puppet/type/ssh_authorized_key.rb +++ b/lib/puppet/type/ssh_authorized_key.rb @@ -34,8 +34,8 @@ module Puppet newproperty(:target) do desc "The absolute filename in which to store the SSH key. This property is optional and should only be used in cases where keys - are stored in a non-standard location (ie not in - ~user/.ssh/authorized_keys)." + are stored in a non-standard location (i.e.` not in + `~user/.ssh/authorized_keys`)." defaultto :absent @@ -96,4 +96,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/sshkey.rb b/lib/puppet/type/sshkey.rb index e1adc7173..b7a1b8a8d 100755 --- a/lib/puppet/type/sshkey.rb +++ b/lib/puppet/type/sshkey.rb @@ -1,8 +1,8 @@ module Puppet newtype(:sshkey) do @doc = "Installs and manages ssh host keys. At this point, this type - only knows how to install keys into /etc/ssh/ssh_known_hosts, and - it cannot manage user authorized keys yet." + only knows how to install keys into `/etc/ssh/ssh_known_hosts`. See + the `ssh_authorized_key` type to manage authorized keys." ensurable @@ -23,9 +23,7 @@ module Puppet # to see if we can automatically glean any aliases. newproperty(:host_aliases) do desc 'Any aliases the host might have. Multiple values must be - specified as an array. Note that this property is not the same as - the "alias" metaparam; use this property to add aliases to a host - on disk, and "alias" to aliases for use in your Puppet scripts.' + specified as an array.' attr_accessor :meta @@ -56,7 +54,7 @@ module Puppet newproperty(:target) do desc "The file in which to store the ssh key. Only used by - the ``parsed`` provider." + the `parsed` provider." defaultto { if @resource.class.defaultprovider.ancestors.include?(Puppet::Provider::ParsedFile) @resource.class.defaultprovider.default_target @@ -67,4 +65,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/stage.rb b/lib/puppet/type/stage.rb index d22cd7b70..0736dc4b9 100644 --- a/lib/puppet/type/stage.rb +++ b/lib/puppet/type/stage.rb @@ -1,11 +1,12 @@ Puppet::Type.newtype(:stage) do desc "A resource type for specifying run stages. The actual stage should - be specified on resources:: - class { foo: stage => pre } + be specified on resources: + + class { foo: stage => pre } - And you must manually control stage order:: + And you must manually control stage order: - stage { pre: before => Stage[main] } + stage { pre: before => Stage[main] } You automatically get a 'main' stage created, and by default all resources get inserted into that stage. diff --git a/lib/puppet/type/tidy.rb b/lib/puppet/type/tidy.rb index a6605211e..64a7a1a88 100755 --- a/lib/puppet/type/tidy.rb +++ b/lib/puppet/type/tidy.rb @@ -5,7 +5,7 @@ Puppet::Type.newtype(:tidy) do criteria are OR'd together, so a file that is too large but is not old enough will still get tidied. - If you don't specify either 'age' or 'size', then all files will + If you don't specify either `age` or `size`, then all files will be removed. This resource type works by generating a file resource for every file @@ -47,7 +47,7 @@ Puppet::Type.newtype(:tidy) do at least one of the patterns specified. Multiple patterns can be specified using an array. - Example:: + Example: tidy { \"/tmp\": age => \"1w\", @@ -55,7 +55,7 @@ Puppet::Type.newtype(:tidy) do matches => [ \"[0-9]pub*.tmp\", \"*.temp\", \"tmpfile?\" ] } - This removes files from \/tmp if they are one week old or older, + This removes files from `/tmp` if they are one week old or older, are not in a subdirectory and match one of the shell globs given. Note that the patterns are matched against the basename of each diff --git a/lib/puppet/type/user.rb b/lib/puppet/type/user.rb index c7ac796a3..007b760bc 100755 --- a/lib/puppet/type/user.rb +++ b/lib/puppet/type/user.rb @@ -12,7 +12,7 @@ module Puppet This resource type uses the prescribed native tools for creating groups and generally uses POSIX APIs for retrieving information - about them. It does not directly modify /etc/passwd or anything." + about them. It does not directly modify `/etc/passwd` or anything." feature :allows_duplicates, "The provider supports duplicate users with the same UID." @@ -381,4 +381,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/yumrepo.rb b/lib/puppet/type/yumrepo.rb index 5d86b1c75..698c077f4 100644 --- a/lib/puppet/type/yumrepo.rb +++ b/lib/puppet/type/yumrepo.rb @@ -52,8 +52,9 @@ module Puppet newtype(:yumrepo) do @doc = "The client-side description of a yum repository. Repository - configurations are found by parsing /etc/yum.conf and - the files indicated by reposdir in that file (see yum.conf(5) for details) + configurations are found by parsing `/etc/yum.conf` and + the files indicated by the `reposdir` option in that file + (see yum.conf(5) for details) Most parameters are identical to the ones documented in yum.conf(5) diff --git a/lib/puppet/type/zfs.rb b/lib/puppet/type/zfs.rb index e1a972ddf..1757931f8 100755 --- a/lib/puppet/type/zfs.rb +++ b/lib/puppet/type/zfs.rb @@ -33,7 +33,7 @@ module Puppet end newproperty(:snapdir) do - desc "The sharenfs property." + desc "The snapdir property." end autorequire(:zpool) do @@ -48,4 +48,3 @@ module Puppet end end end - diff --git a/lib/puppet/type/zone.rb b/lib/puppet/type/zone.rb index d523c469a..5265b8a0f 100644 --- a/lib/puppet/type/zone.rb +++ b/lib/puppet/type/zone.rb @@ -69,9 +69,9 @@ Puppet::Type.newtype(:zone) do ensurable do desc "The running state of the zone. The valid states directly reflect - the states that ``zoneadm`` provides. The states are linear, - in that a zone must be ``configured`` then ``installed``, and - only then can be ``running``. Note also that ``halt`` is currently + the states that `zoneadm` provides. The states are linear, + in that a zone must be `configured` then `installed`, and + only then can be `running`. Note also that `halt` is currently used to stop zones." @states = {} @@ -313,31 +313,31 @@ Puppet::Type.newtype(:zone) do # only used to boot the zone the very first time. newparam(:sysidcfg) do desc %{The text to go into the sysidcfg file when the zone is first - booted. The best way is to use a template:: - - # $templatedir/sysidcfg - system_locale=en_US - timezone=GMT - terminal=xterms - security_policy=NONE - root_password=<%= password %> - timeserver=localhost - name_service=DNS {domain_name=<%= domain %> name_server=<%= nameserver %>} - network_interface=primary {hostname=<%= realhostname %> - ip_address=<%= ip %> - netmask=<%= netmask %> - protocol_ipv6=no - default_route=<%= defaultroute %>} - nfs4_domain=dynamic - - And then call that:: - - zone { myzone: - ip => "bge0:192.168.0.23", - sysidcfg => template(sysidcfg), - path => "/opt/zones/myzone", - realhostname => "fully.qualified.domain.name" - } + booted. The best way is to use a template: + + # $templatedir/sysidcfg + system_locale=en_US + timezone=GMT + terminal=xterms + security_policy=NONE + root_password=<%= password %> + timeserver=localhost + name_service=DNS {domain_name=<%= domain %> name_server=<%= nameserver %>} + network_interface=primary {hostname=<%= realhostname %> + ip_address=<%= ip %> + netmask=<%= netmask %> + protocol_ipv6=no + default_route=<%= defaultroute %>} + nfs4_domain=dynamic + + And then call that: + + zone { myzone: + ip => "bge0:192.168.0.23", + sysidcfg => template(sysidcfg), + path => "/opt/zones/myzone", + realhostname => "fully.qualified.domain.name" + } The sysidcfg only matters on the first booting of the zone, so Puppet only checks for it at that time.} diff --git a/lib/puppet/type/zpool.rb b/lib/puppet/type/zpool.rb index 80e635504..401a2c220 100755 --- a/lib/puppet/type/zpool.rb +++ b/lib/puppet/type/zpool.rb @@ -44,8 +44,11 @@ module Puppet end newproperty(:mirror, :array_matching => :all, :parent => Puppet::Property::MultiVDev) do - desc "List of all the devices to mirror for this pool. Each mirror should be a space separated string. - mirror => [\"disk1 disk2\", \"disk3 disk4\"]" + desc "List of all the devices to mirror for this pool. Each mirror should be a space separated string: + + mirror => [\"disk1 disk2\", \"disk3 disk4\"] + + " validate do |value| raise ArgumentError, "mirror names must be provided as string separated, not a comma-separated list" if value.include?(",") @@ -53,8 +56,11 @@ module Puppet end newproperty(:raidz, :array_matching => :all, :parent => Puppet::Property::MultiVDev) do - desc "List of all the devices to raid for this pool. Should be an array of space separated strings. - raidz => [\"disk1 disk2\", \"disk3 disk4\"]" + desc "List of all the devices to raid for this pool. Should be an array of space separated strings: + + raidz => [\"disk1 disk2\", \"disk3 disk4\"] + + " validate do |value| raise ArgumentError, "raid names must be provided as string separated, not a comma-separated list" if value.include?(",") @@ -84,4 +90,3 @@ module Puppet end end end - diff --git a/lib/puppet/util/nagios_maker.rb b/lib/puppet/util/nagios_maker.rb index 59ed820f9..863fe24fa 100644 --- a/lib/puppet/util/nagios_maker.rb +++ b/lib/puppet/util/nagios_maker.rb @@ -45,17 +45,16 @@ module Puppet::Util::NagiosMaker provider.nagios_type type.desc "The Nagios type #{name.to_s}. This resource type is autogenerated using the - model developed in Naginator_, and all of the Nagios types are generated using the + model developed in Naginator, and all of the Nagios types are generated using the same code and the same library. This type generates Nagios configuration statements in Nagios-parseable configuration - files. By default, the statements will be added to ``#{target}``, but - you can send them to a different file by setting their ``target`` attribute. + files. By default, the statements will be added to `#{target}`, but + you can send them to a different file by setting their `target` attribute. - You can purge Nagios resources using the ``resources`` type, but *only* + You can purge Nagios resources using the `resources` type, but *only* in the default file locations. This is an architectural limitation. - .. _naginator: http://projects.reductivelabs.com/projects/naginator " end end |
