Commit Graph

14 Commits

Author SHA1 Message Date
Michael Friedrich 2b7b2ebd29
Merge pull request #5783 from Icinga/fix/docs-formatting
Fix formatting in value types docs
2017-11-28 11:37:00 +01:00
Michael Friedrich 678defcdb0 Fix formatting in value types docs 2017-11-20 18:48:26 +01:00
Michael Friedrich 6d9a0b7145 Implement DummyCheckTask and move dummy into embedded in-memory checks
This replaces the previous "dummy" CheckCommand, and the user won't
notice it. Provided performance data will be parsed the same way.

This saves a shell fork and check_dummy execution.

We're relying on this when creating cluster checks with Icinga 2 DSL
and more. If one does not have the plugins installed, this then also works.

fixes #5740
2017-11-09 20:19:31 +01:00
Robin O'Brien 31a35a5966 Fixed grammer and spelling mistakes 2017-10-30 18:02:42 +02:00
Michael Friedrich 1da5c53fee Enhance Monitoring Basics in the documentation
This commit adds documentation for

* custom attributes value types and nested dictionaries
* better introduction into apply rules and usage examples
* better apply for iterations and explanations
* notifications with users on the host/service objects explained in a dedicated chapter
* command arguments and set_if - which values are supported
* macro() as scoped function
* alternative host check command

This also changes all code and config snippets to use
three backticks instead of four spaces indent.

fixes #5663
fixes #5664
fixes #5665
fixes #5666
fixes #5667
fixes #5186
fixes #5060
fixes #5662
2017-10-10 21:08:19 +02:00
Michael Friedrich 2d8607d6b0 Enhance documentation with more details on value types for object attributes
Main focus: Object attributes and their value types. Originates from the
API Event Streams patch to document their value types. Now applied to
the entire configuration objects chapter.

The API chapter and their value types has been changed to capitalized
type identifiers.

Value types are now explicitly told about inside monitoring basics. This
has been adopted into the Icinga 2 training material a long time ago
and finds its way into the docs too.

The CheckResult and PerfdataValue value types have been moved into the
advanced topics chapter. mkdocs doesn't like multiple `#` headings in one file
and did just hide it.

Also moved the Influxdb details into the features documentation where it
belongs.

Many small references and URLs to other chapters added.
E.g. dedicated chapters for object accessor examples, to better link against
time dependent thresholds.

Can serve as patch basis and reference for ITL documentation where the
value types are missing too.

This commit also fixes the non-requirement of "legacy-timeperiod" which
also is a default template import since 2.6.

This also fixes the state mapping issue.

fixes #4015
2017-10-10 17:52:49 +02:00
Michael Friedrich 95f0a7a022 Docs: Technical Concepts for cluster and signing
refs #5450
2017-09-12 12:52:50 +02:00
Michael Friedrich f0fbcbba5b Update documentation for optional arguments and add old updated command config
See https://www.icinga.com/docs/icinga2/latest/doc/03-monitoring-basics/#notification-commands-in-27

refs #5474
2017-08-14 17:11:57 +02:00
Michael Friedrich 10b17d8295 Docs: Add section for multiple template imports 2017-08-11 12:49:10 +02:00
Michael Friedrich 5c1de34b0e Docs: Fix ITL chapter TOC; add introduction with mini TOC
fixes #5428
2017-08-08 14:41:27 +02:00
Michael Friedrich e12e04e18c Fix missing code block in the docs
refs #5475
2017-08-08 12:21:09 +02:00
Michael Friedrich bd7d7ef845 Docs: Add a note on required configuration updates for new notification scripts in v2.7.0 2017-08-08 12:14:52 +02:00
Michael 60a851c504 added missing notification state 2017-07-27 08:55:35 +02:00
Blerim Sheqa eb88217e2d Update docs for better compatibility with mkdocs
* Rename files to allow easy ordering
* Update links inside markdown according to new file names
* Move HTML links (<a>...</a>) to the end of the header lines
  * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC
  * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00