granicus.if.org Git - icinga2/blob - doc/16-upgrading-icinga-2.md

   1 # Upgrading Icinga 2 <a id="upgrading-icinga-2"></a>
   2
   3 Upgrading Icinga 2 is usually quite straightforward. Ordinarily the only manual steps involved
   4 are scheme updates for the IDO database.
   5
   6 Specific version upgrades are described below. Please note that version
   7 updates are incremental. An upgrade from v2.6 to v2.8 requires to
   8 follow the instructions for v2.7 too.
   9
  10 ## Upgrading to v2.8.2 <a id="upgrading-to-2-8-2"></a>
  11
  12 With version 2.8.2 the location of settings formerly found in `/etc/icinga2/init.conf` has changed. They are now
  13 located in the sysconfig, `/etc/sysconfig/icinga2` (RPM) or `/etc/default/icinga2` (DPKG) on most systems. The
  14 `init.conf` file has been removed and its settings will be ignored. These changes are only relevant if you edited the
  15 `init.conf`. Below is a table displaying the new names for the affected settings.
  16
  17  Old `init.conf` | New `sysconfig/icinga2`
  18  ----------------|------------------------
  19  RunAsUser       | ICINGA2\_USER
  20  RunAsGroup      | ICINGA2\_GROUP
  21  RLimitFiles     | ICINGA2\_RLIMIT\_FILES
  22  RLimitProcesses | ICINGA2\_RLIMIT\_PROCESSES
  23  RLimitStack     | ICINGA2\_RLIMIT\_STACK
  24
  25
  26 ## Upgrading to v2.8 <a id="upgrading-to-2-8"></a>
  27
  28 ### DB IDO Schema Update to 2.8.0 <a id="upgrading-to-2-8-db-ido"></a>
  29
  30 There are additional indexes and schema fixes which require an update.
  31
  32 Please proceed here for [MySQL](16-upgrading-icinga-2.md#upgrading-mysql-db) or [PostgreSQL](16-upgrading-icinga-2.md#upgrading-postgresql-db).
  33
  34 > **Note**
  35 >
  36 > `2.8.1.sql` fixes a unique constraint problem with fresh 2.8.0 installations.
  37 > You don't need this update if you are upgrading from an older version.
  38
  39 ### Changed Certificate Paths <a id="upgrading-to-2-8-certificate-paths"></a>
  40
  41 The default certificate path was changed from `/etc/icinga2/pki` to
  42 `/var/lib/icinga2/certs`.
  43
  44   Old Path                                           | New Path
  45   ---------------------------------------------------|---------------------------------------------------
  46   `/etc/icinga2/pki/icinga2-client1.localdomain.crt` | `/var/lib/icinga2/certs/icinga2-client1.localdomain.crt`
  47   `/etc/icinga2/pki/icinga2-client1.localdomain.key` | `/var/lib/icinga2/certs/icinga2-client1.localdomain.key`
  48   `/etc/icinga2/pki/ca.crt`                          | `/var/lib/icinga2/certs/ca.crt`
  49
  50 This applies to Windows clients in the same way: `%ProgramData%\etc\icinga2\pki`
  51 was moved to `%ProgramData%\var\lib\icinga2\certs`.
  52
  53   Old Path                                                        | New Path
  54   ----------------------------------------------------------------|----------------------------------------------------------------
  55   `%ProgramData%\etc\icinga2\pki\icinga2-client1.localdomain.crt` | `%ProgramData%\var\lib\icinga2\certs\icinga2-client1.localdomain.crt`
  56   `%ProgramData%\etc\icinga2\pki\icinga2-client1.localdomain.key` | `%ProgramData%\var\lib\icinga2\certs\icinga2-client1.localdomain.key`
  57   `%ProgramData%\etc\icinga2\pki\ca.crt`                          | `%ProgramData%\var\lib\icinga2\certs\ca.crt`
  58
  59
  60 > **Note**
  61 >
  62 > The default expected path for client certificates is `/var/lib/icinga2/certs/ + NodeName + {.crt,.key}`.
  63 > The `NodeName` constant is usually the FQDN and certificate common name (CN). Check the [conventions](06-distributed-monitoring.md#distributed-monitoring-conventions)
  64 > section inside the Distributed Monitoring chapter.
  65
  66 The [setup CLI commands](06-distributed-monitoring.md#distributed-monitoring-setup-master) and the
  67 default [ApiListener configuration](06-distributed-monitoring.md#distributed-monitoring-apilistener)
  68 have been adjusted to these paths too.
  69
  70 The [ApiListener](09-object-types.md#objecttype-apilistener) object attributes `cert_path`, `key_path`
  71 and `ca_path` have been deprecated and removed from the example configuration.
  72
  73 #### Migration Path <a id="upgrading-to-2-8-certificate-paths-migration-path"></a>
  74
  75 > **Note**
  76 >
  77 > Icinga 2 automatically migrates the certificates to the new default location if they
  78 > are configured and detected in `/etc/icinga2/pki`.
  79
  80 During startup, the migration kicks in and ensures to copy the certificates to the new
  81 location. This will also happen if someone updates the certificate files in `/etc/icinga2/pki`
  82 to ensure that the new certificate location always has the latest files.
  83
  84 This has been implemented in the Icinga 2 binary to ensure it works on both Linux/Unix
  85 and the Windows platform.
  86
  87 If you are not using the built-in CLI commands and setup wizards to deploy the client certificates,
  88 please ensure to update your deployment tools/scripts. This mainly affects
  89
  90 * Puppet modules
  91 * Ansible playbooks
  92 * Chef cookbooks
  93 * Salt recipes
  94 * Custom scripts, e.g. Windows Powershell or self-made implementations
  95
  96 In order to support a smooth migration between versions older than 2.8 and future releases,
  97 the built-in certificate migration path is planned to exist as long as the deprecated
  98 `ApiListener` object attributes exist.
  99
 100 You are safe to use the existing configuration paths inside the `api` feature.
 101
 102 **Example**
 103
 104 Look at the following example taken from the Director Linux deployment script for clients.
 105
 106 * Ensure that the default certificate path is changed from `/etc/icinga2/pki` to `/var/lib/icinga2/certs`.
 107
 108 ```
 109 -ICINGA2_SSL_DIR="${ICINGA2_CONF_DIR}/pki"
 110 +ICINGA2_SSL_DIR="${ICINGA2_STATE_DIR}/lib/icinga2/certs"
 111 ```
 112
 113 * Remove the ApiListener configuration attributes.
 114
 115 ```
 116 object ApiListener "api" {
 117 -  cert_path = SysconfDir + "/icinga2/pki/${ICINGA2_NODENAME}.crt"
 118 -  key_path = SysconfDir + "/icinga2/pki/${ICINGA2_NODENAME}.key"
 119 -  ca_path = SysconfDir + "/icinga2/pki/ca.crt"
 120   accept_commands = true
 121   accept_config = true
 122 }
 123 ```
 124
 125 Test the script with a fresh client installation before putting it into production.
 126
 127 > **Tip**
 128 >
 129 > Please support module and script developers in their migration. If you find
 130 > any project which would require these changes, create an issue or a patchset in a PR
 131 > and help them out. Thanks in advance!
 132
 133 ### On-Demand Signing and CA Proxy <a id="upgrading-to-2-8-on-demand-signing-ca-proxy"></a>
 134
 135 Icinga 2 v2.8 supports the following features inside the cluster:
 136
 137 * Forward signing requests from clients through a satellite instance to a signing master ("CA Proxy").
 138 * Signing requests without a ticket. The master instance allows to list and sign CSRs ("On-Demand Signing").
 139
 140 In order to use these features, **all instances must be upgraded to v2.8**.
 141
 142 More details in [this chapter](06-distributed-monitoring.md#distributed-monitoring-setup-sign-certificates-master).
 143
 144 ### Windows Client <a id="upgrading-to-2-8-windows-client"></a>
 145
 146 Windows versions older than Windows 10/Server 2016 require the [Universal C Runtime for Windows](https://support.microsoft.com/en-us/help/2999226/update-for-universal-c-runtime-in-windows).
 147
 148 ### Removed Bottom Up Client Mode <a id="upgrading-to-2-8-removed-bottom-up-client-mode"></a>
 149
 150 This client mode was deprecated in 2.6 and was removed in 2.8.
 151
 152 The node CLI command does not provide `list` or `update-config` anymore.
 153
 154 > **Note**
 155 >
 156 > The old migration guide can be found on [GitHub](https://github.com/Icinga/icinga2/blob/v2.7.0/doc/06-distributed-monitoring.md#bottom-up-migration-to-top-down-).
 157
 158 The clients don't need to have a local `conf.d` directory included.
 159
 160 Icinga 2 continues to run with the generated and imported configuration.
 161 You are advised to [migrate](https://github.com/Icinga/icinga2/issues/4798)
 162 any existing configuration to the "top down" mode with the help of the
 163 Icinga Director or config management tools such as Puppet, Ansible, etc.
 164
 165
 166 ### Removed Classic UI Config Package <a id="upgrading-to-2-8-removed-classicui-config-package"></a>
 167
 168 The config meta package `classicui-config` and the configuration files
 169 have been removed. You need to manually configure
 170 this legacy interface. Create a backup of the configuration
 171 before upgrading and re-configure it afterwards.
 172
 173
 174 ### Flapping Configuration <a id="upgrading-to-2-8-flapping-configuration"></a>
 175
 176 Icinga 2 v2.8 implements a new flapping detection algorithm which splits the
 177 threshold configuration into low and high settings.
 178
 179 `flapping_threshold` is deprecated and does not have any effect when flapping
 180 is enabled. Please remove `flapping_threshold` from your configuration. This
 181 attribute will be removed in v2.9.
 182
 183 Instead you need to use the `flapping_threshold_low` and `flapping_threshold_high`
 184 attributes. More details can be found [here](08-advanced-topics.md#check-flapping).
 185
 186 ### Deprecated Configuration Attributes <a id="upgrading-to-2-8-deprecated-configuration"></a>
 187
 188   Object        | Attribute
 189   --------------|------------------
 190   ApiListener   | cert\_path (migration happens)
 191   ApiListener   | key\_path (migration happens)
 192   ApiListener   | ca\_path (migration happens)
 193   Host, Service | flapping\_threshold (has no effect)
 194
 195 ## Upgrading to v2.7 <a id="upgrading-to-2-7"></a>
 196
 197 v2.7.0 provided new notification scripts and commands. Please ensure to
 198 update your configuration accordingly. An advisory has been published [here](https://www.icinga.com/2017/08/23/advisory-for-icinga-2-v2-7-update-and-mail-notification-scripts/).
 199
 200 In case are having troubles with OpenSSL 1.1.0 and the
 201 public CA certificates, please read [this advisory](https://www.icinga.com/2017/08/30/advisory-for-ssl-problems-with-leading-zeros-on-openssl-1-1-0/)
 202 and check the [troubleshooting chapter](15-troubleshooting.md#troubleshooting).
 203
 204 If Icinga 2 fails to start with an empty reference to `$ICINGA2_CACHE_DIR`
 205 ensure to set it inside `/etc/sysconfig/icinga2` (RHEL) or `/etc/default/icinga2` (Debian).
 206
 207 RPM packages will put a file called `/etc/sysconfig/icinga2.rpmnew`
 208 if you have modified the original file.
 209
 210 Example on CentOS 7:
 211
 212 ```
 213 vim /etc/sysconfig/icinga2
 214
 215 ICINGA2_CACHE_DIR=/var/cache/icinga2
 216
 217 systemctl restart icinga2
 218 ```
 219
 220 ## Upgrading the MySQL database <a id="upgrading-mysql-db"></a>
 221
 222 If you want to upgrade an existing Icinga 2 instance, check the
 223 `/usr/share/icinga2-ido-mysql/schema/upgrade` directory for incremental schema upgrade file(s).
 224
 225 > **Note**
 226 >
 227 > If there isn't an upgrade file for your current version available, there's nothing to do.
 228
 229 Apply all database schema upgrade files incrementally.
 230
 231 ```
 232 # mysql -u root -p icinga < /usr/share/icinga2-ido-mysql/schema/upgrade/<version>.sql
 233 ```
 234
 235 The Icinga 2 DB IDO feature checks the required database schema version on startup
 236 and generates an log message if not satisfied.
 237
 238
 239 **Example:** You are upgrading Icinga 2 from version `2.4.0` to `2.8.0`. Look into
 240 the `upgrade` directory:
 241
 242 ```
 243 $ ls /usr/share/icinga2-ido-mysql/schema/upgrade/
 244 2.0.2.sql 2.1.0.sql 2.2.0.sql 2.3.0.sql 2.4.0.sql 2.5.0.sql 2.6.0.sql 2.8.0.sql
 245 ```
 246
 247 There are two new upgrade files called `2.5.0.sql`, `2.6.0.sql` and `2.8.0.sql`
 248 which must be applied incrementally to your IDO database.
 249
 250 ```
 251 # mysql -u root -p icinga < /usr/share/icinga2-ido-mysql/schema/upgrade/2.5.0.sql
 252 # mysql -u root -p icinga < /usr/share/icinga2-ido-mysql/schema/upgrade/2.6.0.sql
 253 # mysql -u root -p icinga < /usr/share/icinga2-ido-mysql/schema/upgrade/2.8.0.sql
 254 ```
 255
 256 ## Upgrading the PostgreSQL database <a id="upgrading-postgresql-db"></a>
 257
 258 If you want to upgrade an existing Icinga 2 instance, check the
 259 `/usr/share/icinga2-ido-pgsql/schema/upgrade` directory for incremental schema upgrade file(s).
 260
 261 > **Note**
 262 >
 263 > If there isn't an upgrade file for your current version available, there's nothing to do.
 264
 265 Apply all database schema upgrade files incrementally.
 266
 267 ```
 268 # export PGPASSWORD=icinga
 269 # psql -U icinga -d icinga < /usr/share/icinga2-ido-pgsql/schema/upgrade/<version>.sql
 270 ```
 271
 272 The Icinga 2 DB IDO feature checks the required database schema version on startup
 273 and generates an log message if not satisfied.
 274
 275 **Example:** You are upgrading Icinga 2 from version `2.4.0` to `2.8.0`. Look into
 276 the `upgrade` directory:
 277
 278 ```
 279 $ ls /usr/share/icinga2-ido-pgsql/schema/upgrade/
 280 2.0.2.sql 2.1.0.sql 2.2.0.sql 2.3.0.sql 2.4.0.sql 2.5.0.sql 2.6.0.sql 2.8.0.sql
 281 ```
 282
 283 There are two new upgrade files called `2.5.0.sql`, `2.6.0.sql` and `2.8.0.sql`
 284 which must be applied incrementally to your IDO database.
 285
 286 ```
 287 # export PGPASSWORD=icinga
 288 # psql -U icinga -d icinga < /usr/share/icinga2-ido-pgsql/schema/upgrade/2.5.0.sql
 289 # psql -U icinga -d icinga < /usr/share/icinga2-ido-pgsql/schema/upgrade/2.6.0.sql
 290 # psql -U icinga -d icinga < /usr/share/icinga2-ido-pgsql/schema/upgrade/2.8.0.sql
 291 ```