From: Michael Friedrich <michael.friedrich@netways.de>
Date: Fri, 11 Oct 2013 13:34:30 +0000 (+0200)
Subject: Documentation: Update ido installation.
X-Git-Tag: v0.0.3~158
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=bcd6cab527f2a8da920bbc2f80642e9b22bb5a32;p=icinga2

Documentation: Update ido installation.
---

diff --git a/doc/2.4-setting-up-ido.md b/doc/2.4-setting-up-ido.md
index 5f1334735..0f1f8fee4 100644
--- a/doc/2.4-setting-up-ido.md
+++ b/doc/2.4-setting-up-ido.md
@@ -7,6 +7,11 @@ by a number of projects including Icinga Web.
 There is a separate module for each database back-end. At present only support
 for MySQL is implemented.
 
+> **Note**
+>
+> Icinga 2 uses the Icinga 1.x IDOUtils database schema starting with version
+> `1.10.0`
+
 ### Setting up the database
 
 First of all you have to create a database for Icinga 2:
@@ -32,7 +37,36 @@ First of all you have to create a database for Icinga 2:
 After creating the database you can import the Icinga 2 IDO schema using the
 following command:
 
-    # mysql -u root -p icinga < /path/to/icinga-src/components/db_ido_mysql/schema/mysql.sql
+    # mysql -u root -p icinga < /usr/share/doc/icinga2-ido-mysql-*/schema/mysql.sql
+
+> **Note**
+>
+> The Icinga 2 rpm packages install the schema files into `/usr/share/doc/icinga2-ido-mysql-*/schema`.
+> The Icinga 2 tarball ships the schema files in `components/db_ido_mysql/schema/`.
+
+### Upgrading the database
+
+If the database has been installed and requires an upgrade, verify the current
+schema version first:
+
+    # mysql -u root -p icinga -e 'SELECT version FROM icinga_dbversion;'
+    +---------+
+    | version |
+    +---------+
+    | 1.10.0  |
+    +---------+
+
+Check the `schema/upgrade` directory for an incremental schema upgrade file, e.g.
+if your database schema version is `1.10.0` look for `mysql-upgrade-1.11.0.sql`
+and newer.
+Apply all database schema upgrade files incrementially.
+
+    # mysql -u root -p icinga < /usr/share/doc/icinga2-ido-mysql-*/schema/upgrade/mysql-upgrade-1.11.0.sql
+
+> **Note**
+>
+> The Icinga 2 IDO module will check for the required database schema version
+> on startup and generate an error message if not satisfied.
 
 ### Installing the IDO module