Puppet Class: docker

Inherits:
docker::params
Defined in:
manifests/init.pp

Summary

Module to install an up-to-date version of Docker from package.

Overview

Parameters:

  • version (Optional[String]) (defaults to: $docker::params::version)

    The package version to install, used to set the package name.

  • ensure (String) (defaults to: $docker::params::ensure)

    Passed to the docker package.

  • prerequired_packages (Variant[Array[String], Hash]) (defaults to: $docker::params::prerequired_packages)

    An array of additional packages that need to be installed to support docker.

  • dependent_packages (Array) (defaults to: $docker::params::dependent_packages)

    An array of packages installed by the docker-ce package v 18.09 and later. Used when uninstalling to ensure containers cannot be run on the system.

  • tcp_bind (Optional[Variant[String,Array[String]]]) (defaults to: $docker::params::tcp_bind)

    The tcp socket to bind to in the format tcp://127.0.0.1:4243

  • tls_enable (Boolean) (defaults to: $docker::params::tls_enable)

    Enable TLS.

  • tls_verify (Boolean) (defaults to: $docker::params::tls_verify)

    Use TLS and verify the remote

  • tls_cacert (Optional[String]) (defaults to: $docker::params::tls_cacert)

    Path to TLS CA certificate

  • tls_cert (Optional[String]) (defaults to: $docker::params::tls_cert)

    Path to TLS certificate file

  • tls_key (Optional[String]) (defaults to: $docker::params::tls_key)

    Path to TLS key file

  • ip_forward (Boolean) (defaults to: $docker::params::ip_forward)

    Enables IP forwarding on the Docker host.

  • iptables (Boolean) (defaults to: $docker::params::iptables)

    Enable Docker’s addition of iptables rules.

  • ip_masq (Boolean) (defaults to: $docker::params::ip_masq)

    Enable IP masquerading for bridge’s IP range.

  • icc (Optional[Boolean]) (defaults to: $docker::params::icc)

    Enable or disable Docker’s unrestricted inter-container and Docker daemon host communication. (Requires iptables=true to disable)

  • bip (Optional[String]) (defaults to: $docker::params::bip)

    Specify docker’s network bridge IP, in CIDR notation.

  • mtu (Optional[String]) (defaults to: $docker::params::mtu)

    Docker network MTU.

  • bridge (Optional[String]) (defaults to: $docker::params::bridge)

    Attach containers to a pre-existing network bridge use ‘none’ to disable container networking

  • fixed_cidr (Optional[String]) (defaults to: $docker::params::fixed_cidr)

    IPv4 subnet for fixed IPs 10.20.0.0/16

  • default_gateway (Optional[String]) (defaults to: $docker::params::default_gateway)

    IPv4 address of the container default gateway; this address must be part of the bridge subnet (which is defined by bridge)

  • ipv6 (Optional[Boolean]) (defaults to: $docker::params::ipv6)

    Enables ipv6 support for the docker daemon

  • ipv6_cidr (Optional[String]) (defaults to: $docker::params::ipv6_cidr)

    IPv6 subnet for fixed IPs

  • default_gateway_ipv6 (Optional[String]) (defaults to: $docker::params::default_gateway_ipv6)

    IPv6 address of the container default gateway:

  • socket_bind (String) (defaults to: $docker::params::socket_bind)

    The unix socket to bind to.

  • log_level (Optional[String]) (defaults to: $docker::params::log_level)

    Set the logging level Valid values: debug, info, warn, error, fatal

  • log_driver (Optional[String]) (defaults to: $docker::params::log_driver)

    Set the log driver. Docker default is json-file. Please verify the value by yourself, before setting it. Valid shipped log drivers can be found here: docs.docker.com/config/containers/logging/configure/#supported-logging-drivers Since custom log driver plugins are and must be possible, the value can not be verified through code here.

  • log_opt (Array) (defaults to: $docker::params::log_opt)

    Set the log driver specific options Valid values per log driver:

    none     : undef
    local    :
               max-size=[0-9+][k|m|g]
               max-file=[0-9+]
    json-file:
               max-size=[0-9+][k|m|g]
               max-file=[0-9+]
    syslog   :
               syslog-address=[tcp|udp]://host:port
               syslog-address=unix://path
               syslog-facility=daemon|kern|user|mail|auth|
                               syslog|lpr|news|uucp|cron|
                               authpriv|ftp|
                               local0|local1|local2|local3|
                               local4|local5|local6|local7
               syslog-tag="some_tag"
    journald : undef
    gelf     :
               gelf-address=udp://host:port
               gelf-tag="some_tag"
    fluentd  :
               fluentd-address=host:port
               fluentd-tag={{.ID}} - short container id (12 characters)|
                           {{.FullID}} - full container id
                           {{.Name}} - container name
    splunk   :
               splunk-token=<splunk_http_event_collector_token>
               splunk-url=https://your_splunk_instance:8088
    awslogs  :
               awslogs-group=<Cloudwatch Log Group>
               awslogs-stream=<Cloudwatch Log Stream>
               awslogs-create-group=true|false
               awslogs-datetime-format=<Date format> - strftime expression
               awslogs-multiline-pattern=multiline start pattern using a regular expression
               tag={{.ID}} - short container id (12 characters)|
                   {{.FullID}} - full container id
                   {{.Name}} - container name
    
  • selinux_enabled (Optional[Boolean]) (defaults to: $docker::params::selinux_enabled)

    Enable selinux support. Default is false. SELinux does not presently support the BTRFS storage driver.

  • use_upstream_package_source (Optional[Boolean]) (defaults to: $docker::params::use_upstream_package_source)

    Whether or not to use the upstream package source. If you run your own package mirror, you may set this to false.

  • pin_upstream_package_source (Optional[Boolean]) (defaults to: $docker::params::pin_upstream_package_source)

    Pin upstream package source; this option currently only has any effect on apt-based distributions. Set to false to remove pinning on the upstream package repository. See also “apt_source_pin_level”.

  • apt_source_pin_level (Optional[Integer]) (defaults to: $docker::params::apt_source_pin_level)

    What level to pin our source package repository to; this only is relevent if you’re on an apt-based system (Debian, Ubuntu, etc) and $use_upstream_package_source is set to true. Set this to false to disable pinning, and undef to ensure the apt preferences file apt::source uses to define pins is removed.

  • service_state (String) (defaults to: $docker::params::service_state)

    Whether you want to docker daemon to start up

  • service_enable (Boolean) (defaults to: $docker::params::service_enable)

    Whether you want to docker daemon to start up at boot

  • manage_service (Boolean) (defaults to: $docker::params::manage_service)

    Specify whether the service should be managed.

  • root_dir (Optional[String]) (defaults to: $docker::params::root_dir)

    Custom root directory for containers

  • dns (Optional[Variant[String,Array]]) (defaults to: $docker::params::dns)

    Custom dns server address

  • dns_search (Optional[Variant[String,Array]]) (defaults to: $docker::params::dns_search)

    Custom dns search domains

  • socket_group (Optional[Variant[String,Boolean]]) (defaults to: $docker::params::socket_group)

    Group ownership of the unix control socket.

  • extra_parameters (Optional[Variant[String,Array]]) (defaults to: undef)

    Any extra parameters that should be passed to the docker daemon.

  • shell_values (Optional[Variant[String,Array]]) (defaults to: undef)

    Array of shell values to pass into init script config files

  • proxy (Optional[String]) (defaults to: $docker::params::proxy)

    Will set the http_proxy and https_proxy env variables in /etc/sysconfig/docker (redhat/centos) or /etc/default/docker (debian)

  • no_proxy (Optional[String]) (defaults to: $docker::params::no_proxy)

    Will set the no_proxy variable in /etc/sysconfig/docker (redhat/centos) or /etc/default/docker (debian)

  • storage_driver (Optional[String]) (defaults to: $docker::params::storage_driver)

    Specify a storage driver to use Valid values: aufs, devicemapper, btrfs, overlay, overlay2, vfs, zfs

  • dm_basesize (Optional[String]) (defaults to: $docker::params::dm_basesize)

    The size to use when creating the base device, which limits the size of images and containers.

  • dm_fs (Optional[String]) (defaults to: $docker::params::dm_fs)

    The filesystem to use for the base image (xfs or ext4)

  • dm_mkfsarg (Optional[String]) (defaults to: $docker::params::dm_mkfsarg)

    Specifies extra mkfs arguments to be used when creating the base device.

  • dm_mountopt (Optional[String]) (defaults to: $docker::params::dm_mountopt)

    Specifies extra mount options used when mounting the thin devices.

  • dm_blocksize (Optional[String]) (defaults to: $docker::params::dm_blocksize)

    A custom blocksize to use for the thin pool. Default blocksize is 64K. Warning: _DO NOT_ change this parameter after the lvm devices have been initialized.

  • dm_loopdatasize (Optional[String]) (defaults to: $docker::params::dm_loopdatasize)

    Specifies the size to use when creating the loopback file for the “data” device which is used for the thin pool

  • dm_loopmetadatasize (Optional[String]) (defaults to: $docker::params::dm_loopmetadatasize)

    Specifies the size to use when creating the loopback file for the “metadata” device which is used for the thin pool

  • dm_datadev (Optional[String]) (defaults to: $docker::params::dm_datadev)

    (deprecated - dm_thinpooldev should be used going forward) A custom blockdevice to use for data for the thin pool.

  • dm_metadatadev (Optional[String]) (defaults to: $docker::params::dm_metadatadev)

    (deprecated - dm_thinpooldev should be used going forward) A custom blockdevice to use for metadata for the thin pool.

  • dm_thinpooldev (Optional[String]) (defaults to: $docker::params::dm_thinpooldev)

    Specifies a custom block storage device to use for the thin pool.

  • dm_use_deferred_removal (Optional[Boolean]) (defaults to: $docker::params::dm_use_deferred_removal)

    Enables use of deferred device removal if libdm and the kernel driver support the mechanism.

  • dm_use_deferred_deletion (Optional[Boolean]) (defaults to: $docker::params::dm_use_deferred_deletion)

    Enables use of deferred device deletion if libdm and the kernel driver support the mechanism.

  • dm_blkdiscard (Optional[Boolean]) (defaults to: $docker::params::dm_blkdiscard)

    Enables or disables the use of blkdiscard when removing devicemapper devices.

  • dm_override_udev_sync_check (Optional[Boolean]) (defaults to: $docker::params::dm_override_udev_sync_check)

    By default, the devicemapper backend attempts to synchronize with the udev device manager for the Linux kernel. This option allows disabling that synchronization, to continue even though the configuration may be buggy.

  • overlay2_override_kernel_check (Boolean) (defaults to: $docker::params::overlay2_override_kernel_check)

    Overrides the Linux kernel version check allowing using overlay2 with kernel < 4.0.

  • manage_package (Boolean) (defaults to: $docker::params::manage_package)

    Won’t install or define the docker package, useful if you want to use your own package

  • service_name (Optional[String]) (defaults to: $docker::params::service_name)

    Specify custom service name

  • docker_users (Array) (defaults to: [])

    Specify an array of users to add to the docker group

  • create_user (Boolean) (defaults to: true)

    If ‘true` the list of `docker_users` will be created as well as added to the docker group

  • docker_group (String) (defaults to: $docker::params::docker_group)

    Specify a string for the docker group

  • daemon_environment_files (Array) (defaults to: [])

    Specify additional environment files to add to the service-overrides.conf

  • repo_opt (Optional[Variant[String,Hash]]) (defaults to: $docker::params::repo_opt)

    Specify a string to pass as repository options (RedHat only)

  • storage_devs (Optional[String]) (defaults to: $docker::params::storage_devs)

    A quoted, space-separated list of devices to be used.

  • storage_vg (Optional[String]) (defaults to: $docker::params::storage_vg)

    The volume group to use for docker storage.

  • storage_root_size (Optional[String]) (defaults to: $docker::params::storage_root_size)

    The size to which the root filesystem should be grown.

  • storage_data_size (Optional[String]) (defaults to: $docker::params::storage_data_size)

    The desired size for the docker data LV

  • storage_min_data_size (Optional[String]) (defaults to: $docker::params::storage_min_data_size)

    The minimum size of data volume otherwise pool creation fails

  • storage_chunk_size (Optional[String]) (defaults to: $docker::params::storage_chunk_size)

    Controls the chunk size/block size of thin pool.

  • storage_growpart (Optional[Boolean]) (defaults to: $docker::params::storage_growpart)

    Enable resizing partition table backing root volume group.

  • storage_auto_extend_pool (Optional[String]) (defaults to: $docker::params::storage_auto_extend_pool)

    Enable/disable automatic pool extension using lvm

  • storage_pool_autoextend_threshold (Optional[String]) (defaults to: $docker::params::storage_pool_autoextend_threshold)

    Auto pool extension threshold (in % of pool size)

  • storage_pool_autoextend_percent (Optional[String]) (defaults to: $docker::params::storage_pool_autoextend_percent)

    Extend the pool by specified percentage when threshold is hit.

  • tmp_dir_config (Optional[Boolean]) (defaults to: $docker::params::tmp_dir_config)

    Whether to set the TMPDIR value in the systemd config file Default: true (set the value); false will comment out the line. Note: false is backwards compatible prior to PR #58

  • tmp_dir (Optional[String]) (defaults to: $docker::params::tmp_dir)

    Sets the tmp dir for Docker (path)

  • registry_mirror (Optional[Variant[String,Array]]) (defaults to: $docker::params::registry_mirror)

    Sets the prefered container registry mirror.

  • nuget_package_provider_version (Optional[String]) (defaults to: $docker::params::nuget_package_provider_version)

    The version of the NuGet Package provider

  • docker_msft_provider_version (Optional[String]) (defaults to: $docker::params::docker_msft_provider_version)

    The version of the Microsoft Docker Provider Module

  • docker_ce_start_command (String) (defaults to: $docker::params::docker_ce_start_command)
  • docker_ce_package_name (Optional[String]) (defaults to: $docker::params::docker_ce_package_name)
  • docker_ce_cli_package_name (String[1]) (defaults to: $docker::params::docker_ce_cli_package_name)
  • docker_ce_source_location (Optional[String]) (defaults to: $docker::params::package_ce_source_location)
  • docker_ce_key_source (Optional[String]) (defaults to: $docker::params::package_ce_key_source)
  • docker_ce_key_id (Optional[String]) (defaults to: $docker::params::package_ce_key_id)
  • docker_ce_release (Optional[String]) (defaults to: $docker::params::package_ce_release)
  • docker_package_location (Optional[String]) (defaults to: $docker::params::package_source_location)
  • docker_package_key_source (Optional[String]) (defaults to: $docker::params::package_key_source)
  • docker_package_key_check_source (Optional[Boolean]) (defaults to: $docker::params::package_key_check_source)
  • docker_package_key_id (Optional[String]) (defaults to: $docker::params::package_key_id)
  • docker_package_release (Optional[String]) (defaults to: $docker::params::package_release)
  • docker_engine_start_command (String) (defaults to: $docker::params::docker_engine_start_command)
  • docker_engine_package_name (String) (defaults to: $docker::params::docker_engine_package_name)
  • docker_ce_channel (String) (defaults to: $docker::params::docker_ce_channel)
  • docker_ee (Optional[Boolean]) (defaults to: $docker::params::docker_ee)
  • docker_ee_package_name (Optional[String]) (defaults to: $docker::params::package_ee_package_name)
  • docker_ee_source_location (Optional[String]) (defaults to: $docker::params::package_ee_source_location)
  • docker_ee_key_source (Optional[String]) (defaults to: $docker::params::package_ee_key_source)
  • docker_ee_key_id (Optional[String]) (defaults to: $docker::params::package_ee_key_id)
  • docker_ee_repos (Optional[String]) (defaults to: $docker::params::package_ee_repos)
  • docker_ee_release (Optional[String]) (defaults to: $docker::params::package_ee_release)
  • package_release (Optional[String]) (defaults to: $docker::params::package_release)
  • labels (Array) (defaults to: $docker::params::labels)
  • execdriver (Optional[String]) (defaults to: $docker::params::execdriver)
  • package_source (Optional[String]) (defaults to: $docker::params::package_source)
  • os_lc (Optional[String]) (defaults to: $docker::params::os_lc)
  • storage_config (Optional[Variant[String,Boolean]]) (defaults to: $docker::params::storage_config)
  • storage_config_template (Optional[String]) (defaults to: $docker::params::storage_config_template)
  • storage_setup_file (Optional[String]) (defaults to: $docker::params::storage_setup_file)
  • service_provider (Optional[String]) (defaults to: $docker::params::service_provider)
  • service_config (Optional[Variant[String,Boolean]]) (defaults to: $docker::params::service_config)
  • service_config_template (Optional[String]) (defaults to: $docker::params::service_config_template)
  • service_overrides_template (Optional[Variant[String,Boolean]]) (defaults to: $docker::params::service_overrides_template)
  • socket_overrides_template (Optional[Variant[String,Boolean]]) (defaults to: $docker::params::socket_overrides_template)
  • socket_override (Optional[Boolean]) (defaults to: $docker::params::socket_override)
  • service_after_override (Optional[Variant[String,Boolean]]) (defaults to: $docker::params::service_after_override)
  • service_hasstatus (Optional[Boolean]) (defaults to: $docker::params::service_hasstatus)
  • service_hasrestart (Optional[Boolean]) (defaults to: $docker::params::service_hasrestart)
  • acknowledge_unsupported_os (Boolean) (defaults to: false)
  • have_systemd_v230 (Boolean) (defaults to: $docker::params::have_systemd_v230)


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
# File 'manifests/init.pp', line 352

class docker (
  Optional[String]                        $version                           = $docker::params::version,
  String                                  $ensure                            = $docker::params::ensure,
  Variant[Array[String], Hash]            $prerequired_packages              = $docker::params::prerequired_packages,
  Array                                   $dependent_packages                = $docker::params::dependent_packages,
  String                                  $docker_ce_start_command           = $docker::params::docker_ce_start_command,
  Optional[String]                        $docker_ce_package_name            = $docker::params::docker_ce_package_name,
  String[1]                               $docker_ce_cli_package_name        = $docker::params::docker_ce_cli_package_name,
  Optional[String]                        $docker_ce_source_location         = $docker::params::package_ce_source_location,
  Optional[String]                        $docker_ce_key_source              = $docker::params::package_ce_key_source,
  Optional[String]                        $docker_ce_key_id                  = $docker::params::package_ce_key_id,
  Optional[String]                        $docker_ce_release                 = $docker::params::package_ce_release,
  Optional[String]                        $docker_package_location           = $docker::params::package_source_location,
  Optional[String]                        $docker_package_key_source         = $docker::params::package_key_source,
  Optional[Boolean]                       $docker_package_key_check_source   = $docker::params::package_key_check_source,
  Optional[String]                        $docker_package_key_id             = $docker::params::package_key_id,
  Optional[String]                        $docker_package_release            = $docker::params::package_release,
  String                                  $docker_engine_start_command       = $docker::params::docker_engine_start_command,
  String                                  $docker_engine_package_name        = $docker::params::docker_engine_package_name,
  String                                  $docker_ce_channel                 = $docker::params::docker_ce_channel,
  Optional[Boolean]                       $docker_ee                         = $docker::params::docker_ee,
  Optional[String]                        $docker_ee_package_name            = $docker::params::package_ee_package_name,
  Optional[String]                        $docker_ee_source_location         = $docker::params::package_ee_source_location,
  Optional[String]                        $docker_ee_key_source              = $docker::params::package_ee_key_source,
  Optional[String]                        $docker_ee_key_id                  = $docker::params::package_ee_key_id,
  Optional[String]                        $docker_ee_repos                   = $docker::params::package_ee_repos,
  Optional[String]                        $docker_ee_release                 = $docker::params::package_ee_release,
  Optional[Variant[String,Array[String]]] $tcp_bind                          = $docker::params::tcp_bind,
  Boolean                                 $tls_enable                        = $docker::params::tls_enable,
  Boolean                                 $tls_verify                        = $docker::params::tls_verify,
  Optional[String]                        $tls_cacert                        = $docker::params::tls_cacert,
  Optional[String]                        $tls_cert                          = $docker::params::tls_cert,
  Optional[String]                        $tls_key                           = $docker::params::tls_key,
  Boolean                                 $ip_forward                        = $docker::params::ip_forward,
  Boolean                                 $ip_masq                           = $docker::params::ip_masq,
  Optional[Boolean]                       $ipv6                              = $docker::params::ipv6,
  Optional[String]                        $ipv6_cidr                         = $docker::params::ipv6_cidr,
  Optional[String]                        $default_gateway_ipv6              = $docker::params::default_gateway_ipv6,
  Optional[String]                        $bip                               = $docker::params::bip,
  Optional[String]                        $mtu                               = $docker::params::mtu,
  Boolean                                 $iptables                          = $docker::params::iptables,
  Optional[Boolean]                       $icc                               = $docker::params::icc,
  String                                  $socket_bind                       = $docker::params::socket_bind,
  Optional[String]                        $fixed_cidr                        = $docker::params::fixed_cidr,
  Optional[String]                        $bridge                            = $docker::params::bridge,
  Optional[String]                        $default_gateway                   = $docker::params::default_gateway,
  Optional[String]                        $log_level                         = $docker::params::log_level,
  Optional[String]                        $log_driver                        = $docker::params::log_driver,
  Array                                   $log_opt                           = $docker::params::log_opt,
  Optional[Boolean]                       $selinux_enabled                   = $docker::params::selinux_enabled,
  Optional[Boolean]                       $use_upstream_package_source       = $docker::params::use_upstream_package_source,
  Optional[Boolean]                       $pin_upstream_package_source       = $docker::params::pin_upstream_package_source,
  Optional[Integer]                       $apt_source_pin_level              = $docker::params::apt_source_pin_level,
  Optional[String]                        $package_release                   = $docker::params::package_release,
  String                                  $service_state                     = $docker::params::service_state,
  Boolean                                 $service_enable                    = $docker::params::service_enable,
  Boolean                                 $manage_service                    = $docker::params::manage_service,
  Optional[String]                        $root_dir                          = $docker::params::root_dir,
  Optional[Boolean]                       $tmp_dir_config                    = $docker::params::tmp_dir_config,
  Optional[String]                        $tmp_dir                           = $docker::params::tmp_dir,
  Optional[Variant[String,Array]]         $dns                               = $docker::params::dns,
  Optional[Variant[String,Array]]         $dns_search                        = $docker::params::dns_search,
  Optional[Variant[String,Boolean]]       $socket_group                      = $docker::params::socket_group,
  Array                                   $labels                            = $docker::params::labels,
  Optional[Variant[String,Array]]         $extra_parameters                  = undef,
  Optional[Variant[String,Array]]         $shell_values                      = undef,
  Optional[String]                        $proxy                             = $docker::params::proxy,
  Optional[String]                        $no_proxy                          = $docker::params::no_proxy,
  Optional[String]                        $storage_driver                    = $docker::params::storage_driver,
  Optional[String]                        $dm_basesize                       = $docker::params::dm_basesize,
  Optional[String]                        $dm_fs                             = $docker::params::dm_fs,
  Optional[String]                        $dm_mkfsarg                        = $docker::params::dm_mkfsarg,
  Optional[String]                        $dm_mountopt                       = $docker::params::dm_mountopt,
  Optional[String]                        $dm_blocksize                      = $docker::params::dm_blocksize,
  Optional[String]                        $dm_loopdatasize                   = $docker::params::dm_loopdatasize,
  Optional[String]                        $dm_loopmetadatasize               = $docker::params::dm_loopmetadatasize,
  Optional[String]                        $dm_datadev                        = $docker::params::dm_datadev,
  Optional[String]                        $dm_metadatadev                    = $docker::params::dm_metadatadev,
  Optional[String]                        $dm_thinpooldev                    = $docker::params::dm_thinpooldev,
  Optional[Boolean]                       $dm_use_deferred_removal           = $docker::params::dm_use_deferred_removal,
  Optional[Boolean]                       $dm_use_deferred_deletion          = $docker::params::dm_use_deferred_deletion,
  Optional[Boolean]                       $dm_blkdiscard                     = $docker::params::dm_blkdiscard,
  Optional[Boolean]                       $dm_override_udev_sync_check       = $docker::params::dm_override_udev_sync_check,
  Boolean                                 $overlay2_override_kernel_check    = $docker::params::overlay2_override_kernel_check,
  Optional[String]                        $execdriver                        = $docker::params::execdriver,
  Boolean                                 $manage_package                    = $docker::params::manage_package,
  Optional[String]                        $package_source                    = $docker::params::package_source,
  Optional[String]                        $service_name                      = $docker::params::service_name,
  Array                                   $docker_users                      = [],
  Boolean                                 $create_user                       = true,
  String                                  $docker_group                      = $docker::params::docker_group,
  Array                                   $daemon_environment_files          = [],
  Optional[Variant[String,Hash]]          $repo_opt                          = $docker::params::repo_opt,
  Optional[String]                        $os_lc                             = $docker::params::os_lc,
  Optional[String]                        $storage_devs                      = $docker::params::storage_devs,
  Optional[String]                        $storage_vg                        = $docker::params::storage_vg,
  Optional[String]                        $storage_root_size                 = $docker::params::storage_root_size,
  Optional[String]                        $storage_data_size                 = $docker::params::storage_data_size,
  Optional[String]                        $storage_min_data_size             = $docker::params::storage_min_data_size,
  Optional[String]                        $storage_chunk_size                = $docker::params::storage_chunk_size,
  Optional[Boolean]                       $storage_growpart                  = $docker::params::storage_growpart,
  Optional[String]                        $storage_auto_extend_pool          = $docker::params::storage_auto_extend_pool,
  Optional[String]                        $storage_pool_autoextend_threshold = $docker::params::storage_pool_autoextend_threshold,
  Optional[String]                        $storage_pool_autoextend_percent   = $docker::params::storage_pool_autoextend_percent,
  Optional[Variant[String,Boolean]]       $storage_config                    = $docker::params::storage_config,
  Optional[String]                        $storage_config_template           = $docker::params::storage_config_template,
  Optional[String]                        $storage_setup_file                = $docker::params::storage_setup_file,
  Optional[String]                        $service_provider                  = $docker::params::service_provider,
  Optional[Variant[String,Boolean]]       $service_config                    = $docker::params::service_config,
  Optional[String]                        $service_config_template           = $docker::params::service_config_template,
  Optional[Variant[String,Boolean]]       $service_overrides_template        = $docker::params::service_overrides_template,
  Optional[Variant[String,Boolean]]       $socket_overrides_template         = $docker::params::socket_overrides_template,
  Optional[Boolean]                       $socket_override                   = $docker::params::socket_override,
  Optional[Variant[String,Boolean]]       $service_after_override            = $docker::params::service_after_override,
  Optional[Boolean]                       $service_hasstatus                 = $docker::params::service_hasstatus,
  Optional[Boolean]                       $service_hasrestart                = $docker::params::service_hasrestart,
  Optional[Variant[String,Array]]         $registry_mirror                   = $docker::params::registry_mirror,
  Boolean                                 $acknowledge_unsupported_os        = false,

  # Windows specific parameters
  Optional[String]                        $docker_msft_provider_version      = $docker::params::docker_msft_provider_version,
  Optional[String]                        $nuget_package_provider_version    = $docker::params::nuget_package_provider_version,

  Boolean                                 $have_systemd_v230                 = $docker::params::have_systemd_v230,
) inherits docker::params {
  if $facts['os']['family'] and ! $acknowledge_unsupported_os {
    assert_type(Pattern[/^(Debian|RedHat|windows)$/], $facts['os']['family']) |$a, $b| {
      fail('This module only works on Debian, Red Hat or Windows based systems.')
    }
    if ($facts['os']['family'] == 'RedHat') and ($facts['os']['name'] != 'Amazon') and (versioncmp($facts['os']['release']['major'], '7') < 0) {
      fail('This module only works on Red Hat based systems version 7 and higher.')
    } elsif ($facts['os']['name'] == 'Amazon') and ($facts['os']['release']['major'] != '2') and (versioncmp($facts['os']['release']['major'], '2022') < 0) {
      fail('This module only works on Amazon Linux 2 and newer systems.')
    }
  }

  if ($default_gateway) and (!$bridge) {
    fail('You must provide the $bridge parameter.')
  }

  if $log_level {
    assert_type(Pattern[/^(debug|info|warn|error|fatal)$/], $log_level) |$a, $b| {
      fail('log_level must be one of debug, info, warn, error or fatal')
    }
  }

  if $storage_driver {
    if $facts['os']['family'] == 'windows' {
      assert_type(Pattern[/^(windowsfilter)$/], $storage_driver) |$a, $b| {
        fail('Valid values for storage_driver on windows are windowsfilter')
      }
    } else {
      assert_type(Pattern[/^(aufs|devicemapper|btrfs|overlay|overlay2|vfs|zfs)$/], $storage_driver) |$a, $b| {
        fail('Valid values for storage_driver are aufs, devicemapper, btrfs, overlay, overlay2, vfs, zfs.')
      }
    }
  }

  if ($bridge) and ($facts['os']['family'] == 'windows') {
    assert_type(Pattern[/^(none|nat|transparent|overlay|l2bridge|l2tunnel)$/], $bridge) |$a, $b| {
      fail('bridge must be one of none, nat, transparent, overlay, l2bridge or l2tunnel on Windows.')
    }
  }

  if $dm_fs {
    assert_type(Pattern[/^(ext4|xfs)$/], $dm_fs) |$a, $b| {
      fail('Only ext4 and xfs are supported currently for dm_fs.')
    }
  }

  if ($dm_loopdatasize or $dm_loopmetadatasize) and ($dm_datadev or $dm_metadatadev) {
    fail('You should provide parameters only for loop lvm or direct lvm, not both.')
  }

  if ($dm_datadev or $dm_metadatadev) and $dm_thinpooldev {
    fail('You can use the $dm_thinpooldev parameter, or the $dm_datadev and $dm_metadatadev parameter pair, but you cannot use both.') # lint:ignore:140chars
  }

  if ($dm_datadev or $dm_metadatadev) {
    notice('The $dm_datadev and $dm_metadatadev parameter pair are deprecated.  The $dm_thinpooldev parameter should be used instead.')
  }

  if ($dm_datadev and !$dm_metadatadev) or (!$dm_datadev and $dm_metadatadev) {
    fail('You need to provide both $dm_datadev and $dm_metadatadev parameters for direct lvm.')
  }

  if ($dm_basesize or $dm_fs or $dm_mkfsarg or $dm_mountopt or $dm_blocksize or $dm_loopdatasize or $dm_loopmetadatasize or $dm_datadev or $dm_metadatadev) and ($storage_driver != 'devicemapper') {
    fail('Values for dm_ variables will be ignored unless storage_driver is set to devicemapper.')
  }

  if($tls_enable) {
    if(! $tcp_bind) {
      fail('You need to provide tcp bind parameter for TLS.')
    }
  }

  if ($version == undef) or ($version !~ /^(17[.][0-1][0-9][.][0-1](~|-|\.)ce|1.\d+)/) {
    if ($docker_ee) {
      $package_location         = $docker::docker_ee_source_location
      $package_key_source       = $docker::docker_ee_key_source
      $package_key_check_source = $docker_package_key_check_source
      $package_key              = $docker::docker_ee_key_id
      $package_repos            = $docker::docker_ee_repos
      $release                  = $docker::docker_ee_release
      $docker_start_command     = $docker::docker_ee_start_command
      $docker_package_name      = $docker::docker_ee_package_name
    } else {
      case $facts['os']['family'] {
        'Debian' : {
          $package_location   = $docker_ce_source_location
          $package_key_source = $docker_ce_key_source
          $package_key        = $docker_ce_key_id
          $package_repos      = $docker_ce_channel
          $release            = $docker_ce_release
        }
        'RedHat' : {
          $package_location         = $docker_ce_source_location
          $package_key_source       = $docker_ce_key_source
          $package_key_check_source = $docker_package_key_check_source
        }
        'windows': {
          fail('This module only work for Docker Enterprise Edition on Windows.')
        }
        default: {
          $package_location         = $docker_package_location
          $package_key_source       = $docker_package_key_source
          $package_key_check_source = $docker_package_key_check_source
        }
      }

      $docker_start_command = $docker_ce_start_command
      $docker_package_name  = $docker_ce_package_name
    }
  } else {
    case $facts['os']['family'] {
      'Debian': {
        $package_location         = $docker_package_location
        $package_key_source       = $docker_package_key_source
        $package_key_check_source = $docker_package_key_check_source
        $package_key              = $docker_package_key_id
        $package_repos            = 'main'
        $release                  = $docker_package_release
      }
      'RedHat': {
        $package_location         = $docker_package_location
        $package_key_source       = $docker_package_key_source
        $package_key_check_source = $docker_package_key_check_source
      }
      default: {
        $package_location         = $docker_package_location
        $package_key_source       = $docker_package_key_source
        $package_key_check_source = $docker_package_key_check_source
      }
    }

    $docker_start_command = $docker_engine_start_command
    $docker_package_name  = $docker_engine_package_name
  }

  if ($version != undef) and ($version =~ /^(17[.]0[0-4]|1.\d+)/) {
    $root_dir_flag = '-g'
  } else {
    $root_dir_flag = '--data-root'
  }

  if $ensure != 'absent' {
    contain docker::repos
    contain docker::install
    contain docker::config
    contain docker::service

    create_resources(
      'docker::registry',
      lookup("${module_name}::registries", Hash, 'deep', {}),
    )

    create_resources(
      'docker::image',
      lookup("${module_name}::images", Hash, 'deep', {}),
    )

    create_resources(
      'docker::run',
      lookup("${module_name}::runs", Hash, 'deep', {}),
    )

    Class['docker::repos']
    -> Class['docker::install']
    -> Class['docker::config']
    -> Class['docker::service']
    -> Docker::Registry <||>
    -> Docker::Image <||>
    -> Docker::Run <||>
    -> Docker_compose <||>
  } else {
    contain 'docker::repos'
    contain 'docker::install'

    Class['docker::repos'] -> Class['docker::install']
  }
}