Skip to content

Commit

Permalink
Merge pull request #117 from Icinga/release/v5.0.0
Browse files Browse the repository at this point in the history
Release/v5.0.0
  • Loading branch information
lbetz committed May 17, 2024
2 parents 2e8ac83 + c43fc9c commit 14e8fef
Show file tree
Hide file tree
Showing 26 changed files with 435 additions and 245 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ The class supports:
And requiers:

* [puppetlabs/stdlib] >= 6.6.0 < 10.0.0
* [puppetlabs/apt] >= 7.7.0 < 10.0.0
* [puppetlabs/apt] >= 9.2.0 < 10.0.0
* [puppet/zypprepo] >= 4.0.0 < 6.0.0
* [puppetlabs/yumrepo_core] >= 1.1.0 < 3.0.0

Expand Down
136 changes: 94 additions & 42 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@

#### Public Classes

* [`icinga::agent`](#icinga--agent): Setup a Icinga agent.
* [`icinga::agent`](#icinga--agent): Setup an Icinga agent.
* [`icinga::agentless`](#icinga--agentless): Setup an agentless monitoring via SSH.
* [`icinga::db`](#icinga--db)
* [`icinga::db::database`](#icinga--db--database): Setup database for IcingaDB.
* [`icinga::ido`](#icinga--ido): Configure IDO Backend.
Expand Down Expand Up @@ -56,7 +57,6 @@ PHP and a Webserver.
with or without TLS information.
* [`icinga::newline`](#icinga--newline): Replace newlines for Windows systems.
* [`icinga::prepare_web`](#icinga--prepare_web): This funktion checks for web preparation and display a warning if fails
* [`icinga::unwrap`](#icinga--unwrap): This function returns an unwrap string if necessary.

### Data types

Expand All @@ -68,7 +68,7 @@ with or without TLS information.

### <a name="icinga--agent"></a>`icinga::agent`

Setup a Icinga agent.
Setup an Icinga agent.

#### Parameters

Expand Down Expand Up @@ -113,20 +113,16 @@ Default value: `[]`

##### <a name="-icinga--agent--logging_type"></a>`logging_type`

Data type: `Enum['file', 'syslog']`
Data type: `Enum['file', 'syslog', 'eventlog']`

Switch the log target. Only `file` is supported on Windows.

Default value: `'file'`
Switch the log target. On Windows `syslog` is ignored, `eventlog` on all other platforms.

##### <a name="-icinga--agent--logging_level"></a>`logging_level`

Data type: `Optional[Icinga::LogLevel]`
Data type: `Icinga::LogLevel`

Set the log level.

Default value: `undef`

##### <a name="-icinga--agent--zone"></a>`zone`

Data type: `String`
Expand All @@ -144,6 +140,52 @@ and add the Icinga user to this group.

Default value: `false`

### <a name="icinga--agentless"></a>`icinga::agentless`

Setup an agentless monitoring via SSH.

#### Parameters

The following parameters are available in the `icinga::agentless` class:

* [`user`](#-icinga--agentless--user)
* [`manage_user`](#-icinga--agentless--manage_user)
* [`ssh_key_type`](#-icinga--agentless--ssh_key_type)
* [`ssh_public_key`](#-icinga--agentless--ssh_public_key)
* [`extra_packages`](#-icinga--agentless--extra_packages)

##### <a name="-icinga--agentless--user"></a>`user`

Data type: `String`

User name to login.

##### <a name="-icinga--agentless--manage_user"></a>`manage_user`

Data type: `Boolean`

Wether or not to manage user.

##### <a name="-icinga--agentless--ssh_key_type"></a>`ssh_key_type`

Data type: `Enum['ecdsa','ed25519','rsa']`

SSH key type.

##### <a name="-icinga--agentless--ssh_public_key"></a>`ssh_public_key`

Data type: `String`

Public SSH key of ´ssh_key_type´ for ´user´.

##### <a name="-icinga--agentless--extra_packages"></a>`extra_packages`

Data type: `Array[String]`

Install extra packages such as plugins.

Default value: `[]`

### <a name="icinga--db"></a>`icinga::db`

The icinga::db class.
Expand Down Expand Up @@ -607,6 +649,8 @@ The following parameters are available in the `icinga::server` class:
* [`logging_type`](#-icinga--server--logging_type)
* [`logging_level`](#-icinga--server--logging_level)
* [`run_web`](#-icinga--server--run_web)
* [`ssh_private_key`](#-icinga--server--ssh_private_key)
* [`ssh_key_type`](#-icinga--server--ssh_key_type)

##### <a name="-icinga--server--ca"></a>`ca`

Expand Down Expand Up @@ -707,20 +751,16 @@ Default value: `undef`

##### <a name="-icinga--server--logging_type"></a>`logging_type`

Data type: `Enum['file', 'syslog']`
Data type: `Enum['file', 'syslog', 'eventlog']`

Switch the log target. Only `file` is supported on Windows.

Default value: `'file'`
Switch the log target. On Windows `syslog` is ignored, `eventlog` on all other platforms.

##### <a name="-icinga--server--logging_level"></a>`logging_level`

Data type: `Optional[Icinga::LogLevel]`
Data type: `Icinga::LogLevel`

Set the log level.

Default value: `undef`

##### <a name="-icinga--server--run_web"></a>`run_web`

Data type: `Boolean`
Expand All @@ -730,6 +770,22 @@ and add the Icinga user to this group.

Default value: `false`

##### <a name="-icinga--server--ssh_private_key"></a>`ssh_private_key`

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

The private key to install.

Default value: `undef`

##### <a name="-icinga--server--ssh_key_type"></a>`ssh_key_type`

Data type: `Enum['ecdsa','ed25519','rsa']`

SSH key type.

Default value: `rsa`

### <a name="icinga--web"></a>`icinga::web`

Setup Icinga Web 2 including a database backend for user settings,
Expand Down Expand Up @@ -1778,6 +1834,8 @@ The following parameters are available in the `icinga::worker` class:
* [`logging_type`](#-icinga--worker--logging_type)
* [`logging_level`](#-icinga--worker--logging_level)
* [`run_web`](#-icinga--worker--run_web)
* [`ssh_private_key`](#-icinga--worker--ssh_private_key)
* [`ssh_key_type`](#-icinga--worker--ssh_key_type)

##### <a name="-icinga--worker--ca_server"></a>`ca_server`

Expand Down Expand Up @@ -1832,20 +1890,16 @@ Default value: `[]`

##### <a name="-icinga--worker--logging_type"></a>`logging_type`

Data type: `Enum['file', 'syslog']`
Data type: `Enum['file', 'syslog', 'eventlog']`

Switch the log target. Only `file` is supported on Windows.

Default value: `'file'`
Switch the log target. On Windows `syslog` is ignored, `eventlog` on all other platforms.

##### <a name="-icinga--worker--logging_level"></a>`logging_level`

Data type: `Optional[Icinga::LogLevel]`
Data type: `Icinga::LogLevel`

Set the log level.

Default value: `undef`

##### <a name="-icinga--worker--run_web"></a>`run_web`

Data type: `Boolean`
Expand All @@ -1855,6 +1909,22 @@ and add the Icinga user to this group.

Default value: `false`

##### <a name="-icinga--worker--ssh_private_key"></a>`ssh_private_key`

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

The private key to install.

Default value: `undef`

##### <a name="-icinga--worker--ssh_key_type"></a>`ssh_key_type`

Data type: `Enum['ecdsa','ed25519','rsa']`

SSH key type.

Default value: `rsa`

## Defined types

### <a name="icinga--cert"></a>`icinga::cert`
Expand Down Expand Up @@ -2041,24 +2111,6 @@ Data type: `String`



### <a name="icinga--unwrap"></a>`icinga::unwrap`

Type: Puppet Language

This function returns an unwrap string if necessary.

#### `icinga::unwrap(Optional[Variant[String, Sensitive[String]]] $arg = undef)`

The icinga::unwrap function.

Returns: `Any` The unwraped string.

##### `arg`

Data type: `Optional[Variant[String, Sensitive[String]]]`



## Data types

### <a name="Icinga--Certificate"></a>`Icinga::Certificate`
Expand Down
17 changes: 17 additions & 0 deletions data/Debian/Debian/10.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
---
icinga::repos:
'icinga-stable-release':
key:
id: F51A91A5EE001AA5D77D53C4C6E319C334410682
'icinga-testing-builds':
key:
id: F51A91A5EE001AA5D77D53C4C6E319C334410682
'icinga-snapshot-builds':
key:
id: F51A91A5EE001AA5D77D53C4C6E319C334410682
'netways-plugins-release':
key:
id: 0DEE49417F457646CC0C29AD03E3F1C5E8B2FC5E
'netways-extras-release':
key:
id: 0DEE49417F457646CC0C29AD03E3F1C5E8B2FC5E

icinga::repos::configure_backports: true
17 changes: 17 additions & 0 deletions data/Debian/Debian/11.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
icinga::repos:
'icinga-stable-release':
key:
id: F51A91A5EE001AA5D77D53C4C6E319C334410682
'icinga-testing-builds':
key:
id: F51A91A5EE001AA5D77D53C4C6E319C334410682
'icinga-snapshot-builds':
key:
id: F51A91A5EE001AA5D77D53C4C6E319C334410682
'netways-plugins-release':
key:
id: 0DEE49417F457646CC0C29AD03E3F1C5E8B2FC5E
'netways-extras-release':
key:
id: 0DEE49417F457646CC0C29AD03E3F1C5E8B2FC5E
17 changes: 17 additions & 0 deletions data/Debian/Ubuntu/20.04.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
icinga::repos:
'icinga-stable-release':
key:
id: F51A91A5EE001AA5D77D53C4C6E319C334410682
'icinga-testing-builds':
key:
id: F51A91A5EE001AA5D77D53C4C6E319C334410682
'icinga-snapshot-builds':
key:
id: F51A91A5EE001AA5D77D53C4C6E319C334410682
'netways-plugins-release':
key:
id: 0DEE49417F457646CC0C29AD03E3F1C5E8B2FC5E
'netways-extras-release':
key:
id: 0DEE49417F457646CC0C29AD03E3F1C5E8B2FC5E
10 changes: 10 additions & 0 deletions data/Debian/Ubuntu/common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,21 @@
icinga::repos:
'icinga-stable-release':
location: https://packages.icinga.com/ubuntu
# key:
# id: F51A91A5EE001AA5D77D53C4C6E319C334410682
'icinga-testing-builds':
location: https://packages.icinga.com/ubuntu
# key:
# id: F51A91A5EE001AA5D77D53C4C6E319C334410682
'icinga-snapshot-builds':
location: https://packages.icinga.com/ubuntu
# key:
# id: F51A91A5EE001AA5D77D53C4C6E319C334410682
'netways-plugins-release':
location: https://packages.netways.de/plugins/ubuntu
# key:
# id: 0DEE49417F457646CC0C29AD03E3F1C5E8B2FC5E
'netways-extras-release':
location: https://packages.netways.de/extras/ubuntu
# key:
# id: 0DEE49417F457646CC0C29AD03E3F1C5E8B2FC5E
16 changes: 8 additions & 8 deletions data/Debian/common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,34 @@ icinga::repos:
location: https://packages.icinga.com/debian
release: 'icinga-%{facts.os.distro.codename}'
repos: main
key:
id: F51A91A5EE001AA5D77D53C4C6E319C334410682
key:
name: icinga.key
source: https://packages.icinga.com/icinga.key
'icinga-testing-builds':
location: https://packages.icinga.com/debian
release: 'icinga-%{facts.os.distro.codename}-testing'
repos: main
key:
id: F51A91A5EE001AA5D77D53C4C6E319C334410682
key:
name: icinga.key
source: https://packages.icinga.com/icinga.key
'icinga-snapshot-builds':
location: https://packages.icinga.com/debian
release: 'icinga-%{facts.os.distro.codename}-snapshots'
repos: main
key:
id: F51A91A5EE001AA5D77D53C4C6E319C334410682
key:
name: icinga.key
source: https://packages.icinga.com/icinga.key
'netways-plugins-release':
location: https://packages.netways.de/plugins/debian
release: '%{facts.os.distro.codename}'
repos: main
key:
id: 0DEE49417F457646CC0C29AD03E3F1C5E8B2FC5E
name: netways.asc
source: https://packages.netways.de/netways-repo.asc
'netways-extras-release':
location: https://packages.netways.de/extras/debian
release: '%{facts.os.distro.codename}'
repos: main
key:
id: 0DEE49417F457646CC0C29AD03E3F1C5E8B2FC5E
name: netways.asc
source: https://packages.netways.de/netways-repo.asc
4 changes: 4 additions & 0 deletions data/Linux-kernel.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,7 @@ icinga::redis::globals::user: icinga-redis
icinga::redis::globals::group: icinga-redis

icinga::web::apache_cgi_pass_auth: true

icinga::server::logging_type: syslog
icinga::worker::logging_type: syslog
icinga::agent::logging_type: syslog
13 changes: 13 additions & 0 deletions data/common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,16 @@ icinga::repos::manage_crb: false
icinga::repos::manage_server_monitoring: false
icinga::repos::manage_plugins: false
icinga::repos::manage_extras: false

icinga::server::logging_type: file
icinga::server::logging_level: warning

icinga::worker::logging_type: file
icinga::worker::logging_level: warning

icinga::agent::logging_type: file
icinga::agent::logging_level: warning

icinga::agentless::user: icinga
icinga::agentless::manage_user: true
icinga::agentless::ssh_key_type: rsa
Loading

0 comments on commit 14e8fef

Please sign in to comment.