Defined Type: tp::install
- Defined in:
- manifests/install.pp
Overview
This define installs the application (app) set in the given title. Default installation method is package. Alternative ones are possible if the necessary tinydta is present for the app. It manages the packages presence and, eventually, the relevant services on the supported Operating Systems. Several parameters allow any kind of override of default settings and customization. The list of supported applications, and the relevant OS coverage is in the data/ directory of the referred data_module.
Note: the version MUST be a valid for the underlying package provider. This setting is not used if there’s an array of packages to install
tp::install { 'elasticsearch':
ensure => '4.0.1',
}
Note: this works when auto_conf is true (as default) AND when is defined $settings with a valid template in the used data module (default: tinydata)
tp::install { 'puppetserver':
options_hash => lookup('puppetserver::options', {merge => deep}),
}
resources used to manage configuration files. Here eventual auto configuration is explicitly disabled
tp::install { 'puppet':
conf_hash => lookup('puppet::tp_confs', {merge => deep}),,
auto_conf => false,
}
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 |
# File 'manifests/install.pp', line 194
define tp::install (
Variant[Boolean,String] $ensure = present,
String $app = $title,
# Temporary flag to use v4 code
Boolean $use_v4 = pick(getvar('tp::use_v4'),false),
# V4 params
Tp::Install_method $install_method = undef,
Tp::Fail $on_missing_data = pick(getvar('tp::on_missing_data'),'notify'),
String $base_package = 'main',
Hash $confs = {},
Hash $dirs = {},
Hash $options = {},
Hash $my_settings = {},
Hash $params = {},
Optional[String] $version = undef,
Optional[String] $source = undef,
Optional[String] $destination = undef,
String[1] $owner = pick(getvar('identity.user'),'root'),
String[1] $group = pick(getvar('identity.group'),'root'),
# Legacy params preserved
# Boolean $auto_prereq = false,
# Boolean $cli_enable = false,
# String[1] $data_module = 'tinydata',
# Legacy params deprecated
Hash $conf_hash = {},
Hash $dir_hash = {},
Hash $options_hash = {},
Hash $settings_hash = {},
Boolean $auto_repo = true,
Boolean $auto_conf = true,
Optional[Boolean] $auto_prerequisites = undef,
Boolean $auto_prereq = pick(getvar('tp::auto_prereq'), false),
Optional[Boolean] $upstream_repo = undef,
Variant[Undef,String] $repo = undef,
Array $repo_exec_environment = [],
Hash $tp_repo_params = {},
Boolean $manage_package = true,
Boolean $manage_service = true,
Boolean $apt_safe_trusted_key = pick(getvar('tp::apt_safe_trusted_key'), false),
Boolean $cli_enable = pick(getvar('tp::cli_enable'), false),
Boolean $puppi_enable = false,
Boolean $test_enable = false,
Variant[Undef,String] $test_template = undef,
Boolean $debug = false,
String[1] $debug_dir = '/tmp',
String[1] $data_module = 'tinydata',
) {
$sane_app = regsubst($app, '/', '_', 'G')
if $conf_hash != {} {
deprecation('conf_hash', 'Replace with confs')
}
$all_confs = $conf_hash + $confs
if $dir_hash != {} {
deprecation('dir_hash', 'Replace with dirs')
}
$all_dirs = $dir_hash + $dirs
if $options_hash != {} {
deprecation('options_hash', 'Replace with options')
}
$all_options = $options_hash + $options
if $settings_hash != {} {
deprecation('settings_hash', 'Replace with my_settings')
}
# Settings evaluation
$tp_settings = tp_lookup($app,'settings',$data_module,'deep_merge')
$all_but_local_settings = deep_merge($tp_settings,$settings_hash,$my_settings)
$real_install_method = pick($install_method, getvar('all_but_local_settings.install_method'), 'package')
$real_version = tp::get_version($ensure,$version,$all_but_local_settings)
$real_majversion = tp::get_version($ensure,$version,$all_but_local_settings,'major')
$real_filename = pick(tp::url_replace(pick(getvar("all_but_local_settings.${real_install_method}.file_name"),$app), $real_version, $real_majversion), $app) # lint:ignore:140chars
if $use_v4 {
if getvar('tp_settings.release.base_url') {
$real_base_url = tp::url_replace(pick(getvar("tp_settings.${real_install_method}.base_url"), $app), $real_version, $real_majversion)
$real_url = "${real_base_url}/${real_filename}"
} else {
tp::fail($on_missing_data, "tp::install::release - ${app} - Missing tinydata: settings.${real_install_method}.base_url") # lint:ignore:140chars
}
}
$extracted_dir = getvar('tp_settings.release.extracted_dir') ? {
String => tp::url_replace(getvar('tp_settings.release.extracted_dir'), $real_version, $real_majversion), # lint:ignore:140chars
default => tp::url_replace(basename($real_filename), $real_version, $real_majversion),
}
$extracted_file = getvar('tp_settings.release.extracted_file')
$local_settings = delete_undef_values({
install_method => getvar('real_install_method'),
repo => getvar('repo'),
upstream_repo => getvar('upstream_repo'),
git_source => $real_install_method ? {
'source' => getvar('source'),
default => undef,
},
destination => $real_install_method ? {
'source' => pick($destination, "${tp::data_dir}/source/${app}"),
'release' => pick($destination, "${tp::data_dir}/extract/${app}/${extracted_dir}"),
default => undef,
},
packages => delete_undef_values({
name => tp::title_replace(getvar('settings.packages.main.name'),$app),
}),
release => delete_undef_values({
base_url => getvar('real_base_url'),
file_name => getvar('real_filename'),
url => getvar('real_url'),
extracted_dir => getvar('extracted_dir'),
extracted_file => getvar('extracted_file'),
setup => delete_undef_values({
enable => getvar('tp_settings.release.setup.enable'),
links => getvar('tp_settings.release.setup.links'),
}),
}),
})
$settings = deep_merge($all_but_local_settings,$local_settings)
# v4 code
if $use_v4 {
include tp
$real_tp_params = $tp::real_tp_params
$default_install_params = {
ensure => $ensure,
auto_prereq => $auto_prereq,
settings => $settings,
version => $version,
on_missing_data => $on_missing_data,
}
# If not user specified or set as settings.install_method, the default
# installation method is 'package'
# Setup
tp::setup { "tp::install::${real_install_method} ${app}":
ensure => $ensure,
version => $real_version,
install_method => $real_install_method,
source_dir => getvar('settings.destination'),
app => $app,
on_missing_data => $on_missing_data,
settings => $settings,
owner => $owner,
group => $group,
}
# on source_dir => $real_postextract_cwd,
case $real_install_method {
'package': {
$default_install_package_params = {
data_module => $data_module,
base_package => $base_package,
upstream_repo => $upstream_repo,
auto_repo => $auto_repo,
repo => $repo,
repo_exec_environment => $repo_exec_environment,
tp_repo_params => $tp_repo_params,
apt_safe_trusted_key => $apt_safe_trusted_key,
manage_package => $manage_package,
manage_service => $manage_service,
}
tp::install::package { $app:
* => $default_install_params + $default_install_package_params + $params,
}
}
'source': {
$default_install_source_params = {
owner => $owner,
group => $group,
source => $source,
destination => $destination,
}
tp::install::source { $app:
* => $default_install_params + $default_install_source_params + $params,
}
}
'release': {
$default_install_file_params = {
source => $source,
destination => $destination,
owner => $owner,
group => $group,
}
tp::install::release { $app:
* => $default_install_params + $default_install_file_params + $params,
}
}
'image': {
$default_install_image_params = {
owner => $owner,
group => $group,
}
tp::install::image { $app:
* => $default_install_params + $default_install_image_params + $params,
}
}
default: {
fail("Invalid install_method ${real_install_method}")
}
}
# Cli integration
if $cli_enable {
include tp::cli
$tp_dir = $tp::tp_dir
file { "${tp_dir}/app/${sane_app}":
ensure => tp::ensure2file($ensure),
content => $settings.to_yaml,
}
file { "${tp_dir}/shellvars/${sane_app}":
ensure => tp::ensure2file($ensure),
content => epp('tp/shellvars.epp', { settings => $settings , }),
}
}
# Additional confs and dirs
$conf_defaults = {
'ensure' => tp::ensure2file($ensure),
'settings_hash' => $settings,
'options_hash' => $all_options,
'data_module' => $data_module,
}
$all_confs.each |$k,$v| {
tp::conf { $k:
* => $conf_defaults + $v,
}
}
if $all_options != {} and pick_default(getvar('settings.files.config.format'),getvar('settings.config_file_format')) {
tp::conf { $app:
* => $conf_defaults,
}
}
$dir_defaults = {
'ensure' => tp::ensure2dir($ensure),
'settings_hash' => $settings,
'data_module' => $data_module,
}
$all_dirs.each |$k,$v| {
tp::dir { $k:
* => $dir_defaults + $v,
}
}
} else {
# Legacy code
if $settings[package_name] == Variant[Undef,String[0]]
or $manage_package == false {
$service_require = undef
} else {
$service_require = Package[$settings[package_name]]
}
if $settings[package_provider] == Variant[Undef,String[0]] {
$package_provider = undef
} else {
$package_provider = $settings[package_provider]
}
if $settings[package_source] == Variant[Undef,String[0]] {
$package_source = undef
} else {
$package_source = $settings[package_source]
}
if $settings[package_install_options] == Variant[Undef,String[0]] {
$package_install_options = undef
} else {
$package_install_options = $settings[package_install_options]
}
$plain_ensure = $ensure ? {
'absent' => 'absent',
false => 'absent',
default => 'present',
}
$service_ensure = $ensure ? {
'absent' => 'stopped',
false => 'stopped',
default => $settings[service_ensure],
}
$service_enable = $ensure ? {
'absent' => false,
false => false,
default => $settings[service_enable],
}
# Automatic repo management
$use_upstream_repo = pick($upstream_repo,$settings[upstream_repo],false)
if $auto_repo
and ( $settings[repo_url]
or $settings[yum_mirrorlist]
or $settings[repo_package_url]
or $settings[repo_file_url]) {
$repo_enabled = $ensure ? {
'absent' => false,
false => false,
default => true,
}
$tp_repo_params_default = {
enabled => $repo_enabled,
before => Package[$settings[package_name]],
data_module => $data_module,
repo => $repo,
settings_hash => $settings_hash,
exec_environment => $repo_exec_environment,
upstream_repo => $use_upstream_repo,
apt_safe_trusted_key => $apt_safe_trusted_key,
}
tp::repo { $app:
* => $tp_repo_params_default + $tp_repo_params,
}
}
if $auto_prerequisites {
deprecation('auto_prerequisites','Ignored. Parameter renamed to auto_prereq. s/auto_prerequisites/auto_prereq')
}
# Automatic dependencies management, if data defined
if $auto_prereq and $settings[package_prerequisites] and $ensure != 'absent' {
case $settings[package_prerequisites] {
Array: {
$settings[package_prerequisites].each | $p | {
if $settings[package_name] {
Package[$p] -> Package[$settings[package_name]]
}
ensure_packages($p)
}
}
Hash: {
$settings[package_prerequisites].each | $p,$v | {
if $settings[package_name] {
Package[$p] -> Package[$settings[package_name]]
}
ensure_packages($p, $v)
}
}
String: {
if $settings[package_name] {
Package[$settings[package_prerequisites]] -> Package[$settings[package_name]]
}
package { $settings[package_prerequisites]: }
# ensure_packages("${settings[package_prerequisites]}")
}
default: {}
}
}
if $auto_prereq and $settings[tp_prerequisites] and $ensure != 'absent' {
case $settings[tp_prerequisites] {
Array: {
$settings[tp_prerequisites].each | $p | {
if $settings[package_name] {
Tp::Install[$p] -> Package[$settings[package_name]]
}
tp_install($p, { auto_prereq => true })
}
}
Hash: {
$settings[tp_prerequisites].each | $p,$v | {
if $settings[package_name] {
Tp::Install[$p] -> Package[$settings[package_name]]
}
$tp_install_params = { auto_prereq => true } + $v
tp_install($p, $tp_install_params)
}
}
String: {
if $settings[package_name] {
Tp::Install[$settings[tp_prerequisites]] -> Package[$settings[package_name]]
}
tp_install($settings[tp_prerequisites], { auto_prereq => true })
}
default: {}
}
}
if $auto_prereq and $settings['exec_prerequisites'] and $ensure != 'absent' {
$settings[exec_prerequisites].each | $k , $v | {
if $settings[package_name] {
Exec[$k] -> Package[$settings[package_name]]
}
exec { $k:
* => { 'path' => $facts['path'] } + $v,
}
}
}
if $auto_prereq and $settings['extra_prerequisites'] and $ensure != 'absent' {
$settings['extra_prerequisites'].each | $k,$v | {
create_resources($k,$v, { before => Package[$settings[package_name]] })
}
}
if $auto_prereq and $settings['exec_postinstall'] and $ensure != 'absent' {
$settings[exec_postinstall].each | $k , $v | {
if $settings[package_name] {
Package[$settings[package_name]] -> Exec["${app} - ${k}"]
}
exec { "${app} - ${k}":
* => { 'path' => '/bin:/usr/bin:/sbin:/usr/sbin' } + $v,
}
}
}
if $auto_prereq and $settings['extra_postinstall'] and $ensure != 'absent' {
$settings['extra_postinstall'].each | $k,$v | {
create_resources($k,$v, { require => Package[$settings[package_name]] })
}
}
# Resources
if $settings['brew_tap'] =~ String[1] {
Package <| provider == tap |> -> Package <| provider == homebrew |>
Package <| provider == tap |> -> Package <| provider == brew |>
Package <| provider == tap |> -> Package <| provider == brewcask |>
ensure_packages($settings['brew_tap'], { 'provider' => 'tap' })
}
if $settings[package_name] =~ Array and $manage_package {
$package_defaults = {
ensure => $plain_ensure,
provider => $package_provider,
}
$settings[package_name].each |$pkg| {
package { $pkg:
* => $package_defaults + pick($settings[package_params], {}),
}
}
}
if $settings[package_name] =~ String[1] and $manage_package {
$package_defaults = {
ensure => $plain_ensure,
provider => $package_provider,
source => $package_source,
install_options => $package_install_options,
}
package { $settings[package_name]:
* => $package_defaults + pick($settings[package_params], {}),
}
}
if $settings[service_name] and $manage_service {
$services_array=any2array($settings[service_name])
$services_array.each |$svc| {
$service_defaults = {
ensure => $service_ensure,
enable => $service_enable,
require => $service_require,
}
service { $svc:
* => $service_defaults + pick($settings[service_params], {}),
}
}
}
# Install straight from git source
if $settings[git_source] {
if ! $settings[package_name] or $settings[git_use] {
tp::dir { $app:
ensure => tp::ensure2dir($ensure),
path => pick ($settings[git_destination], "/opt/${app}"),
source => $settings[git_source],
vcsrepo => 'git',
}
}
}
# Manage additional tp::conf as in conf_hash
$conf_defaults = {
'ensure' => tp::ensure2file($ensure),
'settings_hash' => $settings,
'options_hash' => $all_options,
'data_module' => $data_module,
}
$all_confs.each |$k,$v| {
tp::conf { $k:
* => $conf_defaults + $v,
}
}
if $all_options != {} and $settings[config_file_format] {
tp::conf { $app:
* => $conf_defaults,
}
}
# Manage additional tp::dir as in dir_hash
$dir_defaults = {
'ensure' => tp::ensure2dir($ensure),
'settings_hash' => $settings,
'data_module' => $data_module,
}
$all_dirs.each |$k,$v| {
tp::dir { $k:
* => $dir_defaults + $v,
}
}
# Automatically manage config files and any Puppet resource, if tinydata defined
if $auto_conf and $settings['config_file_template'] {
::tp::conf { $app:
template => $settings['config_file_template'],
options_hash => $all_options,
data_module => $data_module,
}
}
if $auto_conf and $settings['init_file_template'] {
::tp::conf { "${app}::init":
template => $settings['init_file_template'],
options_hash => $all_options,
base_file => 'init',
data_module => $data_module,
}
}
# Optional test automation integration
if $test_enable and $test_template {
tp::test { $app:
settings_hash => $settings,
options_hash => $all_options,
template => $test_template,
data_module => $data_module,
}
}
# Optional puppi integration
if $puppi_enable {
tp::puppi { $app:
settings_hash => $settings,
data_module => $data_module,
}
}
# Optional cli integration
$tp_basedir = $facts['os']['family'] ? {
'windows' => 'C:/ProgramData/PuppetLabs/tp',
default => '/etc/tp',
}
if $cli_enable and getvar('facts.identity.privileged') != false {
file { "${tp_basedir}/app/${sane_app}":
ensure => $plain_ensure,
content => inline_template('<%= @settings.to_yaml %>'),
}
file { "${tp_basedir}/shellvars/${sane_app}":
ensure => $plain_ensure,
content => epp('tp/shellvars.epp', { settings => $settings }),
}
include tp
}
# Debugging
if $debug == true {
$debug_scope = inline_template('<%= scope.to_hash.reject { |k,v| k.to_s =~ /(uptime.*|path|timestamp|free|.*password.*)/ } %>')
file { "tp_install_debug_${sane_app}":
ensure => tp::ensure2file($ensure),
content => $debug_scope,
path => "${debug_dir}/tp_install_debug_${sane_app}",
}
}
}
}
|