Skip to content

Commit 7a7a5c8

Browse files
committed
parameter types and docs
1 parent e6555b5 commit 7a7a5c8

15 files changed

+100
-112
lines changed

.puppet-lint.rc

-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
--relative
2-
--no-parameter_types-check
3-
--no-parameter_documentation-check

.sync.yml

-4
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,3 @@ spec/spec_helper.rb:
3535
unmanaged: false
3636
.travis.yml:
3737
delete: true
38-
Rakefile:
39-
extra_disabled_lint_checks:
40-
- parameter_types
41-
- parameter_documentation

Rakefile

-2
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@ def changelog_future_release
4242
end
4343

4444
PuppetLint.configuration.send('disable_relative')
45-
PuppetLint.configuration.send('disable_parameter_types')
46-
PuppetLint.configuration.send('disable_parameter_documentation')
4745

4846

4947
if Bundler.rubygems.find_name('github_changelog_generator').any?

manifests/images.pp

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# @param images
44
#
55
class docker::images (
6-
$images
6+
Hash $images
77
) {
88
create_resources(docker::image, $images)
99
}

manifests/init.pp

+1
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,7 @@
347347
# @param service_hasstatus
348348
# @param service_hasrestart
349349
# @param acknowledge_unsupported_os
350+
# @param have_systemd_v230
350351
#
351352
class docker (
352353
Optional[String] $version = $docker::params::version,

manifests/install.pp

+6-6
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919
# @param dependent_packages
2020
#
2121
class docker::install (
22-
$version = $docker::version,
23-
$nuget_package_provider_version = $docker::nuget_package_provider_version,
24-
$docker_msft_provider_version = $docker::docker_msft_provider_version,
25-
$docker_ee_package_name = $docker::docker_ee_package_name,
26-
$docker_download_url = $docker::package_location,
27-
$dependent_packages = $docker::dependent_packages,
22+
Optional[String] $version = $docker::version,
23+
Optional[String] $nuget_package_provider_version = $docker::nuget_package_provider_version,
24+
Optional[String] $docker_msft_provider_version = $docker::docker_msft_provider_version,
25+
Optional[String] $docker_ee_package_name = $docker::docker_ee_package_name,
26+
Optional[String] $docker_download_url = $docker::package_location,
27+
Array $dependent_packages = $docker::dependent_packages,
2828
) {
2929
$docker_start_command = $docker::docker_start_command
3030

manifests/plugin.pp

-5
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@
66
# Note that the default behaviour of docker plugin
77
# requires a plugin be disabled before it can be removed
88
#
9-
# @param plugin_name
10-
# The name of the docker plugin
11-
#
129
# @param enabled
1310
# A setting to enable or disable an installed plugin.
1411
#
@@ -35,8 +32,6 @@
3532
#
3633
# @param ensure
3734
#
38-
# @param grant_all_permissions
39-
#
4035
define docker::plugin (
4136
Enum[present,absent] $ensure = 'present',
4237
String $plugin_name = $title,

manifests/plugins.pp

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# @param plugins
44
#
55
class docker::plugins (
6-
$plugins
6+
Hash $plugins
77
) {
88
create_resources(docker::plugin, $plugins)
99
}

manifests/registry_auth.pp

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# @param registries
44
#
55
class docker::registry_auth (
6-
$registries
6+
Hash $registries
77
) {
88
create_resources(docker::registry, $registries)
99
}

manifests/repos.pp

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
# @param architecture
1010
#
1111
class docker::repos (
12-
$location = $docker::package_location,
13-
$key_source = $docker::package_key_source,
14-
$key_check_source = $docker::package_key_check_source,
15-
$architecture = $facts['os']['architecture'],
12+
Optional[String] $location = $docker::package_location,
13+
Optional[String] $key_source = $docker::package_key_source,
14+
Optional[Boolean] $key_check_source = $docker::package_key_check_source,
15+
String $architecture = $facts['os']['architecture'],
1616
) {
1717
ensure_packages($docker::prerequired_packages)
1818

manifests/run_instance.pp

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# @param instance
44
#
55
class docker::run_instance (
6-
$instance
6+
Hash $instance
77
) {
88
create_resources(docker::run, $instance)
99
}

manifests/service.pp

+82-82
Original file line numberDiff line numberDiff line change
@@ -178,88 +178,88 @@
178178
# @param root_dir_flag
179179
#
180180
class docker::service (
181-
$docker_command = $docker::docker_command,
182-
$docker_start_command = $docker::docker_start_command,
183-
$service_name = $docker::service_name,
184-
$tcp_bind = $docker::tcp_bind,
185-
$ip_forward = $docker::ip_forward,
186-
$iptables = $docker::iptables,
187-
$ip_masq = $docker::ip_masq,
188-
$icc = $docker::icc,
189-
$bridge = $docker::bridge,
190-
$fixed_cidr = $docker::fixed_cidr,
191-
$default_gateway = $docker::default_gateway,
192-
$ipv6 = $docker::ipv6,
193-
$ipv6_cidr = $docker::ipv6_cidr,
194-
$default_gateway_ipv6 = $docker::default_gateway_ipv6,
195-
$socket_bind = $docker::socket_bind,
196-
$log_level = $docker::log_level,
197-
$log_driver = $docker::log_driver,
198-
$log_opt = $docker::log_opt,
199-
$selinux_enabled = $docker::selinux_enabled,
200-
$socket_group = $docker::socket_group,
201-
$labels = $docker::labels,
202-
$dns = $docker::dns,
203-
$dns_search = $docker::dns_search,
204-
$service_state = $docker::service_state,
205-
$service_enable = $docker::service_enable,
206-
$manage_service = $docker::manage_service,
207-
$root_dir = $docker::root_dir,
208-
$extra_parameters = $docker::extra_parameters,
209-
$shell_values = $docker::shell_values,
210-
$proxy = $docker::proxy,
211-
$no_proxy = $docker::no_proxy,
212-
$execdriver = $docker::execdriver,
213-
$bip = $docker::bip,
214-
$mtu = $docker::mtu,
215-
$storage_driver = $docker::storage_driver,
216-
$dm_basesize = $docker::dm_basesize,
217-
$dm_fs = $docker::dm_fs,
218-
$dm_mkfsarg = $docker::dm_mkfsarg,
219-
$dm_mountopt = $docker::dm_mountopt,
220-
$dm_blocksize = $docker::dm_blocksize,
221-
$dm_loopdatasize = $docker::dm_loopdatasize,
222-
$dm_loopmetadatasize = $docker::dm_loopmetadatasize,
223-
$dm_datadev = $docker::dm_datadev,
224-
$dm_metadatadev = $docker::dm_metadatadev,
225-
$tmp_dir_config = $docker::tmp_dir_config,
226-
$tmp_dir = $docker::tmp_dir,
227-
$dm_thinpooldev = $docker::dm_thinpooldev,
228-
$dm_use_deferred_removal = $docker::dm_use_deferred_removal,
229-
$dm_use_deferred_deletion = $docker::dm_use_deferred_deletion,
230-
$dm_blkdiscard = $docker::dm_blkdiscard,
231-
$dm_override_udev_sync_check = $docker::dm_override_udev_sync_check,
232-
$overlay2_override_kernel_check = $docker::overlay2_override_kernel_check,
233-
$storage_devs = $docker::storage_devs,
234-
$storage_vg = $docker::storage_vg,
235-
$storage_root_size = $docker::storage_root_size,
236-
$storage_data_size = $docker::storage_data_size,
237-
$storage_min_data_size = $docker::storage_min_data_size,
238-
$storage_chunk_size = $docker::storage_chunk_size,
239-
$storage_growpart = $docker::storage_growpart,
240-
$storage_auto_extend_pool = $docker::storage_auto_extend_pool,
241-
$storage_pool_autoextend_threshold = $docker::storage_pool_autoextend_threshold,
242-
$storage_pool_autoextend_percent = $docker::storage_pool_autoextend_percent,
243-
$storage_config = $docker::storage_config,
244-
$storage_config_template = $docker::storage_config_template,
245-
$storage_setup_file = $docker::storage_setup_file,
246-
$service_provider = $docker::service_provider,
247-
$service_config = $docker::service_config,
248-
$service_config_template = $docker::service_config_template,
249-
$service_overrides_template = $docker::service_overrides_template,
250-
$socket_overrides_template = $docker::socket_overrides_template,
251-
$socket_override = $docker::socket_override,
252-
$service_after_override = $docker::service_after_override,
253-
$service_hasstatus = $docker::service_hasstatus,
254-
$service_hasrestart = $docker::service_hasrestart,
255-
$daemon_environment_files = $docker::daemon_environment_files,
256-
$tls_enable = $docker::tls_enable,
257-
$tls_verify = $docker::tls_verify,
258-
$tls_cacert = $docker::tls_cacert,
259-
$tls_cert = $docker::tls_cert,
260-
$tls_key = $docker::tls_key,
261-
$registry_mirror = $docker::registry_mirror,
262-
$root_dir_flag = $docker::root_dir_flag,
181+
String $docker_command = $docker::docker_command,
182+
String $docker_start_command = $docker::docker_start_command,
183+
Optional[String] $service_name = $docker::service_name,
184+
Optional[Variant[String,Array[String]]] $tcp_bind = $docker::tcp_bind,
185+
Boolean $ip_forward = $docker::ip_forward,
186+
Boolean $iptables = $docker::iptables,
187+
Boolean $ip_masq = $docker::ip_masq,
188+
Optional[Boolean] $icc = $docker::icc,
189+
Optional[String] $bridge = $docker::bridge,
190+
Optional[String] $fixed_cidr = $docker::fixed_cidr,
191+
Optional[String] $default_gateway = $docker::default_gateway,
192+
Optional[Boolean] $ipv6 = $docker::ipv6,
193+
Optional[String] $ipv6_cidr = $docker::ipv6_cidr,
194+
Optional[String] $default_gateway_ipv6 = $docker::default_gateway_ipv6,
195+
String $socket_bind = $docker::socket_bind,
196+
Optional[String] $log_level = $docker::log_level,
197+
Optional[String] $log_driver = $docker::log_driver,
198+
Array $log_opt = $docker::log_opt,
199+
Optional[Boolean] $selinux_enabled = $docker::selinux_enabled,
200+
Optional[Variant[String,Boolean]] $socket_group = $docker::socket_group,
201+
Array $labels = $docker::labels,
202+
Optional[Variant[String,Array]] $dns = $docker::dns,
203+
Optional[Variant[String,Array]] $dns_search = $docker::dns_search,
204+
String $service_state = $docker::service_state,
205+
Boolean $service_enable = $docker::service_enable,
206+
Boolean $manage_service = $docker::manage_service,
207+
Optional[String] $root_dir = $docker::root_dir,
208+
Optional[Variant[String,Array]] $extra_parameters = $docker::extra_parameters,
209+
Optional[Variant[String,Array]] $shell_values = $docker::shell_values,
210+
Optional[String] $proxy = $docker::proxy,
211+
Optional[String] $no_proxy = $docker::no_proxy,
212+
Optional[String] $execdriver = $docker::execdriver,
213+
Optional[String] $bip = $docker::bip,
214+
Optional[String] $mtu = $docker::mtu,
215+
Optional[String] $storage_driver = $docker::storage_driver,
216+
Optional[String] $dm_basesize = $docker::dm_basesize,
217+
Optional[String] $dm_fs = $docker::dm_fs,
218+
Optional[String] $dm_mkfsarg = $docker::dm_mkfsarg,
219+
Optional[String] $dm_mountopt = $docker::dm_mountopt,
220+
Optional[String] $dm_blocksize = $docker::dm_blocksize,
221+
Optional[String] $dm_loopdatasize = $docker::dm_loopdatasize,
222+
Optional[String] $dm_loopmetadatasize = $docker::dm_loopmetadatasize,
223+
Optional[String] $dm_datadev = $docker::dm_datadev,
224+
Optional[String] $dm_metadatadev = $docker::dm_metadatadev,
225+
Optional[Boolean] $tmp_dir_config = $docker::tmp_dir_config,
226+
Optional[String] $tmp_dir = $docker::tmp_dir,
227+
Optional[String] $dm_thinpooldev = $docker::dm_thinpooldev,
228+
Optional[Boolean] $dm_use_deferred_removal = $docker::dm_use_deferred_removal,
229+
Optional[Boolean] $dm_use_deferred_deletion = $docker::dm_use_deferred_deletion,
230+
Optional[Boolean] $dm_blkdiscard = $docker::dm_blkdiscard,
231+
Optional[Boolean] $dm_override_udev_sync_check = $docker::dm_override_udev_sync_check,
232+
Boolean $overlay2_override_kernel_check = $docker::overlay2_override_kernel_check,
233+
Optional[String] $storage_devs = $docker::storage_devs,
234+
Optional[String] $storage_vg = $docker::storage_vg,
235+
Optional[String] $storage_root_size = $docker::storage_root_size,
236+
Optional[String] $storage_data_size = $docker::storage_data_size,
237+
Optional[String] $storage_min_data_size = $docker::storage_min_data_size,
238+
Optional[String] $storage_chunk_size = $docker::storage_chunk_size,
239+
Optional[Boolean] $storage_growpart = $docker::storage_growpart,
240+
Optional[String] $storage_auto_extend_pool = $docker::storage_auto_extend_pool,
241+
Optional[String] $storage_pool_autoextend_threshold = $docker::storage_pool_autoextend_threshold,
242+
Optional[String] $storage_pool_autoextend_percent = $docker::storage_pool_autoextend_percent,
243+
Optional[Variant[String,Boolean]] $storage_config = $docker::storage_config,
244+
Optional[String] $storage_config_template = $docker::storage_config_template,
245+
Optional[String] $storage_setup_file = $docker::storage_setup_file,
246+
Optional[String] $service_provider = $docker::service_provider,
247+
Optional[Variant[String,Boolean]] $service_config = $docker::service_config,
248+
Optional[String] $service_config_template = $docker::service_config_template,
249+
Optional[Variant[String,Boolean]] $service_overrides_template = $docker::service_overrides_template,
250+
Optional[Variant[String,Boolean]] $socket_overrides_template = $docker::socket_overrides_template,
251+
Optional[Boolean] $socket_override = $docker::socket_override,
252+
Optional[Variant[String,Boolean]] $service_after_override = $docker::service_after_override,
253+
Optional[Boolean] $service_hasstatus = $docker::service_hasstatus,
254+
Optional[Boolean] $service_hasrestart = $docker::service_hasrestart,
255+
Array $daemon_environment_files = $docker::daemon_environment_files,
256+
Boolean $tls_enable = $docker::tls_enable,
257+
Boolean $tls_verify = $docker::tls_verify,
258+
Optional[String] $tls_cacert = $docker::tls_cacert,
259+
Optional[String] $tls_cert = $docker::tls_cert,
260+
Optional[String] $tls_key = $docker::tls_key,
261+
Optional[Variant[String,Array]] $registry_mirror = $docker::registry_mirror,
262+
String $root_dir_flag = $docker::root_dir_flag,
263263
) {
264264
unless $facts['os']['family'] =~ /(Debian|RedHat|windows)/ or $docker::acknowledge_unsupported_os {
265265
fail('The docker::service class needs a Debian, Redhat or Windows based system.')

manifests/swarms.pp

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# @param swarms
44
#
55
class docker::swarms (
6-
$swarms
6+
Hash $swarms
77
) {
88
create_resources(docker::swarm, $swarms)
99
}

manifests/system_user.pp

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# Boolean to cotrol whether the user should be created
55
#
66
define docker::system_user (
7-
$create_user = true
7+
Boolean $create_user = true
88
) {
99
include docker
1010

manifests/volumes.pp

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# @param volumes
44
#
55
class docker::volumes (
6-
$volumes
6+
Hash $volumes
77
) {
88
create_resources(docker_volume, $volumes)
99
}

0 commit comments

Comments
 (0)