[icinga-checkins] icinga.org: icinga-doc/next: docs issue #3906: add hints on addons to beginners/monitoring-overview

git at icinga.org git at icinga.org
Wed Apr 10 23:28:20 CEST 2013


Module: icinga-doc
Branch: next
Commit: 3eea151213e2d925133bea6e80f3a7af064ed754
URL:    https://git.icinga.org/?p=icinga-doc.git;a=commit;h=3eea151213e2d925133bea6e80f3a7af064ed754

Author: Wolfgang <wnd at gmx.net>
Date:   Fri Mar 29 21:35:45 2013 +0100

docs issue #3906: add hints on addons to beginners/monitoring-overview

---

 de/beginners.xml           |    2 ++
 de/icinga-overview.xml     |   39 +++++++++++++++++++++++++++++++++++++++
 de/monitoring-overview.xml |    5 +++++
 en/beginners.xml           |    2 ++
 en/icinga-overview.xml     |   37 +++++++++++++++++++++++++++++++++++++
 en/monitoring-overview.xml |    5 +++++
 6 files changed, 90 insertions(+), 0 deletions(-)

diff --git a/de/beginners.xml b/de/beginners.xml
index 085ae53..b7d15fc 100644
--- a/de/beginners.xml
+++ b/de/beginners.xml
@@ -58,6 +58,8 @@
     </listitem>
   </orderedlist>
 
+  <xi:include href="icinga-overview.xml" />
+
   <indexterm zone="beginners">
     <primary>Anfänger, Hinweise für</primary>
   </indexterm>
diff --git a/de/icinga-overview.xml b/de/icinga-overview.xml
new file mode 100644
index 0000000..a545335
--- /dev/null
+++ b/de/icinga-overview.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section [
+<!ENTITY % all.entities SYSTEM "all-entities.ent">
+%all.entities;
+]>
+<section version="5.0" xml:id="icinga-overview" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+         xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg" xmlns:m="http://www.w3.org/1998/Math/MathML"
+         xmlns:html="http://www.w3.org/1999/xhtml" xmlns:db="http://docbook.org/ns/docbook">
+  <title>&name-icinga;-Überblick</title>
+
+  <para><emphasis role="bold"><anchor xml:id="icinga_overview"/>Überblick</emphasis></para>
+
+  <para>Dieser Abschnitt soll Ihnen einen kurzen Überblick darüber geben, was enthalten ist und was nicht. Er ist möglicherweise nicht
+  vollständig, aber wir arbeiten daran.</para>
+
+  <para>&name-icinga; besteht aus einem Kern, der die Ergebnisse verarbeitet, die von Prüfungen stammen, die entweder vom Core initiert
+  werden (<link linkend="activechecks">aktive Prüfungen</link>), oder von anderen Maschinen kommen (<link linkend="passivechecks">passive
+  Prüfungen</link>), der entscheidet ob <link linkend="notifications">Benachrichtungen</link> versandt werden müssen, der Informationen in
+  Log-Dateien schreibt oder sie durch ein <link linkend="cgis">Web-interface</link> darstellt, sowie andere Aufgaben.</para>
+
+  <para>Der Kern enthält <emphasis>keinerlei</emphasis> Prüfungen, sondern diese werden stattdessen von <link
+  linkend="plugins">Plugins</link> ausgeführt. Die Benachrichtigung von <link linkend="objectdefinitions-contact">Kontakten</link> erfolgt
+  mit Methoden, die vom Betriebssystem zur Verfügung gestellt werden (z.B. sendmail/postfix/..., SMS, Pager). <note>
+      <para>Die Installation und Konfiguration von Plugins, Addons und betriebssystemnaher Software sprengt in den meisten Fällen den Rahmen
+      dieser Dokumentation. Konsultieren Sie daher möglichst zuerst die Dokumentation des Herstellers, benutzen Sie Ihre bevorzugte
+      Suchmaschine falls das nicht hilft, und suchen Sie Hilfe in Foren. Wenn Sie Anleitungen aus Blogs oder anderen privaten Quellen
+      konsultieren, dann finden Sie oft veraltete Informationen oder solche, die nicht auf Ihre Umgebung passt, so dass Sie darauf
+      verzichten sollten.</para>
+    </note>Die Erweiterung der Funktionalität kann durch die Installation von <link linkend="addons">Addons</link> erreicht werden. Dort
+  finden Sie Hinweise zu Web-basierten Konfigurations-Tools, alternativen Web-Interfaces, der Darstellung von Performance-Daten,
+  Benachrichtigung von Kontakten und mehr.</para>
+
+  <para>Die Konfiguration basiert auf Textdateien und die Verwaltung erfordert lediglich einen Texteditor wie den vi. Die <link
+  linkend="objectinheritance">Vererbung</link> mit Hilfe von Vorlagen vereinfacht die Definition von Objekten, indem sie die Definition auf
+  ein Minimum reduziert.</para>
+
+  <para>Der Zugriff auf die Informationen kann durch das CGI-basierte Classic-UI, das &name-web;-UI, oder verschiedene andere Interfaces
+  erfolgen, die ebenfalls in <link linkend="addons">Addons</link> genannt werden.</para>
+</section>
diff --git a/de/monitoring-overview.xml b/de/monitoring-overview.xml
index 4bda808..ab53243 100644
--- a/de/monitoring-overview.xml
+++ b/de/monitoring-overview.xml
@@ -83,6 +83,11 @@
     </listitem>
   </itemizedlist>
 
+  <note>
+    <para>Bitte lesen Sie auch den Abschnitt zu <link linkend="addons">Addons</link>, weil dort allgemeine Hinweise zu Konfigurations-Tools,
+    Web-Interfaces und anderen Addons zu finden sind, die es für &name-icinga; gibt.</para>
+  </note>
+
   <indexterm zone="monitoring_overview">
     <primary>Monitoring-Überblick</primary>
   </indexterm>
diff --git a/en/beginners.xml b/en/beginners.xml
index 4ec54f9..a3e31f9 100644
--- a/en/beginners.xml
+++ b/en/beginners.xml
@@ -51,6 +51,8 @@
       </listitem>
     </orderedlist></para>
 
+    <xi:include href="icinga-overview.xml" />
+
   <indexterm zone="advice_for_beginners">
     <primary>Beginners, Advice for</primary>
   </indexterm>
diff --git a/en/icinga-overview.xml b/en/icinga-overview.xml
new file mode 100644
index 0000000..d8ab4db
--- /dev/null
+++ b/en/icinga-overview.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section [
+<!ENTITY % all.entities SYSTEM "all-entities.ent">
+%all.entities;
+]>
+<section version="5.0" xml:id="icinga-overview" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+         xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg" xmlns:m="http://www.w3.org/1998/Math/MathML"
+         xmlns:html="http://www.w3.org/1999/xhtml" xmlns:db="http://docbook.org/ns/docbook">
+  <title>&name-icinga; Overview</title>
+
+  <para><emphasis role="bold"><anchor xml:id="icinga_overview"/>Overview</emphasis></para>
+
+  <para>This section should give you a short overview on what is included and what isn't. It might be incomplete but we're working on
+  that.</para>
+
+  <para>&name-icinga; consists of a core processing results from checks which are initiated by the core (<link linkend="activechecks">active
+  checks</link>), or delivered from other machines (<link linkend="passivechecks">passive checks</link>), deciding if <link
+  linkend="notifications">notifications</link> have to be sent, providing information by writing log files and showing it via a <link
+  linkend="cgis">web interface</link>, and several other tasks.</para>
+
+  <para>The core does <emphasis>not</emphasis> contain any checks itself but they are executed by <link linkend="plugins">plugins</link>
+  instead. Notifying <link linkend="objectdefinitions-contact">contacts</link> is done by methods provided by the operating system (i.e.
+  sendmail/postfix/..., sms, pager). <note>
+      <para>Installation and configuration of plugins, addons, and os related software is mostly beyond the scope of this documentation so
+      please consult the documentation provided by the manufacturer first, use your favourite search engine if that doesn't help, and seek
+      help in forums. Consulting instructions from blogs or other personal stuff you will often find information that is outdated or doesn't
+      fit your environment so try to avoid such sources.</para>
+    </note>Extending the functionality can be accomplished by installing <link linkend="addons">addons</link>. There you will find hints on
+  web-based configuration tools, alternative web interfaces, presenting performance data, notifying contacts, and more.</para>
+
+  <para>The configuration is based on text files and managing them requires just a text editor like vi. <link
+  linkend="objectinheritance">Inheritance</link> using templates simplifies defining objects because it enables you to reduce the definition
+  to a minimum.</para>
+
+  <para>Accessing the information can be done via the cgi-based classic ui, the &name-web; ui, or several other interfaces like mentioned in
+  <link linkend="addons">addons</link> as well.</para>
+</section>
diff --git a/en/monitoring-overview.xml b/en/monitoring-overview.xml
index 28b9439..f252d34 100644
--- a/en/monitoring-overview.xml
+++ b/en/monitoring-overview.xml
@@ -81,6 +81,11 @@
     </listitem>
   </itemizedlist>
 
+  <note>
+    <para>Please be sure to have read the section on <link linkend="addons">addons</link> as well because it gives general hints on
+    configuration tools, web interfaces, and other addons which are available for &name-icinga;.</para>
+  </note>
+
   <indexterm zone="adaptive_monitoring">
     <primary>Monitoring Overview</primary>
   </indexterm>





More information about the icinga-checkins mailing list