Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set requirement of puppet-icinga to >= 3.0.0 #415

Merged
merged 1 commit into from
Aug 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 23 additions & 30 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ that store groups.

* [`Icingaweb2::AdminRole`](#Icingaweb2--AdminRole): A strict type for the default admin role
* [`Icingaweb2::ImportSchema`](#Icingaweb2--ImportSchema): A type for setting import database schemata
* [`Icingaweb2::Secret`](#Icingaweb2--Secret): A strict type for the secrets like passwords or keys

## Classes

Expand Down Expand Up @@ -360,7 +359,7 @@ Username for database access.

##### <a name="-icingaweb2--db_password"></a>`db_password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

Password for database access.

Expand Down Expand Up @@ -401,7 +400,7 @@ Default value: `undef`

##### <a name="-icingaweb2--tls_key"></a>`tls_key`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The private key to store in spicified `tls_key_file` file. Only valid if tls is enabled.

Expand Down Expand Up @@ -492,7 +491,7 @@ if `import_schema` is set to `true` and only during the import itself.

##### <a name="-icingaweb2--default_admin_password"></a>`default_admin_password`

Data type: `Icingaweb2::Secret`
Data type: `Icinga::Secret`

Default password for initial admin access. This parameter is only used
if `import_schema` is set to `true` and only during the import itself.
Expand Down Expand Up @@ -1085,7 +1084,7 @@ Username for DB connection.

##### <a name="-icingaweb2--module--director--db_password"></a>`db_password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

Password for DB connection.

Expand Down Expand Up @@ -1134,7 +1133,7 @@ Default value: `undef`

##### <a name="-icingaweb2--module--director--tls_key"></a>`tls_key`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The private key to store in spicified `tls_key_file` file. Only valid if tls is enabled.

Expand Down Expand Up @@ -1225,7 +1224,7 @@ Default value: `undef`

##### <a name="-icingaweb2--module--director--api_password"></a>`api_password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

Icinga 2 API password. This setting is only valid if `kickstart` is `true`.

Expand Down Expand Up @@ -1642,7 +1641,7 @@ Default value: `undef`

##### <a name="-icingaweb2--module--graphite--password"></a>`password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The users password.

Expand Down Expand Up @@ -1804,7 +1803,7 @@ Username for IcingaDB database connection.

##### <a name="-icingaweb2--module--icingadb--db_password"></a>`db_password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

Password for IcingaDB database connection.

Expand Down Expand Up @@ -1861,7 +1860,7 @@ Default value: `undef`

##### <a name="-icingaweb2--module--icingadb--db_tls_key"></a>`db_tls_key`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The client private key in PEM format. Only valid if db_use_tls is enabled.

Expand Down Expand Up @@ -1916,7 +1915,7 @@ Default value: `undef`

##### <a name="-icingaweb2--module--icingadb--redis_password"></a>`redis_password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

Password for Redis connection.

Expand All @@ -1940,7 +1939,7 @@ Default value: `$redis_port`

##### <a name="-icingaweb2--module--icingadb--redis_primary_password"></a>`redis_primary_password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

Alternative parameter to use for `redis_passwod`. Useful for high availability environments.

Expand All @@ -1964,7 +1963,7 @@ Default value: `undef`

##### <a name="-icingaweb2--module--icingadb--redis_secondary_password"></a>`redis_secondary_password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

Password for the second Redis server.

Expand All @@ -1990,7 +1989,7 @@ Default value: `undef`

##### <a name="-icingaweb2--module--icingadb--redis_tls_key"></a>`redis_tls_key`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

Client private key in PEM format. Only valid if redis_use_tls is enabled.

Expand Down Expand Up @@ -2230,7 +2229,7 @@ Username for IDO DB connection.

##### <a name="-icingaweb2--module--monitoring--ido_db_password"></a>`ido_db_password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

Password for IDO DB connection.

Expand Down Expand Up @@ -2279,7 +2278,7 @@ Default value: `undef`

##### <a name="-icingaweb2--module--monitoring--tls_key"></a>`tls_key`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The private key to store in spicified `tls_key_file` file. Only valid if tls is enabled.

Expand Down Expand Up @@ -2690,7 +2689,7 @@ The username needed to access the database.

##### <a name="-icingaweb2--module--reporting--db_password"></a>`db_password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The password needed to access the database.

Expand Down Expand Up @@ -2739,7 +2738,7 @@ Default value: `undef`

##### <a name="-icingaweb2--module--reporting--tls_key"></a>`tls_key`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The private key to store in spicified `tls_key_file` file. Only valid if tls is enabled.

Expand Down Expand Up @@ -2977,7 +2976,7 @@ The username needed to access the database.

##### <a name="-icingaweb2--module--vspheredb--db_password"></a>`db_password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The password needed to access the database.

Expand Down Expand Up @@ -3026,7 +3025,7 @@ Default value: `undef`

##### <a name="-icingaweb2--module--vspheredb--tls_key"></a>`tls_key`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The private key to store in spicified `tls_key_file` file. Only valid if tls is enabled.

Expand Down Expand Up @@ -3240,7 +3239,7 @@ The username needed to access the database.

##### <a name="-icingaweb2--module--x509--db_password"></a>`db_password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The password needed to access the database.

Expand Down Expand Up @@ -3289,7 +3288,7 @@ Default value: `undef`

##### <a name="-icingaweb2--module--x509--tls_key"></a>`tls_key`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The private key to store in spicified `tls_key_file` file. Only valid if tls is enabled.

Expand Down Expand Up @@ -4211,7 +4210,7 @@ Default value: `undef`

##### <a name="-icingaweb2--resource--database--password"></a>`password`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The password to use when connecting the database.

Expand Down Expand Up @@ -4358,7 +4357,7 @@ Default value: `undef`

##### <a name="-icingaweb2--resource--ldap--bind_pw"></a>`bind_pw`

Data type: `Optional[Icingaweb2::Secret]`
Data type: `Optional[Icinga::Secret]`

The password to use when connecting to the server.

Expand Down Expand Up @@ -4428,9 +4427,3 @@ A type for setting import database schemata

Alias of `Variant[Boolean, Enum['mariadb', 'mysql']]`

### <a name="Icingaweb2--Secret"></a>`Icingaweb2::Secret`

A strict type for the secrets like passwords or keys

Alias of `Variant[String, Sensitive[String]]`

6 changes: 3 additions & 3 deletions manifests/init.pp
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@
Enum['mysql', 'pgsql'] $db_type,
Variant[Icingaweb2::AdminRole, Boolean[false]] $admin_role,
String $default_admin_username,
Icingaweb2::Secret $default_admin_password,
Icinga::Secret $default_admin_password,
Enum['file', 'syslog', 'php', 'none'] $logging,
Enum['ERROR', 'WARNING', 'INFO', 'DEBUG'] $logging_level,
Pattern[/user|local[0-7]/] $logging_facility,
Expand All @@ -237,15 +237,15 @@
Stdlib::Host $db_host,
String $db_name,
String $db_username,
Optional[Icingaweb2::Secret] $db_password = undef,
Optional[Icinga::Secret] $db_password = undef,
Optional[Stdlib::Port] $db_port = undef,
Optional[Icingaweb2::ImportSchema] $import_schema = undef,
Optional[Boolean] $use_tls = undef,
Optional[Stdlib::Absolutepath] $tls_key_file = undef,
Optional[Stdlib::Absolutepath] $tls_cert_file = undef,
Optional[Stdlib::Absolutepath] $tls_cacert_file = undef,
Optional[Stdlib::Absolutepath] $tls_capath = undef,
Optional[Icingaweb2::Secret] $tls_key = undef,
Optional[Icinga::Secret] $tls_key = undef,
Optional[String] $tls_cert = undef,
Optional[String] $tls_cacert = undef,
Optional[Boolean] $tls_noverify = undef,
Expand Down
6 changes: 3 additions & 3 deletions manifests/module/director.pp
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@
String $db_name,
String $db_username,
Optional[Stdlib::Port] $db_port = undef,
Optional[Icingaweb2::Secret] $db_password = undef,
Optional[Icinga::Secret] $db_password = undef,
Optional[String] $db_charset = undef,
Optional[Boolean] $import_schema = undef,
Stdlib::Absolutepath $module_dir = "${icingaweb2::globals::default_module_path}/director",
Expand All @@ -155,14 +155,14 @@
Optional[Stdlib::Absolutepath] $tls_cert_file = undef,
Optional[Stdlib::Absolutepath] $tls_cacert_file = undef,
Optional[Stdlib::Absolutepath] $tls_capath = undef,
Optional[Icingaweb2::Secret] $tls_key = undef,
Optional[Icinga::Secret] $tls_key = undef,
Optional[String] $tls_cert = undef,
Optional[String] $tls_cacert = undef,
Optional[Boolean] $tls_noverify = undef,
Optional[String] $tls_cipher = undef,
Optional[String] $endpoint = undef,
Optional[String] $api_username = undef,
Optional[Icingaweb2::Secret] $api_password = undef,
Optional[Icinga::Secret] $api_password = undef,
) {
require icingaweb2

Expand Down
2 changes: 1 addition & 1 deletion manifests/module/elasticsearch/instance.pp
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
String $instance_name = $title,
String $uri = undef,
Optional[String] $user = undef,
Optional[Icingaweb2::Secret] $password = undef,
Optional[Icinga::Secret] $password = undef,
Optional[Stdlib::Absolutepath] $ca = undef,
Optional[Stdlib::Absolutepath] $client_certificate = undef,
Optional[Stdlib::Absolutepath] $client_private_key = undef,
Expand Down
2 changes: 1 addition & 1 deletion manifests/module/graphite.pp
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
Optional[Stdlib::HTTPUrl] $url = undef,
Optional[Boolean] $insecure = undef,
Optional[String] $user = undef,
Optional[Icingaweb2::Secret] $password = undef,
Optional[Icinga::Secret] $password = undef,
Optional[String] $graphite_writer_host_name_template = undef,
Optional[String] $graphite_writer_service_name_template = undef,
Optional[String] $customvar_obscured_check_command = undef,
Expand Down
12 changes: 6 additions & 6 deletions manifests/module/icingadb.pp
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,11 @@
String $db_name,
String $db_username,
Optional[Stdlib::Port] $db_port = undef,
Optional[Icingaweb2::Secret] $db_password = undef,
Optional[Icinga::Secret] $db_password = undef,
Optional[String] $db_charset = undef,
Optional[Boolean] $db_use_tls = undef,
Optional[String] $db_tls_cert = undef,
Optional[Icingaweb2::Secret] $db_tls_key = undef,
Optional[Icinga::Secret] $db_tls_key = undef,
Optional[String] $db_tls_cacert = undef,
Optional[Stdlib::Absolutepath] $db_tls_cert_file = undef,
Optional[Stdlib::Absolutepath] $db_tls_key_file = undef,
Expand All @@ -147,16 +147,16 @@
Optional[Boolean] $db_tls_noverify = undef,
Optional[String] $db_tls_cipher = undef,
Optional[Stdlib::Port] $redis_port = undef,
Optional[Icingaweb2::Secret] $redis_password = undef,
Optional[Icinga::Secret] $redis_password = undef,
Stdlib::Host $redis_primary_host = $redis_host,
Optional[Stdlib::Port] $redis_primary_port = $redis_port,
Optional[Icingaweb2::Secret] $redis_primary_password = $redis_password,
Optional[Icinga::Secret] $redis_primary_password = $redis_password,
Optional[Stdlib::Host] $redis_secondary_host = undef,
Optional[Stdlib::Port] $redis_secondary_port = undef,
Optional[Icingaweb2::Secret] $redis_secondary_password = undef,
Optional[Icinga::Secret] $redis_secondary_password = undef,
Optional[Boolean] $redis_use_tls = undef,
Optional[String] $redis_tls_cert = undef,
Optional[Icingaweb2::Secret] $redis_tls_key = undef,
Optional[Icinga::Secret] $redis_tls_key = undef,
Optional[String] $redis_tls_cacert = undef,
Optional[Stdlib::Absolutepath] $redis_tls_cert_file = undef,
Optional[Stdlib::Absolutepath] $redis_tls_key_file = undef,
Expand Down
2 changes: 1 addition & 1 deletion manifests/module/icingadb/commandtransport.pp
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#
define icingaweb2::module::icingadb::commandtransport (
String $username,
Icingaweb2::Secret $password,
Icinga::Secret $password,
String $commandtransport = $title,
Stdlib::Host $host = 'localhost',
Stdlib::Port $port = 5665,
Expand Down
4 changes: 2 additions & 2 deletions manifests/module/monitoring.pp
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,14 @@
String $ido_db_name,
String $ido_db_username,
Optional[Stdlib::Port] $ido_port = undef,
Optional[Icingaweb2::Secret] $ido_db_password = undef,
Optional[Icinga::Secret] $ido_db_password = undef,
Optional[String] $ido_db_charset = undef,
Optional[Boolean] $use_tls = undef,
Optional[Stdlib::Absolutepath] $tls_key_file = undef,
Optional[Stdlib::Absolutepath] $tls_cert_file = undef,
Optional[Stdlib::Absolutepath] $tls_cacert_file = undef,
Optional[Stdlib::Absolutepath] $tls_capath = undef,
Optional[Icingaweb2::Secret] $tls_key = undef,
Optional[Icinga::Secret] $tls_key = undef,
Optional[String] $tls_cert = undef,
Optional[String] $tls_cacert = undef,
Optional[Boolean] $tls_noverify = undef,
Expand Down
2 changes: 1 addition & 1 deletion manifests/module/monitoring/commandtransport.pp
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
Stdlib::Host $host = 'localhost',
Stdlib::Port $port = 5665,
Optional[String] $username = undef,
Optional[Icingaweb2::Secret] $password = undef,
Optional[Icinga::Secret] $password = undef,
Stdlib::Absolutepath $path = '/var/run/icinga2/cmd/icinga2.cmd',
) {
$conf_dir = $icingaweb2::globals::conf_dir
Expand Down
4 changes: 2 additions & 2 deletions manifests/module/reporting.pp
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@
String $db_name,
String $db_username,
Optional[Stdlib::Port] $db_port = undef,
Optional[Icingaweb2::Secret] $db_password = undef,
Optional[Icinga::Secret] $db_password = undef,
Optional[String] $db_charset = undef,
Optional[Icingaweb2::ImportSchema] $import_schema = undef,
Stdlib::Absolutepath $module_dir = "${icingaweb2::globals::default_module_path}/reporting",
Expand All @@ -129,7 +129,7 @@
Optional[Stdlib::Absolutepath] $tls_cert_file = undef,
Optional[Stdlib::Absolutepath] $tls_cacert_file = undef,
Optional[Stdlib::Absolutepath] $tls_capath = undef,
Optional[Icingaweb2::Secret] $tls_key = undef,
Optional[Icinga::Secret] $tls_key = undef,
Optional[String] $tls_cert = undef,
Optional[String] $tls_cacert = undef,
Optional[Boolean] $tls_noverify = undef,
Expand Down
Loading