[Pkg-puppet-devel] [SCM] Puppet packaging for Debian branch, experimental, updated. debian/2.6.8-1-844-g7ec39d5
nfagerlund
nick.fagerlund at gmail.com
Tue May 10 08:04:41 UTC 2011
The following commit has been merged in the experimental branch:
commit f653b8df5226e24bf2e89226ee6cd1e20684ff91
Author: nfagerlund <nick.fagerlund at gmail.com>
Date: Wed Feb 16 13:10:48 2011 -0800
(#1204) Reformat help text for puppet cert and describe
Markdown changes for compatibility with Ronn.
diff --git a/lib/puppet/application/cert.rb b/lib/puppet/application/cert.rb
index 0db968e..0808a42 100644
--- a/lib/puppet/application/cert.rb
+++ b/lib/puppet/application/cert.rb
@@ -48,30 +48,32 @@ class Puppet::Application::Cert < Puppet::Application
def help
<<-HELP
-SYNOPSIS
+puppet-cert(8) -- Manage certificates and requests
========
-Stand-alone certificate authority. Capable of generating certificates
-but mostly meant for signing certificate requests from puppet clients.
+
+SYNOPSIS
+--------
+Standalone certificate authority. Capable of generating certificates,
+but mostly used for signing certificate requests from puppet clients.
USAGE
-=====
- puppet cert [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
- [-g|--generate] [-l|--list] [-s|--sign] [-r|--revoke]
- [-p|--print] [-c|--clean] [--verify] [--digest DIGEST]
- [--fingerprint] [host]
+-----
+puppet cert [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
+ [-g|--generate] [-l|--list] [-s|--sign] [-r|--revoke] [-p|--print]
+ [-c|--clean] [--verify] [--digest <digest>] [--fingerprint] [host]
DESCRIPTION
-===========
-Because the puppetmasterd daemon defaults to not signing client
+-----------
+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.
OPTIONS
-=======
+-------
Note that any configuration parameter that's valid in the configuration
file is also a valid long argument. For example, 'ssldir' is a valid
configuration parameter, so you can specify '--ssldir <directory>' as an
@@ -83,73 +85,82 @@ full list of acceptable parameters. A commented list of all
configuration options can also be generated by running puppet cert with
'--genconfig'.
-all: Operate on all items. Currently only makes sense with
- '--sign', '--clean', or '--list'.
+* --all:
+ Operate on all items. Currently only makes sense with '--sign',
+ '--clean', or '--list'.
-digest: Set the digest for fingerprinting (defaults to md5). Valid
- values depends on your openssl and openssl ruby extension
- version, but should contain at least md5, sha1, md2,
- sha256.
+* --digest:
+ Set the digest for fingerprinting (defaults to md5). Valid values
+ depends on your openssl and openssl ruby extension version, but should
+ contain at least md5, sha1, md2, sha256.
-clean: Remove all files related to a 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. The certificate of the host is also revoked. If
- '--all' is specified then all host certificates, both
- signed and unsigned, will be removed.
+* --clean:
+ Remove all files related to a 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. The certificate of the host is also
+ revoked. If '--all' is specified then all host certificates, both
+ signed and unsigned, will be removed.
-debug: Enable full debugging.
+* --debug:
+ Enable full debugging.
-generate: Generate a certificate for a named client. A
- certificate/keypair will be generated for each client named
- on the command line.
+* --generate:
+ Generate a certificate for a named client. A certificate/keypair will
+ be generated for each client named on the command line.
-help: Print this help message
+* --help:
+ Print this help message
-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).
+* --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).
-print: Print the full-text version of a host's certificate.
+* --print:
+ Print the full-text version of a host's certificate.
-fingerprint: Print the DIGEST (defaults to md5) fingerprint of a host's
- certificate.
+* --fingerprint:
+ Print the DIGEST (defaults to md5) fingerprint of a host's
+ certificate.
-revoke: Revoke the certificate of a client. The certificate can be
- specified either by its serial number, given as a decimal
- number or 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' config
- parameter. Note that the puppetmasterd needs to be
- restarted after revoking certificates.
+* --revoke:
+ Revoke the certificate of a client. The certificate can be specified
+ either by its serial number, given as a decimal number or 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' config parameter. Note that the puppetmasterd
+ needs to be restarted after revoking certificates.
-sign: Sign an outstanding certificate request. Unless '--all' is
- specified, hosts must be listed after all flags.
+* --sign:
+ Sign an outstanding certificate request. Unless '--all' is specified,
+ hosts must be listed after all flags.
-verbose: Enable verbosity.
+* --verbose:
+ Enable verbosity.
-version: Print the puppet version number and exit.
+* --version:
+ Print the puppet version number and exit.
-verify: Verify the named certificate against the local CA
- certificate.
+* --verify:
+ Verify the named certificate against the local CA certificate.
EXAMPLE
-=======
- $ puppet cert -l
- culain.madstop.com
- $ puppet cert -s culain.madstop.com
+-------
+ $ puppet cert -l
+ culain.madstop.com
+ $ puppet cert -s culain.madstop.com
AUTHOR
-======
+------
Luke Kanies
COPYRIGHT
-=========
+---------
Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public
License
diff --git a/lib/puppet/application/describe.rb b/lib/puppet/application/describe.rb
index 0c7bea9..bd23375 100644
--- a/lib/puppet/application/describe.rb
+++ b/lib/puppet/application/describe.rb
@@ -183,50 +183,56 @@ class Puppet::Application::Describe < Puppet::Application
def help
<<-HELP
-SYNOPSIS
+puppet-describe(8) -- Display help about resource types
========
-Print help about puppet types on the console. Run with '-h' to get
-detailed help.
+SYNOPSIS
+--------
+Prints help about Puppet resource types, providers, and metaparameters.
USAGE
-=====
- puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta]
+-----
+puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta]
DESCRIPTION
-===========
+-----------
Prints details of Puppet types, providers and metaparameters on the
console.
OPTIONS
-=======
-help: Print this help text
+-------
+* --help:
+ Print this help text
-providers: Describe providers in detail for each type
+* --providers:
+ Describe providers in detail for each type
-list: List all types
+* --list:
+ List all types
-meta: List all metaparameters
+* --meta:
+ List all metaparameters
-short: List only parameters without detail
+* --short:
+ List only parameters without detail
EXAMPLE
-=======
- puppet describe --list
- puppet describe file --providers
- puppet describe user -s -m
+-------
+ $ puppet describe --list
+ $ puppet describe file --providers
+ $ puppet describe user -s -m
AUTHOR
-======
+------
David Lutterkort
COPYRIGHT
-=========
+---------
Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public
License
--
Puppet packaging for Debian
More information about the Pkg-puppet-devel
mailing list