diff --git a/ext/debian/puppet-common.manpages b/ext/debian/puppet-common.manpages index 6294f3e63..0fdee02c1 100644 --- a/ext/debian/puppet-common.manpages +++ b/ext/debian/puppet-common.manpages @@ -1,31 +1,30 @@ man/man5/puppet.conf.5 man/man8/extlookup2hiera.8 man/man8/puppet.8 man/man8/puppet-agent.8 man/man8/puppet-apply.8 man/man8/puppet-catalog.8 man/man8/puppet-cert.8 man/man8/puppet-certificate.8 man/man8/puppet-certificate_request.8 man/man8/puppet-certificate_revocation_list.8 man/man8/puppet-config.8 man/man8/puppet-describe.8 man/man8/puppet-device.8 man/man8/puppet-doc.8 man/man8/puppet-facts.8 man/man8/puppet-file.8 man/man8/puppet-filebucket.8 man/man8/puppet-help.8 man/man8/puppet-inspect.8 man/man8/puppet-key.8 man/man8/puppet-kick.8 man/man8/puppet-man.8 man/man8/puppet-module.8 man/man8/puppet-node.8 man/man8/puppet-parser.8 man/man8/puppet-plugin.8 man/man8/puppet-report.8 man/man8/puppet-resource.8 man/man8/puppet-resource_type.8 -man/man8/puppet-secret_agent.8 man/man8/puppet-status.8 diff --git a/ext/redhat/puppet.spec.erb b/ext/redhat/puppet.spec.erb index 0dc98de0c..2683f9279 100644 --- a/ext/redhat/puppet.spec.erb +++ b/ext/redhat/puppet.spec.erb @@ -1,856 +1,855 @@ # Augeas and SELinux requirements may be disabled at build time by passing # --without augeas and/or --without selinux to rpmbuild or mock # Fedora 17 ships with ruby 1.9, RHEL 7 with ruby 2.0, which use vendorlibdir instead # of sitelibdir. Adjust our target if installing on f17 or rhel7. %if 0%{?fedora} >= 17 || 0%{?rhel} >= 7 || 0%{?amzn} >= 1 %global puppet_libdir %(ruby -rrbconfig -e 'puts RbConfig::CONFIG["vendorlibdir"]') %else %global puppet_libdir %(ruby -rrbconfig -e 'puts RbConfig::CONFIG["sitelibdir"]') %endif %if 0%{?fedora} >= 17 || 0%{?rhel} >= 7 %global _with_systemd 1 %else %global _with_systemd 0 %endif # VERSION is subbed out during rake srpm process %global realversion <%= @version %> %global rpmversion <%= @rpmversion %> %global confdir ext/redhat %global pending_upgrade_path %{_localstatedir}/lib/rpm-state/puppet %global pending_upgrade_file %{pending_upgrade_path}/upgrade_pending Name: puppet Version: %{rpmversion} Release: <%= @rpmrelease -%>%{?dist} Vendor: %{?_host_vendor} Summary: A network tool for managing many disparate systems License: ASL 2.0 URL: http://puppetlabs.com Source0: http://puppetlabs.com/downloads/%{name}/%{name}-%{realversion}.tar.gz Group: System Environment/Base BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n) BuildRequires: facter >= 1:1.7.0 # Puppet 3.x drops ruby 1.8.5 support and adds ruby 1.9 support BuildRequires: ruby >= 1.8.7 BuildRequires: hiera >= 1.0.0 BuildArch: noarch Requires: ruby >= 1.8 Requires: ruby-shadow Requires: rubygem-json # Pull in ruby selinux bindings where available %if 0%{?fedora} || 0%{?rhel} >= 6 %{!?_without_selinux:Requires: ruby(selinux), libselinux-utils} %else %if ( 0%{?rhel} && 0%{?rhel} == 5 ) || 0%{?amzn} >= 1 %{!?_without_selinux:Requires: libselinux-ruby, libselinux-utils} %endif %endif Requires: facter >= 1:1.7.0 # Puppet 3.x drops ruby 1.8.5 support and adds ruby 1.9 support # Ruby 1.8.7 available for el5 at: yum.puppetlabs.com/el/5/devel/$ARCH Requires: ruby >= 1.8.7 Requires: hiera >= 1.0.0 Obsoletes: hiera-puppet < 1.0.0 Provides: hiera-puppet >= 1.0.0 %{!?_without_augeas:Requires: ruby-augeas} # Required for %%pre Requires: shadow-utils %if 0%{?_with_systemd} # Required for %%post, %%preun, %%postun Requires: systemd %if 0%{?fedora} >= 18 || 0%{?rhel} >= 7 BuildRequires: systemd %else BuildRequires: systemd-units %endif %else # Required for %%post and %%preun Requires: chkconfig # Required for %%preun and %%postun Requires: initscripts %endif %description Puppet lets you centrally manage every important aspect of your system using a cross-platform specification language that manages all the separate elements normally aggregated in different files, like users, cron jobs, and hosts, along with obviously discrete elements like packages, services, and files. %package server Group: System Environment/Base Summary: Server for the puppet system management tool Requires: puppet = %{version}-%{release} # chkconfig (%%post, %%preun) and initscripts (%%preun %%postun) are required for non systemd # and systemd (%%post, %%preun, and %%postun) are required for systems with systemd as default # They come along transitively with puppet-%{version}-%{release}. %description server Provides the central puppet server daemon which provides manifests to clients. The server can also function as a certificate authority and file server. %prep %setup -q -n %{name}-%{realversion} %build for f in external/nagios.rb relationship.rb; do sed -i -e '1d' lib/puppet/$f done find examples/ -type f | xargs --no-run-if-empty chmod a-x %install rm -rf %{buildroot} ruby install.rb --destdir=%{buildroot} --quick --no-rdoc --sitelibdir=%{puppet_libdir} install -d -m0755 %{buildroot}%{_sysconfdir}/puppet/environments/example_env/manifests install -d -m0755 %{buildroot}%{_sysconfdir}/puppet/environments/example_env/modules install -d -m0755 %{buildroot}%{_sysconfdir}/puppet/manifests install -d -m0755 %{buildroot}%{_datadir}/%{name}/modules install -d -m0755 %{buildroot}%{_localstatedir}/lib/puppet install -d -m0755 %{buildroot}%{_localstatedir}/lib/puppet/state install -d -m0755 %{buildroot}%{_localstatedir}/lib/puppet/reports install -d -m0755 %{buildroot}%{_localstatedir}/run/puppet # As per redhat bz #495096 install -d -m0750 %{buildroot}%{_localstatedir}/log/puppet %if 0%{?_with_systemd} # Systemd for fedora >= 17 or el 7 %{__install} -d -m0755 %{buildroot}%{_unitdir} install -Dp -m0644 ext/systemd/puppet.service %{buildroot}%{_unitdir}/puppet.service ln -s %{_unitdir}/puppet.service %{buildroot}%{_unitdir}/puppetagent.service install -Dp -m0644 ext/systemd/puppetmaster.service %{buildroot}%{_unitdir}/puppetmaster.service %else # Otherwise init.d for fedora < 17 or el 5, 6 install -Dp -m0644 %{confdir}/client.sysconfig %{buildroot}%{_sysconfdir}/sysconfig/puppet install -Dp -m0755 %{confdir}/client.init %{buildroot}%{_initrddir}/puppet install -Dp -m0644 %{confdir}/server.sysconfig %{buildroot}%{_sysconfdir}/sysconfig/puppetmaster install -Dp -m0755 %{confdir}/server.init %{buildroot}%{_initrddir}/puppetmaster %endif install -Dp -m0644 %{confdir}/fileserver.conf %{buildroot}%{_sysconfdir}/puppet/fileserver.conf install -Dp -m0644 %{confdir}/puppet.conf %{buildroot}%{_sysconfdir}/puppet/puppet.conf install -Dp -m0644 %{confdir}/logrotate %{buildroot}%{_sysconfdir}/logrotate.d/puppet install -Dp -m0644 ext/README.environment %{buildroot}%{_sysconfdir}/puppet/environments/example_env/README.environment # Install the ext/ directory to %%{_datadir}/%%{name} install -d %{buildroot}%{_datadir}/%{name} cp -a ext/ %{buildroot}%{_datadir}/%{name} # emacs and vim bits are installed elsewhere rm -rf %{buildroot}%{_datadir}/%{name}/ext/{emacs,vim} # remove misc packaging artifacts not applicable to rpms rm -rf %{buildroot}%{_datadir}/%{name}/ext/{gentoo,freebsd,solaris,suse,windows,osx,ips,debian} rm -f %{buildroot}%{_datadir}/%{name}/ext/redhat/*.init rm -f %{buildroot}%{_datadir}/%{name}/ext/{build_defaults.yaml,project_data.yaml} # Rpmlint fixup chmod 755 %{buildroot}%{_datadir}/%{name}/ext/regexp_nodes/regexp_nodes.rb chmod 755 %{buildroot}%{_datadir}/%{name}/ext/puppet-load.rb # Install emacs mode files emacsdir=%{buildroot}%{_datadir}/emacs/site-lisp install -Dp -m0644 ext/emacs/puppet-mode.el $emacsdir/puppet-mode.el install -Dp -m0644 ext/emacs/puppet-mode-init.el \ $emacsdir/site-start.d/puppet-mode-init.el # Install vim syntax files vimdir=%{buildroot}%{_datadir}/vim/vimfiles install -Dp -m0644 ext/vim/ftdetect/puppet.vim $vimdir/ftdetect/puppet.vim install -Dp -m0644 ext/vim/syntax/puppet.vim $vimdir/syntax/puppet.vim install -Dp -m0644 ext/vim/indent/puppet.vim $vimdir/indent/puppet.vim install -Dp -m0644 ext/vim/ftplugin/puppet.vim $vimdir/ftplugin/puppet.vim %if 0%{?fedora} >= 15 || 0%{?rhel} >= 7 # Setup tmpfiles.d config mkdir -p %{buildroot}%{_sysconfdir}/tmpfiles.d echo "D /var/run/%{name} 0755 %{name} %{name} -" > \ %{buildroot}%{_sysconfdir}/tmpfiles.d/%{name}.conf %endif # Create puppet modules directory for puppet module tool mkdir -p %{buildroot}%{_sysconfdir}/%{name}/modules # Install a NetworkManager dispatcher script to pickup changes to # # /etc/resolv.conf and such (https://bugzilla.redhat.com/532085). mkdir -p %{buildroot}%{_sysconfdir}/NetworkManager/dispatcher.d cp -pr ext/puppet-nm-dispatcher \ %{buildroot}%{_sysconfdir}/NetworkManager/dispatcher.d/98-%{name} %files %defattr(-, root, root, 0755) %doc LICENSE README.md examples %{_bindir}/puppet %{_bindir}/extlookup2hiera %{puppet_libdir}/* %dir %{_sysconfdir}/NetworkManager %dir %{_sysconfdir}/NetworkManager/dispatcher.d %{_sysconfdir}/NetworkManager/dispatcher.d/98-puppet %if 0%{?_with_systemd} %{_unitdir}/puppet.service %{_unitdir}/puppetagent.service %else %{_initrddir}/puppet %config(noreplace) %{_sysconfdir}/sysconfig/puppet %endif %dir %{_sysconfdir}/puppet %dir %{_sysconfdir}/%{name}/modules %if 0%{?fedora} >= 15 || 0%{?rhel} >= 7 %config(noreplace) %{_sysconfdir}/tmpfiles.d/%{name}.conf %endif %config(noreplace) %{_sysconfdir}/puppet/puppet.conf %config(noreplace) %{_sysconfdir}/puppet/auth.conf %config(noreplace) %{_sysconfdir}/logrotate.d/puppet # We don't want to require emacs or vim, so we need to own these dirs %{_datadir}/emacs %{_datadir}/vim %{_datadir}/%{name} # man pages %{_mandir}/man5/puppet.conf.5.gz %{_mandir}/man8/puppet.8.gz %{_mandir}/man8/puppet-agent.8.gz %{_mandir}/man8/puppet-apply.8.gz %{_mandir}/man8/puppet-catalog.8.gz %{_mandir}/man8/puppet-describe.8.gz %{_mandir}/man8/puppet-ca.8.gz %{_mandir}/man8/puppet-cert.8.gz %{_mandir}/man8/puppet-certificate.8.gz %{_mandir}/man8/puppet-certificate_request.8.gz %{_mandir}/man8/puppet-certificate_revocation_list.8.gz %{_mandir}/man8/puppet-config.8.gz %{_mandir}/man8/puppet-device.8.gz %{_mandir}/man8/puppet-doc.8.gz %{_mandir}/man8/puppet-facts.8.gz %{_mandir}/man8/puppet-file.8.gz %{_mandir}/man8/puppet-filebucket.8.gz %{_mandir}/man8/puppet-help.8.gz %{_mandir}/man8/puppet-inspect.8.gz %{_mandir}/man8/puppet-key.8.gz %{_mandir}/man8/puppet-kick.8.gz %{_mandir}/man8/puppet-man.8.gz %{_mandir}/man8/puppet-module.8.gz %{_mandir}/man8/puppet-node.8.gz %{_mandir}/man8/puppet-parser.8.gz %{_mandir}/man8/puppet-plugin.8.gz %{_mandir}/man8/puppet-report.8.gz %{_mandir}/man8/puppet-resource.8.gz %{_mandir}/man8/puppet-resource_type.8.gz -%{_mandir}/man8/puppet-secret_agent.8.gz %{_mandir}/man8/puppet-status.8.gz %{_mandir}/man8/extlookup2hiera.8.gz # These need to be owned by puppet so the server can # write to them. The separate %defattr's are required # to work around RH Bugzilla 681540 %defattr(-, puppet, puppet, 0755) %{_localstatedir}/run/puppet %defattr(-, puppet, puppet, 0750) %{_localstatedir}/log/puppet %{_localstatedir}/lib/puppet %{_localstatedir}/lib/puppet/state %{_localstatedir}/lib/puppet/reports # Return the default attributes to 0755 to # prevent incorrect permission assignment on EL6 %defattr(-, root, root, 0755) %files server %defattr(-, root, root, 0755) %if 0%{?_with_systemd} %{_unitdir}/puppetmaster.service %else %{_initrddir}/puppetmaster %config(noreplace) %{_sysconfdir}/sysconfig/puppetmaster %endif %config(noreplace) %{_sysconfdir}/puppet/fileserver.conf %dir %{_sysconfdir}/puppet/manifests %dir %{_sysconfdir}/puppet/environments %dir %{_sysconfdir}/puppet/environments/example_env %dir %{_sysconfdir}/puppet/environments/example_env/manifests %dir %{_sysconfdir}/puppet/environments/example_env/modules %{_sysconfdir}/puppet/environments/example_env/README.environment %{_mandir}/man8/puppet-ca.8.gz %{_mandir}/man8/puppet-master.8.gz # Fixed uid/gid were assigned in bz 472073 (Fedora), 471918 (RHEL-5), # and 471919 (RHEL-4) %pre getent group puppet &>/dev/null || groupadd -r puppet -g 52 &>/dev/null getent passwd puppet &>/dev/null || \ useradd -r -u 52 -g puppet -d %{_localstatedir}/lib/puppet -s /sbin/nologin \ -c "Puppet" puppet &>/dev/null # ensure that old setups have the right puppet home dir if [ $1 -gt 1 ] ; then usermod -d %{_localstatedir}/lib/puppet puppet &>/dev/null fi exit 0 %post %if 0%{?_with_systemd} /bin/systemctl daemon-reload >/dev/null 2>&1 || : if [ "$1" -ge 1 ]; then # The pidfile changed from 0.25.x to 2.6.x, handle upgrades without leaving # the old process running. oldpid="%{_localstatedir}/run/puppet/puppetd.pid" newpid="%{_localstatedir}/run/puppet/agent.pid" if [ -s "$oldpid" -a ! -s "$newpid" ]; then (kill $(< "$oldpid") && rm -f "$oldpid" && \ /bin/systemctl start puppet.service) >/dev/null 2>&1 || : fi fi %else /sbin/chkconfig --add puppet || : if [ "$1" -ge 1 ]; then # The pidfile changed from 0.25.x to 2.6.x, handle upgrades without leaving # the old process running. oldpid="%{_localstatedir}/run/puppet/puppetd.pid" newpid="%{_localstatedir}/run/puppet/agent.pid" if [ -s "$oldpid" -a ! -s "$newpid" ]; then (kill $(< "$oldpid") && rm -f "$oldpid" && \ /sbin/service puppet start) >/dev/null 2>&1 || : fi # If an old puppet process (one whose binary is located in /sbin) is running, # kill it and then start up a fresh with the new binary. if [ -e "$newpid" ]; then if ps aux | grep `cat "$newpid"` | grep -v grep | awk '{ print $12 }' | grep -q sbin; then (kill $(< "$newpid") && rm -f "$newpid" && \ /sbin/service puppet start) >/dev/null 2>&1 || : fi fi fi %endif %post server %if 0%{?_with_systemd} /bin/systemctl daemon-reload >/dev/null 2>&1 || : if [ "$1" -ge 1 ]; then # The pidfile changed from 0.25.x to 2.6.x, handle upgrades without leaving # the old process running. oldpid="%{_localstatedir}/run/puppet/puppetmasterd.pid" newpid="%{_localstatedir}/run/puppet/master.pid" if [ -s "$oldpid" -a ! -s "$newpid" ]; then (kill $(< "$oldpid") && rm -f "$oldpid" && \ /bin/systemctl start puppetmaster.service) > /dev/null 2>&1 || : fi fi %else /sbin/chkconfig --add puppetmaster || : if [ "$1" -ge 1 ]; then # The pidfile changed from 0.25.x to 2.6.x, handle upgrades without leaving # the old process running. oldpid="%{_localstatedir}/run/puppet/puppetmasterd.pid" newpid="%{_localstatedir}/run/puppet/master.pid" if [ -s "$oldpid" -a ! -s "$newpid" ]; then (kill $(< "$oldpid") && rm -f "$oldpid" && \ /sbin/service puppetmaster start) >/dev/null 2>&1 || : fi fi %endif %preun %if 0%{?_with_systemd} if [ "$1" -eq 0 ] ; then # Package removal, not upgrade /bin/systemctl --no-reload disable puppetagent.service > /dev/null 2>&1 || : /bin/systemctl --no-reload disable puppet.service > /dev/null 2>&1 || : /bin/systemctl stop puppetagent.service > /dev/null 2>&1 || : /bin/systemctl stop puppet.service > /dev/null 2>&1 || : /bin/systemctl daemon-reload >/dev/null 2>&1 || : fi if [ "$1" == "1" ]; then /bin/systemctl is-enabled puppetagent.service > /dev/null 2>&1 if [ "$?" == "0" ]; then /bin/systemctl --no-reload disable puppetagent.service > /dev/null 2>&1 ||: /bin/systemctl stop puppetagent.service > /dev/null 2>&1 ||: /bin/systemctl daemon-reload >/dev/null 2>&1 ||: if [ ! -d %{pending_upgrade_path} ]; then mkdir -p %{pending_upgrade_path} fi if [ ! -e %{pending_upgrade_file} ]; then touch %{pending_upgrade_file} fi fi fi %else if [ "$1" = 0 ] ; then /sbin/service puppet stop > /dev/null 2>&1 /sbin/chkconfig --del puppet || : fi %endif %preun server %if 0%{?_with_systemd} if [ $1 -eq 0 ] ; then # Package removal, not upgrade /bin/systemctl --no-reload disable puppetmaster.service > /dev/null 2>&1 || : /bin/systemctl stop puppetmaster.service > /dev/null 2>&1 || : /bin/systemctl daemon-reload >/dev/null 2>&1 || : fi %else if [ "$1" = 0 ] ; then /sbin/service puppetmaster stop > /dev/null 2>&1 /sbin/chkconfig --del puppetmaster || : fi %endif %postun %if 0%{?_with_systemd} if [ $1 -ge 1 ] ; then if [ -e %{pending_upgrade_file} ]; then /bin/systemctl --no-reload enable puppet.service > /dev/null 2>&1 ||: /bin/systemctl start puppet.service > /dev/null 2>&1 ||: /bin/systemctl daemon-reload >/dev/null 2>&1 ||: rm %{pending_upgrade_file} fi # Package upgrade, not uninstall /bin/systemctl try-restart puppetagent.service >/dev/null 2>&1 || : fi %else if [ "$1" -ge 1 ]; then /sbin/service puppet condrestart >/dev/null 2>&1 || : fi %endif %postun server %if 0%{?_with_systemd} if [ $1 -ge 1 ] ; then # Package upgrade, not uninstall /bin/systemctl try-restart puppetmaster.service >/dev/null 2>&1 || : fi %else if [ "$1" -ge 1 ]; then /sbin/service puppetmaster condrestart >/dev/null 2>&1 || : fi %endif %clean rm -rf %{buildroot} %changelog * <%= Time.now.strftime("%a %b %d %Y") %> Puppet Labs Release - <%= @rpmversion %>-<%= @rpmrelease %> - Build for <%= @version %> * Wed Oct 2 2013 Jason Antman - Move systemd service and unit file names back to "puppet" from erroneous "puppetagent" - Add symlink to puppetagent unit file for compatibility with current bug - Alter package removal actions to deactivate and stop both service names * Thu Jun 27 2013 Matthaus Owens - 3.2.3-0.1rc0 - Bump requires on ruby-rgen to 0.6.5 * Fri Apr 12 2013 Matthaus Owens - 3.2.0-0.1rc0 - Add requires on ruby-rgen for new parser in Puppet 3.2 * Fri Jan 25 2013 Matthaus Owens - 3.1.0-0.1rc1 - Add extlookup2hiera.8.gz to the files list * Wed Jan 9 2013 Ryan Uber - 3.1.0-0.1rc1 - Work-around for RH Bugzilla 681540 * Fri Dec 28 2012 Michael Stahnke - 3.0.2-2 - Added a script for Network Manager for bug https://bugzilla.redhat.com/532085 * Tue Dec 18 2012 Matthaus Owens - Remove for loop on examples/ code which no longer exists. Add --no-run-if-empty to xargs invocations. * Sat Dec 1 2012 Ryan Uber - Fix for logdir perms regression (#17866) * Wed Aug 29 2012 Moses Mendoza - 3.0.0-0.1rc5 - Update for 3.0.0 rc5 * Fri Aug 24 2012 Eric Sorenson - 3.0.0-0.1rc4 - Facter requirement is 1.6.11, not 2.0 - Update for 3.0.0 rc4 * Tue Aug 21 2012 Moses Mendoza - 2.7.19-1 - Update for 2.7.19 * Tue Aug 14 2012 Moses Mendoza - 2.7.19-0.1rc3 - Update for 2.7.19rc3 * Tue Aug 7 2012 Moses Mendoza - 2.7.19-0.1rc2 - Update for 2.7.19rc2 * Wed Aug 1 2012 Moses Mendoza - 2.7.19-0.1rc1 - Update for 2.7.19rc1 * Wed Jul 11 2012 William Hopper - 2.7.18-2 - (#15221) Create /etc/puppet/modules for puppet module tool * Mon Jul 9 2012 Moses Mendoza - 2.7.18-1 - Update for 2.7.18 * Tue Jun 19 2012 Matthaus Litteken - 2.7.17-1 - Update for 2.7.17 * Wed Jun 13 2012 Matthaus Litteken - 2.7.16-1 - Update for 2.7.16 * Fri Jun 08 2012 Moses Mendoza - 2.7.16-0.1rc1.2 - Updated facter 2.0 dep to include epoch 1 * Wed Jun 06 2012 Matthaus Litteken - 2.7.16-0.1rc1 - Update for 2.7.16rc1, added generated manpages * Fri Jun 01 2012 Matthaus Litteken - 3.0.0-0.1rc3 - Puppet 3.0.0rc3 Release * Fri Jun 01 2012 Matthaus Litteken - 2.7.15-0.1rc4 - Update for 2.7.15rc4 * Tue May 29 2012 Moses Mendoza - 2.7.15-0.1rc3 - Update for 2.7.15rc3 * Tue May 22 2012 Matthaus Litteken - 3.0.0-0.1rc2 - Puppet 3.0.0rc2 Release * Thu May 17 2012 Matthaus Litteken - 3.0.0-0.1rc1 - Puppet 3.0.0rc1 Release * Wed May 16 2012 Moses Mendoza - 2.7.15-0.1rc2 - Update for 2.7.15rc2 * Tue May 15 2012 Moses Mendoza - 2.7.15-0.1rc1 - Update for 2.7.15rc1 * Wed May 02 2012 Moses Mendoza - 2.7.14-1 - Update for 2.7.14 * Tue Apr 10 2012 Matthaus Litteken - 2.7.13-1 - Update for 2.7.13 * Mon Mar 12 2012 Michael Stahnke - 2.7.12-1 - Update for 2.7.12 * Fri Feb 24 2012 Matthaus Litteken - 2.7.11-2 - Update 2.7.11 from proper tag, including #12572 * Wed Feb 22 2012 Michael Stahnke - 2.7.11-1 - Update for 2.7.11 * Wed Jan 25 2012 Michael Stahnke - 2.7.10-1 - Update for 2.7.10 * Fri Dec 9 2011 Matthaus Litteken - 2.7.9-1 - Update for 2.7.9 * Thu Dec 8 2011 Matthaus Litteken - 2.7.8-1 - Update for 2.7.8 * Wed Nov 30 2011 Michael Stahnke - 2.7.8-0.1rc1 - Update for 2.7.8rc1 * Mon Nov 21 2011 Michael Stahnke - 2.7.7-1 - Relaese 2.7.7 * Tue Nov 01 2011 Michael Stahnke - 2.7.7-0.1rc1 - Update for 2.7.7rc1 * Fri Oct 21 2011 Michael Stahnke - 2.7.6-1 - 2.7.6 final * Thu Oct 13 2011 Michael Stahnke - 2.7.6-.1rc3 - New RC * Fri Oct 07 2011 Michael Stahnke - 2.7.6-0.1rc2 - New RC * Mon Oct 03 2011 Michael Stahnke - 2.7.6-0.1rc1 - New RC * Fri Sep 30 2011 Michael Stahnke - 2.7.5-1 - Fixes for CVE-2011-3869, 3870, 3871 * Wed Sep 28 2011 Michael Stahnke - 2.7.4-1 - Fix for CVE-2011-3484 * Wed Jul 06 2011 Michael Stahnke - 2.7.2-0.2.rc1 - Clean up rpmlint errors - Put man pages in correct package * Wed Jul 06 2011 Michael Stahnke - 2.7.2-0.1.rc1 - Update to 2.7.2rc1 * Wed Jun 15 2011 Todd Zullinger - 2.6.9-0.1.rc1 - Update rc versioning to ensure 2.6.9 final is newer to rpm - sync changes with Fedora/EPEL * Tue Jun 14 2011 Michael Stahnke - 2.6.9rc1-1 - Update to 2.6.9rc1 * Thu Apr 14 2011 Todd Zullinger - 2.6.8-1 - Update to 2.6.8 * Thu Mar 24 2011 Todd Zullinger - 2.6.7-1 - Update to 2.6.7 * Wed Mar 16 2011 Todd Zullinger - 2.6.6-1 - Update to 2.6.6 - Ensure %%pre exits cleanly - Fix License tag, puppet is now GPLv2 only - Create and own /usr/share/puppet/modules (#615432) - Properly restart puppet agent/master daemons on upgrades from 0.25.x - Require libselinux-utils when selinux support is enabled - Support tmpfiles.d for Fedora >= 15 (#656677) * Wed Feb 09 2011 Fedora Release Engineering - 0.25.5-2 - Rebuilt for https://fedoraproject.org/wiki/Fedora_15_Mass_Rebuild * Mon May 17 2010 Todd Zullinger - 0.25.5-1 - Update to 0.25.5 - Adjust selinux conditional for EL-6 - Apply rundir-perms patch from tarball rather than including it separately - Update URL's to reflect the new puppetlabs.com domain * Fri Jan 29 2010 Todd Zullinger - 0.25.4-1 - Update to 0.25.4 * Tue Jan 19 2010 Todd Zullinger - 0.25.3-2 - Apply upstream patch to fix cron resources (upstream #2845) * Mon Jan 11 2010 Todd Zullinger - 0.25.3-1 - Update to 0.25.3 * Tue Jan 05 2010 Todd Zullinger - 0.25.2-1.1 - Replace %%define with %%global for macros * Tue Jan 05 2010 Todd Zullinger - 0.25.2-1 - Update to 0.25.2 - Fixes CVE-2010-0156, tmpfile security issue (#502881) - Install auth.conf, puppetqd manpage, and queuing examples/docs * Wed Nov 25 2009 Jeroen van Meeuwen - 0.25.1-1 - New upstream version * Tue Oct 27 2009 Todd Zullinger - 0.25.1-0.3 - Update to 0.25.1 - Include the pi program and man page (R.I.Pienaar) * Sat Oct 17 2009 Todd Zullinger - 0.25.1-0.2.rc2 - Update to 0.25.1rc2 * Tue Sep 22 2009 Todd Zullinger - 0.25.1-0.1.rc1 - Update to 0.25.1rc1 - Move puppetca to puppet package, it has uses on client systems - Drop redundant %%doc from manpage %%file listings * Fri Sep 04 2009 Todd Zullinger - 0.25.0-1 - Update to 0.25.0 - Fix permissions on /var/log/puppet (#495096) - Install emacs mode and vim syntax files (#491437) - Install ext/ directory in %%{_datadir}/%%{name} (/usr/share/puppet) * Mon May 04 2009 Todd Zullinger - 0.25.0-0.1.beta1 - Update to 0.25.0beta1 - Make Augeas and SELinux requirements build time options * Mon Mar 23 2009 Todd Zullinger - 0.24.8-1 - Update to 0.24.8 - Quiet output from %%pre - Use upstream install script - Increase required facter version to >= 1.5 * Tue Dec 16 2008 Todd Zullinger - 0.24.7-4 - Remove redundant useradd from %%pre * Tue Dec 16 2008 Jeroen van Meeuwen - 0.24.7-3 - New upstream version - Set a static uid and gid (#472073, #471918, #471919) - Add a conditional requirement on libselinux-ruby for Fedora >= 9 - Add a dependency on ruby-augeas * Wed Oct 22 2008 Todd Zullinger - 0.24.6-1 - Update to 0.24.6 - Require ruby-shadow on Fedora and RHEL >= 5 - Simplify Fedora/RHEL version checks for ruby(abi) and BuildArch - Require chkconfig and initstripts for preun, post, and postun scripts - Conditionally restart puppet in %%postun - Ensure %%preun, %%post, and %%postun scripts exit cleanly - Create puppet user/group according to Fedora packaging guidelines - Quiet a few rpmlint complaints - Remove useless %%pbuild macro - Make specfile more like the Fedora/EPEL template * Mon Jul 28 2008 David Lutterkort - 0.24.5-1 - Add /usr/bin/puppetdoc * Thu Jul 24 2008 Brenton Leanhardt - New version - man pages now ship with tarball - examples/code moved to root examples dir in upstream tarball * Tue Mar 25 2008 David Lutterkort - 0.24.4-1 - Add man pages (from separate tarball, upstream will fix to include in main tarball) * Mon Mar 24 2008 David Lutterkort - 0.24.3-1 - New version * Wed Mar 5 2008 David Lutterkort - 0.24.2-1 - New version * Sat Dec 22 2007 David Lutterkort - 0.24.1-1 - New version * Mon Dec 17 2007 David Lutterkort - 0.24.0-2 - Use updated upstream tarball that contains yumhelper.py * Fri Dec 14 2007 David Lutterkort - 0.24.0-1 - Fixed license - Munge examples/ to make rpmlint happier * Wed Aug 22 2007 David Lutterkort - 0.23.2-1 - New version * Thu Jul 26 2007 David Lutterkort - 0.23.1-1 - Remove old config files * Wed Jun 20 2007 David Lutterkort - 0.23.0-1 - Install one puppet.conf instead of old config files, keep old configs around to ease update - Use plain shell commands in install instead of macros * Wed May 2 2007 David Lutterkort - 0.22.4-1 - New version * Thu Mar 29 2007 David Lutterkort - 0.22.3-1 - Claim ownership of _sysconfdir/puppet (bz 233908) * Mon Mar 19 2007 David Lutterkort - 0.22.2-1 - Set puppet's homedir to /var/lib/puppet, not /var/puppet - Remove no-lockdir patch, not needed anymore * Mon Feb 12 2007 David Lutterkort - 0.22.1-2 - Fix bogus config parameter in puppetd.conf * Sat Feb 3 2007 David Lutterkort - 0.22.1-1 - New version * Fri Jan 5 2007 David Lutterkort - 0.22.0-1 - New version * Mon Nov 20 2006 David Lutterkort - 0.20.1-2 - Make require ruby(abi) and buildarch: noarch conditional for fedora 5 or later to allow building on older fedora releases * Mon Nov 13 2006 David Lutterkort - 0.20.1-1 - New version * Mon Oct 23 2006 David Lutterkort - 0.20.0-1 - New version * Tue Sep 26 2006 David Lutterkort - 0.19.3-1 - New version * Mon Sep 18 2006 David Lutterkort - 0.19.1-1 - New version * Thu Sep 7 2006 David Lutterkort - 0.19.0-1 - New version * Tue Aug 1 2006 David Lutterkort - 0.18.4-2 - Use /usr/bin/ruby directly instead of /usr/bin/env ruby in executables. Otherwise, initscripts break since pidof can't find the right process * Tue Aug 1 2006 David Lutterkort - 0.18.4-1 - New version * Fri Jul 14 2006 David Lutterkort - 0.18.3-1 - New version * Wed Jul 5 2006 David Lutterkort - 0.18.2-1 - New version * Wed Jun 28 2006 David Lutterkort - 0.18.1-1 - Removed lsb-config.patch and yumrepo.patch since they are upstream now * Mon Jun 19 2006 David Lutterkort - 0.18.0-1 - Patch config for LSB compliance (lsb-config.patch) - Changed config moves /var/puppet to /var/lib/puppet, /etc/puppet/ssl to /var/lib/puppet, /etc/puppet/clases.txt to /var/lib/puppet/classes.txt, /etc/puppet/localconfig.yaml to /var/lib/puppet/localconfig.yaml * Fri May 19 2006 David Lutterkort - 0.17.2-1 - Added /usr/bin/puppetrun to server subpackage - Backported patch for yumrepo type (yumrepo.patch) * Wed May 3 2006 David Lutterkort - 0.16.4-1 - Rebuilt * Fri Apr 21 2006 David Lutterkort - 0.16.0-1 - Fix default file permissions in server subpackage - Run puppetmaster as user puppet - rebuilt for 0.16.0 * Mon Apr 17 2006 David Lutterkort - 0.15.3-2 - Don't create empty log files in post-install scriptlet * Fri Apr 7 2006 David Lutterkort - 0.15.3-1 - Rebuilt for new version * Wed Mar 22 2006 David Lutterkort - 0.15.1-1 - Patch0: Run puppetmaster as root; running as puppet is not ready for primetime * Mon Mar 13 2006 David Lutterkort - 0.15.0-1 - Commented out noarch; requires fix for bz184199 * Mon Mar 6 2006 David Lutterkort - 0.14.0-1 - Added BuildRequires for ruby * Wed Mar 1 2006 David Lutterkort - 0.13.5-1 - Removed use of fedora-usermgmt. It is not required for Fedora Extras and makes it unnecessarily hard to use this rpm outside of Fedora. Just allocate the puppet uid/gid dynamically * Sun Feb 19 2006 David Lutterkort - 0.13.0-4 - Use fedora-usermgmt to create puppet user/group. Use uid/gid 24. Fixed problem with listing fileserver.conf and puppetmaster.conf twice * Wed Feb 8 2006 David Lutterkort - 0.13.0-3 - Fix puppetd.conf * Wed Feb 8 2006 David Lutterkort - 0.13.0-2 - Changes to run puppetmaster as user puppet * Mon Feb 6 2006 David Lutterkort - 0.13.0-1 - Don't mark initscripts as config files * Mon Feb 6 2006 David Lutterkort - 0.12.0-2 - Fix BuildRoot. Add dist to release * Tue Jan 17 2006 David Lutterkort - 0.11.0-1 - Rebuild * Thu Jan 12 2006 David Lutterkort - 0.10.2-1 - Updated for 0.10.2 Fixed minor kink in how Source is given * Wed Jan 11 2006 David Lutterkort - 0.10.1-3 - Added basic fileserver.conf * Wed Jan 11 2006 David Lutterkort - 0.10.1-1 - Updated. Moved installation of library files to sitelibdir. Pulled initscripts into separate files. Folded tools rpm into server * Thu Nov 24 2005 Duane Griffin - Added init scripts for the client * Wed Nov 23 2005 Duane Griffin - First packaging diff --git a/lib/puppet/application/secret_agent.rb b/lib/puppet/application/secret_agent.rb deleted file mode 100644 index 6bee28431..000000000 --- a/lib/puppet/application/secret_agent.rb +++ /dev/null @@ -1,9 +0,0 @@ -require 'puppet/application/face_base' -require 'puppet/face' - -# NOTE: this is using an "old" naming convention (underscores instead of camel-case), for backwards -# compatibility with 2.7.x. When the old naming convention is officially and publicly deprecated, -# this should be changed to camel-case. -class Puppet::Application::Secret_agent < Puppet::Application::FaceBase - run_mode :agent -end diff --git a/lib/puppet/face/catalog.rb b/lib/puppet/face/catalog.rb index ae2dadc29..e596a55e5 100644 --- a/lib/puppet/face/catalog.rb +++ b/lib/puppet/face/catalog.rb @@ -1,130 +1,130 @@ require 'puppet/indirector/face' Puppet::Indirector::Face.define(:catalog, '0.0.1') do copyright "Puppet Labs", 2011 license "Apache 2 license; see COPYING" summary "Compile, save, view, and convert catalogs." description <<-'EOT' This subcommand deals with catalogs, which are compiled per-node artifacts generated from a set of Puppet manifests. By default, it interacts with the compiling subsystem and compiles a catalog using the default manifest and `certname`, but you can change the source of the catalog with the `--terminus` option. You can also choose to print any catalog in 'dot' format (for easy graph viewing with OmniGraffle or Graphviz) with '--render-as dot'. EOT short_description <<-'EOT' This subcommand deals with catalogs, which are compiled per-node artifacts generated from a set of Puppet manifests. By default, it interacts with the compiling subsystem and compiles a catalog using the default manifest and `certname`; use the `--terminus` option to change the source of the catalog. EOT get_action(:destroy).summary "Invalid for this subcommand." get_action(:search).summary "Invalid for this subcommand." find = get_action(:find) find.summary "Retrieve the catalog for a node." find.arguments "" find.returns <<-'EOT' A serialized catalog. When used from the Ruby API, returns a Puppet::Resource::Catalog object. EOT action(:apply) do summary "Find and apply a catalog." description <<-'EOT' Finds and applies a catalog. This action takes no arguments, but the source of the catalog can be managed with the `--terminus` option. EOT returns <<-'EOT' Nothing. When used from the Ruby API, returns a Puppet::Transaction::Report object. EOT examples <<-'EOT' Apply the locally cached catalog: $ puppet catalog apply --terminus yaml Retrieve a catalog from the master and apply it, in one step: $ puppet catalog apply --terminus rest - From `secret_agent.rb` (API example): + API example: # ... Puppet::Face[:catalog, '0.0.1'].download # (Termini are singletons; catalog.download has a side effect of # setting the catalog terminus to yaml) report = Puppet::Face[:catalog, '0.0.1'].apply # ... EOT when_invoked do |options| catalog = Puppet::Face[:catalog, "0.0.1"].find(Puppet[:certname]) or raise "Could not find catalog for #{Puppet[:certname]}" catalog = catalog.to_ral report = Puppet::Transaction::Report.new("apply") report.configuration_version = catalog.version report.environment = Puppet[:environment] Puppet::Util::Log.newdestination(report) begin benchmark(:notice, "Finished catalog run") do catalog.apply(:report => report) end rescue => detail Puppet.log_exception(detail, "Failed to apply catalog: #{detail}") end report.finalize_report report end end action(:download) do summary "Download this node's catalog from the puppet master server." description <<-'EOT' Retrieves a catalog from the puppet master and saves it to the local yaml cache. This action always contacts the puppet master and will ignore alternate termini. The saved catalog can be used in any subsequent catalog action by specifying '--terminus yaml' for that action. EOT returns "Nothing." notes <<-'EOT' When used from the Ruby API, this action has a side effect of leaving Puppet::Resource::Catalog.indirection.terminus_class set to yaml. The terminus must be explicitly re-set for subsequent catalog actions. EOT examples <<-'EOT' Retrieve and store a catalog: $ puppet catalog download - From `secret_agent.rb` (API example): + API example: Puppet::Face[:plugin, '0.0.1'].download Puppet::Face[:facts, '0.0.1'].upload Puppet::Face[:catalog, '0.0.1'].download # ... EOT when_invoked do |options| Puppet::Resource::Catalog.indirection.terminus_class = :rest Puppet::Resource::Catalog.indirection.cache_class = nil catalog = nil retrieval_duration = thinmark do catalog = Puppet::Face[:catalog, '0.0.1'].find(Puppet[:certname]) end catalog.retrieval_duration = retrieval_duration catalog.write_class_file Puppet::Resource::Catalog.indirection.terminus_class = :yaml Puppet::Face[:catalog, "0.0.1"].save(catalog) Puppet.notice "Saved catalog for #{Puppet[:certname]} to yaml" nil end end end diff --git a/lib/puppet/face/report.rb b/lib/puppet/face/report.rb index 55288cc42..c5ff1a4a9 100644 --- a/lib/puppet/face/report.rb +++ b/lib/puppet/face/report.rb @@ -1,54 +1,54 @@ require 'puppet/indirector/face' Puppet::Indirector::Face.define(:report, '0.0.1') do copyright "Puppet Labs", 2011 license "Apache 2 license; see COPYING" summary "Create, display, and submit reports." get_action(:find).summary "Invalid for this face." get_action(:search).summary "Invalid for this face." get_action(:destroy).summary "Invalid for this face." save = get_action(:save) save.summary "API only: submit a report." save.arguments "" save.returns "Nothing." save.examples <<-'EOT' From the implementation of `puppet report submit` (API example): begin Puppet::Transaction::Report.indirection.terminus_class = :rest Puppet::Face[:report, "0.0.1"].save(report) Puppet.notice "Uploaded report for #{report.name}" rescue => detail Puppet.log_exception(detail, "Could not send report: #{detail}") end EOT action(:submit) do summary "API only: submit a report with error handling." description <<-'EOT' API only: Submits a report to the puppet master. This action is essentially a shortcut and wrapper for the `save` action with the `rest` terminus, and provides additional details in the event of a failure. EOT arguments "" examples <<-'EOT' - From secret_agent.rb (API example): + API example: # ... report = Puppet::Face[:catalog, '0.0.1'].apply Puppet::Face[:report, '0.0.1'].submit(report) return report EOT when_invoked do |report, options| begin Puppet::Transaction::Report.indirection.terminus_class = :rest Puppet::Face[:report, "0.0.1"].save(report) Puppet.notice "Uploaded report for #{report.name}" rescue => detail Puppet.log_exception(detail, "Could not send report: #{detail}") end end end end diff --git a/lib/puppet/face/secret_agent.rb b/lib/puppet/face/secret_agent.rb deleted file mode 100644 index 7771d576a..000000000 --- a/lib/puppet/face/secret_agent.rb +++ /dev/null @@ -1,54 +0,0 @@ -require 'puppet/face' - -Puppet::Face.define(:secret_agent, '0.0.1') do - copyright "Puppet Labs", 2011 - license "Apache 2 license; see COPYING" - - summary "Mimics puppet agent." - description <<-'EOT' - This subcommand currently functions as a proof of concept, demonstrating how - the Faces API exposes Puppet's internal systems to application logic; - compare the actual code for puppet agent. It will eventually replace puppet - agent entirely, and can provide a template for users who wish to implement - agent-like functionality with non-standard application logic. - EOT - - action(:synchronize) do - default - summary "Run secret_agent once." - description <<-'EOT' - Mimics a single run of puppet agent. This action does not currently - daemonize, but can download plugins, submit facts, retrieve and apply a - catalog, and submit a report to the puppet master. - EOT - returns <<-'EOT' - Verbose logging from the completed run. When used from the Ruby API: - returns a Puppet::Transaction::Report object. - EOT - examples <<-'EOT' - Trigger a Puppet run with the configured puppet master: - - $ puppet secret_agent - EOT - notes <<-'EOT' - This action requires that the puppet master's `auth.conf` file allow save - access to the `facts` REST terminus. Puppet agent does not use this - facility, and it is turned off by default. See - for more details. - EOT - - when_invoked do |options| - Puppet::Face[:plugin, '0.0.1'].download - - Puppet::Face[:facts, '0.0.1'].upload - - Puppet::Face[:catalog, '0.0.1'].download - - report = Puppet::Face[:catalog, '0.0.1'].apply - - Puppet::Face[:report, '0.0.1'].submit(report) - - return report - end - end -end diff --git a/man/man5/puppet.conf.5 b/man/man5/puppet.conf.5 index f653f8c4d..9b0ea8136 100644 --- a/man/man5/puppet.conf.5 +++ b/man/man5/puppet.conf.5 @@ -1,2028 +1,2004 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPETCONF" "5" "September 2014" "Puppet Labs, LLC" "Puppet manual" -\fBThis page is autogenerated; any changes will get overwritten\fR \fI(last generated on 2014\-09\-16 20:41:04 \-0700)\fR +.TH "PUPPETCONF" "5" "October 2014" "Puppet Labs, LLC" "Puppet manual" +\fBThis page is autogenerated; any changes will get overwritten\fR \fI(last generated on 2014\-10\-16 00:42:14 +0200)\fR . .SH "Configuration Settings" . .IP "\(bu" 4 Each of these settings can be specified in \fBpuppet\.conf\fR or on the command line\. . .IP "\(bu" 4 When using boolean settings on the command line, use \fB\-\-setting\fR and \fB\-\-no\-setting\fR instead of \fB\-\-setting (true|false)\fR\. . .IP "\(bu" 4 Settings can be interpolated as \fB$variables\fR in other settings; \fB$environment\fR is special, in that puppet master will interpolate each agent node\'s environment instead of its own\. . .IP "\(bu" 4 Multiple values should be specified as comma\-separated lists; multiple directories should be separated with the system path separator (usually a colon)\. . .IP "\(bu" 4 Settings that represent time intervals should be specified in duration format: an integer immediately followed by one of the units \'y\' (years of 365 days), \'d\' (days), \'h\' (hours), \'m\' (minutes), or \'s\' (seconds)\. The unit cannot be combined with other units, and defaults to seconds when omitted\. Examples are \'3600\' which is equivalent to \'1h\' (one hour), and \'1825d\' which is equivalent to \'5y\' (5 years)\. . .IP "\(bu" 4 Settings that take a single file or directory can optionally set the owner, group, and mode for their value: \fBrundir = $vardir/run { owner = puppet, group = puppet, mode = 644 }\fR . .IP "\(bu" 4 The Puppet executables will ignore any setting that isn\'t relevant to their function\. . .IP "" 0 . .P See the configuration guide \fIhttp://docs\.puppetlabs\.com/guides/configuring\.html\fR for more details\. . .SS "agent_catalog_run_lockfile" A lock file to indicate that a puppet agent catalog run is currently in progress\. The file contains the pid of the process that holds the lock on the catalog run\. . .IP "\(bu" 4 \fIDefault\fR: $statedir/agent_catalog_run\.lock . .IP "" 0 . .SS "agent_disabled_lockfile" A lock file to indicate that puppet agent runs have been administratively disabled\. File contains a JSON object with state information\. . .IP "\(bu" 4 \fIDefault\fR: $statedir/agent_disabled\.lock . .IP "" 0 . .SS "allow_duplicate_certs" Whether to allow a new certificate request to overwrite an existing certificate\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "allow_variables_with_dashes" Permit hyphens (\fB\-\fR) in variable names and issue deprecation warnings about them\. This setting \fBshould always be \fBfalse\fR;\fR setting it to \fBtrue\fR will cause subtle and wide\-ranging bugs\. It will be removed in a future version\. . .P Hyphenated variables caused major problems in the language, but were allowed between Puppet 2\.7\.3 and 2\.7\.14\. If you used them during this window, we apologize for the inconvenience \-\-\- you can temporarily set this to \fBtrue\fR in order to upgrade, and can rename your variables at your leisure\. Please revert it to \fBfalse\fR after you have renamed all affected variables\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "always_cache_features" Affects how we cache attempts to load Puppet \'features\'\. If false, then calls to \fBPuppet\.features\.?\fR will always attempt to load the feature (which can be an expensive operation) unless it has already been loaded successfully\. This makes it possible for a single agent run to, e\.g\., install a package that provides the underlying capabilities for a feature, and then later load that feature during the same run (even if the feature had been tested earlier and had not been available)\. . .P If this setting is set to true, then features will only be checked once, and if they are not available, the negative result is cached and returned for all subsequent attempts to load the feature\. This behavior is almost always appropriate for the server, and can result in a significant performance improvement for features that are checked frequently\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "archive_file_server" During an inspect run, the file bucket server to archive files to if archive_files is set\. . .IP "\(bu" 4 \fIDefault\fR: $server . .IP "" 0 . .SS "archive_files" During an inspect run, whether to archive files whose contents are audited to a file bucket\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "autoflush" Whether log files should always flush to disk\. . .IP "\(bu" 4 \fIDefault\fR: true . .IP "" 0 . .SS "autosign" Whether (and how) to autosign certificate requests\. This setting is only relevant on a puppet master acting as a certificate authority (CA)\. . .P Valid values are true (autosigns all certificate requests; not recommended), false (disables autosigning certificates), or the absolute path to a file\. . .P The file specified in this setting may be either a \fBconfiguration file\fR or a \fBcustom policy executable\.\fR Puppet will automatically determine what it is: If the Puppet user (see the \fBuser\fR setting) can execute the file, it will be treated as a policy executable; otherwise, it will be treated as a config file\. . .P If a custom policy executable is configured, the CA puppet master will run it every time it receives a CSR\. The executable will be passed the subject CN of the request \fIas a command line argument,\fR and the contents of the CSR in PEM format \fIon stdin\.\fR It should exit with a status of 0 if the cert should be autosigned and non\-zero if the cert should not be autosigned\. . .P If a certificate request is not autosigned, it will persist for review\. An admin user can use the \fBpuppet cert sign\fR command to manually sign it, or can delete the request\. . .P For info on autosign configuration files, see the guide to Puppet\'s config files \fIhttp://docs\.puppetlabs\.com/guides/configuring\.html\fR\. . .IP "\(bu" 4 \fIDefault\fR: $confdir/autosign\.conf . .IP "" 0 . .SS "basemodulepath" The search path for \fBglobal\fR modules\. Should be specified as a list of directories separated by the system path separator character\. (The POSIX path separator is \':\', and the Windows path separator is \';\'\.) . .P If you are using directory environments, these are the modules that will be used by \fIall\fR environments\. Note that the \fBmodules\fR directory of the active environment will have priority over any global directories\. For more info, see http://docs\.puppetlabs\.com/puppet/latest/reference/environments\.html . .P This setting also provides the default value for the deprecated \fBmodulepath\fR setting, which is used when directory environments are disabled\. . .IP "\(bu" 4 \fIDefault\fR: $confdir/modules:/usr/share/puppet/modules . .IP "" 0 . .SS "bindaddress" The address a listening server should bind to\. . .IP "\(bu" 4 \fIDefault\fR: 0\.0\.0\.0 . .IP "" 0 . .SS "binder" Turns the binding system on or off\. This includes bindings in modules\. The binding system aggregates data from modules and other locations and makes them available for lookup\. The binding system is experimental and any or all of it may change\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "binder_config" The binder configuration file\. Puppet reads this file on each request to configure the bindings system\. If set to nil (the default), a $confdir/binder_config\.yaml is optionally loaded\. If it does not exists, a default configuration is used\. If the setting :binding_config is specified, it must reference a valid and existing yaml file\. . .TP \fIDefault\fR: . .SS "bucketdir" Where FileBucket files are stored\. . .IP "\(bu" 4 \fIDefault\fR: $vardir/bucket . .IP "" 0 . .SS "ca" Whether the master should function as a certificate authority\. . .IP "\(bu" 4 \fIDefault\fR: true . .IP "" 0 . .SS "ca_name" The name to use the Certificate Authority certificate\. . .IP "\(bu" 4 \fIDefault\fR: Puppet CA: $certname . .IP "" 0 . .SS "ca_port" The port to use for the certificate authority\. . .IP "\(bu" 4 \fIDefault\fR: $masterport . .IP "" 0 . .SS "ca_server" The server to use for certificate authority requests\. It\'s a separate server because it cannot and does not need to horizontally scale\. . .IP "\(bu" 4 \fIDefault\fR: $server . .IP "" 0 . .SS "ca_ttl" The default TTL for new certificates\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\. . .IP "\(bu" 4 \fIDefault\fR: 5y . .IP "" 0 . .SS "cacert" The CA certificate\. . .IP "\(bu" 4 \fIDefault\fR: $cadir/ca_crt\.pem . .IP "" 0 . .SS "cacrl" The certificate revocation list (CRL) for the CA\. Will be used if present but otherwise ignored\. . .IP "\(bu" 4 \fIDefault\fR: $cadir/ca_crl\.pem . .IP "" 0 . .SS "cadir" The root directory for the certificate authority\. . .IP "\(bu" 4 \fIDefault\fR: $ssldir/ca . .IP "" 0 . .SS "cakey" The CA private key\. . .IP "\(bu" 4 \fIDefault\fR: $cadir/ca_key\.pem . .IP "" 0 . .SS "capass" Where the CA stores the password for the private key\. . .IP "\(bu" 4 \fIDefault\fR: $caprivatedir/ca\.pass . .IP "" 0 . .SS "caprivatedir" Where the CA stores private certificate information\. . .IP "\(bu" 4 \fIDefault\fR: $cadir/private . .IP "" 0 . .SS "capub" The CA public key\. . .IP "\(bu" 4 \fIDefault\fR: $cadir/ca_pub\.pem . .IP "" 0 . .SS "catalog_cache_terminus" How to store cached catalogs\. Valid values are \'json\', \'msgpack\' and \'yaml\'\. The agent application defaults to \'json\'\. . .TP \fIDefault\fR: . .SS "catalog_format" (Deprecated for \'preferred_serialization_format\') What format to use to dump the catalog\. Only supports \'marshal\' and \'yaml\'\. Only matters on the client, since it asks the server for a specific format\. . .SS "catalog_terminus" Where to get node catalogs\. This is useful to change if, for instance, you\'d like to pre\-compile catalogs and store them in memcached or some other easily\-accessed store\. . .IP "\(bu" 4 \fIDefault\fR: compiler . .IP "" 0 . .SS "cert_inventory" The inventory file\. This is a text file to which the CA writes a complete listing of all certificates\. . .IP "\(bu" 4 \fIDefault\fR: $cadir/inventory\.txt . .IP "" 0 . .SS "certdir" The certificate directory\. . .IP "\(bu" 4 \fIDefault\fR: $ssldir/certs . .IP "" 0 . .SS "certdnsnames" The \fBcertdnsnames\fR setting is no longer functional, after CVE\-2011\-3872\. We ignore the value completely\. . .P For your own certificate request you can set \fBdns_alt_names\fR in the configuration and it will apply locally\. There is no configuration option to set DNS alt names, or any other \fBsubjectAltName\fR value, for another nodes certificate\. . .P Alternately you can use the \fB\-\-dns_alt_names\fR command line option to set the labels added while generating your own CSR\. . .SS "certificate_expire_warning" The window of time leading up to a certificate\'s expiration that a notification will be logged\. This applies to CA, master, and agent certificates\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\. . .IP "\(bu" 4 \fIDefault\fR: 60d . .IP "" 0 . .SS "certificate_revocation" Whether certificate revocation should be supported by downloading a Certificate Revocation List (CRL) to all clients\. If enabled, CA chaining will almost definitely not work\. . .IP "\(bu" 4 \fIDefault\fR: true . .IP "" 0 . .SS "certname" The name to use when handling certificates\. When a node requests a certificate from the CA puppet master, it uses the value of the \fBcertname\fR setting as its requested Subject CN\. . .P This is the name used when managing a node\'s permissions in auth\.conf \fIhttp://docs\.puppetlabs\.com/puppet/latest/reference/config_file_auth\.html\fR\. In most cases, it is also used as the node\'s name when matching node definitions \fIhttp://docs\.puppetlabs\.com/puppet/latest/reference/lang_node_definitions\.html\fR and requesting data from an ENC\. (This can be changed with the \fBnode_name_value\fR and \fBnode_name_fact\fR settings, although you should only do so if you have a compelling reason\.) . .P A node\'s certname is available in Puppet manifests as \fB$trusted[\'certname\']\fR\. (See Facts and Built\-In Variables \fIhttp://docs\.puppetlabs\.com/puppet/latest/reference/lang_facts_and_builtin_vars\.html\fR for more details\.) . .IP "\(bu" 4 For best compatibility, you should limit the value of \fBcertname\fR to only use letters, numbers, periods, underscores, and dashes\. (That is, it should match \fB/A[a\-z0\-9\._\-]+Z/\fR\.) . .IP "\(bu" 4 The special value \fBca\fR is reserved, and can\'t be used as the certname for a normal node\. . .IP "" 0 . .P Defaults to the node\'s fully qualified domain name\. . .IP "\(bu" 4 -\fIDefault\fR: aparker\.corp\.puppetlabs\.net +\fIDefault\fR: henriks\-macbook\-pro\.local . .IP "" 0 . .SS "cfacter" Whether or not to use the native facter (cfacter) implementation instead of the Ruby one (facter)\. Defaults to false\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "classfile" The file in which puppet agent stores a list of the classes associated with the retrieved configuration\. Can be loaded in the separate \fBpuppet\fR executable using the \fB\-\-loadclasses\fR option\. . .IP "\(bu" 4 \fIDefault\fR: $statedir/classes\.txt . .IP "" 0 . .SS "client_datadir" The directory in which serialized data is stored on the client\. . .IP "\(bu" 4 \fIDefault\fR: $vardir/client_data . .IP "" 0 . .SS "clientbucketdir" Where FileBucket files are stored locally\. . .IP "\(bu" 4 \fIDefault\fR: $vardir/clientbucket . .IP "" 0 . .SS "clientyamldir" The directory in which client\-side YAML data is stored\. . .IP "\(bu" 4 \fIDefault\fR: $vardir/client_yaml . .IP "" 0 . .SS "code" Code to parse directly\. This is essentially only used by \fBpuppet\fR, and should only be set if you\'re writing your own Puppet executable\. . .SS "color" Whether to use colors when logging to the console\. Valid values are \fBansi\fR (equivalent to \fBtrue\fR), \fBhtml\fR, and \fBfalse\fR, which produces no color\. Defaults to false on Windows, as its console does not support ansi colors\. . .IP "\(bu" 4 \fIDefault\fR: ansi . .IP "" 0 . .SS "confdir" The main Puppet configuration directory\. The default for this setting is calculated based on the user\. If the process is running as root or the user that Puppet 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 the user\'s home directory\. . .IP "\(bu" 4 \fIDefault\fR: /etc/puppet . .IP "" 0 . .SS "config" The configuration file for the current puppet application\. . .IP "\(bu" 4 \fIDefault\fR: $confdir/${config_file_name} . .IP "" 0 . .SS "config_file_name" The name of the puppet config file\. . .IP "\(bu" 4 \fIDefault\fR: puppet\.conf . .IP "" 0 . .SS "config_version" How to determine the configuration version\. By default, it will be the time that the configuration is parsed, but you can provide a shell script to override how the version is determined\. The output of this script will be added to every log message in the reports, allowing you to correlate changes on your hosts to the source version on the server\. . .P Setting a global value for config_version in puppet\.conf is deprecated\. Please set a per\-environment value in environment\.conf instead\. For more info, see http://docs\.puppetlabs\.com/puppet/latest/reference/environments\.html . .SS "configprint" Print the value of a specific configuration setting\. If the name of a setting is provided for this, then the value is printed and puppet exits\. Comma\-separate multiple values\. For a list of all values, specify \'all\'\. . .SS "configtimeout" 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\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\. . .IP "\(bu" 4 \fIDefault\fR: 2m . .IP "" 0 . .SS "csr_attributes" An optional file containing custom attributes to add to certificate signing requests (CSRs)\. You should ensure that this file does not exist on your CA puppet master; if it does, unwanted certificate extensions may leak into certificates created with the \fBpuppet cert generate\fR command\. . .P If present, this file must be a YAML hash containing a \fBcustom_attributes\fR key and/or an \fBextension_requests\fR key\. The value of each key must be a hash, where each key is a valid OID and each value is an object that can be cast to a string\. . .P Custom attributes can be used by the CA when deciding whether to sign the certificate, but are then discarded\. Attribute OIDs can be any OID value except the standard CSR attributes (i\.e\. attributes described in RFC 2985 section 5\.4)\. This is useful for embedding a pre\-shared key for autosigning policy executables (see the \fBautosign\fR setting), often by using the \fB1\.2\.840\.113549\.1\.9\.7\fR ("challenge password") OID\. . .P Extension requests will be permanently embedded in the final certificate\. Extension OIDs must be in the "ppRegCertExt" (\fB1\.3\.6\.1\.4\.1\.34380\.1\.1\fR) or "ppPrivCertExt" (\fB1\.3\.6\.1\.4\.1\.34380\.1\.2\fR) OID arcs\. The ppRegCertExt arc is reserved for four of the most common pieces of data to embed: \fBpp_uuid\fR (\fB\.1\fR), \fBpp_instance_id\fR (\fB\.2\fR), \fBpp_image_name\fR (\fB\.3\fR), and \fBpp_preshared_key\fR (\fB\.4\fR) \-\-\- in the YAML file, these can be referred to by their short descriptive names instead of their full OID\. The ppPrivCertExt arc is unregulated, and can be used for site\-specific extensions\. . .IP "\(bu" 4 \fIDefault\fR: $confdir/csr_attributes\.yaml . .IP "" 0 . .SS "csrdir" Where the CA stores certificate requests . .IP "\(bu" 4 \fIDefault\fR: $cadir/requests . .IP "" 0 . .SS "daemonize" Whether to send the process into the background\. This defaults to true on POSIX systems, and to false on Windows (where Puppet currently cannot daemonize)\. . .IP "\(bu" 4 \fIDefault\fR: true . .IP "" 0 . .SS "data_binding_terminus" Where to retrive information about data\. . .IP "\(bu" 4 \fIDefault\fR: hiera . .IP "" 0 . .SS "dbadapter" The type of database to use\. This setting is only used by the ActiveRecord storeconfigs and inventory backends, which are deprecated\. . .IP "\(bu" 4 \fIDefault\fR: sqlite3 . .IP "" 0 . .SS "dbconnections" The number of database connections for networked databases\. Will be ignored unless the value is a positive integer\. This setting is only used by the ActiveRecord storeconfigs and inventory backends, which are deprecated\. . .SS "dblocation" The sqlite database file\. This setting is only used by the ActiveRecord storeconfigs and inventory backends, which are deprecated\. . .IP "\(bu" 4 \fIDefault\fR: $statedir/clientconfigs\.sqlite3 . .IP "" 0 . .SS "dbmigrate" Whether to automatically migrate the database\. This setting is only used by the ActiveRecord storeconfigs and inventory backends, which are deprecated\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "dbname" The name of the database to use\. This setting is only used by the ActiveRecord storeconfigs and inventory backends, which are deprecated\. . .IP "\(bu" 4 \fIDefault\fR: puppet . .IP "" 0 . .SS "dbpassword" The database password for caching\. Only used when networked databases are used\. This setting is only used by the ActiveRecord storeconfigs and inventory backends, which are deprecated\. . .IP "\(bu" 4 \fIDefault\fR: puppet . .IP "" 0 . .SS "dbport" The database password for caching\. Only used when networked databases are used\. This setting is only used by the ActiveRecord storeconfigs and inventory backends, which are deprecated\. . .SS "dbserver" The database server for caching\. Only used when networked databases are used\. . .IP "\(bu" 4 \fIDefault\fR: localhost . .IP "" 0 . .SS "dbsocket" The database socket location\. Only used when networked databases are used\. Will be ignored if the value is an empty string\. This setting is only used by the ActiveRecord storeconfigs and inventory backends, which are deprecated\. . .SS "dbuser" The database user for caching\. Only used when networked databases are used\. This setting is only used by the ActiveRecord storeconfigs and inventory backends, which are deprecated\. . .IP "\(bu" 4 \fIDefault\fR: puppet . .IP "" 0 . .SS "default_file_terminus" The default source for files if no server is given in a uri, e\.g\. puppet:///file\. The default of \fBrest\fR causes the file to be retrieved using the \fBserver\fR setting\. When running \fBapply\fR the default is \fBfile_server\fR, causing requests to be filled locally\. . .IP "\(bu" 4 \fIDefault\fR: rest . .IP "" 0 . .SS "default_manifest" The default main manifest for directory environments\. Any environment that doesn\'t set the \fBmanifest\fR setting in its \fBenvironment\.conf\fR file will use this manifest\. . .P This setting\'s value can be an absolute or relative path\. An absolute path will make all environments default to the same main manifest; a relative path will allow each environment to use its own manifest, and Puppet will resolve the path relative to each environment\'s main directory\. . .P In either case, the path can point to a single file or to a directory of manifests to be evaluated in alphabetical order\. . .IP "\(bu" 4 \fIDefault\fR: \./manifests . .IP "" 0 . .SS "default_schedules" Boolean; whether to generate the default schedule resources\. Setting this to false is useful for keeping external report processors clean of skipped schedule resources\. . .IP "\(bu" 4 \fIDefault\fR: true . .IP "" 0 . .SS "deviceconfig" Path to the device config file for puppet device\. . .IP "\(bu" 4 \fIDefault\fR: $confdir/device\.conf . .IP "" 0 . .SS "devicedir" The root directory of devices\' $vardir\. . .IP "\(bu" 4 \fIDefault\fR: $vardir/devices . .IP "" 0 . .SS "diff" Which diff command to use when printing differences between files\. This setting has no default value on Windows, as standard \fBdiff\fR is not available, but Puppet can use many third\-party diff tools\. . .IP "\(bu" 4 \fIDefault\fR: diff . .IP "" 0 . .SS "diff_args" Which arguments to pass to the diff command when printing differences between files\. The command to use can be chosen with the \fBdiff\fR setting\. . .IP "\(bu" 4 \fIDefault\fR: \-u . .IP "" 0 . .SS "digest_algorithm" Which digest algorithm to use for file resources and the filebucket\. Valid values are md5, sha256\. Default is md5\. . .IP "\(bu" 4 \fIDefault\fR: md5 . .IP "" 0 . .SS "disable_per_environment_manifest" Whether to disallow an environment\-specific main manifest\. When set to \fBtrue\fR, Puppet will use the manifest specified in the \fBdefault_manifest\fR setting for all environments\. If an environment specifies a different main manifest in its \fBenvironment\.conf\fR file, catalog requests for that environment will fail with an error\. . .P This setting requires \fBdefault_manifest\fR to be set to an absolute path\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "disable_warnings" A comma\-separated list of warning types to suppress\. If large numbers of warnings are making Puppet\'s logs too large or difficult to use, you can temporarily silence them with this setting\. . .P If you are preparing to upgrade Puppet to a new major version, you should re\-enable all warnings for a while\. . .P Valid values for this setting are: . .IP "\(bu" 4 \fBdeprecations\fR \-\-\- disables deprecation warnings\. . .IP "\(bu" 4 \fIDefault\fR: [] . .IP "" 0 . .SS "dns_alt_names" The comma\-separated list of alternative DNS names to use for the local host\. . .P When the node generates a CSR for itself, these are added to the request as the desired \fBsubjectAltName\fR in the certificate: additional DNS labels that the certificate is also valid answering as\. . .P This is generally required if you use a non\-hostname \fBcertname\fR, or if you want to use \fBpuppet kick\fR or \fBpuppet resource \-H\fR and the primary certname does not match the DNS name you use to communicate with the host\. . .P This is unnecessary for agents, unless you intend to use them as a server for \fBpuppet kick\fR or remote \fBpuppet resource\fR management\. . .P It is rarely necessary for servers; it is usually helpful only if you need to have a pool of multiple load balanced masters, or for the same master to respond on two physically separate networks under different names\. . .SS "document_all" Whether to document all resources when using \fBpuppet doc\fR to generate manifest documentation\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "dynamicfacts" (Deprecated) Facts that are dynamic; these facts will be ignored when deciding whether changed facts should result in a recompile\. Multiple facts should be comma\-separated\. . .IP "\(bu" 4 \fIDefault\fR: memorysize,memoryfree,swapsize,swapfree . .IP "" 0 . .SS "environment" The environment Puppet is running in\. For clients (e\.g\., \fBpuppet agent\fR) this determines the environment itself, which is used to find modules and much more\. For servers (i\.e\., \fBpuppet master\fR) this provides the default environment for nodes we know nothing about\. . .IP "\(bu" 4 \fIDefault\fR: production . .IP "" 0 . .SS "environment_timeout" The time to live for a cached environment\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\. This setting can also be set to \fBunlimited\fR, which causes the environment to be cached until the master is restarted\. . .IP "\(bu" 4 \fIDefault\fR: unlimited . .IP "" 0 . .SS "environmentpath" A search path for directory environments, as a list of directories separated by the system path separator character\. (The POSIX path separator is \':\', and the Windows path separator is \';\'\.) . .P This setting must have a value set to enable \fBdirectory environments\.\fR The recommended value is \fB$confdir/environments\fR\. For more details, see http://docs\.puppetlabs\.com/puppet/latest/reference/environments\.html . .SS "evaltrace" Whether each resource should log when it is being evaluated\. This allows you to interactively see exactly what is being done\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "external_nodes" An external command that can produce node information\. The command\'s output must be a YAML dump of a hash, and that hash must have a \fBclasses\fR key and/or a \fBparameters\fR key, where \fBclasses\fR is an array or hash and \fBparameters\fR is a hash\. For unknown nodes, the command should exit with a non\-zero exit code\. . .P This command makes it straightforward to store your node mapping information in other data sources like databases\. . .IP "\(bu" 4 \fIDefault\fR: none . .IP "" 0 . .SS "factpath" Where Puppet should look for facts\. Multiple directories should be separated by the system path separator character\. (The POSIX path separator is \':\', and the Windows path separator is \';\'\.) . .IP "\(bu" 4 \fIDefault\fR: $vardir/lib/facter:$vardir/facts . .IP "" 0 . .SS "facts_terminus" The node facts terminus\. . .IP "\(bu" 4 \fIDefault\fR: facter . .IP "" 0 . .SS "fileserverconfig" Where the fileserver configuration is stored\. . .IP "\(bu" 4 \fIDefault\fR: $confdir/fileserver\.conf . .IP "" 0 . .SS "filetimeout" The minimum time to wait between checking for updates in configuration files\. This timeout determines how quickly Puppet checks whether a file (such as manifests or templates) has changed on disk\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\. . .IP "\(bu" 4 \fIDefault\fR: 15s . .IP "" 0 . .SS "forge_authorization" The authorization key to connect to the Puppet Forge\. Leave blank for unauthorized or license based connections . .TP \fIDefault\fR: . .SS "freeze_main" Freezes the \'main\' class, disallowing any code to be added to it\. This essentially means that you can\'t have any code outside of a node, class, or definition other than in the site manifest\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "genconfig" When true, causes Puppet applications to print an example config file to stdout and exit\. The example will include descriptions of each setting, and the current (or default) value of each setting, incorporating any settings overridden on the CLI (with the exception of \fBgenconfig\fR itself)\. This setting only makes sense when specified on the command line as \fB\-\-genconfig\fR\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "genmanifest" Whether to just print a manifest to stdout and exit\. Only makes sense when specified on the command line as \fB\-\-genmanifest\fR\. Takes into account arguments specified on the CLI\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "graph" Whether to create dot graph files for the different configuration graphs\. These dot files can be interpreted by tools like OmniGraffle or dot (which is part of ImageMagick)\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "graphdir" Where to store dot\-outputted graphs\. . .IP "\(bu" 4 \fIDefault\fR: $statedir/graphs . .IP "" 0 . .SS "group" The group puppet master should run as\. . .IP "\(bu" 4 \fIDefault\fR: puppet . .IP "" 0 . .SS "hiera_config" The hiera configuration file\. Puppet only reads this file on startup, so you must restart the puppet master every time you edit it\. . .IP "\(bu" 4 \fIDefault\fR: $confdir/hiera\.yaml . .IP "" 0 . .SS "hostcert" Where individual hosts store and look for their certificates\. . .IP "\(bu" 4 \fIDefault\fR: $certdir/$certname\.pem . .IP "" 0 . .SS "hostcrl" Where the host\'s certificate revocation list can be found\. This is distinct from the certificate authority\'s CRL\. . .IP "\(bu" 4 \fIDefault\fR: $ssldir/crl\.pem . .IP "" 0 . .SS "hostcsr" Where individual hosts store and look for their certificate requests\. . .IP "\(bu" 4 \fIDefault\fR: $ssldir/csr_$certname\.pem . .IP "" 0 . .SS "hostprivkey" Where individual hosts store and look for their private key\. . .IP "\(bu" 4 \fIDefault\fR: $privatekeydir/$certname\.pem . .IP "" 0 . .SS "hostpubkey" Where individual hosts store and look for their public key\. . .IP "\(bu" 4 \fIDefault\fR: $publickeydir/$certname\.pem . .IP "" 0 . -.SS "http_compression" -Allow http compression in REST communication with the master\. This setting might improve performance for agent \-> master communications over slow WANs\. Your puppet master needs to support compression (usually by activating some settings in a reverse\-proxy in front of the puppet master, which rules out webrick)\. It is harmless to activate this settings if your master doesn\'t support compression, but if it supports it, this setting might reduce performance on high\-speed LANs\. -. -.IP "\(bu" 4 -\fIDefault\fR: false -. -.IP "" 0 -. .SS "http_debug" Whether to write HTTP request and responses to stderr\. This should never be used in a production environment\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "http_keepalive_timeout" The maximum amount of time a persistent HTTP connection can remain idle in the connection pool, before it is closed\. This timeout should be shorter than the keepalive timeout used on the HTTP server, e\.g\. Apache KeepAliveTimeout directive\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\. . .IP "\(bu" 4 \fIDefault\fR: 4s . .IP "" 0 . .SS "http_proxy_host" The HTTP proxy host to use for outgoing connections\. Note: You may need to use a FQDN for the server hostname when using a proxy\. Environment variable http_proxy or HTTP_PROXY will override this value . .IP "\(bu" 4 \fIDefault\fR: none . .IP "" 0 . .SS "http_proxy_password" The password for the user of an authenticated HTTP proxy\. Requires the \fBhttp_proxy_user\fR setting\. . .P Note that passwords must be valid when used as part of a URL\. If a password contains any characters with special meanings in URLs (as specified by RFC 3986 section 2\.2), they must be URL\-encoded\. (For example, \fB#\fR would become \fB%23\fR\.) . .IP "\(bu" 4 \fIDefault\fR: none . .IP "" 0 . .SS "http_proxy_port" The HTTP proxy port to use for outgoing connections . .IP "\(bu" 4 \fIDefault\fR: 3128 . .IP "" 0 . .SS "http_proxy_user" The user name for an authenticated HTTP proxy\. Requires the \fBhttp_proxy_host\fR setting\. . .IP "\(bu" 4 \fIDefault\fR: none . .IP "" 0 . .SS "httplog" Where the puppet agent web server logs\. . .IP "\(bu" 4 \fIDefault\fR: $logdir/http\.log . .IP "" 0 . .SS "ignorecache" Ignore cache and always recompile the configuration\. This is useful for testing new configurations, where the local cache may in fact be stale even if the timestamps are up to date \- if the facts change or if the server changes\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "ignoreimport" If true, allows the parser to continue without requiring all files referenced with \fBimport\fR statements to exist\. This setting was primarily designed for use with commit hooks for parse\-checking\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "ignoremissingtypes" Skip searching for classes and definitions that were missing during a prior compilation\. The list of missing objects is maintained per\-environment and persists until the environment is cleared or the master is restarted\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "ignoreschedules" Boolean; whether puppet agent should ignore schedules\. This is useful for initial puppet agent runs\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "immutable_node_data" When true, also prevents $trusted and $facts from being overridden in any scope . .IP "\(bu" 4 \fIDefault\fR: $trusted_node_data . .IP "" 0 . .SS "keylength" The bit length of keys\. . .IP "\(bu" 4 \fIDefault\fR: 4096 . .IP "" 0 . .SS "lastrunfile" Where puppet agent stores the last run report summary in yaml format\. . .IP "\(bu" 4 \fIDefault\fR: $statedir/last_run_summary\.yaml . .IP "" 0 . .SS "lastrunreport" Where puppet agent stores the last run report in yaml format\. . .IP "\(bu" 4 \fIDefault\fR: $statedir/last_run_report\.yaml . .IP "" 0 . .SS "ldapattrs" The LDAP attributes to include when querying LDAP for nodes\. All returned attributes are set as variables in the top\-level scope\. Multiple values should be comma\-separated\. The value \'all\' returns all attributes\. . .IP "\(bu" 4 \fIDefault\fR: all . .IP "" 0 . .SS "ldapbase" The search base for LDAP searches\. It\'s impossible to provide a meaningful default here, although the LDAP libraries might have one already set\. Generally, it should be the \'ou=Hosts\' branch under your main directory\. . .SS "ldapclassattrs" The LDAP attributes to use to define Puppet classes\. Values should be comma\-separated\. . .IP "\(bu" 4 \fIDefault\fR: puppetclass . .IP "" 0 . .SS "ldapparentattr" The attribute to use to define the parent node\. . .IP "\(bu" 4 \fIDefault\fR: parentnode . .IP "" 0 . .SS "ldappassword" The password to use to connect to LDAP\. . .SS "ldapport" The LDAP port\. Only used if \fBnode_terminus\fR is set to \fBldap\fR\. . .IP "\(bu" 4 \fIDefault\fR: 389 . .IP "" 0 . .SS "ldapserver" The LDAP server\. Only used if \fBnode_terminus\fR is set to \fBldap\fR\. . .IP "\(bu" 4 \fIDefault\fR: ldap . .IP "" 0 . .SS "ldapssl" Whether SSL should be used when searching for nodes\. Defaults to false because SSL usually requires certificates to be set up on the client side\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "ldapstackedattrs" The LDAP attributes that should be stacked to arrays by adding the values in all hierarchy elements of the tree\. Values should be comma\-separated\. . .IP "\(bu" 4 \fIDefault\fR: puppetvar . .IP "" 0 . .SS "ldapstring" The search string used to find an LDAP node\. . .IP "\(bu" 4 \fIDefault\fR: (&(objectclass=puppetClient)(cn=%s)) . .IP "" 0 . .SS "ldaptls" Whether TLS should be used when searching for nodes\. Defaults to false because TLS usually requires certificates to be set up on the client side\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "ldapuser" The user to use to connect to LDAP\. Must be specified as a full DN\. . .SS "legacy_query_parameter_serialization" The serialization format to use when sending file_metadata query parameters\. Older versions of puppet master expect certain query parameters to be serialized as yaml, which is deprecated\. . .P This should almost always be false\. It can be temporarily set to true to let agents using this Puppet version connect to a puppet master running Puppet 3\.0\.0 through 3\.2\.x\. . .P Note that this is set to true automatically if the agent detects an older master, so should never need to be set explicitly\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "libdir" An extra search path for Puppet\. This is only useful for those files that Puppet will load on demand, and is only guaranteed to work for those cases\. In fact, the autoload mechanism is responsible for making sure this directory is in Ruby\'s search path . .IP "\(bu" 4 \fIDefault\fR: $vardir/lib . .IP "" 0 . .SS "listen" Whether puppet agent should listen for connections\. If this is true, then puppet agent will accept incoming REST API requests, subject to the default ACLs and the ACLs set in the \fBrest_authconfig\fR file\. Puppet agent can respond usefully to requests on the \fBrun\fR, \fBcertificate\fR, and \fBresource\fR endpoints\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "localcacert" Where each client stores the CA certificate\. . .IP "\(bu" 4 \fIDefault\fR: $certdir/ca\.pem . .IP "" 0 . .SS "localconfig" Where puppet agent caches the local configuration\. An extension indicating the cache format is added automatically\. . .IP "\(bu" 4 \fIDefault\fR: $statedir/localconfig . .IP "" 0 . .SS "log_level" Default logging level for messages from Puppet\. Allowed values are: . .IP "\(bu" 4 debug . .IP "\(bu" 4 info . .IP "\(bu" 4 notice . .IP "\(bu" 4 warning . .IP "\(bu" 4 err . .IP "\(bu" 4 alert . .IP "\(bu" 4 emerg . .IP "\(bu" 4 crit . .IP "\(bu" 4 \fIDefault\fR: notice . .IP "" 0 . .SS "logdir" The directory in which to store log files . .TP \fIDefault\fR: . .SS "manage_internal_file_permissions" Whether Puppet should manage the owner, group, and mode of files it uses internally . .IP "\(bu" 4 \fIDefault\fR: true . .IP "" 0 . .SS "manifest" The entry\-point manifest for puppet master\. This can be one file or a directory of manifests to be evaluated in alphabetical order\. Puppet manages this path as a directory if one exists or if the path ends with a / or \. . .P Setting a global value for \fBmanifest\fR in puppet\.conf is deprecated\. Please use directory environments instead\. If you need to use something other than the environment\'s \fBmanifests\fR directory as the main manifest, you can set \fBmanifest\fR in environment\.conf\. For more info, see http://docs\.puppetlabs\.com/puppet/latest/reference/environments\.html . .IP "\(bu" 4 \fIDefault\fR: $manifestdir/site\.pp . .IP "" 0 . .SS "manifestdir" Used to build the default value of the \fBmanifest\fR setting\. Has no other purpose\. . .P This setting is deprecated\. . .IP "\(bu" 4 \fIDefault\fR: $confdir/manifests . .IP "" 0 . .SS "masterhttplog" Where the puppet master web server saves its access log\. This is only used when running a WEBrick puppet master\. When puppet master is running under a Rack server like Passenger, that web server will have its own logging behavior\. . .IP "\(bu" 4 \fIDefault\fR: $logdir/masterhttp\.log . .IP "" 0 . .SS "masterport" The port for puppet master traffic\. For puppet master, this is the port to listen on; for puppet agent, this is the port to make requests on\. Both applications use this setting to get the port\. . .IP "\(bu" 4 \fIDefault\fR: 8140 . .IP "" 0 . .SS "max_deprecations" Sets the max number of logged/displayed parser validation deprecation warnings in case multiple deprecation warnings have been detected\. A value of 0 blocks the logging of deprecation warnings\. The count is per manifest\. . .IP "\(bu" 4 \fIDefault\fR: 10 . .IP "" 0 . .SS "max_errors" Sets the max number of logged/displayed parser validation errors in case multiple errors have been detected\. A value of 0 is the same as a value of 1; a minimum of one error is always raised\. The count is per manifest\. . .IP "\(bu" 4 \fIDefault\fR: 10 . .IP "" 0 . .SS "max_warnings" Sets the max number of logged/displayed parser validation warnings in case multiple warnings have been detected\. A value of 0 blocks logging of warnings\. The count is per manifest\. . .IP "\(bu" 4 \fIDefault\fR: 10 . .IP "" 0 . .SS "maximum_uid" The maximum allowed UID\. Some platforms use negative UIDs but then ship with tools that do not know how to handle signed ints, so the UIDs show up as huge numbers that can then not be fed back into the system\. This is a hackish way to fail in a slightly more useful way when that happens\. . .IP "\(bu" 4 \fIDefault\fR: 4294967290 . .IP "" 0 . .SS "mkusers" Whether to create the necessary user and group that puppet agent will run as\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "module_groups" Extra module groups to request from the Puppet Forge . .TP \fIDefault\fR: . .SS "module_repository" The module repository . .IP "\(bu" 4 \fIDefault\fR: https://forgeapi\.puppetlabs\.com . .IP "" 0 . .SS "module_skeleton_dir" The directory which the skeleton for module tool generate is stored\. . .IP "\(bu" 4 \fIDefault\fR: $module_working_dir/skeleton . .IP "" 0 . .SS "module_working_dir" The directory into which module tool data is stored . .IP "\(bu" 4 \fIDefault\fR: $vardir/puppet\-module . .IP "" 0 . .SS "modulepath" The search path for modules, as a list of directories separated by the system path separator character\. (The POSIX path separator is \':\', and the Windows path separator is \';\'\.) . .P Setting a global value for \fBmodulepath\fR in puppet\.conf is deprecated\. Please use directory environments instead\. If you need to use something other than the default modulepath of \fB:$basemodulepath\fR, you can set \fBmodulepath\fR in environment\.conf\. For more info, see http://docs\.puppetlabs\.com/puppet/latest/reference/environments\.html . .IP "\(bu" 4 \fIDefault\fR: $basemodulepath . .IP "" 0 . .SS "name" The name of the application, if we are running as one\. The default is essentially $0 without the path or \fB\.rb\fR\. . .TP \fIDefault\fR: . .SS "node_cache_terminus" How to store cached nodes\. Valid values are (none), \'json\', \'msgpack\', \'yaml\' or write only yaml (\'write_only_yaml\')\. The master application defaults to \'write_only_yaml\', all others to none\. . .TP \fIDefault\fR: . .SS "node_name" How the puppet master determines the client\'s identity and sets the \'hostname\', \'fqdn\' and \'domain\' facts for use in the manifest, in particular for determining which \'node\' statement applies to the client\. Possible values are \'cert\' (use the subject\'s CN in the client\'s certificate) and \'facter\' (use the hostname that the client reported in its facts) . .IP "\(bu" 4 \fIDefault\fR: cert . .IP "" 0 . .SS "node_name_fact" The fact name used to determine the node name used for all requests the agent makes to the master\. WARNING: This setting is mutually exclusive with node_name_value\. Changing this setting also requires changes to the default auth\.conf configuration on the Puppet Master\. Please see http://links\.puppetlabs\.com/node_name_fact for more information\. . .SS "node_name_value" The explicit value used for the node name for all requests the agent makes to the master\. WARNING: This setting is mutually exclusive with node_name_fact\. Changing this setting also requires changes to the default auth\.conf configuration on the Puppet Master\. Please see http://links\.puppetlabs\.com/node_name_value for more information\. . .IP "\(bu" 4 \fIDefault\fR: $certname . .IP "" 0 . .SS "node_terminus" Where to find information about nodes\. . .IP "\(bu" 4 \fIDefault\fR: plain . .IP "" 0 . .SS "noop" Whether to apply catalogs in noop mode, which allows Puppet to partially simulate a normal run\. This setting affects puppet agent and puppet apply\. . .P When running in noop mode, Puppet will check whether each resource is in sync, like it does when running normally\. However, if a resource attribute is not in the desired state (as declared in the catalog), Puppet will take no action, and will instead report the changes it \fIwould\fR have made\. These simulated changes will appear in the report sent to the puppet master, or be shown on the console if running puppet agent or puppet apply in the foreground\. The simulated changes will not send refresh events to any subscribing or notified resources, although Puppet will log that a refresh event \fIwould\fR have been sent\. . .P \fBImportant note:\fR The \fBnoop\fR metaparameter \fIhttp://docs\.puppetlabs\.com/references/latest/metaparameter\.html#noop\fR allows you to apply individual resources in noop mode, and will override the global value of the \fBnoop\fR setting\. This means a resource with \fBnoop => false\fR \fIwill\fR be changed if necessary, even when running puppet agent with \fBnoop = true\fR or \fB\-\-noop\fR\. (Conversely, a resource with \fBnoop => true\fR will only be simulated, even when noop mode is globally disabled\.) . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "onetime" Perform one configuration run and exit, rather than spawning a long\-running daemon\. This is useful for interactively running puppet agent, or running puppet agent from cron\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "ordering" How unrelated resources should be ordered when applying a catalog\. Allowed values are \fBtitle\-hash\fR, \fBmanifest\fR, and \fBrandom\fR\. This setting affects puppet agent and puppet apply, but not puppet master\. . .IP "\(bu" 4 \fBtitle\-hash\fR (the default) will order resources randomly, but will use the same order across runs and across nodes\. . .IP "\(bu" 4 \fBmanifest\fR will use the order in which the resources were declared in their manifest files\. . .IP "\(bu" 4 \fBrandom\fR will order resources randomly and change their order with each run\. This can work like a fuzzer for shaking out undeclared dependencies\. . .IP "" 0 . .P Regardless of this setting\'s value, Puppet will always obey explicit dependencies set with the before/require/notify/subscribe metaparameters and the \fB\->\fR/\fB~>\fR chaining arrows; this setting only affects the relative ordering of \fIunrelated\fR resources\. . .IP "\(bu" 4 \fIDefault\fR: manifest . .IP "" 0 . .SS "parser" Selects the parser to use for parsing puppet manifests (in puppet DSL language/\'\.pp\' files)\. Available choices are \fBcurrent\fR (the default) and \fBfuture\fR\. . .P The \fBcurrent\fR parser means that the released version of the parser should be used\. . .P The \fBfuture\fR parser is a "time travel to the future" allowing early exposure to new language features\. What these features are will vary from release to release and they may be invididually configurable\. . .P Available Since Puppet 3\.2\. . .IP "\(bu" 4 \fIDefault\fR: current . .IP "" 0 . .SS "passfile" Where puppet agent stores the password for its private key\. Generally unused\. . .IP "\(bu" 4 \fIDefault\fR: $privatedir/password . .IP "" 0 . .SS "path" The shell search path\. Defaults to whatever is inherited from the parent process\. . .IP "\(bu" 4 \fIDefault\fR: none . .IP "" 0 . .SS "pidfile" The file containing the PID of a running process\. This file is intended to be used by service management frameworks and monitoring systems to determine if a puppet process is still in the process table\. . .IP "\(bu" 4 \fIDefault\fR: $rundir/${run_mode}\.pid . .IP "" 0 . .SS "plugindest" Where Puppet should store plugins that it pulls down from the central server\. . .IP "\(bu" 4 \fIDefault\fR: $libdir . .IP "" 0 . .SS "pluginfactdest" Where Puppet should store external facts that are being handled by pluginsync . .IP "\(bu" 4 \fIDefault\fR: $vardir/facts\.d . .IP "" 0 . .SS "pluginfactsource" Where to retrieve external facts for pluginsync . .IP "\(bu" 4 \fIDefault\fR: puppet://$server/pluginfacts . .IP "" 0 . .SS "pluginsignore" What files to ignore when pulling down plugins\. . .IP "\(bu" 4 \fIDefault\fR: \.svn CVS \.git . .IP "" 0 . .SS "pluginsource" From where to retrieve plugins\. The standard Puppet \fBfile\fR type is used for retrieval, so anything that is a valid file source can be used here\. . .IP "\(bu" 4 \fIDefault\fR: puppet://$server/plugins . .IP "" 0 . .SS "pluginsync" Whether plugins should be synced with the central server\. . .IP "\(bu" 4 \fIDefault\fR: true . .IP "" 0 . .SS "postrun_command" A command to run after every agent run\. If this command returns a non\-zero return code, the entire Puppet run will be considered to have failed, even though it might have performed work during the normal run\. . .SS "preferred_serialization_format" The preferred means of serializing ruby instances for passing over the wire\. This won\'t guarantee that all instances will be serialized using this method, since not all classes can be guaranteed to support this format, but it will be used for all classes that support it\. . .IP "\(bu" 4 \fIDefault\fR: pson . .IP "" 0 . .SS "prerun_command" A command to run before every agent run\. If this command returns a non\-zero return code, the entire Puppet run will fail\. . .SS "priority" The scheduling priority of the process\. Valid values are \'high\', \'normal\', \'low\', or \'idle\', which are mapped to platform\-specific values\. The priority can also be specified as an integer value and will be passed as is, e\.g\. \-5\. Puppet must be running as a privileged user in order to increase scheduling priority\. . .TP \fIDefault\fR: . .SS "privatedir" Where the client stores private certificate information\. . .IP "\(bu" 4 \fIDefault\fR: $ssldir/private . .IP "" 0 . .SS "privatekeydir" The private key directory\. . .IP "\(bu" 4 \fIDefault\fR: $ssldir/private_keys . .IP "" 0 . .SS "profile" Whether to enable experimental performance profiling . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "publickeydir" The public key directory\. . .IP "\(bu" 4 \fIDefault\fR: $ssldir/public_keys . .IP "" 0 . .SS "puppetdlog" The fallback log file\. This is only used when the \fB\-\-logdest\fR option is not specified AND Puppet is running on an operating system where both the POSIX syslog service and the Windows Event Log are unavailable\. (Currently, no supported operating systems match that description\.) . .P Despite the name, both puppet agent and puppet master will use this file as the fallback logging destination\. . .P For control over logging destinations, see the \fB\-\-logdest\fR command line option in the manual pages for puppet master, puppet agent, and puppet apply\. You can see man pages by running \fBpuppet \-\-help\fR, or read them online at http://docs\.puppetlabs\.com/references/latest/man/\. . .IP "\(bu" 4 \fIDefault\fR: $logdir/puppetd\.log . .IP "" 0 . .SS "puppetport" Which port puppet agent listens on\. . .IP "\(bu" 4 \fIDefault\fR: 8139 . .IP "" 0 . .SS "rails_loglevel" The log level for Rails connections\. The value must be a valid log level within Rails\. Production environments normally use \fBinfo\fR and other environments normally use \fBdebug\fR\. This setting is only used by the ActiveRecord storeconfigs and inventory backends, which are deprecated\. . .IP "\(bu" 4 \fIDefault\fR: info . .IP "" 0 . .SS "railslog" Where Rails\-specific logs are sent\. This setting is only used by the ActiveRecord storeconfigs and inventory backends, which are deprecated\. . .IP "\(bu" 4 \fIDefault\fR: $logdir/rails\.log . .IP "" 0 . .SS "report" Whether to send reports after every transaction\. . .IP "\(bu" 4 \fIDefault\fR: true . .IP "" 0 . .SS "report_port" The port to communicate with the report_server\. . .IP "\(bu" 4 \fIDefault\fR: $masterport . .IP "" 0 . .SS "report_serialization_format" The serialization format to use when sending reports to the \fBreport_server\fR\. Possible values are \fBpson\fR and \fByaml\fR\. This setting affects puppet agent, but not puppet apply (which processes its own reports)\. . .P This should almost always be set to \fBpson\fR\. It can be temporarily set to \fByaml\fR to let agents using this Puppet version connect to a puppet master running Puppet 3\.0\.0 through 3\.2\.x\. . .P Note that this is set to \'yaml\' automatically if the agent detects an older master, so should never need to be set explicitly\. . .IP "\(bu" 4 \fIDefault\fR: pson . .IP "" 0 . .SS "report_server" The server to send transaction reports to\. . .IP "\(bu" 4 \fIDefault\fR: $server . .IP "" 0 . .SS "reportdir" The directory in which to store reports\. Each node gets a separate subdirectory in this directory\. This setting is only used when the \fBstore\fR report processor is enabled (see the \fBreports\fR setting)\. . .IP "\(bu" 4 \fIDefault\fR: $vardir/reports . .IP "" 0 . .SS "reportfrom" The \'from\' email address for the reports\. . .IP "\(bu" 4 -\fIDefault\fR: report@aparker\.corp\.puppetlabs\.net +\fIDefault\fR: report@henriks\-macbook\-pro\.local . .IP "" 0 . .SS "reports" The list of report handlers to use\. When using multiple report handlers, their names should be comma\-separated, with whitespace allowed\. (For example, \fBreports = http, tagmail\fR\.) . .P This setting is relevant to puppet master and puppet apply\. The puppet master will call these report handlers with the reports it receives from agent nodes, and puppet apply will call them with its own report\. (In all cases, the node applying the catalog must have \fBreport = true\fR\.) . .P See the report reference for information on the built\-in report handlers; custom report handlers can also be loaded from modules\. (Report handlers are loaded from the lib directory, at \fBpuppet/reports/NAME\.rb\fR\.) . .IP "\(bu" 4 \fIDefault\fR: store . .IP "" 0 . .SS "reporturl" The URL that reports should be forwarded to\. This setting is only used when the \fBhttp\fR report processor is enabled (see the \fBreports\fR setting)\. . .IP "\(bu" 4 \fIDefault\fR: http://localhost:3000/reports/upload . .IP "" 0 . .SS "req_bits" The bit length of the certificates\. . .IP "\(bu" 4 \fIDefault\fR: 4096 . .IP "" 0 . .SS "requestdir" Where host certificate requests are stored\. . .IP "\(bu" 4 \fIDefault\fR: $ssldir/certificate_requests . .IP "" 0 . .SS "resourcefile" The file in which puppet agent stores a list of the resources associated with the retrieved configuration\. . .IP "\(bu" 4 \fIDefault\fR: $statedir/resources\.txt . .IP "" 0 . .SS "rest_authconfig" The configuration file that defines the rights to the different rest indirections\. This can be used as a fine\-grained authorization system for \fBpuppet master\fR\. . .IP "\(bu" 4 \fIDefault\fR: $confdir/auth\.conf . .IP "" 0 . .SS "route_file" The YAML file containing indirector route configuration\. . .IP "\(bu" 4 \fIDefault\fR: $confdir/routes\.yaml . .IP "" 0 . -.SS "rrddir" -The directory where RRD database files are stored\. Directories for each reporting host will be created under this directory\. -. -.IP "\(bu" 4 -\fIDefault\fR: $vardir/rrd -. -.IP "" 0 -. -.SS "rrdinterval" -How often RRD should expect data\. This should match how often the hosts report back to the server\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\. -. -.IP "\(bu" 4 -\fIDefault\fR: $runinterval -. -.IP "" 0 -. .SS "rundir" Where Puppet PID files are kept\. . .TP \fIDefault\fR: . .SS "runinterval" How often puppet agent applies the catalog\. Note that a runinterval of 0 means "run continuously" rather than "never run\." If you want puppet agent to never run, you should start it with the \fB\-\-no\-client\fR option\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\. . .IP "\(bu" 4 \fIDefault\fR: 30m . .IP "" 0 . .SS "sendmail" Where to find the sendmail binary with which to send email\. . .IP "\(bu" 4 \fIDefault\fR: /usr/sbin/sendmail . .IP "" 0 . .SS "serial" Where the serial number for certificates is stored\. . .IP "\(bu" 4 \fIDefault\fR: $cadir/serial . .IP "" 0 . .SS "server" The puppet master server to which the puppet agent should connect\. . .IP "\(bu" 4 \fIDefault\fR: puppet . .IP "" 0 . .SS "server_datadir" The directory in which serialized data is stored, usually in a subdirectory\. . .IP "\(bu" 4 \fIDefault\fR: $vardir/server_data . .IP "" 0 . .SS "show_diff" Whether to log and report a contextual diff when files are being replaced\. This causes partial file contents to pass through Puppet\'s normal logging and reporting system, so this setting should be used with caution if you are sending Puppet\'s reports to an insecure destination\. This feature currently requires the \fBdiff/lcs\fR Ruby library\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "signeddir" Where the CA stores signed certificates\. . .IP "\(bu" 4 \fIDefault\fR: $cadir/signed . .IP "" 0 . .SS "smtphelo" The name by which we identify ourselves in SMTP HELO for reports\. If you send to a smtpserver which does strict HELO checking (as with Postfix\'s \fBsmtpd_helo_restrictions\fR access controls), you may need to ensure this resolves\. . .IP "\(bu" 4 -\fIDefault\fR: aparker\.corp\.puppetlabs\.net +\fIDefault\fR: Henriks\-MacBook\-Pro\.local . .IP "" 0 . .SS "smtpport" The TCP port through which to send email reports\. . .IP "\(bu" 4 \fIDefault\fR: 25 . .IP "" 0 . .SS "smtpserver" The server through which to send email reports\. . .IP "\(bu" 4 \fIDefault\fR: none . .IP "" 0 . .SS "splay" Whether to sleep for a pseudo\-random (but consistent) amount of time before a run\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "splaylimit" The maximum time to delay before runs\. Defaults to being the same as the run interval\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\. . .IP "\(bu" 4 \fIDefault\fR: $runinterval . .IP "" 0 . .SS "srv_domain" The domain which will be queried to find the SRV records of servers to use\. . .IP "\(bu" 4 -\fIDefault\fR: corp\.puppetlabs\.net +\fIDefault\fR: local . .IP "" 0 . .SS "ssl_client_ca_auth" Certificate authorities who issue server certificates\. SSL servers will not be considered authentic unless they possess a certificate issued by an authority listed in this file\. If this setting has no value then the Puppet master\'s CA certificate (localcacert) will be used\. . .TP \fIDefault\fR: . .SS "ssl_client_header" The header containing an authenticated client\'s SSL DN\. This header must be set by the proxy to the authenticated client\'s SSL DN (e\.g\., \fB/CN=puppet\.puppetlabs\.com\fR)\. Puppet will parse out the Common Name (CN) from the Distinguished Name (DN) and use the value of the CN field for authorization\. . .P Note that the name of the HTTP header gets munged by the web server common gateway inteface: an \fBHTTP_\fR prefix is added, dashes are converted to underscores, and all letters are uppercased\. Thus, to use the \fBX\-Client\-DN\fR header, this setting should be \fBHTTP_X_CLIENT_DN\fR\. . .IP "\(bu" 4 \fIDefault\fR: HTTP_X_CLIENT_DN . .IP "" 0 . .SS "ssl_client_verify_header" The header containing the status message of the client verification\. This header must be set by the proxy to \'SUCCESS\' if the client successfully authenticated, and anything else otherwise\. . .P Note that the name of the HTTP header gets munged by the web server common gateway inteface: an \fBHTTP_\fR prefix is added, dashes are converted to underscores, and all letters are uppercased\. Thus, to use the \fBX\-Client\-Verify\fR header, this setting should be \fBHTTP_X_CLIENT_VERIFY\fR\. . .IP "\(bu" 4 \fIDefault\fR: HTTP_X_CLIENT_VERIFY . .IP "" 0 . .SS "ssl_server_ca_auth" Certificate authorities who issue client certificates\. SSL clients will not be considered authentic unless they possess a certificate issued by an authority listed in this file\. If this setting has no value then the Puppet master\'s CA certificate (localcacert) will be used\. . .TP \fIDefault\fR: . .SS "ssldir" Where SSL certificates are kept\. . .IP "\(bu" 4 \fIDefault\fR: $confdir/ssl . .IP "" 0 . .SS "statedir" The directory where Puppet state is stored\. Generally, this directory can be removed without causing harm (although it might result in spurious service restarts)\. . .IP "\(bu" 4 \fIDefault\fR: $vardir/state . .IP "" 0 . .SS "statefile" Where puppet agent and puppet master store state associated with the running configuration\. In the case of puppet master, this file reflects the state discovered through interacting with clients\. . .IP "\(bu" 4 \fIDefault\fR: $statedir/state\.yaml . .IP "" 0 . .SS "storeconfigs" Whether to store each client\'s configuration, including catalogs, facts, and related data\. This also enables the import and export of resources in the Puppet language \- a mechanism for exchange resources between nodes\. . .P By default this uses ActiveRecord and an SQL database to store and query the data; this, in turn, will depend on Rails being available\. . .P You can adjust the backend using the storeconfigs_backend setting\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "storeconfigs_backend" Configure the backend terminus used for StoreConfigs\. By default, this uses the ActiveRecord store, which directly talks to the database from within the Puppet Master process\. . .IP "\(bu" 4 \fIDefault\fR: active_record . .IP "" 0 . .SS "strict_hostname_checking" Whether to only search for the complete hostname as it is in the certificate when searching for node information in the catalogs\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "strict_variables" Makes the parser raise errors when referencing unknown variables\. (This does not affect referencing variables that are explicitly set to undef)\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "stringify_facts" Flatten fact values to strings using #to_s\. Means you can\'t have arrays or hashes as fact values\. (DEPRECATED) This option will be removed in Puppet 4\.0\. . .IP "\(bu" 4 \fIDefault\fR: true . .IP "" 0 . .SS "summarize" Whether to print a transaction summary\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "syslogfacility" What syslog facility to use when logging to syslog\. Syslog has a fixed list of valid facilities, and you must choose one of those; you cannot just make one up\. . .IP "\(bu" 4 \fIDefault\fR: daemon . .IP "" 0 . .SS "tagmap" The mapping between reporting tags and email addresses\. . .IP "\(bu" 4 \fIDefault\fR: $confdir/tagmail\.conf . .IP "" 0 . .SS "tags" Tags to use to find resources\. If this is set, then only resources tagged with the specified tags will be applied\. Values must be comma\-separated\. . .SS "templatedir" Where Puppet looks for template files\. Can be a list of colon\-separated directories\. . .P This setting is deprecated\. Please put your templates in modules instead\. . .IP "\(bu" 4 \fIDefault\fR: $vardir/templates . .IP "" 0 . .SS "thin_storeconfigs" Boolean; whether Puppet should store only facts and exported resources in the storeconfigs database\. This will improve the performance of exported resources with the older \fBactive_record\fR backend, but will disable external tools that search the storeconfigs database\. Thinning catalogs is generally unnecessary when using PuppetDB to store catalogs\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "trace" Whether to print stack traces on some errors . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "trusted_node_data" Stores trusted node data in a hash called $trusted\. When true also prevents $trusted from being overridden in any scope\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . +.SS "trusted_oid_mapping_file" +File that provides mapping between custom SSL oids and user\-friendly names +. +.IP "\(bu" 4 +\fIDefault\fR: $confdir/custom_trusted_oid_mapping\.yaml +. +.IP "" 0 +. .SS "use_cached_catalog" Whether to only use the cached catalog rather than compiling a new catalog on every run\. Puppet can be run with this enabled by default and then selectively disabled when a recompile is desired\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "use_srv_records" Whether the server will search for SRV records in DNS for the current domain\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . .SS "usecacheonfailure" Whether to use the cached configuration when the remote configuration will not compile\. This option is useful for testing new configurations, where you want to fix the broken configuration rather than reverting to a known\-good one\. . .IP "\(bu" 4 \fIDefault\fR: true . .IP "" 0 . .SS "user" The user puppet master should run as\. . .IP "\(bu" 4 \fIDefault\fR: puppet . .IP "" 0 . .SS "vardir" Where Puppet stores dynamic and growing data\. The default for this setting is calculated specially, like \fBconfdir\fR_\. . .IP "\(bu" 4 \fIDefault\fR: /var/lib/puppet . .IP "" 0 . .SS "waitforcert" How frequently puppet agent should ask for a signed certificate\. . .P When starting for the first time, puppet agent will submit a certificate signing request (CSR) to the server named in the \fBca_server\fR setting (usually the puppet master); this may be autosigned, or may need to be approved by a human, depending on the CA server\'s configuration\. . .P Puppet agent cannot apply configurations until its approved certificate is available\. Since the certificate may or may not be available immediately, puppet agent will repeatedly try to fetch it at this interval\. You can turn off waiting for certificates by specifying a time of 0, in which case puppet agent will exit if it cannot get a cert\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\. . .IP "\(bu" 4 \fIDefault\fR: 2m . .IP "" 0 . .SS "yamldir" The directory in which YAML data is stored, usually in a subdirectory\. . .IP "\(bu" 4 \fIDefault\fR: $vardir/yaml . .IP "" 0 . -.SS "zlib" -Boolean; whether to use the zlib library -. -.IP "\(bu" 4 -\fIDefault\fR: true -. -.IP "" 0 -. .P -\fIThis page autogenerated on 2014\-09\-16 20:41:04 \-0700\fR +\fIThis page autogenerated on 2014\-10\-16 00:42:14 +0200\fR diff --git a/man/man8/extlookup2hiera.8 b/man/man8/extlookup2hiera.8 index 035545b02..bc808e782 100644 --- a/man/man8/extlookup2hiera.8 +++ b/man/man8/extlookup2hiera.8 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "EXTLOOKUP2HIERA" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "EXTLOOKUP2HIERA" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBextlookup2hiera\fR . .P Converter for extlookup CSV files into Hiera JSON and YAML files \-i, \-\-in FILE Input CSV file \-o, \-\-out FILE Output Hiera file \-j, \-\-json Create JSON format file diff --git a/man/man8/puppet-agent.8 b/man/man8/puppet-agent.8 index d509908d6..731204586 100644 --- a/man/man8/puppet-agent.8 +++ b/man/man8/puppet-agent.8 @@ -1,161 +1,161 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-AGENT" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-AGENT" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-agent\fR \- The puppet agent daemon . .SH "SYNOPSIS" Retrieves the client configuration from the puppet master and applies it to the local host\. . .P This service may be run as a daemon, run periodically using cron (or something similar), or run interactively for testing purposes\. . .SH "USAGE" puppet agent [\-\-certname \fINAME\fR] [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-digest \fIDIGEST\fR] [\-\-disable [MESSAGE]] [\-\-enable] [\-\-fingerprint] [\-h|\-\-help] [\-l|\-\-logdest syslog|eventlog|\fIFILE\fR|console] [\-\-masterport \fIPORT\fR] [\-\-no\-client] [\-\-noop] [\-o|\-\-onetime] [\-t|\-\-test] [\-v|\-\-verbose] [\-V|\-\-version] [\-w|\-\-waitforcert \fISECONDS\fR] . .SH "DESCRIPTION" This is the main puppet client\. Its job is to retrieve the local machine\'s configuration from a remote server and apply it\. In order to successfully communicate with the remote server, the client must have a certificate signed by a certificate authority that the server trusts; the recommended method for this, at the moment, is to run a certificate authority as part of the puppet server (which is the default)\. The client will connect and request a signed certificate, and will continue connecting until it receives one\. . .P Once the client has a signed certificate, it will retrieve its configuration and apply it\. . .SH "USAGE NOTES" \'puppet agent\' does its best to find a compromise between interactive use and daemon use\. Run with no arguments and no configuration, it will go into the background, attempt to get a signed certificate, and retrieve and apply its configuration every 30 minutes\. . .P Some flags are meant specifically for interactive use \-\- in particular, \'test\', \'tags\' or \'fingerprint\' are useful\. \'test\' enables verbose logging, causes the daemon to stay in the foreground, exits if the server\'s configuration is invalid (this happens if, for instance, you\'ve left a syntax error on the server), and exits after running the configuration once (rather than hanging around as a long\-running process)\. . .P \'tags\' allows you to specify what portions of a configuration you want to apply\. Puppet elements are tagged with all of the class or definition names that contain them, and you can use the \'tags\' flag to specify one of these names, causing only configuration elements contained within that class or definition to be applied\. This is very useful when you are testing new configurations \-\- for instance, if you are just starting to manage \'ntpd\', you would put all of the new elements into an \'ntpd\' class, and call puppet with \'\-\-tags ntpd\', which would only apply that small portion of the configuration during your testing, rather than applying the whole thing\. . .P \'fingerprint\' is a one\-time flag\. In this mode \'puppet agent\' will run once and display on the console (and in the log) the current certificate (or certificate request) fingerprint\. Providing the \'\-\-digest\' option allows to use a different digest algorithm to generate the fingerprint\. The main use is to verify that before signing a certificate request on the master, the certificate request the master received is the same as the one the client sent (to prevent against man\-in\-the\-middle attacks when signing certificates)\. . .SH "OPTIONS" Note that any Puppet setting that\'s valid in the configuration file is also a valid long argument\. For example, \'server\' is a valid setting, so you can specify \'\-\-server \fIservername\fR\' as an argument\. Boolean settings translate into \'\-\-setting\' and \'\-\-no\-setting\' pairs\. . .P See the configuration file documentation at http://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable settings\. A commented list of all settings can also be generated by running puppet agent with \'\-\-genconfig\'\. . .TP \-\-certname Set the certname (unique ID) of the client\. The master reads this unique identifying string, which is usually set to the node\'s fully\-qualified domain name, to determine which configurations the node will receive\. Use this option to debug setup problems or implement unusual node identification schemes\. (This is a Puppet setting, and can go in puppet\.conf\.) . .TP \-\-daemonize Send the process into the background\. This is the default\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special \'no\-\' prefix for boolean settings on the command line\.) . .TP \-\-no\-daemonize Do not send the process into the background\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special \'no\-\' prefix for boolean settings on the command line\.) . .TP \-\-debug Enable full debugging\. . .TP \-\-detailed\-exitcodes Provide transaction information via exit codes\. If this is enabled, an exit code of \'2\' means there were changes, an exit code of \'4\' means there were failures during the transaction, and an exit code of \'6\' means there were both changes and failures\. . .TP \-\-digest Change the certificate fingerprinting digest algorithm\. The default is SHA256\. Valid values depends on the version of OpenSSL installed, but will likely contain MD5, MD2, SHA1 and SHA256\. . .TP \-\-disable Disable working on the local system\. This puts a lock file in place, causing \'puppet agent\' not to work on the system until the lock file is removed\. This is useful if you are testing a configuration and do not want the central configuration to override the local state until everything is tested and committed\. . .IP Disable can also take an optional message that will be reported by the \'puppet agent\' at the next disabled run\. . .IP \'puppet agent\' uses the same lock file while it is running, so no more than one \'puppet agent\' process is working at a time\. . .IP \'puppet agent\' exits after executing this\. . .TP \-\-enable Enable working on the local system\. This removes any lock file, causing \'puppet agent\' to start managing the local system again (although it will continue to use its normal scheduling, so it might not start for another half hour)\. . .IP \'puppet agent\' exits after executing this\. . .TP \-\-fingerprint Display the current certificate or certificate signing request fingerprint and then exit\. Use the \'\-\-digest\' option to change the digest algorithm used\. . .TP \-\-help Print this help message . .TP \-\-logdest Where to send log messages\. Choose between \'syslog\' (the POSIX syslog service), \'eventlog\' (the Windows Event Log), \'console\', or the path to a log file\. If debugging or verbosity is enabled, this defaults to \'console\'\. Otherwise, it defaults to \'syslog\' on POSIX systems and \'eventlog\' on Windows\. . .TP \-\-masterport The port on which to contact the puppet master\. (This is a Puppet setting, and can go in puppet\.conf\.) . .TP \-\-no\-client Do not create a config client\. This will cause the daemon to start but not check configuration unless it is triggered with \fBpuppet kick\fR\. This only makes sense when puppet agent is being run with listen = true in puppet\.conf or was started with the \fB\-\-listen\fR option\. . .TP \-\-noop Use \'noop\' mode where the daemon runs in a no\-op or dry\-run mode\. This is useful for seeing what changes Puppet will make without actually executing the changes\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special \'no\-\' prefix for boolean settings on the command line\.) . .TP \-\-onetime Run the configuration once\. Runs a single (normally daemonized) Puppet run\. Useful for interactively running puppet agent when used in conjunction with the \-\-no\-daemonize option\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special \'no\-\' prefix for boolean settings on the command line\.) . .TP \-\-test Enable the most common options used for testing\. These are \'onetime\', \'verbose\', \'ignorecache\', \'no\-daemonize\', \'no\-usecacheonfailure\', \'detailed\-exitcodes\', \'no\-splay\', and \'show_diff\'\. . .TP \-\-verbose Turn on verbose reporting\. . .TP \-\-version Print the puppet version number and exit\. . .TP \-\-waitforcert This option only matters for daemons that do not yet have certificates and it is enabled by default, with a value of 120 (seconds)\. This causes \'puppet agent\' to connect to the server every 2 minutes and ask it to sign a certificate request\. This is useful for the initial setup of a puppet client\. You can turn off waiting for certificates by specifying a time of 0\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special \'no\-\' prefix for boolean settings on the command line\.) . .SH "EXAMPLE" . .nf $ puppet agent \-\-server puppet\.domain\.com . .fi . .SH "DIAGNOSTICS" Puppet agent accepts the following signals: . .TP SIGHUP Restart the puppet agent daemon\. . .TP SIGINT and SIGTERM Shut down the puppet agent daemon\. . .TP SIGUSR1 Immediately retrieve and apply configurations from the puppet master\. . .TP SIGUSR2 Close file descriptors for log files and reopen them\. Used with logrotate\. . .SH "AUTHOR" Luke Kanies . .SH "COPYRIGHT" Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-apply.8 b/man/man8/puppet-apply.8 index 5419ecc64..58c067ac2 100644 --- a/man/man8/puppet-apply.8 +++ b/man/man8/puppet-apply.8 @@ -1,79 +1,79 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-APPLY" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-APPLY" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-apply\fR \- Apply Puppet manifests locally . .SH "SYNOPSIS" Applies a standalone Puppet manifest to the local system\. . .SH "USAGE" puppet apply [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-execute] [\-\-detailed\-exitcodes] [\-L|\-\-loadclasses] [\-l|\-\-logdest syslog|eventlog|\fIFILE\fR|console] [\-\-noop] [\-\-catalog \fIcatalog\fR] [\-\-write\-catalog\-summary] \fIfile\fR . .SH "DESCRIPTION" This is the standalone puppet execution tool; use it to apply individual manifests\. . .P When provided with a modulepath, via command line or config file, puppet apply can effectively mimic the catalog that would be served by puppet master with access to the same modules, although there are some subtle differences\. When combined with scheduling and an automated system for pushing manifests, this can be used to implement a serverless Puppet site\. . .P Most users should use \'puppet agent\' and \'puppet master\' for site\-wide manifests\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument\. For example, \'tags\' is a valid setting, so you can specify \'\-\-tags \fIclass\fR,\fItag\fR\' as an argument\. . .P See the configuration file documentation at http://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \'\-\-genconfig\'\. . .IP "\(bu" 4 \-\-debug: Enable full debugging\. . .IP "\(bu" 4 \-\-detailed\-exitcodes: Provide transaction information via exit codes\. If this is enabled, an exit code of \'2\' means there were changes, an exit code of \'4\' means there were failures during the transaction, and an exit code of \'6\' means there were both changes and failures\. . .IP "\(bu" 4 \-\-help: Print this help message . .IP "\(bu" 4 \-\-loadclasses: Load any stored classes\. \'puppet agent\' caches configured classes (usually at /etc/puppet/classes\.txt), and setting this option causes all of those classes to be set in your puppet manifest\. . .IP "\(bu" 4 \-\-logdest: Where to send log messages\. Choose between \'syslog\' (the POSIX syslog service), \'eventlog\' (the Windows Event Log), \'console\', or the path to a log file\. Defaults to \'console\'\. . .IP "\(bu" 4 \-\-noop: Use \'noop\' mode where Puppet runs in a no\-op or dry\-run mode\. This is useful for seeing what changes Puppet will make without actually executing the changes\. . .IP "\(bu" 4 \-\-execute: Execute a specific piece of Puppet code . .IP "\(bu" 4 \-\-test: Enable the most common options used for testing\. These are \'verbose\', \'detailed\-exitcodes\' and \'show_diff\'\. . .IP "\(bu" 4 \-\-verbose: Print extra information\. . .IP "\(bu" 4 \-\-catalog: Apply a JSON catalog (such as one generated with \'puppet master \-\-compile\')\. You can either specify a JSON file or pipe in JSON from standard input\. . .IP "\(bu" 4 \-\-write\-catalog\-summary After compiling the catalog saves the resource list and classes list to the node in the state directory named classes\.txt and resources\.txt . .IP "" 0 . .SH "EXAMPLE" . .nf $ puppet apply \-l /tmp/manifest\.log manifest\.pp $ puppet apply \-\-modulepath=/root/dev/modules \-e "include ntpd::server" $ puppet apply \-\-catalog catalog\.json . .fi . .SH "AUTHOR" Luke Kanies . .SH "COPYRIGHT" Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-ca.8 b/man/man8/puppet-ca.8 index 171a2a03e..e18306195 100644 --- a/man/man8/puppet-ca.8 +++ b/man/man8/puppet-ca.8 @@ -1,182 +1,182 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-CA" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-CA" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-ca\fR \- Local Puppet Certificate Authority management\. . .SH "SYNOPSIS" puppet ca \fIaction\fR . .SH "DESCRIPTION" This provides local management of the Puppet Certificate Authority\. . .P You can use this subcommand to sign outstanding certificate requests, list and manage local certificates, and inspect the state of the CA\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .SH "ACTIONS" . .TP \fBdestroy\fR \- Destroy named certificate or pending certificate request\. \fBSYNOPSIS\fR . .IP puppet ca destroy . .IP \fBDESCRIPTION\fR . .IP Destroy named certificate or pending certificate request\. . .TP \fBfingerprint\fR \- Print the DIGEST (defaults to the signing algorithm) fingerprint of a host\'s certificate\. \fBSYNOPSIS\fR . .IP puppet ca fingerprint [\-\-digest ALGORITHM] . .IP \fBDESCRIPTION\fR . .IP Print the DIGEST (defaults to the signing algorithm) fingerprint of a host\'s certificate\. . .IP \fBOPTIONS\fR \fI\-\-digest ALGORITHM\fR \- The hash algorithm to use when displaying the fingerprint . .TP \fBgenerate\fR \- Generate a certificate for a named client\. \fBSYNOPSIS\fR . .IP puppet ca generate [\-\-dns\-alt\-names NAMES] . .IP \fBDESCRIPTION\fR . .IP Generate a certificate for a named client\. . .IP \fBOPTIONS\fR \fI\-\-dns\-alt\-names NAMES\fR \- The comma\-separated list of alternative DNS names to use for the local host\. . .IP When the node generates a CSR for itself, these are added to the request as the desired \fBsubjectAltName\fR in the certificate: additional DNS labels that the certificate is also valid answering as\. . .IP This is generally required if you use a non\-hostname \fBcertname\fR, or if you want to use \fBpuppet kick\fR or \fBpuppet resource \-H\fR and the primary certname does not match the DNS name you use to communicate with the host\. . .IP This is unnecessary for agents, unless you intend to use them as a server for \fBpuppet kick\fR or remote \fBpuppet resource\fR management\. . .IP It is rarely necessary for servers; it is usually helpful only if you need to have a pool of multiple load balanced masters, or for the same master to respond on two physically separate networks under different names\. . .TP \fBlist\fR \- List certificates and/or certificate requests\. \fBSYNOPSIS\fR . .IP puppet ca list [\-\-[no\-]all] [\-\-[no\-]pending] [\-\-[no\-]signed] [\-\-digest ALGORITHM] [\-\-subject PATTERN] . .IP \fBDESCRIPTION\fR . .IP This will list the current certificates and certificate signing requests in the Puppet CA\. You will also get the fingerprint, and any certificate verification failure reported\. . .IP \fBOPTIONS\fR \fI\-\-[no\-]all\fR \- Include all certificates and requests\. . .IP \fI\-\-digest ALGORITHM\fR \- The hash algorithm to use when displaying the fingerprint . .IP \fI\-\-[no\-]pending\fR \- Include pending certificate signing requests\. . .IP \fI\-\-[no\-]signed\fR \- Include signed certificates\. . .IP \fI\-\-subject PATTERN\fR \- Only include certificates or requests where subject matches PATTERN\. . .IP PATTERN is interpreted as a regular expression, allowing complex filtering of the content\. . .TP \fBprint\fR \- Print the full\-text version of a host\'s certificate\. \fBSYNOPSIS\fR . .IP puppet ca print . .IP \fBDESCRIPTION\fR . .IP Print the full\-text version of a host\'s certificate\. . .TP \fBrevoke\fR \- Add certificate to certificate revocation list\. \fBSYNOPSIS\fR . .IP puppet ca revoke . .IP \fBDESCRIPTION\fR . .IP Add certificate to certificate revocation list\. . .TP \fBsign\fR \- Sign an outstanding certificate request\. \fBSYNOPSIS\fR . .IP puppet ca sign [\-\-[no\-]allow\-dns\-alt\-names] . .IP \fBDESCRIPTION\fR . .IP Sign an outstanding certificate request\. . .IP \fBOPTIONS\fR \fI\-\-[no\-]allow\-dns\-alt\-names\fR \- Whether or not to accept DNS alt names in the certificate request . .TP \fBverify\fR \- Verify the named certificate against the local CA certificate\. \fBSYNOPSIS\fR . .IP puppet ca verify . .IP \fBDESCRIPTION\fR . .IP Verify the named certificate against the local CA certificate\. . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-catalog.8 b/man/man8/puppet-catalog.8 index 4c654718e..ca14a6588 100644 --- a/man/man8/puppet-catalog.8 +++ b/man/man8/puppet-catalog.8 @@ -1,292 +1,292 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-CATALOG" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-CATALOG" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-catalog\fR \- Compile, save, view, and convert catalogs\. . .SH "SYNOPSIS" puppet catalog \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "DESCRIPTION" This subcommand deals with catalogs, which are compiled per\-node artifacts generated from a set of Puppet manifests\. By default, it interacts with the compiling subsystem and compiles a catalog using the default manifest and \fBcertname\fR, but you can change the source of the catalog with the \fB\-\-terminus\fR option\. You can also choose to print any catalog in \'dot\' format (for easy graph viewing with OmniGraffle or Graphviz) with \'\-\-render\-as dot\'\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-extra HASH A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. . .TP \-\-terminus TERMINUS Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\. . .IP Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\. . .IP The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\. . .SH "ACTIONS" . .TP \fBapply\fR \- Find and apply a catalog\. \fBSYNOPSIS\fR . .IP puppet catalog apply [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR . .IP Finds and applies a catalog\. This action takes no arguments, but the source of the catalog can be managed with the \fB\-\-terminus\fR option\. . .IP \fBRETURNS\fR . .IP Nothing\. When used from the Ruby API, returns a Puppet::Transaction::Report object\. . .TP \fBdestroy\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet catalog destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBdownload\fR \- Download this node\'s catalog from the puppet master server\. \fBSYNOPSIS\fR . .IP puppet catalog download [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR . .IP Retrieves a catalog from the puppet master and saves it to the local yaml cache\. This action always contacts the puppet master and will ignore alternate termini\. . .IP The saved catalog can be used in any subsequent catalog action by specifying \'\-\-terminus yaml\' for that action\. . .IP \fBRETURNS\fR . .IP Nothing\. . .IP \fBNOTES\fR . .IP When used from the Ruby API, this action has a side effect of leaving Puppet::Resource::Catalog\.indirection\.terminus_class set to yaml\. The terminus must be explicitly re\-set for subsequent catalog actions\. . .TP \fBfind\fR \- Retrieve the catalog for a node\. \fBSYNOPSIS\fR . .IP puppet catalog find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIcertname\fR . .IP \fBDESCRIPTION\fR . .IP Retrieve the catalog for a node\. . .IP \fBRETURNS\fR . .IP A serialized catalog\. When used from the Ruby API, returns a Puppet::Resource::Catalog object\. . .TP \fBinfo\fR \- Print the default terminus class for this face\. \fBSYNOPSIS\fR . .IP puppet catalog info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR . .IP Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\. . .TP \fBsave\fR \- API only: create or overwrite an object\. \fBSYNOPSIS\fR . .IP puppet catalog save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\. . .TP \fBsearch\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet catalog search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBselect\fR \- Retrieve a catalog and filter it for resources of a given type\. \fBSYNOPSIS\fR . .IP puppet catalog select [\-\-terminus TERMINUS] [\-\-extra HASH] \fIhost\fR \fIresource_type\fR . .IP \fBDESCRIPTION\fR . .IP Retrieves a catalog for the specified host, then searches it for all resources of the requested type\. . .IP \fBRETURNS\fR . .IP A list of resource references ("Type[title]")\. When used from the API, returns an array of Puppet::Resource objects excised from a catalog\. . .IP \fBNOTES\fR . .IP By default, this action will retrieve a catalog from Puppet\'s compiler subsystem; you must call the action with \fB\-\-terminus rest\fR if you wish to retrieve a catalog from the puppet master\. . .IP FORMATTING ISSUES: This action cannot currently render useful yaml; instead, it returns an entire catalog\. Use json instead\. . .SH "EXAMPLES" \fBapply\fR . .P Apply the locally cached catalog: . .P $ puppet catalog apply \-\-terminus yaml . .P Retrieve a catalog from the master and apply it, in one step: . .P $ puppet catalog apply \-\-terminus rest . .P -From \fBsecret_agent\.rb\fR (API example): +API example: . .IP "" 4 . .nf # \.\.\. Puppet::Face[:catalog, \'0\.0\.1\']\.download # (Termini are singletons; catalog\.download has a side effect of # setting the catalog terminus to yaml) report = Puppet::Face[:catalog, \'0\.0\.1\']\.apply # \.\.\. . .fi . .IP "" 0 . .P \fBdownload\fR . .P Retrieve and store a catalog: . .P $ puppet catalog download . .P -From \fBsecret_agent\.rb\fR (API example): +API example: . .IP "" 4 . .nf Puppet::Face[:plugin, \'0\.0\.1\']\.download Puppet::Face[:facts, \'0\.0\.1\']\.upload Puppet::Face[:catalog, \'0\.0\.1\']\.download # \.\.\. . .fi . .IP "" 0 . .P \fBselect\fR . .P Ask the puppet master for a list of managed file resources for a node: . .P $ puppet catalog select \-\-terminus rest somenode\.magpie\.lan file . .SH "NOTES" This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include: . .IP "\(bu" 4 \fBactive_record\fR . .IP "\(bu" 4 \fBcompiler\fR . .IP "\(bu" 4 \fBjson\fR . .IP "\(bu" 4 \fBmsgpack\fR . .IP "\(bu" 4 \fBrest\fR . .IP "\(bu" 4 \fBstatic_compiler\fR . .IP "\(bu" 4 \fBstore_configs\fR . .IP "\(bu" 4 \fByaml\fR . .IP "" 0 . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-cert.8 b/man/man8/puppet-cert.8 index ed089468f..6b1430e9b 100644 --- a/man/man8/puppet-cert.8 +++ b/man/man8/puppet-cert.8 @@ -1,101 +1,101 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-CERT" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-CERT" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-cert\fR \- Manage certificates and requests . .SH "SYNOPSIS" Standalone certificate authority\. Capable of generating certificates, but mostly used for signing certificate requests from puppet clients\. . .SH "USAGE" puppet cert \fIaction\fR [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-\-digest \fIdigest\fR] [\fIhost\fR] . .SH "DESCRIPTION" Because the puppet master service defaults to not signing client certificate requests, this script is available for signing outstanding requests\. It can be used to list outstanding requests and then either sign them individually or sign all of them\. . .SH "ACTIONS" Every action except \'list\' and \'generate\' requires a hostname to act on, unless the \'\-\-all\' option is set\. . .TP clean Revoke a host\'s certificate (if applicable) and remove all files related to that host from puppet cert\'s storage\. This is useful when rebuilding hosts, since new certificate signing requests will only be honored if puppet cert does not have a copy of a signed certificate for that host\. If \'\-\-all\' is specified then all host certificates, both signed and unsigned, will be removed\. . .TP fingerprint Print the DIGEST (defaults to the signing algorithm) fingerprint of a host\'s certificate\. . .TP generate Generate a certificate for a named client\. A certificate/keypair will be generated for each client named on the command line\. . .TP list List outstanding certificate requests\. If \'\-\-all\' is specified, signed certificates are also listed, prefixed by \'+\', and revoked or invalid certificates are prefixed by \'\-\' (the verification outcome is printed in parenthesis)\. . .TP print Print the full\-text version of a host\'s certificate\. . .TP revoke Revoke the certificate of a client\. The certificate can be specified either by its serial number (given as a hexadecimal number prefixed by \'0x\') or by its hostname\. The certificate is revoked by adding it to the Certificate Revocation List given by the \'cacrl\' configuration option\. Note that the puppet master needs to be restarted after revoking certificates\. . .TP sign Sign an outstanding certificate request\. . .TP verify Verify the named certificate against the local CA certificate\. . .TP reinventory Build an inventory of the issued certificates\. This will destroy the current inventory file specified by \'cert_inventory\' and recreate it from the certificates found in the \'certdir\'\. Ensure the puppet master is stopped before running this action\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument\. For example, \'ssldir\' is a valid setting, so you can specify \'\-\-ssldir \fIdirectory\fR\' as an argument\. . .P See the configuration file documentation at http://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet cert with \'\-\-genconfig\'\. . .TP \-\-all Operate on all items\. Currently only makes sense with the \'sign\', \'clean\', \'list\', and \'fingerprint\' actions\. . .TP \-\-digest Set the digest for fingerprinting (defaults to the digest used when signing the cert)\. Valid values depends on your openssl and openssl ruby extension version\. . .TP \-\-debug Enable full debugging\. . .TP \-\-help Print this help message . .TP \-\-verbose Enable verbosity\. . .TP \-\-version Print the puppet version number and exit\. . .SH "EXAMPLE" . .nf $ puppet cert list culain\.madstop\.com $ puppet cert sign culain\.madstop\.com . .fi . .SH "AUTHOR" Luke Kanies . .SH "COPYRIGHT" Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-certificate.8 b/man/man8/puppet-certificate.8 index 56b6398fe..c37ee64e5 100644 --- a/man/man8/puppet-certificate.8 +++ b/man/man8/puppet-certificate.8 @@ -1,250 +1,250 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-CERTIFICATE" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-CERTIFICATE" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-certificate\fR \- Provide access to the CA for certificate management\. . .SH "SYNOPSIS" puppet certificate \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR . .SH "DESCRIPTION" This subcommand interacts with a local or remote Puppet certificate authority\. Currently, its behavior is not a full superset of \fBpuppet cert\fR; specifically, it is unable to mimic puppet cert\'s "clean" option, and its "generate" action submits a CSR rather than creating a signed certificate\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-ca\-location LOCATION Whether to act on the local certificate authority or one provided by a remote puppet master\. Allowed values are \'local\' and \'remote\.\' . .IP This option is required\. . .TP \-\-extra HASH A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. . .TP \-\-terminus TERMINUS Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\. . .IP Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\. . .IP The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\. . .SH "ACTIONS" . .TP \fBdestroy\fR \- Delete a certificate\. \fBSYNOPSIS\fR . .IP puppet certificate destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIhost\fR . .IP \fBDESCRIPTION\fR . .IP Deletes a certificate\. This action currently only works on the local CA\. . .IP \fBRETURNS\fR . .IP Nothing\. . .TP \fBfind\fR \- Retrieve a certificate\. \fBSYNOPSIS\fR . .IP puppet certificate find [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIhost\fR . .IP \fBDESCRIPTION\fR . .IP Retrieve a certificate\. . .IP \fBRETURNS\fR . .IP An x509 SSL certificate\. . .IP Note that this action has a side effect of caching a copy of the certificate in Puppet\'s \fBssldir\fR\. . .TP \fBgenerate\fR \- Generate a new certificate signing request\. \fBSYNOPSIS\fR . .IP puppet certificate generate [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR [\-\-dns\-alt\-names NAMES] \fIhost\fR . .IP \fBDESCRIPTION\fR . .IP Generates and submits a certificate signing request (CSR) for the specified host\. This CSR will then have to be signed by a user with the proper authorization on the certificate authority\. . .IP Puppet agent usually handles CSR submission automatically\. This action is primarily useful for requesting certificates for individual users and external applications\. . .IP \fBOPTIONS\fR \fI\-\-dns\-alt\-names NAMES\fR \- The comma\-separated list of alternative DNS names to use for the local host\. . .IP When the node generates a CSR for itself, these are added to the request as the desired \fBsubjectAltName\fR in the certificate: additional DNS labels that the certificate is also valid answering as\. . .IP This is generally required if you use a non\-hostname \fBcertname\fR, or if you want to use \fBpuppet kick\fR or \fBpuppet resource \-H\fR and the primary certname does not match the DNS name you use to communicate with the host\. . .IP This is unnecessary for agents, unless you intend to use them as a server for \fBpuppet kick\fR or remote \fBpuppet resource\fR management\. . .IP It is rarely necessary for servers; it is usually helpful only if you need to have a pool of multiple load balanced masters, or for the same master to respond on two physically separate networks under different names\. . .IP \fBRETURNS\fR . .IP Nothing\. . .TP \fBinfo\fR \- Print the default terminus class for this face\. \fBSYNOPSIS\fR . .IP puppet certificate info [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR . .IP \fBDESCRIPTION\fR . .IP Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\. . .TP \fBlist\fR \- List all certificate signing requests\. \fBSYNOPSIS\fR . .IP puppet certificate list [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR . .IP \fBDESCRIPTION\fR . .IP List all certificate signing requests\. . .IP \fBRETURNS\fR . .IP An array of #inspect output from CSR objects\. This output is currently messy, but does contain the names of nodes requesting certificates\. This action returns #inspect strings even when used from the Ruby API\. . .TP \fBsave\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet certificate save [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBsearch\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet certificate search [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIquery\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBsign\fR \- Sign a certificate signing request for HOST\. \fBSYNOPSIS\fR . .IP puppet certificate sign [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR [\-\-[no\-]allow\-dns\-alt\-names] \fIhost\fR . .IP \fBDESCRIPTION\fR . .IP Sign a certificate signing request for HOST\. . .IP \fBOPTIONS\fR \fI\-\-[no\-]allow\-dns\-alt\-names\fR \- Whether or not to accept DNS alt names in the certificate request . .IP \fBRETURNS\fR . .IP A string that appears to be (but isn\'t) an x509 certificate\. . .SH "EXAMPLES" \fBgenerate\fR . .P Request a certificate for "somenode" from the site\'s CA: . .P $ puppet certificate generate somenode\.puppetlabs\.lan \-\-ca\-location remote . .P \fBsign\fR . .P Sign somenode\.puppetlabs\.lan\'s certificate: . .P $ puppet certificate sign somenode\.puppetlabs\.lan \-\-ca\-location remote . .SH "NOTES" This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include: . .IP "\(bu" 4 \fBca\fR . .IP "\(bu" 4 \fBdisabled_ca\fR . .IP "\(bu" 4 \fBfile\fR . .IP "\(bu" 4 \fBrest\fR . .IP "" 0 . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-certificate_request.8 b/man/man8/puppet-certificate_request.8 index fa86bbbe6..3bfe6087b 100644 --- a/man/man8/puppet-certificate_request.8 +++ b/man/man8/puppet-certificate_request.8 @@ -1,171 +1,171 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-CERTIFICATE_REQUEST" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-CERTIFICATE_REQUEST" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-certificate_request\fR \- Manage certificate requests\. . .SH "SYNOPSIS" puppet certificate_request \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "DESCRIPTION" This subcommand retrieves and submits certificate signing requests (CSRs)\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-extra HASH A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. . .TP \-\-terminus TERMINUS Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\. . .IP Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\. . .IP The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\. . .SH "ACTIONS" . .TP \fBdestroy\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet certificate_request destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBfind\fR \- Retrieve a single CSR\. \fBSYNOPSIS\fR . .IP puppet certificate_request find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIhost\fR . .IP \fBDESCRIPTION\fR . .IP Retrieve a single CSR\. . .IP \fBRETURNS\fR . .IP A single certificate request\. When used from the Ruby API, returns a Puppet::SSL::CertificateRequest object\. . .TP \fBinfo\fR \- Print the default terminus class for this face\. \fBSYNOPSIS\fR . .IP puppet certificate_request info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR . .IP Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\. . .TP \fBsave\fR \- API only: submit a certificate signing request\. \fBSYNOPSIS\fR . .IP puppet certificate_request save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIx509_CSR\fR . .IP \fBDESCRIPTION\fR . .IP API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\. . .TP \fBsearch\fR \- Retrieve all outstanding CSRs\. \fBSYNOPSIS\fR . .IP puppet certificate_request search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR . .IP \fBDESCRIPTION\fR . .IP Retrieve all outstanding CSRs\. . .IP \fBRETURNS\fR . .IP A list of certificate requests\. When used from the Ruby API, returns an array of Puppet::SSL::CertificateRequest objects\. . .IP \fBNOTES\fR . .IP Although this action always returns all CSRs, it requires a dummy search key; this is a known bug\. . .SH "EXAMPLES" \fBfind\fR . .P Retrieve a single CSR from the puppet master\'s CA: . .P $ puppet certificate_request find somenode\.puppetlabs\.lan \-\-terminus rest . .P \fBsearch\fR . .P Retrieve all CSRs from the local CA (similar to \'puppet cert list\'): . .P $ puppet certificate_request search x \-\-terminus ca . .SH "NOTES" This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include: . .IP "\(bu" 4 \fBca\fR . .IP "\(bu" 4 \fBdisabled_ca\fR . .IP "\(bu" 4 \fBfile\fR . .IP "\(bu" 4 \fBmemory\fR . .IP "\(bu" 4 \fBrest\fR . .IP "" 0 . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-certificate_revocation_list.8 b/man/man8/puppet-certificate_revocation_list.8 index 607670786..e6b1f4cd1 100644 --- a/man/man8/puppet-certificate_revocation_list.8 +++ b/man/man8/puppet-certificate_revocation_list.8 @@ -1,165 +1,165 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-CERTIFICATE_REVOCATION_LIST" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-CERTIFICATE_REVOCATION_LIST" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-certificate_revocation_list\fR \- Manage the list of revoked certificates\. . .SH "SYNOPSIS" puppet certificate_revocation_list \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "DESCRIPTION" This subcommand is primarily for retrieving the certificate revocation list from the CA\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-extra HASH A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. . .TP \-\-terminus TERMINUS Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\. . .IP Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\. . .IP The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\. . .SH "ACTIONS" . .TP \fBdestroy\fR \- Delete the certificate revocation list\. \fBSYNOPSIS\fR . .IP puppet certificate_revocation_list destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR . .IP \fBDESCRIPTION\fR . .IP Deletes the certificate revocation list\. This cannot be done over REST, but it is possible to delete the locally cached copy or the local CA\'s copy of the CRL\. . .IP \fBRETURNS\fR . .IP Nothing\. . .IP \fBNOTES\fR . .IP Although this action always deletes the CRL from the specified terminus, it requires a dummy argument; this is a known bug\. . .TP \fBfind\fR \- Retrieve the certificate revocation list\. \fBSYNOPSIS\fR . .IP puppet certificate_revocation_list find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR . .IP \fBDESCRIPTION\fR . .IP Retrieve the certificate revocation list\. . .IP \fBRETURNS\fR . .IP The certificate revocation list\. When used from the Ruby API: returns an OpenSSL::X509::CRL object\. . .IP \fBNOTES\fR . .IP Although this action always returns the CRL from the specified terminus, it requires a dummy argument; this is a known bug\. . .TP \fBinfo\fR \- Print the default terminus class for this face\. \fBSYNOPSIS\fR . .IP puppet certificate_revocation_list info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR . .IP Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\. . .TP \fBsave\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet certificate_revocation_list save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBsearch\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet certificate_revocation_list search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .SH "EXAMPLES" \fBfind\fR . .P Retrieve a copy of the puppet master\'s CRL: . .P $ puppet certificate_revocation_list find crl \-\-terminus rest . .SH "NOTES" This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include: . .IP "\(bu" 4 \fBca\fR . .IP "\(bu" 4 \fBdisabled_ca\fR . .IP "\(bu" 4 \fBfile\fR . .IP "\(bu" 4 \fBrest\fR . .IP "" 0 . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-config.8 b/man/man8/puppet-config.8 index 14f5f2777..072268e23 100644 --- a/man/man8/puppet-config.8 +++ b/man/man8/puppet-config.8 @@ -1,117 +1,117 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-CONFIG" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-CONFIG" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-config\fR \- Interact with Puppet\'s settings\. . .SH "SYNOPSIS" puppet config \fIaction\fR [\-\-section SECTION_NAME] . .SH "DESCRIPTION" This subcommand can inspect and modify settings from Puppet\'s \'puppet\.conf\' configuration file\. For documentation about individual settings, see http://docs\.puppetlabs\.com/references/latest/configuration\.html\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-section SECTION_NAME The section of the puppet\.conf configuration file to interact with\. . .IP The three most commonly used sections are \'main\', \'master\', and \'agent\'\. \'Main\' is the default, and is used by all Puppet applications\. Other sections can override \'main\' values for specific applications \-\-\- the \'master\' section affects puppet master and puppet cert, and the \'agent\' section affects puppet agent\. . .IP Less commonly used is the \'user\' section, which affects puppet apply\. Any other section will be treated as the name of a legacy environment (a deprecated feature), and can only include the \'manifest\' and \'modulepath\' settings\. . .SH "ACTIONS" . .TP \fBprint\fR \- Examine Puppet\'s current settings\. \fBSYNOPSIS\fR . .IP puppet config print [\-\-section SECTION_NAME] (all | \fIsetting\fR [\fIsetting\fR \.\.\.] . .IP \fBDESCRIPTION\fR . .IP Prints the value of a single setting or a list of settings\. . .IP This action is an alternate interface to the information available with \fBpuppet \-\-configprint\fR\. . .IP \fBNOTES\fR . .IP By default, this action reads the general configuration in the \'main\' section\. Use the \'\-\-section\' and \'\-\-environment\' flags to examine other configuration domains\. . .TP \fBset\fR \- Set Puppet\'s settings\. \fBSYNOPSIS\fR . .IP puppet config set [\-\-section SECTION_NAME] [setting_name] [setting_value] . .IP \fBDESCRIPTION\fR . .IP Updates values in the \fBpuppet\.conf\fR configuration file\. . .IP \fBNOTES\fR . .IP By default, this action manipulates the configuration in the \'main\' section\. Use the \'\-\-section\' flag to manipulate other configuration domains\. . .SH "EXAMPLES" \fBprint\fR . .P Get puppet\'s runfile directory: . .P $ puppet config print rundir . .P Get a list of important directories from the master\'s config: . .P $ puppet config print all \-\-section master | grep \-E "(path|dir)" . .P \fBset\fR . .P Set puppet\'s runfile directory: . .P $ puppet config set rundir /var/run/puppet . .P Set the vardir for only the agent: . .P $ puppet config set vardir /var/lib/puppetagent \-\-section agent . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-describe.8 b/man/man8/puppet-describe.8 index b403ac2f0..0b788cc35 100644 --- a/man/man8/puppet-describe.8 +++ b/man/man8/puppet-describe.8 @@ -1,51 +1,51 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-DESCRIBE" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-DESCRIBE" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-describe\fR \- Display help about resource types . .SH "SYNOPSIS" Prints help about Puppet resource types, providers, and metaparameters\. . .SH "USAGE" puppet describe [\-h|\-\-help] [\-s|\-\-short] [\-p|\-\-providers] [\-l|\-\-list] [\-m|\-\-meta] . .SH "OPTIONS" . .TP \-\-help Print this help text . .TP \-\-providers Describe providers in detail for each type . .TP \-\-list List all types . .TP \-\-meta List all metaparameters . .TP \-\-short List only parameters without detail . .SH "EXAMPLE" . .nf $ puppet describe \-\-list $ puppet describe file \-\-providers $ puppet describe user \-s \-m . .fi . .SH "AUTHOR" David Lutterkort . .SH "COPYRIGHT" Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-device.8 b/man/man8/puppet-device.8 index 51e21c720..69b77d3b9 100644 --- a/man/man8/puppet-device.8 +++ b/man/man8/puppet-device.8 @@ -1,75 +1,75 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-DEVICE" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-DEVICE" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-device\fR \- Manage remote network devices . .SH "SYNOPSIS" Retrieves all configurations from the puppet master and apply them to the remote devices configured in /etc/puppet/device\.conf\. . .P Currently must be run out periodically, using cron or something similar\. . .SH "USAGE" puppet device [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-V|\-\-version] [\-h|\-\-help] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-v|\-\-verbose] [\-w|\-\-waitforcert \fIseconds\fR] . .SH "DESCRIPTION" Once the client has a signed certificate for a given remote device, it will retrieve its configuration and apply it\. . .SH "USAGE NOTES" One need a /etc/puppet/device\.conf file with the following content: . .P [remote\.device\.fqdn] type \fItype\fR url \fIurl\fR . .P where: * type: the current device type (the only value at this time is cisco) * url: an url allowing to connect to the device . .P Supported url must conforms to: scheme://user:password@hostname/?query . .P with: * scheme: either ssh or telnet * user: username, can be omitted depending on the switch/router configuration * password: the connection password * query: this is device specific\. Cisco devices supports an enable parameter whose value would be the enable password\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument\. For example, \'server\' is a valid configuration parameter, so you can specify \'\-\-server \fIservername\fR\' as an argument\. . .TP \-\-debug Enable full debugging\. . .TP \-\-detailed\-exitcodes Provide transaction information via exit codes\. If this is enabled, an exit code of \'2\' means there were changes, an exit code of \'4\' means there were failures during the transaction, and an exit code of \'6\' means there were both changes and failures\. . .TP \-\-help Print this help message . .TP \-\-logdest Where to send messages\. Choose between syslog, the console, and a log file\. Defaults to sending messages to syslog, or the console if debugging or verbosity is enabled\. . .TP \-\-verbose Turn on verbose reporting\. . .TP \-\-waitforcert This option only matters for daemons that do not yet have certificates and it is enabled by default, with a value of 120 (seconds)\. This causes +puppet agent+ to connect to the server every 2 minutes and ask it to sign a certificate request\. This is useful for the initial setup of a puppet client\. You can turn off waiting for certificates by specifying a time of 0\. . .SH "EXAMPLE" . .nf $ puppet device \-\-server puppet\.domain\.com . .fi . .SH "AUTHOR" Brice Figureau . .SH "COPYRIGHT" Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-doc.8 b/man/man8/puppet-doc.8 index 02eab5778..d11e1253b 100644 --- a/man/man8/puppet-doc.8 +++ b/man/man8/puppet-doc.8 @@ -1,113 +1,113 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-DOC" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-DOC" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-doc\fR \- Generate Puppet documentation and references . .SH "SYNOPSIS" Generates a reference for all Puppet types\. Largely meant for internal Puppet Labs use\. . .SH "USAGE" puppet doc [\-a|\-\-all] [\-h|\-\-help] [\-l|\-\-list] [\-o|\-\-outputdir \fIrdoc\-outputdir\fR] [\-m|\-\-mode text|pdf|rdoc] [\-r|\-\-reference \fIreference\-name\fR] [\-\-charset \fIcharset\fR] [\fImanifest\-file\fR] . .SH "DESCRIPTION" If mode is not \'rdoc\', then this command generates a Markdown document describing all installed Puppet types or all allowable arguments to puppet executables\. It is largely meant for internal use and is used to generate the reference document available on the Puppet Labs web site\. . .P In \'rdoc\' mode, this command generates an html RDoc hierarchy describing the manifests that are in \'manifestdir\' and \'modulepath\' configuration directives\. The generated documentation directory is doc by default but can be changed with the \'outputdir\' option\. . .P If the command is run with the name of a manifest file as an argument, puppet doc will output a single manifest\'s documentation on stdout\. . .SH "OPTIONS" . .TP \-\-all Output the docs for all of the reference types\. In \'rdoc\' mode, this also outputs documentation for all resources\. . .TP \-\-help Print this help message . .TP \-\-outputdir Used only in \'rdoc\' mode\. The directory to which the rdoc output should be written\. . .TP \-\-mode Determine the output mode\. Valid modes are \'text\', \'pdf\' and \'rdoc\'\. The \'pdf\' mode creates PDF formatted files in the /tmp directory\. The default mode is \'text\'\. . .TP \-\-reference Build a particular reference\. Get a list of references by running \'puppet doc \-\-list\'\. . .TP \-\-charset Used only in \'rdoc\' mode\. It sets the charset used in the html files produced\. . .TP \-\-manifestdir Used only in \'rdoc\' mode\. The directory to scan for stand\-alone manifests\. If not supplied, puppet doc will use the manifestdir from puppet\.conf\. . .TP \-\-modulepath Used only in \'rdoc\' mode\. The directory or directories to scan for modules\. If not supplied, puppet doc will use the modulepath from puppet\.conf\. . .TP \-\-environment Used only in \'rdoc\' mode\. The configuration environment from which to read the modulepath and manifestdir settings, when reading said settings from puppet\.conf\. . .SH "EXAMPLE" . .nf $ puppet doc \-r type > /tmp/type_reference\.markdown . .fi . .P or . .IP "" 4 . .nf $ puppet doc \-\-outputdir /tmp/rdoc \-\-mode rdoc /path/to/manifests . .fi . .IP "" 0 . .P or . .IP "" 4 . .nf $ puppet doc /etc/puppet/manifests/site\.pp . .fi . .IP "" 0 . .P or . .IP "" 4 . .nf $ puppet doc \-m pdf \-r configuration . .fi . .IP "" 0 . .SH "AUTHOR" Luke Kanies . .SH "COPYRIGHT" Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-facts.8 b/man/man8/puppet-facts.8 index eabde4030..44705352e 100644 --- a/man/man8/puppet-facts.8 +++ b/man/man8/puppet-facts.8 @@ -1,162 +1,162 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-FACTS" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-FACTS" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-facts\fR \- Retrieve and store facts\. . .SH "SYNOPSIS" puppet facts \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "DESCRIPTION" This subcommand manages facts, which are collections of normalized system information used by Puppet\. It can read facts directly from the local system (with the default \fBfacter\fR terminus)\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-extra HASH A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. . .TP \-\-terminus TERMINUS Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\. . .IP Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\. . .IP The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\. . .SH "ACTIONS" . .TP \fBdestroy\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet facts destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBfind\fR \- Retrieve a node\'s facts\. \fBSYNOPSIS\fR . .IP puppet facts find [\-\-terminus TERMINUS] [\-\-extra HASH] \fInode_certname\fR . .IP \fBDESCRIPTION\fR . .IP Retrieve a node\'s facts\. . .IP \fBRETURNS\fR . .IP A hash containing some metadata and (under the "values" key) the set of facts for the requested node\. When used from the Ruby API: A Puppet::Node::Facts object\. . .IP RENDERING ISSUES: Facts cannot currently be rendered as a string; use yaml or json\. . .IP \fBNOTES\fR . .IP When using the \fBfacter\fR terminus, the host argument is ignored\. . .TP \fBinfo\fR \- Print the default terminus class for this face\. \fBSYNOPSIS\fR . .IP puppet facts info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR . .IP Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\. . .TP \fBsave\fR \- API only: create or overwrite an object\. \fBSYNOPSIS\fR . .IP puppet facts save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\. . .TP \fBsearch\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet facts search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .SH "EXAMPLES" \fBfind\fR . .P Get facts from the local system: . .P $ puppet facts find x . .SH "NOTES" This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include: . .IP "\(bu" 4 \fBactive_record\fR . .IP "\(bu" 4 \fBfacter\fR . .IP "\(bu" 4 \fBmemory\fR . .IP "\(bu" 4 \fBnetwork_device\fR . .IP "\(bu" 4 \fBstore_configs\fR . .IP "\(bu" 4 \fByaml\fR . .IP "" 0 . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-file.8 b/man/man8/puppet-file.8 index 7477e65f7..42ff1887f 100644 --- a/man/man8/puppet-file.8 +++ b/man/man8/puppet-file.8 @@ -1,215 +1,215 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-FILE" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-FILE" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-file\fR \- Retrieve and store files in a filebucket . .SH "SYNOPSIS" puppet file \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "DESCRIPTION" This subcommand interacts with objects stored in a local or remote filebucket\. File objects are accessed by their MD5 sum; see the examples for the relevant syntax\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-extra HASH A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. . .TP \-\-terminus TERMINUS Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\. . .IP Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\. . .IP The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\. . .SH "ACTIONS" . .TP \fBdestroy\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet file destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBdownload\fR \- Download a file into the local filebucket\. \fBSYNOPSIS\fR . .IP puppet file download [\-\-terminus TERMINUS] [\-\-extra HASH] ( {md5}\fIchecksum\fR | \fIpuppet_url\fR ) . .IP \fBDESCRIPTION\fR . .IP Downloads a file from the puppet master\'s filebucket and duplicates it in the local filebucket\. This action\'s checksum syntax differs from \fBfind\fR\'s, and it can accept a URL\. . .IP \fBRETURNS\fR . .IP Nothing\. . .TP \fBfind\fR \- Retrieve a file from the filebucket\. \fBSYNOPSIS\fR . .IP puppet file find [\-\-terminus TERMINUS] [\-\-extra HASH] md5/\fImd5sum\fR . .IP \fBDESCRIPTION\fR . .IP Retrieve a file from the filebucket\. . .IP \fBRETURNS\fR . .IP The file object with the specified checksum\. . .IP RENDERING ISSUES: Rendering as a string returns the contents of the file object; rendering as yaml returns a hash of metadata about said file, including but not limited to its contents\. Rendering as json is currently broken, and returns a hash containing only the contents of the file\. . .TP \fBinfo\fR \- Print the default terminus class for this face\. \fBSYNOPSIS\fR . .IP puppet file info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR . .IP Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\. . .TP \fBsave\fR \- API only: create or overwrite an object\. \fBSYNOPSIS\fR . .IP puppet file save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\. . .TP \fBsearch\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet file search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBstore\fR \- Store a file in the local filebucket\. \fBSYNOPSIS\fR . .IP puppet file store [\-\-terminus TERMINUS] [\-\-extra HASH] \fIfile\fR . .IP \fBDESCRIPTION\fR . .IP Store a file in the local filebucket\. . .IP \fBRETURNS\fR . .IP Nothing\. . .SH "EXAMPLES" \fBdownload\fR . .P Download a file by URL: . .P $ puppet file download puppet:///modules/editors/vim/\.vimrc . .P Download a file by MD5 sum: . .P $ puppet file download {md5}8f798d4e754db0ac89186bbaeaf0af18 . .P \fBfind\fR . .P Retrieve the contents of a file: . .P $ puppet file find md5/9aedba7f413c97dc65895b1cd9421f2c \-\-render\-as s . .P \fBstore\fR . .P Store a file: . .P $ puppet file store /root/\.bashrc . .SH "NOTES" To retrieve the unmunged contents of a file, you must call find with \-\-render\-as s\. Rendering as yaml will return a hash of metadata about the file, including its contents\. . .P This subcommand does not interact with the \fBclientbucketdir\fR (the default local filebucket for puppet agent); it interacts with the primary "master"\-type filebucket located in the \fBbucketdir\fR\. If you wish to interact with puppet agent\'s default filebucket, you\'ll need to set the \fI\-\-bucketdir\fR option appropriately when invoking actions\. . .P This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include: . .IP "\(bu" 4 \fBfile\fR . .IP "\(bu" 4 \fBrest\fR . .IP "\(bu" 4 \fBselector\fR . .IP "" 0 . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-filebucket.8 b/man/man8/puppet-filebucket.8 index 058885aff..4d5092f62 100644 --- a/man/man8/puppet-filebucket.8 +++ b/man/man8/puppet-filebucket.8 @@ -1,81 +1,81 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-FILEBUCKET" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-FILEBUCKET" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket . .SH "SYNOPSIS" A stand\-alone Puppet filebucket client\. . .SH "USAGE" puppet filebucket \fImode\fR [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-l|\-\-local] [\-r|\-\-remote] [\-s|\-\-server \fIserver\fR] [\-b|\-\-bucket \fIdirectory\fR] \fIfile\fR \fIfile\fR \.\.\. . .P Puppet filebucket can operate in three modes, with only one mode per call: . .P backup: Send one or more files to the specified file bucket\. Each sent file is printed with its resulting md5 sum\. . .P get: Return the text associated with an md5 sum\. The text is printed to stdout, and only one file can be retrieved at a time\. . .P restore: Given a file path and an md5 sum, store the content associated with the sum into the specified file path\. You can specify an entirely new path to this argument; you are not restricted to restoring the content to its original location\. . .SH "DESCRIPTION" This is a stand\-alone filebucket client for sending files to a local or central filebucket\. . .P Note that \'filebucket\' defaults to using a network\-based filebucket available on the server named \'puppet\'\. To use this, you\'ll have to be running as a user with valid Puppet certificates\. Alternatively, you can use your local file bucket by specifying \'\-\-local\'\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument\. For example, \'ssldir\' is a valid setting, so you can specify \'\-\-ssldir \fIdirectory\fR\' as an argument\. . .P See the configuration file documentation at http://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \'\-\-genconfig\'\. . .TP \-\-debug Enable full debugging\. . .TP \-\-help Print this help message . .TP \-\-local Use the local filebucket\. This will use the default configuration information\. . .TP \-\-remote Use a remote filebucket\. This will use the default configuration information\. . .TP \-\-server The server to send the file to, instead of locally\. . .TP \-\-verbose Print extra information\. . .TP \-\-version Print version information\. . .SH "EXAMPLE" . .nf $ puppet filebucket backup /etc/passwd /etc/passwd: 429b225650b912a2ee067b0a4cf1e949 $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949 . .fi . .SH "AUTHOR" Luke Kanies . .SH "COPYRIGHT" Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-help.8 b/man/man8/puppet-help.8 index 3ed761468..e7781b4ff 100644 --- a/man/man8/puppet-help.8 +++ b/man/man8/puppet-help.8 @@ -1,64 +1,64 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-HELP" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-HELP" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-help\fR \- Display Puppet help\. . .SH "SYNOPSIS" puppet help \fIaction\fR . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .SH "ACTIONS" . .TP \fBhelp\fR \- Display help about Puppet subcommands and their actions\. \fBSYNOPSIS\fR . .IP puppet help [\-\-version VERSION] [\fIsubcommand\fR] [\fIaction\fR] . .IP \fBDESCRIPTION\fR . .IP Display help about Puppet subcommands and their actions\. . .IP \fBOPTIONS\fR \fI\-\-version VERSION\fR \- The version of the subcommand for which to show help\. . .IP \fBRETURNS\fR . .IP Short help text for the specified subcommand or action\. . .SH "EXAMPLES" \fBhelp\fR . .P Get help for an action: . .P $ puppet help . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-inspect.8 b/man/man8/puppet-inspect.8 index c6e4eabc3..529d5c15f 100644 --- a/man/man8/puppet-inspect.8 +++ b/man/man8/puppet-inspect.8 @@ -1,36 +1,36 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-INSPECT" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-INSPECT" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-inspect\fR \- Send an inspection report . .SH "SYNOPSIS" Prepares and submits an inspection report to the puppet master\. . .SH "USAGE" puppet inspect [\-\-archive_files] [\-\-archive_file_server] . .SH "DESCRIPTION" This command uses the cached catalog from the previous run of \'puppet agent\' to determine which attributes of which resources have been marked as auditable with the \'audit\' metaparameter\. It then examines the current state of the system, writes the state of the specified resource attributes to a report, and submits the report to the puppet master\. . .P Puppet inspect does not run as a daemon, and must be run manually or from cron\. . .SH "OPTIONS" Any configuration setting which is valid in the configuration file is also a valid long argument, e\.g\. \'\-\-server=master\.domain\.com\'\. See the configuration file documentation at http://docs\.puppetlabs\.com/references/latest/configuration\.html for the full list of acceptable settings\. . .TP \-\-archive_files During an inspect run, whether to archive files whose contents are audited to a file bucket\. . .TP \-\-archive_file_server During an inspect run, the file bucket server to archive files to if archive_files is set\. The default value is \'$server\'\. . .SH "AUTHOR" Puppet Labs . .SH "COPYRIGHT" Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-key.8 b/man/man8/puppet-key.8 index 01858bbed..19d5a5fc6 100644 --- a/man/man8/puppet-key.8 +++ b/man/man8/puppet-key.8 @@ -1,132 +1,132 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-KEY" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-KEY" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-key\fR \- Create, save, and remove certificate keys\. . .SH "SYNOPSIS" puppet key \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "DESCRIPTION" This subcommand manages certificate private keys\. Keys are created automatically by puppet agent and when certificate requests are generated with \'puppet certificate generate\'; it should not be necessary to use this subcommand directly\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-extra HASH A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. . .TP \-\-terminus TERMINUS Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\. . .IP Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\. . .IP The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\. . .SH "ACTIONS" . .TP \fBdestroy\fR \- Delete an object\. \fBSYNOPSIS\fR . .IP puppet key destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Delete an object\. . .TP \fBfind\fR \- Retrieve an object by name\. \fBSYNOPSIS\fR . .IP puppet key find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Retrieve an object by name\. . .TP \fBinfo\fR \- Print the default terminus class for this face\. \fBSYNOPSIS\fR . .IP puppet key info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR . .IP Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\. . .TP \fBsave\fR \- API only: create or overwrite an object\. \fBSYNOPSIS\fR . .IP puppet key save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\. . .TP \fBsearch\fR \- Search for an object or retrieve multiple objects\. \fBSYNOPSIS\fR . .IP puppet key search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR . .IP Search for an object or retrieve multiple objects\. . .SH "NOTES" This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include: . .IP "\(bu" 4 \fBca\fR . .IP "\(bu" 4 \fBdisabled_ca\fR . .IP "\(bu" 4 \fBfile\fR . .IP "\(bu" 4 \fBmemory\fR . .IP "" 0 . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-kick.8 b/man/man8/puppet-kick.8 index 9275d22f8..5fd676a45 100644 --- a/man/man8/puppet-kick.8 +++ b/man/man8/puppet-kick.8 @@ -1,131 +1,131 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-KICK" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-KICK" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-kick\fR \- Remotely control puppet agent . .SH "SYNOPSIS" Trigger a puppet agent run on a set of hosts\. . .SH "USAGE" puppet kick [\-a|\-\-all] [\-c|\-\-class \fIclass\fR] [\-d|\-\-debug] [\-f|\-\-foreground] [\-h|\-\-help] [\-\-host \fIhost\fR] [\-\-no\-fqdn] [\-\-ignoreschedules] [\-t|\-\-tag \fItag\fR] [\-\-test] [\-p|\-\-ping] \fIhost\fR [\fIhost\fR [\.\.\.]] . .SH "DESCRIPTION" This script can be used to connect to a set of machines running \'puppet agent\' and trigger them to run their configurations\. The most common usage would be to specify a class of hosts and a set of tags, and \'puppet kick\' would look up in LDAP all of the hosts matching that class, then connect to each host and trigger a run of all of the objects with the specified tags\. . .P If you are not storing your host configurations in LDAP, you can specify hosts manually\. . .P You will most likely have to run \'puppet kick\' as root to get access to the SSL certificates\. . .P \'puppet kick\' reads \'puppet master\'\'s configuration file, so that it can copy things like LDAP settings\. . .SH "USAGE NOTES" Puppet kick needs the puppet agent on the target machine to be running as a daemon, be configured to listen for incoming network connections, and have an appropriate security configuration\. . .P The specific changes required are: . .IP "\(bu" 4 Set \fBlisten = true\fR in the agent\'s \fBpuppet\.conf\fR file (or \fB\-\-listen\fR on the command line) . .IP "\(bu" 4 Configure the node\'s firewall to allow incoming connections on port 8139 . .IP "\(bu" 4 Insert the following stanza at the top of the node\'s \fBauth\.conf\fR file: . .IP "" 4 . .nf # Allow puppet kick access path /run method save auth any allow workstation\.example\.com . .fi . .IP "" 0 . .IP "" 0 . .P This example would allow the machine \fBworkstation\.example\.com\fR to trigger a Puppet run; adjust the "allow" directive to suit your site\. You may also use \fBallow *\fR to allow anyone to trigger a Puppet run, but that makes it possible to interfere with your site by triggering excessive Puppet runs\. . .P See \fBhttp://docs\.puppetlabs\.com/guides/rest_auth_conf\.html\fR for more details about security settings\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument\. For example, \'ssldir\' is a valid setting, so you can specify \'\-\-ssldir \fIdirectory\fR\' as an argument\. . .P See the configuration file documentation at http://docs\.puppetlabs\.com/references/latest/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet master with \'\-\-genconfig\'\. . .TP \-\-all Connect to all available hosts\. Requires LDAP support at this point\. . .TP \-\-class Specify a class of machines to which to connect\. This only works if you have LDAP configured, at the moment\. . .TP \-\-debug Enable full debugging\. . .TP \-\-foreground Run each configuration in the foreground; that is, when connecting to a host, do not return until the host has finished its run\. The default is false\. . .TP \-\-help Print this help message . .TP \-\-host A specific host to which to connect\. This flag can be specified more than once\. . .TP \-\-ignoreschedules Whether the client should ignore schedules when running its configuration\. This can be used to force the client to perform work it would not normally perform so soon\. The default is false\. . .TP \-\-parallel How parallel to make the connections\. Parallelization is provided by forking for each client to which to connect\. The default is 1, meaning serial execution\. . .TP \-\-puppetport Use the specified TCP port to connect to agents\. Defaults to 8139\. . .TP \-\-tag Specify a tag for selecting the objects to apply\. Does not work with the \-\-test option\. . .TP \-\-test Print the hosts you would connect to but do not actually connect\. This option requires LDAP support at this point\. . .TP \-\-ping Do an ICMP echo against the target host\. Skip hosts that don\'t respond to ping\. . .SH "EXAMPLE" . .nf $ sudo puppet kick \-p 10 \-t remotefile \-t webserver host1 host2 . .fi . .SH "AUTHOR" Luke Kanies . .SH "COPYRIGHT" Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-man.8 b/man/man8/puppet-man.8 index f6d41dc1f..ad229a0da 100644 --- a/man/man8/puppet-man.8 +++ b/man/man8/puppet-man.8 @@ -1,70 +1,70 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-MAN" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-MAN" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-man\fR \- Display Puppet manual pages\. . .SH "SYNOPSIS" puppet man \fIaction\fR . .SH "DESCRIPTION" This subcommand displays manual pages for all Puppet subcommands\. If the \fBronn\fR gem (\fIhttps://github\.com/rtomayko/ronn/\fR) is installed on your system, puppet man will display fully\-formated man pages\. If \fBronn\fR is not available, puppet man will display the raw (but human\-readable) source text in a pager\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .SH "ACTIONS" . .TP \fBman\fR \- Display the manual page for a Puppet subcommand\. \fBSYNOPSIS\fR . .IP puppet man \fIsubcommand\fR . .IP \fBDESCRIPTION\fR . .IP Display the manual page for a Puppet subcommand\. . .IP \fBRETURNS\fR . .IP The man data, in Markdown format, suitable for consumption by Ronn\. . .IP RENDERING ISSUES: To skip fancy formatting and output the raw Markdown text (e\.g\. for use in a pipeline), call this action with \'\-\-render\-as s\'\. . .SH "EXAMPLES" \fBman\fR . .P View the manual page for a subcommand: . .P $ puppet man facts . .SH "NOTES" The pager used for display will be the first found of \fB$MANPAGER\fR, \fB$PAGER\fR, \fBless\fR, \fBmost\fR, or \fBmore\fR\. . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-master.8 b/man/man8/puppet-master.8 index 1aab4301d..a83fcc114 100644 --- a/man/man8/puppet-master.8 +++ b/man/man8/puppet-master.8 @@ -1,82 +1,82 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-MASTER" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-MASTER" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-master\fR \- The puppet master daemon . .SH "SYNOPSIS" The central puppet server\. Functions as a certificate authority by default\. . .SH "USAGE" puppet master [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-h|\-\-help] [\-l|\-\-logdest syslog|\fIFILE\fR|console] [\-v|\-\-verbose] [\-V|\-\-version] [\-\-compile \fINODE\-NAME\fR] . .SH "DESCRIPTION" This command starts an instance of puppet master, running as a daemon and using Ruby\'s built\-in Webrick webserver\. Puppet master can also be managed by other application servers; when this is the case, this executable is not used\. . .SH "OPTIONS" Note that any Puppet setting that\'s valid in the configuration file is also a valid long argument\. For example, \'server\' is a valid setting, so you can specify \'\-\-server \fIservername\fR\' as an argument\. Boolean settings translate into \'\-\-setting\' and \'\-\-no\-setting\' pairs\. . .P See the configuration file documentation at http://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable settings\. A commented list of all settings can also be generated by running puppet master with \'\-\-genconfig\'\. . .TP \-\-daemonize Send the process into the background\. This is the default\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special \'no\-\' prefix for boolean settings on the command line\.) . .TP \-\-no\-daemonize Do not send the process into the background\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special \'no\-\' prefix for boolean settings on the command line\.) . .TP \-\-debug Enable full debugging\. . .TP \-\-help Print this help message\. . .TP \-\-logdest Where to send log messages\. Choose between \'syslog\' (the POSIX syslog service), \'console\', or the path to a log file\. If debugging or verbosity is enabled, this defaults to \'console\'\. Otherwise, it defaults to \'syslog\'\. . .TP \-\-masterport The port on which to listen for traffic\. (This is a Puppet setting, and can go in puppet\.conf\.) . .TP \-\-verbose Enable verbosity\. . .TP \-\-version Print the puppet version number and exit\. . .TP \-\-compile Compile a catalogue and output it in JSON from the puppet master\. Uses facts contained in the $vardir/yaml/ directory to compile the catalog\. . .SH "EXAMPLE" puppet master . .SH "DIAGNOSTICS" When running as a standalone daemon, puppet master accepts the following signals: . .TP SIGHUP Restart the puppet master server\. . .TP SIGINT and SIGTERM Shut down the puppet master server\. . .TP SIGUSR2 Close file descriptors for log files and reopen them\. Used with logrotate\. . .SH "AUTHOR" Luke Kanies . .SH "COPYRIGHT" Copyright (c) 2012 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-module.8 b/man/man8/puppet-module.8 index 463f54eb6..bb4469a4c 100644 --- a/man/man8/puppet-module.8 +++ b/man/man8/puppet-module.8 @@ -1,448 +1,448 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-MODULE" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-MODULE" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-module\fR \- Creates, installs and searches for modules on the Puppet Forge\. . .SH "SYNOPSIS" puppet module \fIaction\fR [\-\-environment production ] [\-\-modulepath $basemodulepath ] . .SH "DESCRIPTION" This subcommand can find, install, and manage modules from the Puppet Forge, a repository of user\-contributed Puppet code\. It can also generate empty modules, and prepare locally developed modules for release on the Forge\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-environment production The environment Puppet is running in\. For clients (e\.g\., \fBpuppet agent\fR) this determines the environment itself, which is used to find modules and much more\. For servers (i\.e\., \fBpuppet master\fR) this provides the default environment for nodes we know nothing about\. . .TP \-\-modulepath $basemodulepath The search path for modules, as a list of directories separated by the system path separator character\. (The POSIX path separator is \':\', and the Windows path separator is \';\'\.) . .IP Setting a global value for \fBmodulepath\fR in puppet\.conf is deprecated\. Please use directory environments instead\. If you need to use something other than the default modulepath of \fB:$basemodulepath\fR, you can set \fBmodulepath\fR in environment\.conf\. For more info, see http://docs\.puppetlabs\.com/puppet/latest/reference/environments\.html . .SH "ACTIONS" . .TP \fBbuild\fR \- Build a module release package\. \fBSYNOPSIS\fR . .IP puppet module build [\fIpath\fR] . .IP \fBDESCRIPTION\fR . .IP Prepares a local module for release on the Puppet Forge by building a ready\-to\-upload archive file\. . .IP This action uses the Modulefile in the module directory to set metadata used by the Forge\. See \fIhttp://links\.puppetlabs\.com/modulefile\fR for more about writing modulefiles\. . .IP After being built, the release archive file can be found in the module\'s \fBpkg\fR directory\. . .IP \fBRETURNS\fR . .IP Pathname object representing the path to the release archive\. . .TP \fBchanges\fR \- Show modified files of an installed module\. \fBSYNOPSIS\fR . .IP puppet module changes \fIpath\fR . .IP \fBDESCRIPTION\fR . .IP Shows any files in a module that have been modified since it was installed\. This action compares the files on disk to the md5 checksums included in the module\'s metadata\. . .IP \fBRETURNS\fR . .IP Array of strings representing paths of modified files\. . .TP \fBgenerate\fR \- Generate boilerplate for a new module\. \fBSYNOPSIS\fR . .IP puppet module generate [\-\-skip\-interview] \fIname\fR . .IP \fBDESCRIPTION\fR . .IP Generates boilerplate for a new module by creating the directory structure and files recommended for the Puppet community\'s best practices\. . .IP A module may need additional directories beyond this boilerplate if it provides plugins, files, or templates\. . .IP \fBOPTIONS\fR \fI\-\-skip\-interview\fR \- Do not attempt to perform a metadata interview\. Primarily useful for automatic execution of \fBpuppet module generate\fR\. . .IP \fBRETURNS\fR . .IP Array of Pathname objects representing paths of generated files\. . .TP \fBinstall\fR \- Install a module from the Puppet Forge or a release archive\. \fBSYNOPSIS\fR . .IP puppet module install [\-\-force | \-f] [\-\-target\-dir DIR | \-i DIR] [\-\-ignore\-dependencies] [\-\-version VER | \-v VER] \fIname\fR . .IP \fBDESCRIPTION\fR . .IP Installs a module from the Puppet Forge or from a release archive file\. . .IP The specified module will be installed into the directory specified with the \fB\-\-target\-dir\fR option, which defaults to the first directory in the modulepath\. . .IP \fBOPTIONS\fR \fI\-\-force\fR | \fI\-f\fR \- Force overwrite of existing module, if any\. Implies \-\-ignore\-dependencies\. . .IP \fI\-\-ignore\-dependencies\fR \- Do not attempt to install dependencies\. Implied by \-\-force\. . .IP \fI\-\-target\-dir DIR\fR | \fI\-i DIR\fR \- The directory into which modules are installed; defaults to the first directory in the modulepath\. . .IP Specifying this option will change the installation directory, and will use the existing modulepath when checking for dependencies\. If you wish to check a different set of directories for dependencies, you must also use the \fB\-\-environment\fR or \fB\-\-modulepath\fR options\. . .IP \fI\-\-version VER\fR | \fI\-v VER\fR \- Module version to install; can be an exact version or a requirement string, eg \'>= 1\.0\.3\'\. Defaults to latest version\. . .IP \fBRETURNS\fR . .IP Pathname object representing the path to the installed module\. . .TP \fBlist\fR \- List installed modules \fBSYNOPSIS\fR . .IP puppet module list [\-\-tree] . .IP \fBDESCRIPTION\fR . .IP Lists the installed puppet modules\. By default, this action scans the modulepath from puppet\.conf\'s \fB[main]\fR block; use the \-\-modulepath option to change which directories are scanned\. . .IP The output of this action includes information from the module\'s metadata, including version numbers and unmet module dependencies\. . .IP \fBOPTIONS\fR \fI\-\-tree\fR \- Whether to show dependencies as a tree view . .IP \fBRETURNS\fR . .IP hash of paths to module objects . .TP \fBsearch\fR \- Search the Puppet Forge for a module\. \fBSYNOPSIS\fR . .IP puppet module search \fIsearch_term\fR . .IP \fBDESCRIPTION\fR . .IP Searches a repository for modules whose names, descriptions, or keywords match the provided search term\. . .IP \fBRETURNS\fR . .IP Array of module metadata hashes . .TP \fBuninstall\fR \- Uninstall a puppet module\. \fBSYNOPSIS\fR . .IP puppet module uninstall [\-\-force | \-f] [\-\-ignore\-changes | \-c] [\-\-version=] \fIname\fR . .IP \fBDESCRIPTION\fR . .IP Uninstalls a puppet module from the modulepath (or a specific target directory)\. . .IP \fBOPTIONS\fR \fI\-\-force\fR | \fI\-f\fR \- Force the uninstall of an installed module even if there are local changes or the possibility of causing broken dependencies\. . .IP \fI\-\-ignore\-changes\fR | \fI\-c\fR \- Uninstall an installed module even if there are local changes to it\. (Implied by \-\-force\.) . .IP \fI\-\-version=\fR \- The version of the module to uninstall\. When using this option, a module matching the specified version must be installed or else an error is raised\. . .IP \fBRETURNS\fR . .IP Hash of module objects representing uninstalled modules and related errors\. . .TP \fBupgrade\fR \- Upgrade a puppet module\. \fBSYNOPSIS\fR . .IP puppet module upgrade [\-\-force | \-f] [\-\-ignore\-dependencies] [\-\-ignore\-changes | \-c] [\-\-version=] \fIname\fR . .IP \fBDESCRIPTION\fR . .IP Upgrades a puppet module\. . .IP \fBOPTIONS\fR \fI\-\-force\fR | \fI\-f\fR \- Force the upgrade of an installed module even if there are local changes or the possibility of causing broken dependencies\. Implies \-\-ignore\-dependencies\. . .IP \fI\-\-ignore\-changes\fR | \fI\-c\fR \- Upgrade an installed module even if there are local changes to it\. (Implied by \-\-force\.) . .IP \fI\-\-ignore\-dependencies\fR \- Do not attempt to install dependencies\. Implied by \-\-force\. . .IP \fI\-\-version=\fR \- The version of the module to upgrade to\. . .IP \fBRETURNS\fR . .IP Hash . .SH "EXAMPLES" \fBbuild\fR . .P Build a module release: . .P $ puppet module build puppetlabs\-apache notice: Building /Users/kelseyhightower/puppetlabs\-apache for release Module built: /Users/kelseyhightower/puppetlabs\-apache/pkg/puppetlabs\-apache\-0\.0\.1\.tar\.gz . .P Build the module in the current working directory: . .P $ cd /Users/kelseyhightower/puppetlabs\-apache $ puppet module build notice: Building /Users/kelseyhightower/puppetlabs\-apache for release Module built: /Users/kelseyhightower/puppetlabs\-apache/pkg/puppetlabs\-apache\-0\.0\.1\.tar\.gz . .P \fBchanges\fR . .P Show modified files of an installed module: . .P $ puppet module changes /etc/puppet/modules/vcsrepo/ warning: 1 files modified lib/puppet/provider/vcsrepo\.rb . .P \fBgenerate\fR . .P Generate a new module in the current directory: . .P $ puppet module generate puppetlabs\-ssh We need to create a metadata\.json file for this module\. Please answer the following questions; if the question is not applicable to this module, feel free to leave it blank\. . .P Puppet uses Semantic Versioning (semver\.org) to version modules\. What version is this module? [0\.1\.0] \-\-> . .P Who wrote this module? [puppetlabs] \-\-> . .P What license does this module code fall under? [Apache 2\.0] \-\-> . .P How would you describe this module in a single sentence? \-\-> . .P Where is this module\'s source code repository? \-\-> . .P Where can others go to learn more about this module? \-\-> . .P Where can others go to file issues about this module? \-\-> . .P { "name": "puppetlabs\-ssh", "version": "0\.1\.0", "author": "puppetlabs", "summary": null, "license": "Apache 2\.0", "source": "", "project_page": null, "issues_url": null, "dependencies": [ { "name": "puppetlabs\-stdlib", "version_requirement": ">= 1\.0\.0" } ] . .SH "}" About to generate this metadata; continue? [n/Y] \-\-> . .P Notice: Generating module at /Users/username/Projects/puppet/puppetlabs\-ssh\.\.\. Notice: Populating ERB templates\.\.\. Finished; module generated in puppetlabs\-ssh\. puppetlabs\-ssh/manifests puppetlabs\-ssh/manifests/init\.pp puppetlabs\-ssh/metadata\.json puppetlabs\-ssh/README\.md puppetlabs\-ssh/spec puppetlabs\-ssh/spec/spec_helper\.rb puppetlabs\-ssh/tests puppetlabs\-ssh/tests/init\.pp . .P \fBinstall\fR . .P Install a module: . .P $ puppet module install puppetlabs\-vcsrepo Preparing to install into /etc/puppet/modules \.\.\. Downloading from http://forgeapi\.puppetlabs\.com \.\.\. Installing \-\- do not interrupt \.\.\. /etc/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4) . .P Install a module to a specific environment: . .P $ puppet module install puppetlabs\-vcsrepo \-\-environment development Preparing to install into /etc/puppet/environments/development/modules \.\.\. Downloading from http://forgeapi\.puppetlabs\.com \.\.\. Installing \-\- do not interrupt \.\.\. /etc/puppet/environments/development/modules └── puppetlabs\-vcsrepo (v0\.0\.4) . .P Install a specific module version: . .P $ puppet module install puppetlabs\-vcsrepo \-v 0\.0\.4 Preparing to install into /etc/puppet/modules \.\.\. Downloading from http://forgeapi\.puppetlabs\.com \.\.\. Installing \-\- do not interrupt \.\.\. /etc/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4) . .P Install a module into a specific directory: . .P $ puppet module install puppetlabs\-vcsrepo \-\-target\-dir=/usr/share/puppet/modules Preparing to install into /usr/share/puppet/modules \.\.\. Downloading from http://forgeapi\.puppetlabs\.com \.\.\. Installing \-\- do not interrupt \.\.\. /usr/share/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4) . .P Install a module into a specific directory and check for dependencies in other directories: . .P $ puppet module install puppetlabs\-vcsrepo \-\-target\-dir=/usr/share/puppet/modules \-\-modulepath /etc/puppet/modules Preparing to install into /usr/share/puppet/modules \.\.\. Downloading from http://forgeapi\.puppetlabs\.com \.\.\. Installing \-\- do not interrupt \.\.\. /usr/share/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4) . .P Install a module from a release archive: . .P $ puppet module install puppetlabs\-vcsrepo\-0\.0\.4\.tar\.gz Preparing to install into /etc/puppet/modules \.\.\. Downloading from http://forgeapi\.puppetlabs\.com \.\.\. Installing \-\- do not interrupt \.\.\. /etc/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4) . .P Install a module from a release archive and ignore dependencies: . .P $ puppet module install puppetlabs\-vcsrepo\-0\.0\.4\.tar\.gz \-\-ignore\-dependencies Preparing to install into /etc/puppet/modules \.\.\. Installing \-\- do not interrupt \.\.\. /etc/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4) . .P \fBlist\fR . .P List installed modules: . .P $ puppet module list /etc/puppet/modules ├── bodepd\-create_resources (v0\.0\.1) ├── puppetlabs\-bacula (v0\.0\.2) ├── puppetlabs\-mysql (v0\.0\.1) ├── puppetlabs\-sqlite (v0\.0\.1) └── puppetlabs\-stdlib (v2\.2\.1) /usr/share/puppet/modules (no modules installed) . .P List installed modules in a tree view: . .P $ puppet module list \-\-tree /etc/puppet/modules └─┬ puppetlabs\-bacula (v0\.0\.2) ├── puppetlabs\-stdlib (v2\.2\.1) ├─┬ puppetlabs\-mysql (v0\.0\.1) │ └── bodepd\-create_resources (v0\.0\.1) └── puppetlabs\-sqlite (v0\.0\.1) /usr/share/puppet/modules (no modules installed) . .P List installed modules from a specified environment: . .P $ puppet module list \-\-environment production /etc/puppet/modules ├── bodepd\-create_resources (v0\.0\.1) ├── puppetlabs\-bacula (v0\.0\.2) ├── puppetlabs\-mysql (v0\.0\.1) ├── puppetlabs\-sqlite (v0\.0\.1) └── puppetlabs\-stdlib (v2\.2\.1) /usr/share/puppet/modules (no modules installed) . .P List installed modules from a specified modulepath: . .P $ puppet module list \-\-modulepath /usr/share/puppet/modules /usr/share/puppet/modules (no modules installed) . .P \fBsearch\fR . .P Search the Puppet Forge for a module: . .P $ puppet module search puppetlabs NAME DESCRIPTION AUTHOR KEYWORDS bacula This is a generic Apache module @puppetlabs backups . .P \fBuninstall\fR . .P Uninstall a module: . .P $ puppet module uninstall puppetlabs\-ssh Removed /etc/puppet/modules/ssh (v1\.0\.0) . .P Uninstall a module from a specific directory: . .P $ puppet module uninstall puppetlabs\-ssh \-\-modulepath /usr/share/puppet/modules Removed /usr/share/puppet/modules/ssh (v1\.0\.0) . .P Uninstall a module from a specific environment: . .P $ puppet module uninstall puppetlabs\-ssh \-\-environment development Removed /etc/puppet/environments/development/modules/ssh (v1\.0\.0) . .P Uninstall a specific version of a module: . .P $ puppet module uninstall puppetlabs\-ssh \-\-version 2\.0\.0 Removed /etc/puppet/modules/ssh (v2\.0\.0) . .P \fBupgrade\fR . .P upgrade an installed module to the latest version . .P $ puppet module upgrade puppetlabs\-apache /etc/puppet/modules └── puppetlabs\-apache (v1\.0\.0 \-> v2\.4\.0) . .P upgrade an installed module to a specific version . .P $ puppet module upgrade puppetlabs\-apache \-\-version 2\.1\.0 /etc/puppet/modules └── puppetlabs\-apache (v1\.0\.0 \-> v2\.1\.0) . .P upgrade an installed module for a specific environment . .P $ puppet module upgrade puppetlabs\-apache \-\-environment test /usr/share/puppet/environments/test/modules └── puppetlabs\-apache (v1\.0\.0 \-> v2\.4\.0) . .SH "COPYRIGHT AND LICENSE" Copyright 2012 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-node.8 b/man/man8/puppet-node.8 index 5b0e6361f..d4e2f59b0 100644 --- a/man/man8/puppet-node.8 +++ b/man/man8/puppet-node.8 @@ -1,214 +1,214 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-NODE" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-NODE" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-node\fR \- View and manage node definitions\. . .SH "SYNOPSIS" puppet node \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "DESCRIPTION" This subcommand interacts with node objects, which are used by Puppet to build a catalog\. A node object consists of the node\'s facts, environment, node parameters (exposed in the parser as top\-scope variables), and classes\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-extra HASH A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. . .TP \-\-terminus TERMINUS Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\. . .IP Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\. . .IP The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\. . .SH "ACTIONS" . .TP \fBclean\fR \- Clean up everything a puppetmaster knows about a node\. \fBSYNOPSIS\fR . .IP puppet node clean [\-\-terminus TERMINUS] [\-\-extra HASH] [\-\-[no\-]unexport] \fIhost1\fR [\fIhost2\fR \.\.\.] . .IP \fBDESCRIPTION\fR . .IP Clean up everything a puppet master knows about a node, including certificates and storeconfigs data\. . .IP The full list of info cleaned by this action is: . .IP \fISigned certificates\fR \- ($vardir/ssl/ca/signed/node\.domain\.pem) . .IP \fICached facts\fR \- ($vardir/yaml/facts/node\.domain\.yaml) . .IP \fICached node objects\fR \- ($vardir/yaml/node/node\.domain\.yaml) . .IP \fIReports\fR \- ($vardir/reports/node\.domain) . .IP \fIStored configs\fR \- (in database) The clean action can either remove all data from a host in your storeconfigs database, or, with the \fI\-\-unexport\fR option, turn every exported resource supporting ensure to absent so that any other host that collected those resources can remove them\. Without unexporting, a removed node\'s exported resources become unmanaged by Puppet, and may linger as cruft unless you are purging that resource type\. . .IP \fBOPTIONS\fR \fI\-\-[no\-]unexport\fR \- Whether to remove this node\'s exported resources from other nodes . .TP \fBdestroy\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet node destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBfind\fR \- Retrieve a node object\. \fBSYNOPSIS\fR . .IP puppet node find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIhost\fR . .IP \fBDESCRIPTION\fR . .IP Retrieve a node object\. . .IP \fBRETURNS\fR . .IP A hash containing the node\'s \fBclasses\fR, \fBenvironment\fR, \fBexpiration\fR, \fBname\fR, \fBparameters\fR (its facts, combined with any ENC\-set parameters), and \fBtime\fR\. When used from the Ruby API: a Puppet::Node object\. . .IP RENDERING ISSUES: Rendering as string and json are currently broken; node objects can only be rendered as yaml\. . .TP \fBinfo\fR \- Print the default terminus class for this face\. \fBSYNOPSIS\fR . .IP puppet node info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR . .IP Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\. . .TP \fBsave\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet node save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBsearch\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet node search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .SH "EXAMPLES" \fBfind\fR . .P Retrieve an "empty" (no classes, no ENC\-imposed parameters, and an environment of "production") node: . .P $ puppet node find somenode\.puppetlabs\.lan \-\-terminus plain \-\-render\-as yaml . .P Retrieve a node using the puppet master\'s configured ENC: . .P $ puppet node find somenode\.puppetlabs\.lan \-\-terminus exec \-\-run_mode master \-\-render\-as yaml . .P Retrieve the same node from the puppet master: . .P $ puppet node find somenode\.puppetlabs\.lan \-\-terminus rest \-\-render\-as yaml . .SH "NOTES" This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include: . .IP "\(bu" 4 \fBactive_record\fR . .IP "\(bu" 4 \fBexec\fR . .IP "\(bu" 4 \fBldap\fR . .IP "\(bu" 4 \fBmemory\fR . .IP "\(bu" 4 \fBmsgpack\fR . .IP "\(bu" 4 \fBplain\fR . .IP "\(bu" 4 \fBrest\fR . .IP "\(bu" 4 \fBstore_configs\fR . .IP "\(bu" 4 \fBwrite_only_yaml\fR . .IP "\(bu" 4 \fByaml\fR . .IP "" 0 . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-parser.8 b/man/man8/puppet-parser.8 index 163a4274a..3a50d5a0e 100644 --- a/man/man8/puppet-parser.8 +++ b/man/man8/puppet-parser.8 @@ -1,110 +1,110 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-PARSER" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-PARSER" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-parser\fR \- Interact directly with the parser\. . .SH "SYNOPSIS" puppet parser \fIaction\fR . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .SH "ACTIONS" . .TP \fBdump\fR \- Outputs a dump of the internal parse tree for debugging \fBSYNOPSIS\fR . .IP puppet parser dump [\-\-e \fIsource\fR] [\-\-[no\-]validate] \-e \fIsource\fR| [\fImanifest\fR \.\.\.] . .IP \fBDESCRIPTION\fR . .IP This action parses and validates the Puppet DSL syntax without compiling a catalog or syncing any resources\. It automatically turns on the future parser for the parsing\. . .IP The command accepts one or more manifests (\.pp) files, or an \-e followed by the puppet source text\. If no arguments are given, the stdin is read (unless it is attached to a terminal) . .IP The output format of the dumped tree is not API, it may change from time to time\. . .IP \fBOPTIONS\fR \fI\-\-e \- dump one source expression given on the command line\. . .IP \fI\-\-[no\-]validate\fR \- Whether or not to validate the parsed result, if no\-validate only syntax errors are reported . .IP \fBRETURNS\fR . .IP A dump of the resulting AST model unless there are syntax or validation errors\. . .TP \fBvalidate\fR \- Validate the syntax of one or more Puppet manifests\. \fBSYNOPSIS\fR . .IP puppet parser validate [\fImanifest\fR] [\fImanifest\fR \.\.\.] . .IP \fBDESCRIPTION\fR . .IP This action validates Puppet DSL syntax without compiling a catalog or syncing any resources\. If no manifest files are provided, it will validate the default site manifest\. . .IP When validating with \-\-parser current, the validation stops after the first encountered issue\. . .IP When validating with \-\-parser future, multiple issues per file are reported up to the settings of max_error, and max_warnings\. The processing stops after having reported issues for the first encountered file with errors\. . .IP \fBRETURNS\fR . .IP Nothing, or the first syntax error encountered\. . .SH "EXAMPLES" \fBvalidate\fR . .P Validate the default site manifest at /etc/puppet/manifests/site\.pp: . .P $ puppet parser validate . .P Validate two arbitrary manifest files: . .P $ puppet parser validate init\.pp vhost\.pp . .P Validate from STDIN: . .P $ cat init\.pp | puppet parser validate . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-plugin.8 b/man/man8/puppet-plugin.8 index 4f811c4a6..c44765e50 100644 --- a/man/man8/puppet-plugin.8 +++ b/man/man8/puppet-plugin.8 @@ -1,73 +1,73 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-PLUGIN" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-PLUGIN" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-plugin\fR \- Interact with the Puppet plugin system\. . .SH "SYNOPSIS" puppet plugin \fIaction\fR . .SH "DESCRIPTION" This subcommand provides network access to the puppet master\'s store of plugins\. . .P The puppet master serves Ruby code collected from the \fBlib\fR directories of its modules\. These plugins can be used on agent nodes to extend Facter and implement custom types and providers\. Plugins are normally downloaded by puppet agent during the course of a run\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .SH "ACTIONS" . .TP \fBdownload\fR \- Download plugins from the puppet master\. \fBSYNOPSIS\fR . .IP puppet plugin download . .IP \fBDESCRIPTION\fR . .IP Downloads plugins from the configured puppet master\. Any plugins downloaded in this way will be used in all subsequent Puppet activity\. This action modifies files on disk\. . .IP \fBRETURNS\fR . .IP A list of the files downloaded, or a confirmation that no files were downloaded\. When used from the Ruby API, this action returns an array of the files downloaded, which will be empty if none were retrieved\. . .SH "EXAMPLES" \fBdownload\fR . .P Retrieve plugins from the puppet master: . .P $ puppet plugin download . .P Retrieve plugins from the puppet master (API example): . .P $ Puppet::Face[:plugin, \'0\.0\.1\']\.download . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-report.8 b/man/man8/puppet-report.8 index d49e691ed..19267bc86 100644 --- a/man/man8/puppet-report.8 +++ b/man/man8/puppet-report.8 @@ -1,163 +1,163 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-REPORT" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-REPORT" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-report\fR \- Create, display, and submit reports\. . .SH "SYNOPSIS" puppet report \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-extra HASH A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. . .TP \-\-terminus TERMINUS Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\. . .IP Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\. . .IP The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\. . .SH "ACTIONS" . .TP \fBdestroy\fR \- Invalid for this face\. \fBSYNOPSIS\fR . .IP puppet report destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this face\. . .TP \fBfind\fR \- Invalid for this face\. \fBSYNOPSIS\fR . .IP puppet report find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this face\. . .TP \fBinfo\fR \- Print the default terminus class for this face\. \fBSYNOPSIS\fR . .IP puppet report info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR . .IP Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\. . .TP \fBsave\fR \- API only: submit a report\. \fBSYNOPSIS\fR . .IP puppet report save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIreport\fR . .IP \fBDESCRIPTION\fR . .IP API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\. . .IP \fBRETURNS\fR . .IP Nothing\. . .TP \fBsearch\fR \- Invalid for this face\. \fBSYNOPSIS\fR . .IP puppet report search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this face\. . .TP \fBsubmit\fR \- API only: submit a report with error handling\. \fBSYNOPSIS\fR . .IP puppet report submit [\-\-terminus TERMINUS] [\-\-extra HASH] \fIreport\fR . .IP \fBDESCRIPTION\fR . .IP API only: Submits a report to the puppet master\. This action is essentially a shortcut and wrapper for the \fBsave\fR action with the \fBrest\fR terminus, and provides additional details in the event of a failure\. . .SH "EXAMPLES" \fBsave\fR . .P From the implementation of \fBpuppet report submit\fR (API example): . .P begin Puppet::Transaction::Report\.indirection\.terminus_class = :rest Puppet::Face[:report, "0\.0\.1"]\.save(report) Puppet\.notice "Uploaded report for #{report\.name}" rescue => detail Puppet\.log_exception(detail, "Could not send report: #{detail}") end . .P \fBsubmit\fR . .P -From secret_agent\.rb (API example):report = Puppet::Face[:catalog, \'0\.0\.1\']\.apply Puppet::Face[:report, \'0\.0\.1\']\.submit(report) return report +API example:report = Puppet::Face[:catalog, \'0\.0\.1\']\.apply Puppet::Face[:report, \'0\.0\.1\']\.submit(report) return report . .SH "NOTES" This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include: . .IP "\(bu" 4 \fBmsgpack\fR . .IP "\(bu" 4 \fBprocessor\fR . .IP "\(bu" 4 \fBrest\fR . .IP "\(bu" 4 \fByaml\fR . .IP "" 0 . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-resource.8 b/man/man8/puppet-resource.8 index 7edff74de..494c32d76 100644 --- a/man/man8/puppet-resource.8 +++ b/man/man8/puppet-resource.8 @@ -1,88 +1,88 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-RESOURCE" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-RESOURCE" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-resource\fR \- The resource abstraction layer shell . .SH "SYNOPSIS" Uses the Puppet RAL to directly interact with the system\. . .SH "USAGE" puppet resource [\-h|\-\-help] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-edit] [\-H|\-\-host \fIhost\fR] [\-p|\-\-param \fIparameter\fR] [\-t|\-\-types] [\-y|\-\-to_yaml] \fItype\fR [\fIname\fR] [\fIattribute\fR=\fIvalue\fR \.\.\.] . .SH "DESCRIPTION" This command provides simple facilities for converting current system state into Puppet code, along with some ability to modify the current state using Puppet\'s RAL\. . .P By default, you must at least provide a type to list, in which case puppet resource will tell you everything it knows about all resources of that type\. You can optionally specify an instance name, and puppet resource will only describe that single instance\. . .P If given a type, a name, and a series of \fIattribute\fR=\fIvalue\fR pairs, puppet resource will modify the state of the specified resource\. Alternately, if given a type, a name, and the \'\-\-edit\' flag, puppet resource will write its output to a file, open that file in an editor, and then apply the saved file as a Puppet transaction\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument\. For example, \'ssldir\' is a valid setting, so you can specify \'\-\-ssldir \fIdirectory\fR\' as an argument\. . .P See the configuration file documentation at http://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \'\-\-genconfig\'\. . .TP \-\-debug Enable full debugging\. . .TP \-\-edit Write the results of the query to a file, open the file in an editor, and read the file back in as an executable Puppet manifest\. . .TP \-\-host When specified, connect to the resource server on the named host and retrieve the list of resouces of the type specified\. . .TP \-\-help Print this help message\. . .TP \-\-param Add more parameters to be outputted from queries\. . .TP \-\-types List all available types\. . .TP \-\-verbose Print extra information\. . .TP \-\-to_yaml Output found resources in yaml format, suitable to use with Hiera and create_resources\. . .SH "EXAMPLE" This example uses \fBpuppet resource\fR to return a Puppet configuration for the user \fBluke\fR: . .IP "" 4 . .nf $ puppet resource user luke user { \'luke\': home => \'/home/luke\', uid => \'100\', ensure => \'present\', comment => \'Luke Kanies,,,\', gid => \'1000\', shell => \'/bin/bash\', groups => [\'sysadmin\',\'audio\',\'video\',\'puppet\'] } . .fi . .IP "" 0 . .SH "AUTHOR" Luke Kanies . .SH "COPYRIGHT" Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-resource_type.8 b/man/man8/puppet-resource_type.8 index d232c571d..d07aa27bb 100644 --- a/man/man8/puppet-resource_type.8 +++ b/man/man8/puppet-resource_type.8 @@ -1,214 +1,214 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-RESOURCE_TYPE" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-RESOURCE_TYPE" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-resource_type\fR \- View classes, defined resource types, and nodes from all manifests\. . .SH "SYNOPSIS" puppet resource_type \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "DESCRIPTION" This subcommand reads information about the resource collections (classes, nodes, and defined types) available in Puppet\'s site manifest and modules\. . .P It will eventually be extended to examine native resource types\. . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-extra HASH A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. . .TP \-\-terminus TERMINUS Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\. . .IP Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\. . .IP The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\. . .SH "ACTIONS" . .TP \fBdestroy\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet resource_type destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBfind\fR \- Retrieve info about a resource collection\. \fBSYNOPSIS\fR . .IP puppet resource_type find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIcollection_name\fR . .IP \fBDESCRIPTION\fR . .IP Retrieve info about a resource collection\. . .IP \fBRETURNS\fR . .IP A hash of info about the requested resource collection\. When used from the Ruby API: returns a Puppet::Resource::Type object\. . .IP RENDERING ISSUES: yaml and string output for this indirection are currently unusable; use json instead\. . .IP \fBNOTES\fR . .IP If two resource collections share the same name (e\.g\. you have both a node and a class named "default"), \fBfind\fR will only return one of them\. This can be worked around by using \fBsearch\fR instead\. . .TP \fBinfo\fR \- Print the default terminus class for this face\. \fBSYNOPSIS\fR . .IP puppet resource_type info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR . .IP Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\. . .TP \fBsave\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet resource_type save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBsearch\fR \- Search for collections matching a regular expression\. \fBSYNOPSIS\fR . .IP puppet resource_type search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIregular_expression\fR . .IP \fBDESCRIPTION\fR . .IP Search for collections matching a regular expression\. . .IP \fBRETURNS\fR . .IP An array of hashes of resource collection info\. When used from the Ruby API: returns an array of Puppet::Resource::Type objects\. . .IP RENDERING ISSUES: yaml and string output for this indirection are currently unusable; use json instead\. . .SH "EXAMPLES" \fBfind\fR . .P Retrieve info about a specific locally\-defined class: . .P $ puppet resource_type find ntp::disabled . .P Retrieve info from the puppet master about a specific class: . .P $ puppet resource_type find ntp \-\-terminus rest . .P \fBsearch\fR . .P Retrieve all classes, nodes, and defined types: . .P $ puppet resource_type search \'\.*\' . .P Search for classes related to Nagios: . .P $ puppet resource_type search nagios . .SH "NOTES" The \fBfind\fR and \fBsearch\fR actions return similar hashes of resource collection info\. These hashes will include the following four keys: . .IP "\(bu" 4 \fBfile\fR (a string) . .IP "\(bu" 4 \fBname\fR (a string) . .IP "\(bu" 4 \fBtype\fR (\fIhostclass\fR, \fIdefinition\fR, or \fInode\fR) . .IP "\(bu" 4 \fBline\fR (an integer) . .IP "" 0 . .P They may optionally include the following keys: . .IP "\(bu" 4 \fBparent\fR (\fIname_of_resource_collection\fR) . .IP "\(bu" 4 \fBarguments\fR (a hash of parameters and default values) . .IP "\(bu" 4 \fBdoc\fR (a string) . .IP "" 0 . .P This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include: . .IP "\(bu" 4 \fBparser\fR . .IP "\(bu" 4 \fBrest\fR . .IP "" 0 . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-secret_agent.8 b/man/man8/puppet-secret_agent.8 deleted file mode 100644 index 8ae2ff401..000000000 --- a/man/man8/puppet-secret_agent.8 +++ /dev/null @@ -1,70 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "PUPPET\-SECRET_AGENT" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" -. -.SH "NAME" -\fBpuppet\-secret_agent\fR \- Mimics puppet agent\. -. -.SH "SYNOPSIS" -puppet secret_agent \fIaction\fR -. -.SH "DESCRIPTION" -This subcommand currently functions as a proof of concept, demonstrating how the Faces API exposes Puppet\'s internal systems to application logic; compare the actual code for puppet agent\. It will eventually replace puppet agent entirely, and can provide a template for users who wish to implement agent\-like functionality with non\-standard application logic\. -. -.SH "OPTIONS" -Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. -. -.P -See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. -. -.TP -\-\-render\-as FORMAT -The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. -. -.TP -\-\-verbose -Whether to log verbosely\. -. -.TP -\-\-debug -Whether to log debug information\. -. -.SH "ACTIONS" -. -.TP -\fBsynchronize\fR \- Run secret_agent once\. -\fBSYNOPSIS\fR -. -.IP -puppet secret_agent -. -.IP -\fBDESCRIPTION\fR -. -.IP -Mimics a single run of puppet agent\. This action does not currently daemonize, but can download plugins, submit facts, retrieve and apply a catalog, and submit a report to the puppet master\. -. -.IP -\fBRETURNS\fR -. -.IP -Verbose logging from the completed run\. When used from the Ruby API: returns a Puppet::Transaction::Report object\. -. -.IP -\fBNOTES\fR -. -.IP -This action requires that the puppet master\'s \fBauth\.conf\fR file allow save access to the \fBfacts\fR REST terminus\. Puppet agent does not use this facility, and it is turned off by default\. See \fIhttp://docs\.puppetlabs\.com/guides/rest_auth_conf\.html\fR for more details\. -. -.SH "EXAMPLES" -\fBsynchronize\fR -. -.P -Trigger a Puppet run with the configured puppet master: -. -.P -$ puppet secret_agent -. -.SH "COPYRIGHT AND LICENSE" -Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-status.8 b/man/man8/puppet-status.8 index 390bfe94c..47bab6485 100644 --- a/man/man8/puppet-status.8 +++ b/man/man8/puppet-status.8 @@ -1,150 +1,150 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-STATUS" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-STATUS" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-status\fR \- View puppet server status\. . .SH "SYNOPSIS" puppet status \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "OPTIONS" Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server \fR, or \fB\-\-run_mode \fR as an argument\. . .P See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\. . .TP \-\-render\-as FORMAT The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\. . .TP \-\-verbose Whether to log verbosely\. . .TP \-\-debug Whether to log debug information\. . .TP \-\-extra HASH A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. . .TP \-\-terminus TERMINUS Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\. . .IP Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\. . .IP The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\. . .SH "ACTIONS" . .TP \fBdestroy\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet status destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBfind\fR \- Check status of puppet master server\. \fBSYNOPSIS\fR . .IP puppet status [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR . .IP \fBDESCRIPTION\fR . .IP Checks whether a Puppet server is properly receiving and processing HTTP requests\. This action is only useful when used with \'\-\-terminus rest\'; when invoked with the \fBlocal\fR terminus, \fBfind\fR will always return true\. . .IP Over REST, this action will query the configured puppet master by default\. To query other servers, including puppet agent nodes started with the \fI\-\-listen\fR option, you can set the global \fI\-\-server\fR and \fI\-\-masterport\fR options on the command line; note that agent nodes listen on port 8139\. . .IP \fBRETURNS\fR . .IP A "true" response or a low\-level connection error\. When used from the Ruby API: returns a Puppet::Status object\. . .IP \fBNOTES\fR . .IP This action requires that the server\'s \fBauth\.conf\fR file allow find access to the \fBstatus\fR REST terminus\. Puppet agent does not use this facility, and it is turned off by default\. See \fIhttp://docs\.puppetlabs\.com/guides/rest_auth_conf\.html\fR for more details\. . .IP Although this action always returns an unnamed status object, it requires a dummy argument\. This is a known bug\. . .TP \fBinfo\fR \- Print the default terminus class for this face\. \fBSYNOPSIS\fR . .IP puppet status info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR . .IP Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\. . .TP \fBsave\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet status save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .TP \fBsearch\fR \- Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP puppet status search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR . .IP Invalid for this subcommand\. . .SH "EXAMPLES" \fBfind\fR . .P Check the status of the configured puppet master: . .P $ puppet status find x \-\-terminus rest . .SH "NOTES" This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include: . .IP "\(bu" 4 \fBlocal\fR . .IP "\(bu" 4 \fBrest\fR . .IP "" 0 . .SH "COPYRIGHT AND LICENSE" Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet.8 b/man/man8/puppet.8 index 43daeb946..9e24672a2 100644 --- a/man/man8/puppet.8 +++ b/man/man8/puppet.8 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET" "8" "September 2014" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET" "8" "October 2014" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\fR . .P [1;31mError: Could not parse application options: invalid option: \-\-help[0m diff --git a/spec/unit/application/secret_agent_spec.rb b/spec/unit/application/secret_agent_spec.rb deleted file mode 100755 index be6e1cf15..000000000 --- a/spec/unit/application/secret_agent_spec.rb +++ /dev/null @@ -1,34 +0,0 @@ -#! /usr/bin/env ruby -require 'spec_helper' -require 'puppet/application/secret_agent' -require 'puppet/indirector/catalog/rest' -require 'puppet/indirector/report/rest' -require 'tempfile' - -describe "Puppet::Application::Secret_agent" do - include PuppetSpec::Files - - it "should retrieve and apply a catalog and submit a report" do - pending "REVISIT: 2.7 changes broke this, and we want the merge published" - - dirname = tmpdir("puppetdir") - Puppet[:vardir] = dirname - Puppet[:confdir] = dirname - Puppet[:certname] = "foo" - @catalog = Puppet::Resource::Catalog.new - @file = Puppet::Resource.new(:file, File.join(dirname, "tmp_dir_resource"), :parameters => {:ensure => :present}) - @catalog.add_resource(@file) - - @report = Puppet::Transaction::Report.new("apply") - Puppet::Transaction::Report.stubs(:new).returns(@report) - - Puppet::Resource::Catalog::Rest.any_instance.stubs(:find).returns(@catalog) - @report.expects(:save) - - Puppet::Util::Log.stubs(:newdestination) - - Puppet::Application::Secret_agent.new.run - - @report.status.should == "changed" - end -end diff --git a/spec/unit/face/secret_agent_spec.rb b/spec/unit/face/secret_agent_spec.rb deleted file mode 100755 index fa692281d..000000000 --- a/spec/unit/face/secret_agent_spec.rb +++ /dev/null @@ -1,27 +0,0 @@ -#! /usr/bin/env ruby -require 'spec_helper' -require 'puppet/face' -require 'puppet/indirector/catalog/rest' -require 'tempfile' - -describe Puppet::Face[:secret_agent, '0.0.1'] do - include PuppetSpec::Files - - describe "#synchronize" do - it "should retrieve and apply a catalog and return a report" do - pending "This test doesn't work, but the code actually does - tested by LAK" - dirname = tmpdir("puppetdir") - Puppet[:vardir] = dirname - Puppet[:confdir] = dirname - @catalog = Puppet::Resource::Catalog.new - @file = Puppet::Resource.new(:file, File.join(dirname, "tmp_dir_resource"), :parameters => {:ensure => :present}) - @catalog.add_resource(@file) - Puppet::Resource::Catalog::Rest.any_instance.stubs(:find).returns(@catalog) - - report = subject.synchronize - - report.kind.should == "apply" - report.status.should == "changed" - end - end -end