Skip to content

Commit 9228f70

Browse files
author
Michael Friedrich
committed
Update documentation & what's new.
1 parent f989bbd commit 9228f70

File tree

3 files changed

+73
-47
lines changed

3 files changed

+73
-47
lines changed

ChangeLog

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,34 @@ Please check doc/1-about.md.
44

55
## What's New
66

7+
### What's New in Version 0.0.10
8+
9+
* Make Host and Service checkable. #5919
10+
* Support new lines in addition to commas to seperate object attributes. #5901
11+
* Add group membership assign rules. #5910
12+
* Support nested groups. #5858
13+
* Add apply target type. #5924
14+
* Add relative object names. #5925
15+
* Merge macros and custom into 'vars' dictionary. Changed runtime macros and environment variable export. #5855
16+
* Add support for modified attributes for custom attributes. #5956
17+
* Allow to assign var values to existin vars evaluted on runtime. #5959
18+
* Rename/shorten attribute names and filter variables. #5857
19+
* Remove the 'Icinga' prefix for global constants. #5960
20+
* Global option to enable/disable host/service checks. #5975
21+
* Add legacy attributes to host, service and group objects: `address{,6}'`, `notes`, `notes_url`, `action_url`, `icon_image`, `icon_image_alt`. #5856
22+
* Support "#" hash comments. #5994
23+
* Cluster: Spanning Tree like communication. #5467
24+
* Properly implement the Process class for Windows. #3684
25+
26+
#### Changes
27+
28+
> **Note**
29+
>
30+
> Configuration updates required!
31+
32+
* Configuration Changes. For a detailed list of changes check out [#5909](https://dev.icinga.org/issues/5909)
33+
* DB IDO schema upgrade required.
34+
735
### What's New in Version 0.0.9
836

937
* new [apply](#apply) rules for assigning objects based on attribute conditions

doc/1-about.md

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -29,36 +29,33 @@ Please get in touch with the Icinga team at [https://www.icinga.org/ecosystem/].
2929

3030
## <a id="whats-new"></a> What's new
3131

32-
### What's New in Version 0.0.9
33-
34-
* new [apply](#apply) rules for assigning objects based on attribute conditions
35-
* inline object definitions removed in favor of [apply](#apply) rules
36-
* [import](#template-imports) keyword instead of `inherits` keyword for all objects
37-
* new [constants.conf](#constants-conf) providing `PluginDir` constant instead of `$plugindir$` macro
38-
* unknown attributes and duplicate objects generate a configuration error
39-
* improved configuration error output
40-
* create endpoint tables for legacy interfaces (status data, DB IDO, Livestatus)
41-
* export host `check` attribute in legacy interfaces (status data, DB IDO, Livestatus)
42-
* add documentation about [cluster scenarios](#cluster-scenarios)
43-
* Livestatus: add `check_source` attribute to services table
44-
* Compat: Fix host service order for Classic UI
45-
* Remove comments when clearing acknowledgements
46-
* Recovery [Notifications](#objecttype-notification) require StateFilterOK
32+
### What's New in Version 0.0.10
33+
34+
* Make Host and Service checkable. #5919
35+
* Support new lines in addition to commas to seperate object attributes. #5901
36+
* Add group membership assign rules. #5910
37+
* Support nested groups. #5858
38+
* Add apply target type. #5924
39+
* Add relative object names. #5925
40+
* Merge macros and custom into 'vars' dictionary. Changed runtime macros and environment variable export. #5855
41+
* Add support for modified attributes for custom attributes. #5956
42+
* Allow to assign var values to existin vars evaluted on runtime. #5959
43+
* Rename/shorten attribute names and filter variables. #5857
44+
* Remove the 'Icinga' prefix for global constants. #5960
45+
* Global option to enable/disable host/service checks. #5975
46+
* Add legacy attributes to host, service and group objects: `address{,6}'`, `notes`, `notes_url`, `action_url`, `icon_image`, `icon_image_alt`. #5856
47+
* Support "#" hash comments. #5994
48+
* Cluster: Spanning Tree like communication. #5467
49+
* Properly implement the Process class for Windows. #3684
4750

4851
#### Changes
4952

5053
> **Note**
5154
>
5255
> Configuration updates required!
5356
54-
* removed deprecated `var`/`set` identifier, use [const](#const) instead
55-
* [constants.conf](#constants-conf) needs to be included in [icinga2.conf](#icinga2-conf) before [ITL](#itl) inclusion
56-
* [import](#template-imports) instead of `inherits` (examples in [localhost.conf](#localhost-conf))
57-
* [apply](#apply) rules instead of inline definitions for [Service](#objecttype-service),
58-
[Dependency](#objecttype-dependency), [Notification](#objecttype-notitifcation),
59-
[ScheduledDowntime](#objecttype-scheduleddowntime) objects (examples in [localhost.conf](#localhost-conf)).
60-
* unknown attributes and duplicate objects generate a configuration error
61-
* DB IDO: schema update for 0.0.9 ([MySQL](#upgrading-mysql-db), [PostgreSQL](#upgrading-postgresql-db))
57+
* Configuration Changes. For a detailed list of changes check out [#5909](https://dev.icinga.org/issues/5909)
58+
* DB IDO schema upgrade required.
6259

6360
### Archive
6461

doc/6.04-cluster.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ CA files:
2323
In the next step you have to create a certificate and a key file for every node
2424
using the following command:
2525

26-
icinga2-build-key icinga-node-1
26+
icinga2-build-key icinga2a
2727

2828
Please create a certificate and a key file for every node in the Icinga 2
2929
Cluster and save the CA key in case you want to set up certificates for
@@ -44,7 +44,7 @@ This setting must be unique on each cluster node, and must also match
4444
the name of the local [Endpoint](#objecttype-endpoint) object and the
4545
SSL certificate common name.
4646

47-
const NodeName = "icinga-node-1"
47+
const NodeName = "icinga2a"
4848

4949
Read further about additional [naming conventions](#cluster-naming-convention).
5050

@@ -74,12 +74,12 @@ A sample config part can look like this:
7474

7575
object ClusterListener "cluster" {
7676
ca_path = "/etc/icinga2/ca/ca.crt"
77-
cert_path = "/etc/icinga2/ca/icinga-node-1.crt"
78-
key_path = "/etc/icinga2/ca/icinga-node-1.key"
77+
cert_path = "/etc/icinga2/ca/icinga2a.crt"
78+
key_path = "/etc/icinga2/ca/icinga2a.key"
7979

8080
bind_port = 8888
8181

82-
peers = [ "icinga-node-2" ]
82+
peers = [ "icinga2b" ]
8383
}
8484

8585
The certificate files must be readable by the user Icinga 2 is running as. Also,
@@ -105,8 +105,9 @@ to send configuration files.
105105
-------------------------|------------------------------------
106106
host | hostname
107107
port | port
108-
accept_config | defines all nodes allowed to send configs
109-
config_files | defines all files to be send to that node - MUST BE AN ABSOLUTE PATH
108+
accept_config | all nodes allowed to send configuration
109+
config_files | all files sent to that node - MUST BE AN ABSOLUTE PATH
110+
config_files_recursive | all files in a directory recursively sent to that node
110111
------------------------- ------------------------------------
111112

112113
A sample config part can look like this:
@@ -115,10 +116,10 @@ A sample config part can look like this:
115116
* Configure config master endpoint
116117
*/
117118

118-
object Endpoint "icinga-node-1" {
119-
host = "icinga-node-1.localdomain"
119+
object Endpoint "icinga2a" {
120+
host = "icinga2a.localdomain"
120121
port = 8888
121-
config_files = ["/etc/icinga2/conf.d/*.conf"]
122+
config_files_recursive = ["/etc/icinga2/conf.d"]
122123
}
123124

124125
If you update the configuration files on the configured file sender, it will
@@ -130,10 +131,10 @@ A sample config part for a config receiver endpoint can look like this:
130131
* Configure config receiver endpoint
131132
*/
132133

133-
object Endpoint "icinga-node-2" {
134-
host = "icinga-node-2.localdomain"
134+
object Endpoint "icinga2b" {
135+
host = "icinga2b.localdomain"
135136
port = 8888
136-
accept_config = [ "icinga-node-1" ]
137+
accept_config = [ "icinga2a" ]
137138
}
138139

139140
By default these configuration files are saved in /var/lib/icinga2/cluster/config.
@@ -152,39 +153,39 @@ object name.
152153

153154
Example:
154155

155-
# icinga2-build-key icinga-node-1
156+
# icinga2-build-key icinga2a
156157
...
157-
Common Name (e.g. server FQDN or YOUR name) [icinga-node-1]:
158+
Common Name (e.g. server FQDN or YOUR name) [icinga2a]:
158159

159160
# vim cluster.conf
160161

161-
object Endpoint "icinga-node-1" {
162-
host = "icinga-node-1.localdomain"
162+
object Endpoint "icinga2a" {
163+
host = "icinga2a.localdomain"
163164
port = 8888
164165
}
165166

166167
The [Endpoint](#objecttype-endpoint) name is further referenced as `peers` attribute on the
167168
[ClusterListener](pbjecttype-clusterlistener) object.
168169

169-
object Endpoint "icinga-node-2" {
170-
host = "icinga-node-2.localdomain"
170+
object Endpoint "icinga2b" {
171+
host = "icinga2b.localdomain"
171172
port = 8888
172173
}
173174

174175
object ClusterListener "cluster" {
175176
ca_path = "/etc/icinga2/ca/ca.crt"
176-
cert_path = "/etc/icinga2/ca/icinga-node-1.crt"
177-
key_path = "/etc/icinga2/ca/icinga-node-1.key"
177+
cert_path = "/etc/icinga2/ca/icinga2a.crt"
178+
key_path = "/etc/icinga2/ca/icinga2a.key"
178179

179180
bind_port = 8888
180181

181-
peers = [ "icinga-node-2" ]
182+
peers = [ "icinga2b" ]
182183
}
183184

184185
Specifying the local node name using the [NodeName](#global-constants) variable requires
185186
the same name as used for the endpoint name and common name above. If not set, the FQDN is used.
186187

187-
const NodeName = "icinga-node-1"
188+
const NodeName = "icinga2a"
188189

189190

190191
### <a id="initial-cluster-sync"></a> Initial Cluster Sync
@@ -209,7 +210,7 @@ attribute. Required Endpoints must be defined as array.
209210
apply Service "dmz-oracledb" {
210211
import "generic-service"
211212

212-
authorities = [ "icinga-node-1" ]
213+
authorities = [ "icinga2a" ]
213214

214215
assign where "oracle" in host.groups
215216
}

0 commit comments

Comments
 (0)