cookbook 'cpan', '= 0.0.18'
cpan
(33) Versions
0.0.18
-
Follow6
CPAN modules provider (cpan_client provider LWRP)
cookbook 'cpan', '= 0.0.18', :supermarket
knife supermarket install cpan
knife supermarket download cpan
DESCRIPTION
cpan modules resource provider
PREREQUISITES
- 1) I assume you have a cpan client installed on your system.
-
2) Run recipe
cpan::bootstrap
to ensure all others dependencies are met:include_recipe 'cpan::bootstrap'
ATTRIBUTES used in cpan::bootstrap recipe
-
cpan.minimal_version
- minimal required version of cpan client -
cpan.download_url
- url to download fresh cpan client
BASIC USAGE
cpan_client 'CGI' do
action 'install'
install_type 'cpan_module'
user 'root'
group 'root'
end
RESOURCE ACTIONS
-
install
- install module or application -
test
- test module, don't install it -
reload_cpan_index
- reload cpan client indexes
RESOURCE ATTRIBUTES
-
cwd
- specifies current working directory where installation process runs -
dry_run
- specifies whether to run installation process in dry-run mode or not, default - false -
environment
- specifies Hash with environment variables exported to installation process -
force
- specifies whether to run installation process in force mode, default - false -
from_cookbook
- specifies cookbook, where distributive stored at. Check out cookbook file resource documentation -
user
/group
- specifies a user/group rights for installation process -
inc
- specifies an Array passed to PERL5LIB environment variable (@INC), default value [] -
install_base
- specifies install base for installation -
install_path
- specifies install paths for installation, Array of Strings -
install_type
- whether to install as cpan module or as application : cpan_module, application; default - application -
module_name
- specifies the name of cpan module to check version against when doing install, useful when doing install from http url or cookbook -
version
- specifies version of module, default value is nil. see alsomodule_name
parameter- if version defined as
version '0'
- installs only if module is not installed yet. see examples further - if version defined as
version 'version-number'
- installs by version and higher. see examples further - if version defined as
version '=version-number'
- installs exact version. see examples further
- if version defined as
EXAMPLES OF USAGE
fake install
cpan_client 'CGI' do
user 'root'
group 'root'
dry_run true
install_type 'cpan_module'
action 'install'
end
do not install, only run tests
cpan_client 'CGI' do
user 'root'
group 'root'
install_type 'cpan_module'
action 'test'
end
force install
cpan_client 'CGI' do
user 'root'
group 'root'
force true
install_type 'cpan_module'
action 'install'
end
installs version or higher
cpan_client 'CGI' do
user 'root'
group 'root'
version '3.55'
install_type 'cpan_module'
action 'install'
end
installs only if module is not installed yet
cpan_client 'CGI' do
user 'root'
group 'root'
version '0'
install_type 'cpan_module'
action 'install'
end
installs exact version of module
# exact version installation is available only for install from cookbook or from http url
cpan_client 'http://search.cpan.org/CPAN/authors/id/M/MA/MARKSTOS/CGI.pm-3.59.tar.gz' do
user 'root'
group 'root'
module_name 'CGI'
version '=3.59'
action 'install'
end
cpan_client 'Moose-1.24.tar.gz' do
user 'root'
group 'root'
from_cookbook 'moose'
module_name 'Moose'
version '=1.24'
action 'install'
end
installs distributive stored in cookbook
cpan_client 'Moose-1.24.tar.gz' do
user 'root'
group 'root'
from_cookbook 'moose'
install_type 'cpan_module'
action 'install'
end
installs distributive stored in cookbook with version check
cpan_client 'Moose-1.24.tar.gz' do
user 'root'
group 'root'
from_cookbook 'moose'
module_name 'Moose'
version '1.24'
action 'install'
end
installs from http url
# only http protocol now is supported:
cpan_client 'http://search.cpan.org/CPAN/authors/id/M/MA/MARKSTOS/CGI.pm-3.59.tar.gz' do
user 'root'
group 'root'
action 'install'
end
installs from http url with version check
cpan_client 'http://search.cpan.org/CPAN/authors/id/M/MA/MARKSTOS/CGI.pm-3.58.tar.gz' do
user 'root'
group 'root'
module_name 'CGI'
version '3.59'
action 'install'
end
installs into given install_base
cpan_client 'CGI' do
user 'root'
group 'root'
install_base '/some/where/else'
install_type 'cpan_module'
action 'install'
end
installs into given install_base with relative_path
# will install into '/home/alex/mydir'
cpan_client 'CGI' do
user 'root'
group 'root'
install_base 'mydir'
cwd '/home/alex/'
install_type 'cpan_module'
action 'install'
end
installs with given install path
# will override settings for `htdocs` and `config` elements
cpan_client 'Module' do
user 'root'
group 'root'
install_path ["htdocs=#{ENV['PWD']}/htdocs/", "config=#{ENV['PWD']}/etc/"]
install_type 'cpan_module'
action 'install'
end
installs distributive unpacked in current working directory
cpan_client 'my application' do
user 'root'
group 'root'
install_type 'application'
action 'install'
end
installs under not privileged user
# will install into $PWD/cpanlib directory
cpan_client 'my application' do
install_type 'application'
user 'user'
group 'users'
install_base 'cpanlib'
action 'install'
end
reloads cpan indexes
cpan_client 'reload cpan index' do
user 'user'
group 'users'
action 'reload_cpan_index'
end
Features
For complete examples of usage see cucumber features at https://github.com/melezhik/cookbooks/tree/master/cpan/features/
Dependent cookbooks
This cookbook has no specified dependencies.