diff --git a/CHANGELOG.md b/CHANGELOG.md index 51cad334..d442e64b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,20 @@ # Change Log +## [v3.5.0](https://github.com/icinga/puppet-icinga2/tree/v3.5.0) (2022-12-16) +[Full Changelog](https://github.com/icinga/puppet-icinga2/compare/v3.4.1...v3.5.0) + +**Implemented enhancements:** + +- Add support for EL9 [\#716](https://github.com/Icinga/puppet-icinga2/pull/716) ([lbetz](https://github.com/lbetz)) +- Add Ubuntu Jammy support [\#715](https://github.com/Icinga/puppet-icinga2/pull/715) ([lbetz](https://github.com/lbetz)) +- Rewrite some feature classes [\#714](https://github.com/Icinga/puppet-icinga2/pull/714) ([lbetz](https://github.com/lbetz)) +- Complete attributes for the icingadb object type [\#709](https://github.com/Icinga/puppet-icinga2/pull/709) ([lbetz](https://github.com/lbetz)) +- Add a fact to get the installed icinga2 version [\#705](https://github.com/Icinga/puppet-icinga2/pull/705) ([lbetz](https://github.com/lbetz)) + +**Fixed bugs:** + +- Change data type of all TLS cert and key params back to String [\#713](https://github.com/Icinga/puppet-icinga2/issues/713) + ## [v3.4.1](https://github.com/icinga/puppet-icinga2/tree/v3.4.1) (2022-10-15) [Full Changelog](https://github.com/icinga/puppet-icinga2/compare/v3.4.0...v3.4.1) diff --git a/README.md b/README.md index da69d839..c713b2cd 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,9 @@ Icinga 2 is a widely used open source monitoring software. This Puppet module helps with installing and managing configuration of Icinga 2 on multiple operating systems. +### What's new in version 3.5.0 +There are some new function for internal use. Function `icinga2::cert` handels files and/or content for TLS client auth for bot IDO features and for influxdb, infuxdb2, elasticsearch, gelf and icingadb. The function `icinga2::db::connect` provides the client connection string to mysql, mariadb or pgsql databses for both IDO features. + ### What's new in version 3.4.0 The internal used function `icinga_attributes` was moved to `icinga2::icinga2_attributes` with parameter changes. All direct calls of these functions are replaced with a new wrapper function `icinga2::parse`. This function has the same parameters like the old one `icinga2_attributes`. @@ -94,9 +97,9 @@ The use of Icinga's own CA is recommended. If you still want to use the Puppet c This module has been tested on: * Debian 10, 11 -* Ubuntu 18.04, 20.04 -* CentOS/RHEL 7, 8 -* AlmaLinux/Rocky 8 +* Ubuntu 18.04, 20.04, 22.04 +* CentOS/RHEL 7, 8, 9 +* AlmaLinux/Rocky 8, 9 * Fedora 32 * Windows Server 2019 diff --git a/REFERENCE.md b/REFERENCE.md index d912bd64..0c657e2f 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -74,10 +74,13 @@ start on boot and will be restarted if stopped. ### Functions * [`icinga2::cert`](#icinga2cert): Choose the path of tls key, cert and ca file. +* [`icinga2::db::connect`](#icinga2dbconnect): This function returns a string to connect databases +with or without TLS information. * [`icinga2::icinga2_attributes`](#icinga2icinga2_attributes): Calls the simple parser to decide what to quote. For more information, see lib/puppet_x/icinga2/utils.rb. * [`icinga2::icinga2_ticket_id`](#icinga2icinga2_ticket_id): Summarise what the function does here -* [`icinga2::parse`](#icinga2parse): This function parse icinga object attributes. +* [`icinga2::newline`](#icinga2newline): Replace newlines for Windows systems. +* [`icinga2::parse`](#icinga2parse) * [`icinga2::unwrap`](#icinga2unwrap): This function returns an unwrap string if necessary. ### Data types @@ -874,7 +877,7 @@ Default value: ``undef`` Data type: `Optional[Boolean]` -Disable TLS peer verification. +Disable TLS peer verification. Only valid if ssl is enabled. Default value: ``undef`` @@ -882,7 +885,7 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the private key. +Location of the client private key. Only valid if ssl is enabled. Default value: ``undef`` @@ -890,7 +893,7 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the certificate. +Location of the client certificate. Only valid if ssl is enabled. Default value: ``undef`` @@ -898,31 +901,31 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the CA certificate. +Location of the CA certificate. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_key` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[Variant[String, Sensitive[String]]]` -The private key in a base64 encoded string to store in spicified ssl_key_path file. +The client private key in PEM format. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_cert` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[String]` -The certificate in a base64 encoded to store in spicified ssl_cert_path file. +The client certificate in PEM format. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_cacert` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[String]` -The CA root certificate in a base64 encoded string to store in spicified ssl_cacert_path file. +The CA root certificate in PEM format. Only valid if ssl is enabled. Default value: ``undef`` @@ -1047,28 +1050,25 @@ Default value: ``undef`` ##### `ssl_key` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[Variant[String, Sensitive[String]]]` -The private key in a base64 encoded string to store in spicified ssl_key_path file. -Only valid if ssl is enabled. +The client private key in PEM format. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_cert` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[String]` -The certificate in a base64 encoded string to store in spicified ssl_cert_path file. -Only valid if ssl is enabled. +The client certificate in PEM format. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_cacert` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[String]` -The CA root certificate in a base64 encoded string to store in spicified ssl_cacert_path file. -Only valid if ssl is enabled. +The CA certificate in PEM format. Only valid if ssl is enabled. Default value: ``undef`` @@ -1076,7 +1076,7 @@ Default value: ``undef`` Data type: `Optional[Boolean]` -Disable TLS peer verification. +Disable TLS peer verification. Only valid if ssl is enabled. Default value: ``undef`` @@ -1498,7 +1498,7 @@ Default value: ``false`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the private key. Only valid if ssl is enabled. +Location of the client private key. Only valid if ssl is enabled. Default value: ``undef`` @@ -1506,7 +1506,7 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the certificate. Only valid if ssl is enabled. +Location of the client certificate. Only valid if ssl is enabled. Default value: ``undef`` @@ -1520,28 +1520,25 @@ Default value: ``undef`` ##### `ssl_key` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[Variant[String, Sensitive[String]]]` -The private key in a base64 encoded string to store in spicified ssl_key_path file. -Only valid if ssl is enabled. +The client private key in PEM Format. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_cert` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[String]` -The certificate in a base64 encoded string to store in spicified ssl_cert_path file. -Only valid if ssl is enabled. +The client certificate in PEM format. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_cacert` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[String]` -The CA root certificate in a base64 encoded string to store in spicified ssl_cacert_path file. -Only valid if ssl is enabled. +The CA root certificate in PEM format. Only valid if ssl is enabled. Default value: ``undef`` @@ -1697,11 +1694,11 @@ Default value: `'localhost'` ##### `port` -Data type: `Stdlib::Port::Unprivileged` +Data type: `Optional[Stdlib::Port::Unprivileged]` PostgreSQL database port. -Default value: `5432` +Default value: ``undef`` ##### `user` @@ -1727,9 +1724,8 @@ Default value: `'icinga'` ##### `ssl_mode` -Data type: `Optional[Enum['disable', 'allow', - 'prefer', 'verify-full', - 'verify-ca', 'require']]` +Data type: `Optional[Enum['disable', 'allow', 'prefer', + 'verify-full', 'verify-ca', 'require']]` Enable SSL connection mode. @@ -1739,7 +1735,7 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the private key. +Location of the private key. Only valid if ssl_mode is set unequal to `disabled`. Default value: ``undef`` @@ -1747,7 +1743,7 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the certificate. +Location of the certificate. Only valid if ssl_mode is set unequal to `disabled`. Default value: ``undef`` @@ -1755,31 +1751,31 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the CA certificate. +Location of the CA certificate. Only valid if ssl_mode is set unequal to `disabled`. Default value: ``undef`` ##### `ssl_key` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[Variant[String, Sensitive[String]]]` -The private key in a base64 encoded string to store in spicified ssl_key_path file. +The client private key in PEM format. Only valid if ssl_mode is set unequal to `disabled`. Default value: ``undef`` ##### `ssl_cert` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[String]` -The certificate in a base64 encoded string to store in spicified ssl_cert_path file. +The client certificate in PEM format. Only valid if ssl_mode is set unequal to `disabled`. Default value: ``undef`` ##### `ssl_cacert` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[String]` -The CA root certificate in a base64 encoded string to store in spicified ssl_cacert_path file. +The CA root certificate in PEM format. Only valid if ssl_mode is set unequal to `disabled`. Default value: ``undef`` @@ -1961,7 +1957,7 @@ Default value: ``undef`` Data type: `Optional[Boolean]` -Disable TLS peer verification. +Disable TLS peer verification. Only valid if ssl is enabled. Default value: ``undef`` @@ -1969,7 +1965,7 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the private key. +Location of the client private key. Only valid if ssl is enabled. Default value: ``undef`` @@ -1977,7 +1973,7 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the certificate. +Location of the client certificate. Only valid if ssl is enabled. Default value: ``undef`` @@ -1985,31 +1981,31 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the CA certificate. +Location of the CA certificate. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_key` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[Variant[String, Sensitive[String]]]` -The private key in a base64 encoded string to store in ssl_key_path file. +The client private key in PEM format. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_cert` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[String]` -The certificate in a base64 encoded string to store in ssl_cert_path file. +The client certificate in PEM format. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_cacert` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[String]` -The CA root certificate in a base64 encoded to store in ssl_cacert_path file. +The CA root certificate in PEM format. Only valid if ssl is enabled. Default value: ``undef`` @@ -2184,7 +2180,7 @@ Default value: ``undef`` Data type: `Optional[Boolean]` -Disable TLS peer verification. +Disable TLS peer verification. Only valid if ssl is enabled. Default value: ``undef`` @@ -2192,7 +2188,7 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the private key. +Location of the client private key. Only valid if ssl is enabled. Default value: ``undef`` @@ -2200,7 +2196,7 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the certificate. +Location of the client certificate. Only valid if ssl is enabled. Default value: ``undef`` @@ -2208,31 +2204,31 @@ Default value: ``undef`` Data type: `Optional[Stdlib::Absolutepath]` -Location of the CA certificate. +Location of the CA certificate. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_key` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[Variant[String, Sensitive[String]]]` -The private key in a base64 encoded string to store in ssl_key_path file. +The client private key in PEM format. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_cert` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[String]` -The certificate in a base64 encoded string to store in ssl_cert_path file. +The client certificate in PEM format. Only valid if ssl is enabled. Default value: ``undef`` ##### `ssl_cacert` -Data type: `Optional[Stdlib::Base64]` +Data type: `Optional[String]` -The CA root certificate in a base64 encoded to store in ssl_cacert_path file. +The CA root certificate in PEM format. Only valid if ssl is enabled. Default value: ``undef`` @@ -5384,7 +5380,7 @@ Type: Puppet Language Choose the path of tls key, cert and ca file. -#### `icinga2::cert(String $name, Optional[Stdlib::Absolutepath] $key_file = undef, Optional[Stdlib::Absolutepath] $cert_file = undef, Optional[Stdlib::Absolutepath] $cacert_file = undef, Optional[Variant[String, Sensitive]] $key = undef, Optional[String] $cert = undef, Optional[String] $cacert = undef)` +#### `icinga2::cert(String $name, Optional[Stdlib::Absolutepath] $key_file = undef, Optional[Stdlib::Absolutepath] $cert_file = undef, Optional[Stdlib::Absolutepath] $cacert_file = undef, Optional[Variant[String, Sensitive[String]]] $key = undef, Optional[String] $cert = undef, Optional[String] $cacert = undef)` The icinga2::cert function. @@ -5416,7 +5412,7 @@ Data type: `Optional[Stdlib::Absolutepath]` ##### `key` -Data type: `Optional[Variant[String, Sensitive]]` +Data type: `Optional[Variant[String, Sensitive[String]]]` @@ -5432,6 +5428,51 @@ Data type: `Optional[String]` +### `icinga2::db::connect` + +Type: Puppet Language + +This function returns a string to connect databases +with or without TLS information. + +#### `icinga2::db::connect(Struct[{ + type => Enum['pgsql','mysql','mariadb'], + host => Stdlib::Host, + port => Optional[Stdlib::Port], + database => String, + username => String, + password => Optional[Variant[String, Sensitive[String]]], + }] $db, Hash[String, Any] $tls, Optional[Boolean] $use_tls = undef)` + +The icinga2::db::connect function. + +Returns: `String` Connection string to connect database. + +##### `db` + +Data type: `Struct[{ + type => Enum['pgsql','mysql','mariadb'], + host => Stdlib::Host, + port => Optional[Stdlib::Port], + database => String, + username => String, + password => Optional[Variant[String, Sensitive[String]]], + }]` + + + +##### `tls` + +Data type: `Hash[String, Any]` + + + +##### `use_tls` + +Data type: `Optional[Boolean]` + + + ### `icinga2::icinga2_attributes` Type: Ruby 4.x API @@ -5493,6 +5534,24 @@ Data type: `Variant[String, Sensitive[String]]` The ticket salt of the Icinga CA. +### `icinga2::newline` + +Type: Puppet Language + +Replace newlines for Windows systems. + +#### `icinga2::newline(Optional[String] $text)` + +The icinga2::newline function. + +Returns: `String` Text with correct newlines. + +##### `text` + +Data type: `Optional[String]` + + + ### `icinga2::parse` Type: Puppet Language @@ -5529,7 +5588,7 @@ Data type: `Hash[String, Any]` -### `icinga2::unwrap` +### `icinga2::unwrap` Type: Puppet Language diff --git a/metadata.json b/metadata.json index bb370a49..16157ce4 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "icinga-icinga2", - "version": "3.4.1", + "version": "3.5.0", "author": "Icinga Development Team", "summary": "Icinga 2 Puppet Module", "license": "Apache-2.0", @@ -88,6 +88,13 @@ "15" ] }, + { + "operatingsystem": "FreeBSD", + "operatingsystemrelease": [ + "12", + "13" + ] + }, { "operatingsystem": "windows", "operatingsystemrelease": [