From: Gunnar Beutner Date: Fri, 27 Sep 2013 05:19:13 +0000 (+0200) Subject: Update documentation. X-Git-Tag: v0.0.3~381 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=22dccac2b02172b3845004e1d96dab94d9c4e6da;p=icinga2 Update documentation. --- diff --git a/doc/1-about.md b/doc/1-about.md index 37e8d71f1..c8f9ca0ea 100644 --- a/doc/1-about.md +++ b/doc/1-about.md @@ -1,22 +1,20 @@ -# About +# About Icinga 2 -## About Icinga 2 - -### What is Icinga? +## What is Icinga 2? Icinga 2 is a network monitoring application. -### Licensing +## Licensing Icinga 2 and the Icinga 2 documentation are licensed under the terms of the GNU General Public License Version 2, you will find a copy of this license in the LICENSE file included in the package. -### Support +## Support Support for Icinga 2 is available in a number of ways. Please have a look at the support overview page at https://www.icinga.org/support/. ## What's New in Version 0.0.3 -* Lots of things. \ No newline at end of file +* Lots of things. diff --git a/doc/2-getting-started.md b/doc/2-getting-started.md index 83af1feca..3da28d604 100644 --- a/doc/2-getting-started.md +++ b/doc/2-getting-started.md @@ -6,7 +6,7 @@ This tutorial is a step-by-step introduction to installing Icinga 2 and the standalone version of the Icinga 1.x classic web interface. It assumes that you are familiar with the system you're installing Icinga 2 on. -### Installing Icinga 2 +### Setting up Icinga 2 In order to get started with Icinga 2 you will have to install it. The preferred way of doing this is to use the official Debian or RPM @@ -27,6 +27,8 @@ In case you're running a distribution for which Icinga 2 packages are not yet available you will have to check out the Icinga 2 Git repository from git://git.icinga.org/icinga2 and read the *INSTALL* file. +#### Installation Paths + By default Icinga 2 uses the following files and directories: Path |Description @@ -39,6 +41,8 @@ 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 + 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 @@ -149,7 +153,7 @@ The *macros* attribute can be used to define macros that are available for all services which belong to this host. Most of the templates in the Icinga Template Library require an *address* macro. -### Installing the Icinga Classic UI +### Setting up the Icinga Classic UI Icinga 2 can write status.dat and objects.cache files in the format that is supported by the Icinga 1.x Classic UI. External commands (a.k.a. the @@ -163,6 +167,8 @@ You should be able to find the status.dat and objects.cache files in /var/cache/icinga2. The log files can be found in /var/log/icinga2/compat. The command pipe can be found in /var/run/icinga2. +#### Installing the Icinga Classic UI + You can install the Icinga 1.x Classic UI in standalone mode using the following commands: @@ -179,9 +185,11 @@ following commands: > found on the Icinga Wiki here: > [https://wiki.icinga.org/display/howtos/Setting+up+Icinga+Classic+UI+Standalone](https://wiki.icinga.org/display/howtos/Setting+up+Icinga+Classic+UI+Standalone) +#### Configuring the Classic UI + After installing the Classic UI you will need to update the following -settings in your cgi.cfg configuration file in the "STANDALONE (ICINGA 2) -OPTIONS" section: +settings in your *cgi.cfg* configuration file in the *STANDALONE (ICINGA 2) +OPTIONS* section: Configuration Setting |Value ------------------------------------|------------------------------------ @@ -215,4 +223,50 @@ write permissions for the command pipe: Verify that your Icinga 1.x Classic UI works by browsing to your Classic UI installation URL, e.g. -[http://localhost/icinga](http://localhost/icinga) \ No newline at end of file +[http://localhost/icinga](http://localhost/icinga) + +### Configuring IDO Support + +TODO + +## Running Icinga + +TODO + +## Monitoring Basics + +### Hosts + +TODO + +### Services + +TODO + +### Check Commands + +TODO + +### Macros + +TODO + +## Using Templates + +TODO + +## Groups + +TODO + +## Host/Service Dependencies + +TODO + +## Time Periods + +TODO + +## Notifications + +TODO diff --git a/doc/3-configuring-icinga.md b/doc/3-configuring-icinga.md index e69de29bb..3e9b3a661 100644 --- a/doc/3-configuring-icinga.md +++ b/doc/3-configuring-icinga.md @@ -0,0 +1 @@ +# Configuring Icinga \ No newline at end of file diff --git a/doc/3.1-configuration-syntax.md b/doc/3.1-configuration-syntax.md index 52a8a4f22..28a96c827 100644 --- a/doc/3.1-configuration-syntax.md +++ b/doc/3.1-configuration-syntax.md @@ -1,8 +1,6 @@ -Configuration Syntax -==================== +## Configuration Syntax -Object Definition ------------------ +### Object Definition Icinga 2 features an object-based configuration format. In order to define objects the *object* keyword is used: @@ -29,7 +27,7 @@ Each object is uniquely identified by its type (*Host*) and name property declarations. The following data types are available for property values: -### Numeric Literals +#### Numeric Literals A floating-point number. @@ -37,7 +35,7 @@ Example: -27.3 -### Duration Literal +#### Duration Literals Similar to floating-point numbers except for the fact that they support suffixes to help with specifying time durations. @@ -49,7 +47,7 @@ Example: Supported suffixes include ms (milliseconds), s (seconds), m (minutes) and h (hours). -### String Literals +#### String Literals A string. @@ -74,7 +72,7 @@ In addition to these pre-defined escape sequences you can specify arbitrary ASCII characters using the backslash character (\\) followed by an ASCII character in octal encoding. -### Multiline String Literals +#### Multiline String Literals Strings spanning multiple lines can be specified by enclosing them in {{{ and }}}. @@ -86,15 +84,15 @@ Example. a multi-line string.}}} -### Boolean Literals +#### Boolean Literals The keywords *true* and *false* are equivalent to 1 and 0 respectively. -### Null Value +#### Null Value The *null* keyword can be used to specify an empty value. -### Dictionary +#### Dictionary An unordered list of key-value pairs. Keys must be unique and are compared in a case-insensitive manner. @@ -121,7 +119,7 @@ Example: > Setting a dictionary key to null causes the key and its value to be > removed from the dictionary. -### Array +#### Array An ordered list of values. @@ -130,26 +128,20 @@ comma. The comma after the last element is optional. Example: - [ - "hello", - "world", - 42, - [ "a", "nested", "array" ] - ] + [ "hello", 42 ] > **Note** > -> An array may simultaneously contain values of different types, e.g. +> An array may simultaneously contain values of different types, such as > strings and numbers. -Operators ---------- +### Operators In addition to the *=* operator shown above a number of other operators to manipulate configuration objects are supported. Here's a list of all available operators: -### Operator = +#### Operator = Sets a dictionary element to the specified value. @@ -162,7 +154,7 @@ Example: In this example a has the value 7 after both instructions are executed. -### Operator += +#### Operator += Modifies a dictionary or array by adding new elements to it. @@ -178,7 +170,7 @@ only works for dictionaries and arrays. -Attribute Shortcuts -------------------- +### Indexer -### Indexer Shortcut +The indexer syntax provides a convenient way to set dictionary elements. Example: @@ -243,8 +234,7 @@ This is equivalent to writing: } } -Inheritance ------------ +### Inheritance Objects can inherit attributes from other objects. @@ -278,8 +268,7 @@ templates though in general they are. Parent objects are resolved in the order they're specified using the *inherits* keyword. -Variables ---------- +### Variables Global variables can be set using the *set* keyword: @@ -287,8 +276,7 @@ Global variables can be set using the *set* keyword: The value can be a string, number, array or a dictionary. -Constant Expressions --------------------- +### Constant Expressions Simple calculations can be performed using the constant expression syntax: @@ -318,8 +306,7 @@ Global variables may be used in constant expressions. > Constant expressions are evaluated as soon as they're encountered in > the configuration file. -Comments --------- +### Comments The Icinga 2 configuration format supports C/C++-style comments. @@ -333,8 +320,7 @@ Example: retry_interval = 15 } -Includes --------- +### Includes Other configuration files can be included using the *include* directive. Paths must be relative to the configuration file that contains the @@ -361,8 +347,7 @@ paths. Wildcards are not permitted when using angle brackets. -Library directive ------------------ +### Library directive The *library* directive can be used to manually load additional libraries. Libraries can be used to provide additional object types and @@ -378,8 +363,7 @@ Example: