]> granicus.if.org Git - icinga2/commitdiff
Update documentation.
authorGunnar Beutner <gunnar.beutner@netways.de>
Fri, 27 Sep 2013 09:48:20 +0000 (11:48 +0200)
committerGunnar Beutner <gunnar.beutner@netways.de>
Fri, 27 Sep 2013 11:56:24 +0000 (13:56 +0200)
doc/2.1.1-setting-up-icinga-2.md
doc/2.2-running-icinga.md
etc/icinga2/conf.d/localhost.conf

index b100cefc2a114ec6596714e55e22135dcea3ab8d..7a899071702145ee39a6180a0e46ed9961ee44e2 100644 (file)
@@ -34,12 +34,11 @@ By default Icinga 2 uses the following files and directories:
   /var/cache/icinga2                  |Performance data files and status.dat/objects.cache.
   /var/lib/icinga2                    |The Icinga 2 state file.
 
-#### Configuration
+#### icinga2.conf
 
-An example configuration file is installed for you in /etc/icinga2/icinga2.conf.
+An example configuration file is installed for you in */etc/icinga2/icinga2.conf*.
 
-Here's a brief description of the concepts the example configuration file
-introduces:
+Here's a brief description of the example config:
 
     /**
      * Icinga 2 configuration file
@@ -59,6 +58,37 @@ The *include* directive can be used to include other files. The *itl/itl.conf*
 file is distributed as part of Icinga 2 and provides a number of useful templates
 and constants you can use to configure your services.
 
+    /**
+     * The features-available directory contains a number of configuration
+     * files for features which can be enabled and disabled using the
+     * i2enfeature / i2disfeature tools. These two tools work by creating
+     * and removing symbolic links in the features-enabled directory.
+     */
+    include "features-enabled/*.conf"
+
+The Icinga 2 example configuration includes a number of configuration files for
+some of Icinga 2's features. These are installed in the *features-available*
+directory and can be enabled and disabled using the *i2enfeature* and
+*i2disfeature* tools.
+
+This include directive takes care of including the configuration files for all
+the features which have been enabled with *i2enfeature*. See
+[Enabling/Disabling Features](#features) for more details.
+
+    /**
+     * Although in theory you could define all your objects in this file
+     * the preferred way is to create separate files in the conf.d
+     * directory.
+     */
+    include "conf.d/*.conf"
+
+You can put your own configuration files in the *conf.d* directory. This
+directive makes sure that all of your own configuration files are included.
+
+#### macros.conf
+
+The *conf.d/macros.conf* file can be used to define global macros:
+
     /**
      * Global macros
      */
@@ -69,31 +99,12 @@ and constants you can use to configure your services.
 Icinga 2 lets you define free-form macros. The IcingaMacros variable can be used
 to define global macros which are available in all command definitions.
 
-    /**
-     * The compat library periodically updates the status.dat and objects.cache
-     * files. These are used by the Icinga 1.x CGIs to display the state of
-     * hosts and services. CompatLog writeis the Icinga 1.x icinga.log and archives.
-     */
-    library "compat"
-
-Some of Icinga 2's functionality is available in separate libraries. These
-libraries usually implement their own object types that can be used to configure
-what you want the library to do.
-
-    object StatusDataWriter "status" { }
-    object ExternalCommandListener "command" { }
-    object CompatLogger "compat-log" { }
-
-Those three object types are provided by the *compat* library:
+#### localhost.conf
 
-  Type                     | Description
-  -------------------------|-------------------------
-  StatusDataWriter         | Responsible for writing the status.dat and objects.cache files.
-  ExternalCommandListener  | Implements the command pipe which is used by the CGIs to send commands to Icinga 2.
-  CompatLogger             | Writes log files in a format that is compatible with Icinga 1.x.
+The *conf.d/localhost.conf* file contains our first host definition:
 
     /**
-     * And finally we define some host that should be checked.
+     * Our first host.
      */
     object Host "localhost" {
       services["ping4"] = {
index 988c0e8549b5aa442f8e4f3e4165290454ff3cf0..012889d941ae661afaf00446faf9a5a79cf126f6 100644 (file)
@@ -1,3 +1,5 @@
 ## Running Icinga
 
 TODO
+
+### <a id="features"></a> Enabling/Disabling Features
\ No newline at end of file
index 191bffa09615969cfa0cea1cd8bbf6eb87d5bb75..cc17aae3614b754ab2328bd7bf074a69d248b929 100644 (file)
@@ -1,5 +1,5 @@
 /**
- * And finally we define some host that should be checked.
+ * Out first host.
  */
 object Host "localhost" {
   services["ping4"] = {