From 3f14b374bc65ca8c1afccc61da8a288b0a4489b2 Mon Sep 17 00:00:00 2001 From: Michael Friedrich Date: Wed, 14 Aug 2013 13:46:13 +0200 Subject: [PATCH] docs: add install/config/main pages --- docs/.gitignore | 2 + docs/Makefile.am | 8 +++- docs/icinga2-config.adoc | 80 ++++++++++++++++++++++++++++++++++++++ docs/icinga2-install.adoc | 67 +++++++++++++++++++++++++++++++ docs/icinga2-main.adoc | 55 ++++++++++++++++++++++++++ docs/icinga2-tutorial.adoc | 1 + 6 files changed, 212 insertions(+), 1 deletion(-) create mode 100644 docs/icinga2-config.adoc create mode 100644 docs/icinga2-install.adoc create mode 100644 docs/icinga2-main.adoc diff --git a/docs/.gitignore b/docs/.gitignore index 55cf3109d..8eb6e94c8 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -4,6 +4,8 @@ icinga2-config.html icinga2-config-syntax.html icinga2-config-types.html icinga2-tutorial.html +icinga2-main.html +icinga2-install.html icinga2-config.xml icinga2.8 .directory diff --git a/docs/Makefile.am b/docs/Makefile.am index 228305052..45d32faa8 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,10 +1,13 @@ .PHONY: clean EXTRA_DIST = \ + icinga2-config.adoc \ icinga2-config-syntax.adoc \ icinga2-config-types.adoc \ + icinga2-install.adoc \ icinga2-intro.adoc \ icinga2-tutorial.adoc \ + icinga2-main.adoc \ icinga2.8 icinga2docdir = ${docdir} @@ -17,10 +20,13 @@ man8_MANS = \ if AD_COND_doc icinga2doc_DATA += \ + icinga2-config.html \ icinga2-config-syntax.html \ icinga2-config-types.html \ + icinga2-install.html \ icinga2-intro.html \ - icinga2-tutorial.html + icinga2-tutorial.html \ + icinga2-main.html .adoc.html: $(AD_ENV) $(AD_ASCIIDOC) -a toc -a numbered -o $@ $< diff --git a/docs/icinga2-config.adoc b/docs/icinga2-config.adoc new file mode 100644 index 000000000..3467ce5dc --- /dev/null +++ b/docs/icinga2-config.adoc @@ -0,0 +1,80 @@ +Icinga 2 Configuration +====================== + +:keywords: Icinga, documentation, index +:description: Main index of Icinga 2 documentation + +Configuration Introduction +-------------------------- + +In Icinga 2 configuration is based on objects. There's no difference in defining +global settings for the core application or for a specific runtime configuration +object. + +There are different types for the main application, its components and tools. +The runtime configuration objects such as hosts, services, etc are defined using +the same syntax. + +Each configuration object must be unique by its name. Otherwise Icinga 2 will +bail early on verifying the parsed configuration. + +Main Configuration +------------------ + +Starting Icinga 2 requires the main configuration file called "icinga2.conf". +That's the location where everything is defined or included. Icinga 2 will only +know the content of that file and included configuration file snippets. + +---- +# /usr/bin/icinga2 -c /etc/icinga2/icinga2.conf +---- + +NOTE: You can use just the main configuration file and put everything in there. +Though that is not advised because configuration may be expanded over time. +Rather organize runtime configuration objects into their own files and/or +directories and include that in the main configuration file. + +Configuration Syntax +-------------------- + +/* TODO */ + +Details on the syntax can be found in the chapter +icinga2-config-syntax.html[Configuration Syntax] + + +Configuration Types +------------------- + +/* TODO */ + +Details on the available types can be found in the chapter +icinga2-config-types.html[Configuration Types] + + +Configuration Templates +----------------------- + +Icinga 2 ships with the *Icinga Template Library (ITL)*. This is a set of +predefined templates and definitions available in your actual configuration. + +NOTE: Do not change the ITL's files. They will be overridden on upgrade. Submit +a patch upstream or include your very own configuration snippet. + +Include the basic ITL set in your main configuration like + +---- +include +---- + +NOTE: Icinga 2 recognizes the ITL's installation path and looks for that +specific file then. + +Having Icinga 2 installed in standalone mode make sure to include +itl/standalone.conf as well (see sample configuration). + +---- +include +---- + +/* vim: set syntax=asciidoc filetype=asciidoc: */ diff --git a/docs/icinga2-install.adoc b/docs/icinga2-install.adoc new file mode 100644 index 000000000..7c4bd3b0c --- /dev/null +++ b/docs/icinga2-install.adoc @@ -0,0 +1,67 @@ +Icinga 2 Installation +===================== + +:keywords: Icinga, documentation, installation +:description: Icinga 2 Installation + +Requirements +------------ + + +Packages +-------- + +NOTE: Use packages whenever possible. + +|=== +|Distribution | Package URL +|Debian | TBD +|RHEL/CentOS | TBD +|SLES | TBD +|=== + +In case you're running a distribution for which Icinga 2 packages are not yet +available download the source tarball and jump to Source Builds. + + +Windows Installer +----------------- + +TODO + +Source Builds +------------- + +Download the source tarball and read the 'INSTALL' file for details and +requirements. + +Linux Builds +~~~~~~~~~~~~ + +Building from source on specific linux distributions is described on the wiki: +https://wiki.icinga.org/display/icinga2/Linux+Builds + +Windows Builds +~~~~~~~~~~~~~~ + +Icinga 2 ships a MS Visual Studio solution file. Requirements and compilation +instructions can be found on the wiki: +https://wiki.icinga.org/display/icinga2/Windows+Builds + +Installation Locations +---------------------- + +|=== +|Path |Description +|/etc/icinga2 |Contains Icinga 2 configuration files. +|/etc/init.d/icinga2 |The Icinga 2 init script. +|/usr/share/doc/icinga2 |Documentation files that come with Icinga 2. +|/usr/share/icinga2/itl |The Icinga Template Library. +|/var/run/icinga2 |Command pipe and PID file. +|/var/cache/icinga2 |Performance data files and status.dat/objects.cache. +|/var/lib/icinga2 |The Icinga 2 state file. +|=== + +/* TODO */ + +/* vim: set syntax=asciidoc filetype=asciidoc: */ diff --git a/docs/icinga2-main.adoc b/docs/icinga2-main.adoc new file mode 100644 index 000000000..5c2dd8006 --- /dev/null +++ b/docs/icinga2-main.adoc @@ -0,0 +1,55 @@ +Icinga 2 +======== + +:keywords: Icinga, documentation, index +:description: Main index of Icinga 2 documentation + +Introduction +------------ + +A detailed introduction can be found in the chapter link:icinga2-intro.html[Introduction]. /* TODO insert url */ + +Installation +------------ + +For more information see the chapter Installation. /* TODO insert url */ + +Quick Example +------------- + +/* TODO */ + +For a general tutorial see the chapter link:icinga2-tutorial.html[Tutorial]. /* TODO insert url */ + +Requirements +------------ + +/* TODO */ + +License +------- +Icinga 2 is licensed under the GPLv2 license, a copy of this license can be found in the LICENSE file on +the main source tree. + + +Community +--------- + +* http://webchat.freenode.net/?channels=icinga[#icinga] on the Freenode IRC Network +* https://lists.sourceforge.net/lists/listinfo/icinga-users[Mailinglists] +* http://www.monitoring-portal.org[Monitoring Portal] + +More details at http://www.icinga.org/support/ + +Support +------- + +For more information on the support options refer to https://www.icinga.org/support + + +Chapters +-------- + +/* TODO */ + +/* vim: set syntax=asciidoc filetype=asciidoc: */ diff --git a/docs/icinga2-tutorial.adoc b/docs/icinga2-tutorial.adoc index 5226aa676..6ba8ca248 100644 --- a/docs/icinga2-tutorial.adoc +++ b/docs/icinga2-tutorial.adoc @@ -785,3 +785,4 @@ additive attributes: ---- +/* vim: set syntax=asciidoc filetype=asciidoc: */