From 7a7a5c804dad977e3dfad870d105c2b4d8fb6a0e Mon Sep 17 00:00:00 2001 From: Lukas Audzevicius Date: Tue, 21 Feb 2023 11:20:47 +0000 Subject: [PATCH] parameter types and docs --- .puppet-lint.rc | 2 - .sync.yml | 4 - Rakefile | 2 - manifests/images.pp | 2 +- manifests/init.pp | 1 + manifests/install.pp | 12 +-- manifests/plugin.pp | 5 -- manifests/plugins.pp | 2 +- manifests/registry_auth.pp | 2 +- manifests/repos.pp | 8 +- manifests/run_instance.pp | 2 +- manifests/service.pp | 164 ++++++++++++++++++------------------- manifests/swarms.pp | 2 +- manifests/system_user.pp | 2 +- manifests/volumes.pp | 2 +- 15 files changed, 100 insertions(+), 112 deletions(-) diff --git a/.puppet-lint.rc b/.puppet-lint.rc index 1d38d542..cc96ece0 100644 --- a/.puppet-lint.rc +++ b/.puppet-lint.rc @@ -1,3 +1 @@ --relative ---no-parameter_types-check ---no-parameter_documentation-check diff --git a/.sync.yml b/.sync.yml index 424900a9..cf21eb72 100644 --- a/.sync.yml +++ b/.sync.yml @@ -35,7 +35,3 @@ spec/spec_helper.rb: unmanaged: false .travis.yml: delete: true -Rakefile: - extra_disabled_lint_checks: - - parameter_types - - parameter_documentation diff --git a/Rakefile b/Rakefile index 94e70d80..0f8754eb 100644 --- a/Rakefile +++ b/Rakefile @@ -42,8 +42,6 @@ def changelog_future_release end PuppetLint.configuration.send('disable_relative') -PuppetLint.configuration.send('disable_parameter_types') -PuppetLint.configuration.send('disable_parameter_documentation') if Bundler.rubygems.find_name('github_changelog_generator').any? diff --git a/manifests/images.pp b/manifests/images.pp index 96372f7e..35d2138a 100644 --- a/manifests/images.pp +++ b/manifests/images.pp @@ -3,7 +3,7 @@ # @param images # class docker::images ( - $images + Hash $images ) { create_resources(docker::image, $images) } diff --git a/manifests/init.pp b/manifests/init.pp index 4a8b0b6f..29984e62 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -347,6 +347,7 @@ # @param service_hasstatus # @param service_hasrestart # @param acknowledge_unsupported_os +# @param have_systemd_v230 # class docker ( Optional[String] $version = $docker::params::version, diff --git a/manifests/install.pp b/manifests/install.pp index 039effbe..4dc2f238 100644 --- a/manifests/install.pp +++ b/manifests/install.pp @@ -19,12 +19,12 @@ # @param dependent_packages # class docker::install ( - $version = $docker::version, - $nuget_package_provider_version = $docker::nuget_package_provider_version, - $docker_msft_provider_version = $docker::docker_msft_provider_version, - $docker_ee_package_name = $docker::docker_ee_package_name, - $docker_download_url = $docker::package_location, - $dependent_packages = $docker::dependent_packages, + Optional[String] $version = $docker::version, + Optional[String] $nuget_package_provider_version = $docker::nuget_package_provider_version, + Optional[String] $docker_msft_provider_version = $docker::docker_msft_provider_version, + Optional[String] $docker_ee_package_name = $docker::docker_ee_package_name, + Optional[String] $docker_download_url = $docker::package_location, + Array $dependent_packages = $docker::dependent_packages, ) { $docker_start_command = $docker::docker_start_command diff --git a/manifests/plugin.pp b/manifests/plugin.pp index 836aaea1..ff20ce9d 100644 --- a/manifests/plugin.pp +++ b/manifests/plugin.pp @@ -6,9 +6,6 @@ # Note that the default behaviour of docker plugin # requires a plugin be disabled before it can be removed # -# @param plugin_name -# The name of the docker plugin -# # @param enabled # A setting to enable or disable an installed plugin. # @@ -35,8 +32,6 @@ # # @param ensure # -# @param grant_all_permissions -# define docker::plugin ( Enum[present,absent] $ensure = 'present', String $plugin_name = $title, diff --git a/manifests/plugins.pp b/manifests/plugins.pp index 382bcb83..97372c16 100644 --- a/manifests/plugins.pp +++ b/manifests/plugins.pp @@ -3,7 +3,7 @@ # @param plugins # class docker::plugins ( - $plugins + Hash $plugins ) { create_resources(docker::plugin, $plugins) } diff --git a/manifests/registry_auth.pp b/manifests/registry_auth.pp index 354efc9c..55864349 100644 --- a/manifests/registry_auth.pp +++ b/manifests/registry_auth.pp @@ -3,7 +3,7 @@ # @param registries # class docker::registry_auth ( - $registries + Hash $registries ) { create_resources(docker::registry, $registries) } diff --git a/manifests/repos.pp b/manifests/repos.pp index 76bff8eb..2e27614a 100644 --- a/manifests/repos.pp +++ b/manifests/repos.pp @@ -9,10 +9,10 @@ # @param architecture # class docker::repos ( - $location = $docker::package_location, - $key_source = $docker::package_key_source, - $key_check_source = $docker::package_key_check_source, - $architecture = $facts['os']['architecture'], + Optional[String] $location = $docker::package_location, + Optional[String] $key_source = $docker::package_key_source, + Optional[Boolean] $key_check_source = $docker::package_key_check_source, + String $architecture = $facts['os']['architecture'], ) { ensure_packages($docker::prerequired_packages) diff --git a/manifests/run_instance.pp b/manifests/run_instance.pp index e000940e..27be0aed 100644 --- a/manifests/run_instance.pp +++ b/manifests/run_instance.pp @@ -3,7 +3,7 @@ # @param instance # class docker::run_instance ( - $instance + Hash $instance ) { create_resources(docker::run, $instance) } diff --git a/manifests/service.pp b/manifests/service.pp index 0c64d48a..b4472ded 100644 --- a/manifests/service.pp +++ b/manifests/service.pp @@ -178,88 +178,88 @@ # @param root_dir_flag # class docker::service ( - $docker_command = $docker::docker_command, - $docker_start_command = $docker::docker_start_command, - $service_name = $docker::service_name, - $tcp_bind = $docker::tcp_bind, - $ip_forward = $docker::ip_forward, - $iptables = $docker::iptables, - $ip_masq = $docker::ip_masq, - $icc = $docker::icc, - $bridge = $docker::bridge, - $fixed_cidr = $docker::fixed_cidr, - $default_gateway = $docker::default_gateway, - $ipv6 = $docker::ipv6, - $ipv6_cidr = $docker::ipv6_cidr, - $default_gateway_ipv6 = $docker::default_gateway_ipv6, - $socket_bind = $docker::socket_bind, - $log_level = $docker::log_level, - $log_driver = $docker::log_driver, - $log_opt = $docker::log_opt, - $selinux_enabled = $docker::selinux_enabled, - $socket_group = $docker::socket_group, - $labels = $docker::labels, - $dns = $docker::dns, - $dns_search = $docker::dns_search, - $service_state = $docker::service_state, - $service_enable = $docker::service_enable, - $manage_service = $docker::manage_service, - $root_dir = $docker::root_dir, - $extra_parameters = $docker::extra_parameters, - $shell_values = $docker::shell_values, - $proxy = $docker::proxy, - $no_proxy = $docker::no_proxy, - $execdriver = $docker::execdriver, - $bip = $docker::bip, - $mtu = $docker::mtu, - $storage_driver = $docker::storage_driver, - $dm_basesize = $docker::dm_basesize, - $dm_fs = $docker::dm_fs, - $dm_mkfsarg = $docker::dm_mkfsarg, - $dm_mountopt = $docker::dm_mountopt, - $dm_blocksize = $docker::dm_blocksize, - $dm_loopdatasize = $docker::dm_loopdatasize, - $dm_loopmetadatasize = $docker::dm_loopmetadatasize, - $dm_datadev = $docker::dm_datadev, - $dm_metadatadev = $docker::dm_metadatadev, - $tmp_dir_config = $docker::tmp_dir_config, - $tmp_dir = $docker::tmp_dir, - $dm_thinpooldev = $docker::dm_thinpooldev, - $dm_use_deferred_removal = $docker::dm_use_deferred_removal, - $dm_use_deferred_deletion = $docker::dm_use_deferred_deletion, - $dm_blkdiscard = $docker::dm_blkdiscard, - $dm_override_udev_sync_check = $docker::dm_override_udev_sync_check, - $overlay2_override_kernel_check = $docker::overlay2_override_kernel_check, - $storage_devs = $docker::storage_devs, - $storage_vg = $docker::storage_vg, - $storage_root_size = $docker::storage_root_size, - $storage_data_size = $docker::storage_data_size, - $storage_min_data_size = $docker::storage_min_data_size, - $storage_chunk_size = $docker::storage_chunk_size, - $storage_growpart = $docker::storage_growpart, - $storage_auto_extend_pool = $docker::storage_auto_extend_pool, - $storage_pool_autoextend_threshold = $docker::storage_pool_autoextend_threshold, - $storage_pool_autoextend_percent = $docker::storage_pool_autoextend_percent, - $storage_config = $docker::storage_config, - $storage_config_template = $docker::storage_config_template, - $storage_setup_file = $docker::storage_setup_file, - $service_provider = $docker::service_provider, - $service_config = $docker::service_config, - $service_config_template = $docker::service_config_template, - $service_overrides_template = $docker::service_overrides_template, - $socket_overrides_template = $docker::socket_overrides_template, - $socket_override = $docker::socket_override, - $service_after_override = $docker::service_after_override, - $service_hasstatus = $docker::service_hasstatus, - $service_hasrestart = $docker::service_hasrestart, - $daemon_environment_files = $docker::daemon_environment_files, - $tls_enable = $docker::tls_enable, - $tls_verify = $docker::tls_verify, - $tls_cacert = $docker::tls_cacert, - $tls_cert = $docker::tls_cert, - $tls_key = $docker::tls_key, - $registry_mirror = $docker::registry_mirror, - $root_dir_flag = $docker::root_dir_flag, + String $docker_command = $docker::docker_command, + String $docker_start_command = $docker::docker_start_command, + Optional[String] $service_name = $docker::service_name, + Optional[Variant[String,Array[String]]] $tcp_bind = $docker::tcp_bind, + Boolean $ip_forward = $docker::ip_forward, + Boolean $iptables = $docker::iptables, + Boolean $ip_masq = $docker::ip_masq, + Optional[Boolean] $icc = $docker::icc, + Optional[String] $bridge = $docker::bridge, + Optional[String] $fixed_cidr = $docker::fixed_cidr, + Optional[String] $default_gateway = $docker::default_gateway, + Optional[Boolean] $ipv6 = $docker::ipv6, + Optional[String] $ipv6_cidr = $docker::ipv6_cidr, + Optional[String] $default_gateway_ipv6 = $docker::default_gateway_ipv6, + String $socket_bind = $docker::socket_bind, + Optional[String] $log_level = $docker::log_level, + Optional[String] $log_driver = $docker::log_driver, + Array $log_opt = $docker::log_opt, + Optional[Boolean] $selinux_enabled = $docker::selinux_enabled, + Optional[Variant[String,Boolean]] $socket_group = $docker::socket_group, + Array $labels = $docker::labels, + Optional[Variant[String,Array]] $dns = $docker::dns, + Optional[Variant[String,Array]] $dns_search = $docker::dns_search, + String $service_state = $docker::service_state, + Boolean $service_enable = $docker::service_enable, + Boolean $manage_service = $docker::manage_service, + Optional[String] $root_dir = $docker::root_dir, + Optional[Variant[String,Array]] $extra_parameters = $docker::extra_parameters, + Optional[Variant[String,Array]] $shell_values = $docker::shell_values, + Optional[String] $proxy = $docker::proxy, + Optional[String] $no_proxy = $docker::no_proxy, + Optional[String] $execdriver = $docker::execdriver, + Optional[String] $bip = $docker::bip, + Optional[String] $mtu = $docker::mtu, + Optional[String] $storage_driver = $docker::storage_driver, + Optional[String] $dm_basesize = $docker::dm_basesize, + Optional[String] $dm_fs = $docker::dm_fs, + Optional[String] $dm_mkfsarg = $docker::dm_mkfsarg, + Optional[String] $dm_mountopt = $docker::dm_mountopt, + Optional[String] $dm_blocksize = $docker::dm_blocksize, + Optional[String] $dm_loopdatasize = $docker::dm_loopdatasize, + Optional[String] $dm_loopmetadatasize = $docker::dm_loopmetadatasize, + Optional[String] $dm_datadev = $docker::dm_datadev, + Optional[String] $dm_metadatadev = $docker::dm_metadatadev, + Optional[Boolean] $tmp_dir_config = $docker::tmp_dir_config, + Optional[String] $tmp_dir = $docker::tmp_dir, + Optional[String] $dm_thinpooldev = $docker::dm_thinpooldev, + Optional[Boolean] $dm_use_deferred_removal = $docker::dm_use_deferred_removal, + Optional[Boolean] $dm_use_deferred_deletion = $docker::dm_use_deferred_deletion, + Optional[Boolean] $dm_blkdiscard = $docker::dm_blkdiscard, + Optional[Boolean] $dm_override_udev_sync_check = $docker::dm_override_udev_sync_check, + Boolean $overlay2_override_kernel_check = $docker::overlay2_override_kernel_check, + Optional[String] $storage_devs = $docker::storage_devs, + Optional[String] $storage_vg = $docker::storage_vg, + Optional[String] $storage_root_size = $docker::storage_root_size, + Optional[String] $storage_data_size = $docker::storage_data_size, + Optional[String] $storage_min_data_size = $docker::storage_min_data_size, + Optional[String] $storage_chunk_size = $docker::storage_chunk_size, + Optional[Boolean] $storage_growpart = $docker::storage_growpart, + Optional[String] $storage_auto_extend_pool = $docker::storage_auto_extend_pool, + Optional[String] $storage_pool_autoextend_threshold = $docker::storage_pool_autoextend_threshold, + Optional[String] $storage_pool_autoextend_percent = $docker::storage_pool_autoextend_percent, + Optional[Variant[String,Boolean]] $storage_config = $docker::storage_config, + Optional[String] $storage_config_template = $docker::storage_config_template, + Optional[String] $storage_setup_file = $docker::storage_setup_file, + Optional[String] $service_provider = $docker::service_provider, + Optional[Variant[String,Boolean]] $service_config = $docker::service_config, + Optional[String] $service_config_template = $docker::service_config_template, + Optional[Variant[String,Boolean]] $service_overrides_template = $docker::service_overrides_template, + Optional[Variant[String,Boolean]] $socket_overrides_template = $docker::socket_overrides_template, + Optional[Boolean] $socket_override = $docker::socket_override, + Optional[Variant[String,Boolean]] $service_after_override = $docker::service_after_override, + Optional[Boolean] $service_hasstatus = $docker::service_hasstatus, + Optional[Boolean] $service_hasrestart = $docker::service_hasrestart, + Array $daemon_environment_files = $docker::daemon_environment_files, + Boolean $tls_enable = $docker::tls_enable, + Boolean $tls_verify = $docker::tls_verify, + Optional[String] $tls_cacert = $docker::tls_cacert, + Optional[String] $tls_cert = $docker::tls_cert, + Optional[String] $tls_key = $docker::tls_key, + Optional[Variant[String,Array]] $registry_mirror = $docker::registry_mirror, + String $root_dir_flag = $docker::root_dir_flag, ) { unless $facts['os']['family'] =~ /(Debian|RedHat|windows)/ or $docker::acknowledge_unsupported_os { fail('The docker::service class needs a Debian, Redhat or Windows based system.') diff --git a/manifests/swarms.pp b/manifests/swarms.pp index d63ad932..1e4a9ef1 100644 --- a/manifests/swarms.pp +++ b/manifests/swarms.pp @@ -3,7 +3,7 @@ # @param swarms # class docker::swarms ( - $swarms + Hash $swarms ) { create_resources(docker::swarm, $swarms) } diff --git a/manifests/system_user.pp b/manifests/system_user.pp index e5c05608..42fbc14f 100644 --- a/manifests/system_user.pp +++ b/manifests/system_user.pp @@ -4,7 +4,7 @@ # Boolean to cotrol whether the user should be created # define docker::system_user ( - $create_user = true + Boolean $create_user = true ) { include docker diff --git a/manifests/volumes.pp b/manifests/volumes.pp index 9b1346eb..3ec1e0ca 100644 --- a/manifests/volumes.pp +++ b/manifests/volumes.pp @@ -3,7 +3,7 @@ # @param volumes # class docker::volumes ( - $volumes + Hash $volumes ) { create_resources(docker_volume, $volumes) }