More mkdocs/Markdown tests.
This commit is contained in:
parent
e65fbae8dd
commit
629aa8777a
8 changed files with 35 additions and 62 deletions
|
|
@ -1,10 +0,0 @@
|
|||
---
|
||||
title: About
|
||||
---
|
||||
|
||||
<h2>About</h2>
|
||||
|
||||
<h3>Introduction</h3>
|
||||
|
||||
<p>More to come...</p>
|
||||
|
||||
5
docs/configuration/index.md
Normal file
5
docs/configuration/index.md
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Configuration
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
|
@ -2,19 +2,19 @@
|
|||
title: Minimal Configuration Guide
|
||||
---
|
||||
|
||||
<h2>Minimal Configuration Guide</h2>
|
||||
# Minimal Configuration Guide
|
||||
|
||||
<ul>
|
||||
<li><i>Added: 2013.09.30 by Johannes Findeisen (hanez)</i></li>
|
||||
<li><i>Last update: 2013.11.03 by Johannes Findeisen (hanez)</i></li>
|
||||
<li><i>License: <a href="http://creativecommons.org/licenses/by-sa/3.0/" class="ext">CC Attribution-Share Alike 3.0 Unported</a></i></li>
|
||||
</ul>
|
||||
- <i>Added: 2013.09.30 by Johannes Findeisen (hanez)</i></li>
|
||||
- <i>Last update: 2013.11.03 by Johannes Findeisen (hanez)</i></li>
|
||||
- <i>License: <a href="http://creativecommons.org/licenses/by-sa/3.0/" class="ext">CC Attribution-Share Alike 3.0 Unported</a></i></li>
|
||||
|
||||
<h3>Introduction</h3>
|
||||
## Introduction
|
||||
|
||||
<p>This is step by step guide on howto setup Linspector for monitoring two services on two hosts. Be sure to always write <a href="http://en.wikipedia.org/wiki/JSON" class="ext">JSON</a> compatible syntax, e.g. add colons, commas etc. the right places or Linspector will fail to parse the configuration at startup.</p>
|
||||
This is step-by-step guide on howto setup Linspector for monitoring two services on two hosts. Be sure
|
||||
to always write <a href="http://en.wikipedia.org/wiki/JSON" class="ext">JSON</a> compatible syntax, e.g.
|
||||
add colons, commas etc. the right places or Linspector will fail to parse the configuration at startup.
|
||||
|
||||
<h3>The base configuration</h3>
|
||||
## The base configuration
|
||||
|
||||
<p>At first we need a minimal json config file:</p>
|
||||
|
||||
|
|
@ -33,7 +33,7 @@ title: Minimal Configuration Guide
|
|||
}
|
||||
}</pre>
|
||||
|
||||
<h3>Hostgroups and Hosts</h3>
|
||||
## Hostgroups and Hosts
|
||||
|
||||
<p>Now we need to add a minimum of one hostgroup. Hosts needs always to be nested in a hostgroup. So if you just want to monitor one host, you need add one hostgroup too. We will add two hosts to that hostgroup (demo1.example.org and demo2.example.org):</p>
|
||||
|
||||
|
|
@ -55,7 +55,7 @@ title: Minimal Configuration Guide
|
|||
}
|
||||
}</pre>
|
||||
|
||||
<h3>Services</h3>
|
||||
## Services
|
||||
|
||||
<p>We want to monitor the availability of port 80 (http) and 25 (smtp) now so we need to add two services of class "tcpconnect":</p>
|
||||
|
||||
|
|
@ -91,7 +91,7 @@ title: Minimal Configuration Guide
|
|||
}
|
||||
}</pre>
|
||||
|
||||
<h3>Periods / Polling Intervals</h3>
|
||||
## Periods / Polling Intervals
|
||||
|
||||
<p>Since we have a period (polling interval) set to "normal" we need to add a peroid to our base configuration. This peroid is an interval peroid which polls every 2 minutes. Other peroid types are cron based which accepts cron style parameters and date based which accepts a date and executes on that date.</p>
|
||||
|
||||
|
|
@ -128,7 +128,7 @@ title: Minimal Configuration Guide
|
|||
}
|
||||
}</pre>
|
||||
|
||||
<h3>Members and Tasks</h3>
|
||||
## Members and Tasks
|
||||
|
||||
<p>As you can see we have set a "threshold" to 10, so what is that? The threshold indicates after how many fails of polling a service an alert will be executed. We will come to that next. Alerting means that there must be performed some action when the threshold is overriden. For that Linspector has it's members in the base configuration. We will add a member which accepts alerts via email so we are adding a task of type "mail" for that. So let's add a member and it's task:</p>
|
||||
|
||||
|
|
@ -171,7 +171,7 @@ title: Minimal Configuration Guide
|
|||
}
|
||||
}</pre>
|
||||
|
||||
<h3>Core configuration for Tasks</h3>
|
||||
## Core configuration for Tasks
|
||||
|
||||
<p>Since we are making use of the mail task we need to set some configuration variables now. This will be the hostname of the SMTP server etc. For that we will add a task section containing a mail section directly in the root of the configuration:</p>
|
||||
|
||||
|
|
@ -221,7 +221,7 @@ title: Minimal Configuration Guide
|
|||
}
|
||||
}</pre>
|
||||
|
||||
<h3>Add member to Hostgroup</h3>
|
||||
## Add member to Hostgroup
|
||||
|
||||
<p>For now we have add a hostgroup, added two hosts to that group which each will be monitored for availability of two ports. They will be polled every 2 minutes by a peroid called "normal" and the alert threshold is set to 10 for both services. No we need to add the member to the hostgroup so the member "demo" will accept alerts for the hostgroup "demogroup1":</p>
|
||||
|
||||
|
|
@ -274,7 +274,7 @@ title: Minimal Configuration Guide
|
|||
|
||||
<p>We just added the string '"members": ["demo"],' (line 16) to the hostgroup. Thats it. If you want more members to be informed about alerts just add a new member to the members section and the add that meber to the list of members in the hostgroup.</p>
|
||||
|
||||
<h3>Layouts</h3>
|
||||
## Layouts
|
||||
|
||||
<p>Now we can finalize the configuration but there a still one step for making monitoring work with this configuration. We need to enable the hostgroup for monitoring in the layouts section of the configuration. This makes it possible to add hostgroups for testing or to organize your hosts in groups and then just enable the hostgroups in the layout you really want to monitor or you can configure downtimes for some hostgroups by just adding more layouts with hostgroups disabled for monitoring.</p>
|
||||
|
||||
|
|
@ -329,14 +329,14 @@ title: Minimal Configuration Guide
|
|||
}
|
||||
}</pre>
|
||||
|
||||
<h3>Finished Configuration</h3>
|
||||
## Finished Configuration
|
||||
|
||||
<p>We are done! This is a working example of a very minimal Linspector configuration file for monitoring two services on two hosts. Save the above file in the root of your Linspector installation as demo.json for later usage.</p>
|
||||
|
||||
<h3>Start Linspector</h3>
|
||||
## Start Linspector
|
||||
|
||||
<p>If everything was setup right you should be able to start Linspector for monitoring your hosts. Just run the following command in the root directory of your Linspector installation:</p>
|
||||
|
||||
<pre>bin/linspector ./demo.json</pre>
|
||||
|
||||
<p>That schould be all.</p>
|
||||
<p>That should be all.</p>
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
title: Documentation
|
||||
---
|
||||
|
||||
<h2>Documentation</h2>
|
||||
|
||||
<h3>Tutorials and Guides</h3>
|
||||
|
||||
<p>The following documentation is available to you:</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="/documentation/installation-guide/">Installation Guide</a></li>
|
||||
<li><a href="/documentation/minimal-configuration-guide/">Minimal Configuration Guide</a></li>
|
||||
<li><a href="/documentation/faq/">The Linspector FAQ's</a></li>
|
||||
</ul>
|
||||
|
||||
<p>If you wanna try to understand how Linspector works you can take a look at the <a href="https://github.com/linspector/linspector/blob/master/examples/minimal.json" class="ext">minimal.json configuration file</a>. It really shows up what is currently possible with Linspector but is not documented. Please ask us if you want to know more.</p>
|
||||
|
||||
<p>More documentation will follow ASAP! It is a work in progress.</p>
|
||||
|
|
@ -1,23 +1,19 @@
|
|||
---
|
||||
title: Home
|
||||
title: Introduction
|
||||
---
|
||||
|
||||
<h2>Linspector</h2>
|
||||
# Introduction
|
||||
|
||||
<h3>Introduction</h3>
|
||||
More to come...
|
||||
|
||||
<p>More to come...</p>
|
||||
## Documentation and Guides
|
||||
|
||||
<h3>Tutorials and Guides</h3>
|
||||
The following documentation is available to you:
|
||||
|
||||
<p>The following documentation is available to you:</p>
|
||||
- <a href="/faq/">The Linspector FAQ's</a>
|
||||
- <a href="/installation-guide/">Installation Guide</a>
|
||||
- <a href="/minimal-configuration-guide/">Minimal Configuration Guide</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="/documentation/installation-guide/">Installation Guide</a></li>
|
||||
<li><a href="/documentation/minimal-configuration-guide/">Minimal Configuration Guide</a></li>
|
||||
<li><a href="/documentation/faq/">The Linspector FAQ's</a></li>
|
||||
</ul>
|
||||
If you want to try to understand how Linspector works you can take a look at the <a href="https://github.com/linspector/linspector/blob/master/examples/minimal.json" class="ext">minimal.json configuration file</a>. It really shows up what is currently possible with Linspector but is not documented. Please ask us if you want to know more.
|
||||
|
||||
<p>If you wanna try to understand how Linspector works you can take a look at the <a href="https://github.com/linspector/linspector/blob/master/examples/minimal.json" class="ext">minimal.json configuration file</a>. It really shows up what is currently possible with Linspector but is not documented. Please ask us if you want to know more.</p>
|
||||
|
||||
<p>More documentation will follow ASAP! It is a work in progress.</p>
|
||||
More documentation will follow ASAP! It is a work in progress.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue