Merge pull request #697 from bastelfreak/tls13

Cleanup puppet-lint/regenerate REFERENCE.md

manifests/config/fragment.pp

@@ -25,14 +25,14 @@
 #     }}',
 #   }
 #
-# @param [String] content
+# @param content
 #   Content to insert in file specified in target.
 #
-# @param [Stdlib::Absolutepath]target
+# @param target
 #   Destination config file to store in this fragment. File will be declared the
 #   first time.
 #
-# @param [Variant[String, Integer]] order
+# @param order
 #   String or integer to set the position in the target file, sorted in alpha numeric order. Defaults to `00`.
 #
 define icinga2::config::fragment(

manifests/feature/api.pp

@@ -48,10 +48,10 @@
 #     tag    => 'icinga2::config::file',
 #   }
 #
-# @param [Enum['absent', 'present']] ensure
+# @param ensure
 #   Set to present enables the feature api, absent disabled it.
 #
-# @param [Enum['ca', 'icinga2', 'none', 'puppet']] pki
+# @param pki
 #   Provides multiple sources for the certificate, key and ca.
 #   - puppet: Copies the key, cert and CAcert from the Puppet ssl directory to the cert directory
 #             /var/lib/icinga2/certs on Linux and C:/ProgramData/icinga2/var/lib/icinga2/certs on Windows.
@@ -65,88 +65,88 @@
 #   - none: Does nothing and you either have to manage the files yourself as file resources
 #           or use the ssl_key, ssl_cert, ssl_cacert parameters.
 #
-# @param [Optional[Stdlib::Base64]] ssl_key
+# @param ssl_key
 #   The private key in a base64 encoded string to store in cert directory. This parameter
 #   requires pki to be set to 'none'.
 #
-# @param [Optional[Stdlib::Base64]] ssl_cert
+# @param ssl_cert
 #   The certificate in a base64 encoded string to store in cert directory This parameter
 #    requires pki to be set to 'none'.
 #
-# @param [Optional[Stdlib::Base64]] ssl_cacert
+# @param ssl_cacert
 #   The CA root certificate in a base64 encoded string to store in cert directory. This parameter
 #   requires pki to be set to 'none'.
 #
-# @param [Optional[Stdlib::Absolutepath]] ssl_crl
+# @param ssl_crl
 #   Optional location of the certificate revocation list.
 #
-# @param [Optional[Boolean]] accept_config
+# @param accept_config
 #   Accept zone configuration.
 #
-# @param [Optional[Boolean]] accept_commands
+# @param accept_commands
 #   Accept remote commands.
 #
-# @param [Optional[Integer[0]]] max_anonymous_clients
+# @param max_anonymous_clients
 #   Limit the number of anonymous client connections (not configured endpoints and signing requests).
 #
-# @param [Optional[Stdlib::Host]] ca_host
+# @param ca_host
 #   This host will be connected to request the certificate. Set this if you use the icinga2 pki.
 #
-# @param [Stdlib::Port::Unprivileged] ca_port
+# @param ca_port
 #   Port of the 'ca_host'.
 #
-# @param [Optional[Icinga2::Fingerprint]] fingerprint
+# @param fingerprint
 #   Fingerprint of the CA host certificate for validation. Requires pki is set to `icinga2`.
 #   You can get the fingerprint via 'openssl x509 -noout -fingerprint -sha256 -inform pem -in [certificate-file.crt]'
 #   on your CA host. (Icinga2 versions before 2.12.0 require '-sha1' as digest algorithm.)
 #
-# @param Variant[[String, Sensitive[String]] ticket_salt
+# @param ticket_salt
 #   Salt to use for ticket generation. The salt is stored to api.conf if none or ca is chosen for pki.
 #   Defaults to constant TicketSalt. Keep in mind this parameter is parsed so please use only alpha numric
 #   characters as salt or a constant.
 #
-# @param [Optional[Variant[String, Sensitive[String]]]] ticket_id
+# @param ticket_id
 #   If a ticket_id is given it will be used instead of generating an ticket_id.
 #   The ticket_id will be used only when requesting a certificate from the ca_host
 #   in case the pki is set to 'icinga2'.
 #
-# @param [Hash[String, Hash]] endpoints
+# @param endpoints
 #   Hash to configure endpoint objects. `NodeName` is a icnga2 constant.
 #
-# @param [Hash[String, Hash]] zones
+# @param zones
 #   Hash to configure zone objects. `ZoneName` and `NodeName` are icinga2 constants.
 #
-# @param [Optional[Enum['TLSv1', 'TLSv1.1', 'TLSv1.2']]] ssl_protocolmin
+# @param ssl_protocolmin
 #   Minimal TLS version to require.
 #
-# @param [Optional[Icinga2::Interval]] ssl_handshake_timeout
+# @param ssl_handshake_timeout
 #   TLS Handshake timeout.
 #
-# @param [Optional[Icinga2::Interval]] connect_timeout
+# @param connect_timeout
 #   Timeout for establishing new connections.
 #
-# @param [Optional[String]] ssl_cipher_list
+# @param ssl_cipher_list
 #   List of allowed TLS ciphers, to finetune encryption.
 #
-# @param [Optional[Stdlib::Host]] bind_host
+# @param bind_host
 #   The IP address the api listener will be bound to.
 #
-# @param [Optional[Stdlib::Port::Unprivileged]] bind_port
+# @param bind_port
 #   The port the api listener will be bound to.
 #
-# @param [Optional[Array[String]]] access_control_allow_origin
+# @param access_control_allow_origin
 #  Specifies an array of origin URLs that may access the API.
 #
-# @param [Optional[Boolean]] access_control_allow_credentials
+# @param access_control_allow_credentials
 #  Indicates whether or not the actual request can be made using credentials.
 #
-# @param [Optional[String]] access_control_allow_headers
+# @param access_control_allow_headers
 #  Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request.
 #
-# @param [Optional[Array[Enum['GET', 'POST', 'PUT', 'DELETE']]]] access_control_allow_methods
+# @param access_control_allow_methods
 #  Used in response to a preflight request to indicate which HTTP methods can be used when making the actual request.
 #
-# @param [Optional[String]] environment
+# @param environment
 #  Used as suffix in TLS SNI extension name; default from constant ApiEnvironment, which is empty.
 #
 class icinga2::feature::api(

manifests/feature/checker.pp

@@ -1,11 +1,12 @@
 # @summary
 #   Configures the Icinga 2 feature checker.
 #
-# @param [Enum['absent', 'present']] ensure
+# @param ensure
 #   Set to present enables the feature checker, absent disabled it.
 #
-# @param [Optional[Integer[1]]] concurrent_checks
+# @param concurrent_checks
 #   The maximum number of concurrent checks.
+#
 # @note Deprecated in Icinga 2.11, replaced by global constant
 #   MaxConcurrentChecks which will be set if you still use concurrent_checks.
 #

manifests/feature/command.pp

@@ -1,10 +1,10 @@
 # @summary
 #   Configures the Icinga 2 feature command.
 #
-# @param [Enum['absent', 'present']] ensure
+# @param ensure
 #   Set to present to enable the feature command, absent to disabled it.
 #
-# @param [Optional[Stdlib::Absolutepath]] command_path
+# @param command_path
 #   Absolute path to the command pipe.
 #
 class icinga2::feature::command(

manifests/feature/compatlog.pp

@@ -1,13 +1,13 @@
 # @summary
 #   Configures the Icinga 2 feature compatlog.
 #
-# @param [Enum['absent', 'present']] ensure
+# @param ensure
 #   Set to present enables the feature compatlog, absent disabled it.
 #
-# @param [Optional[Stdlib::Absolutepath]] log_dir
+# @param log_dir
 #   Absolute path to the log directory.
 #
-# @param [Optional[Enum['DAILY', 'HOURLY', 'MONTHLY', 'WEEKLY']]] rotation_method
+# @param rotation_method
 #   Sets how often should the log file be rotated.
 #
 class icinga2::feature::compatlog(

manifests/feature/debuglog.pp

@@ -1,10 +1,10 @@
 # @summary
 #   Configures the Icinga 2 feature mainlog.
 #
-# @param [Enum['absent', 'present']] ensure
+# @param ensure
 #   Set to present enables the feature mainlog, absent disables it.
 #
-# @param [Stdlib::Absolutepath] path
+# @param path
 #   Absolute path to the log file.
 #
 class icinga2::feature::debuglog(

manifests/feature/elasticsearch.pp

@@ -7,58 +7,58 @@
 #     index    => "icinga2"
 #   }
 #
-# @param [Enum['absent', 'present']] ensure
+# @param ensure
 #   Set to present enables the feature elasticsearch, absent disables it.
 #
-# @param [Optional[Stdlib::Host]] host
+# @param host
 #    Elasticsearch host address.
 #
-# @param [Optional[Stdlib::Port::Unprivileged]] port
+# @param port
 #    Elasticsearch HTTP port.
 #
-# @param [Optional[String]] index
+# @param index
 #    Elasticsearch index name.
 #
-# @param [Optional[String]] username
+# @param username
 #    Elasticsearch user name.
 #
-# @param [Optional[Variant[String, Sensitive[String]]]] password
+# @param password
 #    Elasticsearch user password. The password parameter isn't parsed anymore.
 #
-# @param [Optional[Boolean]] enable_ssl
+# @param enable_ssl
 #    Either enable or disable SSL. Other SSL parameters are only affected if this is set to 'true'.
 #
-# @param [Optional[Boolean]] ssl_noverify
+# @param ssl_noverify
 #     Disable TLS peer verification.
 #
-# @param [Optional[Stdlib::Absolutepath]] ssl_key_path
+# @param ssl_key_path
 #   Location of the private key.
 #
-# @param [Optional[Stdlib::Absolutepath]] ssl_cert_path
+# @param ssl_cert_path
 #   Location of the certificate.
 #
-# @param [Optional[Stdlib::Absolutepath]] ssl_cacert_path
+# @param ssl_cacert_path
 #   Location of the CA certificate.
 #
-# @param [Optional[Stdlib::Base64]] ssl_key
+# @param ssl_key
 #   The private key in a base64 encoded string to store in spicified ssl_key_path file.
 #
-# @param [Optional[Stdlib::Base64]] ssl_cert
+# @param ssl_cert
 #   The certificate in a base64 encoded to store in spicified ssl_cert_path file.
 #
-# @param [Optional[Stdlib::Base64]] ssl_cacert
+# @param ssl_cacert
 #   The CA root certificate in a base64 encoded string to store in spicified ssl_cacert_path file.
 #
-# @param [Optional[Boolean]] enable_send_perfdata
+# @param enable_send_perfdata
 #   Whether to send check performance data metrics.
 #
-# @param [Optional[Icinga2::Interval]] flush_interval
+# @param flush_interval
 #   How long to buffer data points before transferring to Elasticsearch.
 #
-# @param [Optional[Integer]] flush_threshold
+# @param flush_threshold
 #   How many data points to buffer before forcing a transfer to Elasticsearch.
 #
-# @param [Optional[Boolean]] enable_ha
+# @param enable_ha
 #   Enable the high availability functionality. Only valid in a cluster setup.
 #
 class icinga2::feature::elasticsearch(

manifests/feature/gelf.pp

@@ -1,49 +1,49 @@
 # @summary
 #   Configures the Icinga 2 feature gelf.
 #
-# @param [Enum['absent', 'present']] ensure
+# @param ensure
 #   Set to present enables the feature gelf, absent disables it.
 #
-# @param [Optional[Stdlib::Host]] host
+# @param host
 #   GELF receiver host address.
 #
-# @param [Optional[Stdlib::Port::Unprivileged]] port
+# @param port
 #   GELF receiver port.
 #
-# @param [Optional[String]] source
+# @param source
 #   Source name for this instance.
 #
-# @param [Boolean] enable_ssl
+# @param enable_ssl
 #    Either enable or disable SSL/TLS. Other SSL parameters are only affected if this is set to 'true'.
 #
-# @param [Optional[Stdlib::Absolutepath]] ssl_key_path
+# @param ssl_key_path
 #   Location of the private key. Only valid if ssl is enabled.
 #
-# @param [Optional[Stdlib::Absolutepath]] ssl_cert_path
+# @param ssl_cert_path
 #   Location of the certificate. Only valid if ssl is enabled.
 #
-# @param [Optional[Stdlib::Absolutepath]] ssl_cacert_path
+# @param ssl_cacert_path
 #   Location of the CA certificate. Only valid if ssl is enabled.
 #
-# @param [Optional[Stdlib::Base64]] ssl_key
+# @param ssl_key
 #   The private key in a base64 encoded string to store in spicified ssl_key_path file.
 #   Only valid if ssl is enabled.
 #
-# @param [Optional[Stdlib::Base64]] ssl_cert
+# @param ssl_cert
 #   The certificate in a base64 encoded string to store in spicified ssl_cert_path file.
 #   Only valid if ssl is enabled.
 #
-# @param [Optional[Stdlib::Base64]] ssl_cacert
+# @param ssl_cacert
 #   The CA root certificate in a base64 encoded string to store in spicified ssl_cacert_path file.
 #   Only valid if ssl is enabled.
 #
-# @param [Optional[Boolean]] ssl_noverify
+# @param ssl_noverify
 #     Disable TLS peer verification.
 #
-# @param [Optional[Boolean]] enable_send_perfdata
+# @param enable_send_perfdata
 #   Enable performance data for 'CHECK RESULT' events.
 #
-# @param [Optional[Boolean]] enable_ha
+# @param enable_ha
 #   Enable the high availability functionality. Only valid in a cluster setup.
 #
 class icinga2::feature::gelf(

manifests/feature/graphite.pp

@@ -9,24 +9,24 @@
 #     enable_send_metadata   => true,
 #   }
 #
-# @param [Enum['absent', 'present']] ensure
+# @param ensure
 #   Set to present enables the feature graphite, absent disabled it.
 #
-# @param [Optional[Stdlib::Host]] host
+# @param host
 #   Graphite Carbon host address.
 #
-# @param [Optional[Stdlib::Port::Unprivileged]] port
+# @param port
 #   Graphite Carbon port.
 #
-# @param [Optional[String]] host_name_template
+# @param host_name_template
 #   Template for metric path of hosts.
 #
-# @param [Optional[String]] service_name_template
+# @param service_name_template
 #   Template for metric path of services.
 #
-# @param [Optional[Boolean]] enable_send_thresholds
+# @param enable_send_thresholds
 #
-# @param [Optional[Boolean]] enable_send_metadata
+# @param enable_send_metadata
 #
 # @param [Optional[Boolean]] enable_ha
 #   Enable the high availability functionality. Only valid in a cluster setup.