On Apache
Under GNU General Public License
2024-04-27 01:58 @3.12.161.77 CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)
PUPPET-MODULE(8) Puppet manual PUPPET-MODULE(8)
NAME
puppet-module - Creates, installs and searches for modules on the Puppet Forge.
SYNOPSIS
puppet module action [--environment production ] [--modulepath $confdir/mod-
ules:/usr/share/puppet/modules ]
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.
OPTIONS
Note that any configuration parameter 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, server and run_mode are valid configuration parameters, so you can specify
--server <servername>, or --run_mode <runmode> as an argument.
See the configuration file documentation at http://docs.puppetlabs.com/references/sta-
ble/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.
--render-as FORMAT
The format in which to render output. The most common formats are json, s (string),
yaml, and console, but other options such as dot are sometimes available.
--verbose
Whether to log verbosely.
--debug
Whether to log debug information.
--environment production
The environment Puppet is running in. For clients (e.g., puppet agent) this deter-
mines the environment itself, which is used to find modules and much more. For
servers (i.e., puppet master) this provides the default environment for nodes we
know nothing about.
--modulepath $confdir/modules:/usr/share/puppet/modules
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 separa-
tor is ';'.)
ACTIONS
build - Build a module release package.
SYNOPSIS
puppet module build [path]
DESCRIPTION
Prepares a local module for release on the Puppet Forge by building a
ready-to-upload archive file.
This action uses the Modulefile in the module directory to set metadata used by the
Forge. See http://links.puppetlabs.com/modulefile for more about writing module-
files.
After being built, the release archive file can be found in the module's pkg direc-
tory.
RETURNS
Pathname object representing the path to the release archive.
changes - Show modified files of an installed module.
SYNOPSIS
puppet module changes path
DESCRIPTION
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.
RETURNS
Array of strings representing paths of modified files.
generate - Generate boilerplate for a new module.
SYNOPSIS
puppet module generate name
DESCRIPTION
Generates boilerplate for a new module by creating the directory structure and
files recommended for the Puppet community's best practices.
A module may need additional directories beyond this boilerplate if it provides
plugins, files, or templates.
RETURNS
Array of Pathname objects representing paths of generated files.
install - Install a module from the Puppet Forge or a release archive.
SYNOPSIS
puppet module install [--force | -f] [--target-dir DIR | -i DIR] [--ignore-depen-
dencies] [--version VER | -v VER] name
DESCRIPTION
Installs a module from the Puppet Forge or from a release archive file.
The specified module will be installed into the directory specified with the --tar-
get-dir option, which defaults to /Users/josh/.puppet/modules.
OPTIONS --force | -f - Force overwrite of existing module, if any.
--ignore-dependencies - Do not attempt to install dependencies.
--target-dir DIR | -i DIR - The directory into which modules are installed;
defaults to the first directory in the modulepath.
Specifying this option will change the installation directory, and will use the
existing modulepath when checking for dependencies. If you wish to check a differ-
ent set of directories for dependencies, you must also use the --environment or
--modulepath options.
--version VER | -v VER - Module version to install; can be an exact version or a
requirement string, eg '>= 1.0.3'. Defaults to latest version.
RETURNS
Pathname object representing the path to the installed module.
list - List installed modules
SYNOPSIS
puppet module list [--tree]
DESCRIPTION
Lists the installed puppet modules. By default, this action scans the modulepath
from puppet.conf's [main] block; use the --modulepath option to change which direc-
tories are scanned.
The output of this action includes information from the module's metadata, includ-
ing version numbers and unmet module dependencies.
OPTIONS --tree - Whether to show dependencies as a tree view
RETURNS
hash of paths to module objects
search - Search the Puppet Forge for a module.
SYNOPSIS
puppet module search search_term
DESCRIPTION
Searches a repository for modules whose names, descriptions, or keywords match the
provided search term.
RETURNS
Array of module metadata hashes
uninstall - Uninstall a puppet module.
SYNOPSIS
puppet module uninstall [--force | -f] [--version=] name
DESCRIPTION
Uninstalls a puppet module from the modulepath (or a specific target directory).
OPTIONS --force | -f - Force the uninstall of an installed module even if there are
local changes or the possibility of causing broken dependencies.
--version= - The version of the module to uninstall. When using this option, a mod-
ule matching the specified version must be installed or else an error is raised.
RETURNS
Hash of module objects representing uninstalled modules and related errors.
upgrade - Upgrade a puppet module.
SYNOPSIS
puppet module upgrade [--force | -f] [--ignore-dependencies] [--version=] name
DESCRIPTION
Upgrades a puppet module.
OPTIONS --force | -f - Force the upgrade of an installed module even if there are
local changes or the possibility of causing broken dependencies.
--ignore-dependencies - Do not attempt to install dependencies
--version= - The version of the module to upgrade to.
RETURNS
Hash
EXAMPLES
build
Build a module release:
$ puppet module build puppetlabs-apache notice: Building /Users/kelseyhightower/puppet-
labs-apache for release Module built: /Users/kelseyhightower/puppetlabs-apache/pkg/puppet-
labs-apache-0.0.1.tar.gz
Build the module in the current working directory:
$ cd /Users/kelseyhightower/puppetlabs-apache $ puppet module build notice: Building
/Users/kelseyhightower/puppetlabs-apache for release Module built: /Users/kelseyhigh-
tower/puppetlabs-apache/pkg/puppetlabs-apache-0.0.1.tar.gz
changes
Show modified files of an installed module:
$ puppet module changes /etc/puppet/modules/vcsrepo/ warning: 1 files modified lib/pup-
pet/provider/vcsrepo.rb
generate
Generate a new module in the current directory:
$ puppet module generate puppetlabs-ssh notice: Generating module at /Users/kelseyhigh-
tower/puppetlabs-ssh puppetlabs-ssh puppetlabs-ssh/tests puppetlabs-ssh/tests/init.pp pup-
petlabs-ssh/spec puppetlabs-ssh/spec/spec_helper.rb puppetlabs-ssh/spec/spec.opts puppet-
labs-ssh/README puppetlabs-ssh/Modulefile puppetlabs-ssh/metadata.json puppetlabs-ssh/man-
ifests puppetlabs-ssh/manifests/init.pp
install
Install a module:
$ puppet module install puppetlabs-vcsrepo Preparing to install into /etc/puppet/modules
... Downloading from http://forge.puppetlabs.com ... Installing -- do not interrupt ...
/etc/puppet/modules puppetlabs-vcsrepo (v0.0.4)
Install a module to a specific environment:
$ puppet module install puppetlabs-vcsrepo --environment development Preparing to install
into /etc/puppet/environments/development/modules ... Downloading from http://forge.pup-
petlabs.com ... Installing -- do not interrupt ... /etc/puppet/environments/develop-
ment/modules puppetlabs-vcsrepo (v0.0.4)
Install a specific module version:
$ puppet module install puppetlabs-vcsrepo -v 0.0.4 Preparing to install into /etc/pup-
pet/modules ... Downloading from http://forge.puppetlabs.com ... Installing -- do not
interrupt ... /etc/puppet/modules puppetlabs-vcsrepo (v0.0.4)
Install a module into a specific directory:
$ puppet module install puppetlabs-vcsrepo --target-dir=/usr/share/puppet/modules Prepar-
ing to install into /usr/share/puppet/modules ... Downloading from http://forge.puppet-
labs.com ... Installing -- do not interrupt ... /usr/share/puppet/modules puppet-
labs-vcsrepo (v0.0.4)
Install a module into a specific directory and check for dependencies in other directo-
ries:
$ puppet module install puppetlabs-vcsrepo --target-dir=/usr/share/puppet/modules --mod-
ulepath /etc/puppet/modules Preparing to install into /usr/share/puppet/modules ... Down-
loading from http://forge.puppetlabs.com ... Installing -- do not interrupt ...
/usr/share/puppet/modules puppetlabs-vcsrepo (v0.0.4)
Install a module from a release archive:
$ puppet module install puppetlabs-vcsrepo-0.0.4.tar.gz Preparing to install into
/etc/puppet/modules ... Downloading from http://forge.puppetlabs.com ... Installing -- do
not interrupt ... /etc/puppet/modules puppetlabs-vcsrepo (v0.0.4)
Install a module from a release archive and ignore dependencies:
$ 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/mod-
ules puppetlabs-vcsrepo (v0.0.4)
list
List installed modules:
$ puppet module list /etc/puppet/modules bodepd-create_resources (v0.0.1) puppet-
labs-bacula (v0.0.2) puppetlabs-mysql (v0.0.1) puppetlabs-sqlite (v0.0.1) puppet-
labs-stdlib (v2.2.1) /usr/share/puppet/modules (no modules installed)
List installed modules in a tree view:
$ 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)
List installed modules from a specified environment:
$ 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)
List installed modules from a specified modulepath:
$ puppet module list --modulepath /usr/share/puppet/modules /usr/share/puppet/modules (no
modules installed)
search
Search the Puppet Forge for a module:
$ puppet module search puppetlabs NAME DESCRIPTION AUTHOR KEYWORDS bacula This is a
generic Apache module @puppetlabs backups
uninstall
Uninstall a module:
$ puppet module uninstall puppetlabs-ssh Removed /etc/puppet/modules/ssh (v1.0.0)
Uninstall a module from a specific directory:
$ puppet module uninstall puppetlabs-ssh --modulepath /usr/share/puppet/modules Removed
/usr/share/puppet/modules/ssh (v1.0.0)
Uninstall a module from a specific environment:
$ puppet module uninstall puppetlabs-ssh --environment development Removed /etc/pup-
pet/environments/development/modules/ssh (v1.0.0)
Uninstall a specific version of a module:
$ puppet module uninstall puppetlabs-ssh --version 2.0.0 Removed /etc/puppet/modules/ssh
(v2.0.0)
upgrade
upgrade an installed module to the latest version
$ puppet module upgrade puppetlabs-apache /etc/puppet/modules puppetlabs-apache (v1.0.0
-> v2.4.0)
upgrade an installed module to a specific version
$ puppet module upgrade puppetlabs-apache --version 2.1.0 /etc/puppet/modules puppet-
labs-apache (v1.0.0 -> v2.1.0)
upgrade an installed module for a specific environment
$ puppet module upgrade puppetlabs-apache --environment test /usr/share/puppet/environ-
ments/test/modules puppetlabs-apache (v1.0.0 -> v2.4.0)
COPYRIGHT AND LICENSE
Copyright 2012 by Puppet Labs Apache 2 license; see COPYING
Puppet Labs, LLC January 2013 PUPPET-MODULE(8)
Generated by $Id: phpMan.php,v 4.55 2007/09/05 04:42:51 chedong Exp $ Author: Che Dong
On Apache
Under GNU General Public License
2024-04-27 01:58 @3.12.161.77 CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)