tyler.durden/icinga2
1
0
Fork 0
mirror of https://github.com/Icinga/icinga2.git synced 2025-07-21 04:34:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

Remove Classic UI references from docs

Browse Source 
refs #5301
This commit is contained in:
Michael Friedrich 2017-09-22 12:25:47 +02:00
parent 6ab38b6c15
commit f41f220c78
5 changed files with 24 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/09-object-types.md
View File

@ -1478,7 +1478,7 @@ Configuration Attributes:
## StatusDataWriter <a id="objecttype-statusdatawriter"></a> ## StatusDataWriter <a id="objecttype-statusdatawriter"></a>
Periodically writes status data files which are used by the Classic UI and other third-party tools. Periodically writes status and configuration data files which are used by third-party tools.
Example: Example:
@ -1494,8 +1494,8 @@ Configuration Attributes:
Name |Description Name |Description
----------------|---------------- ----------------|----------------
status\_path |**Optional.** Path to the status.dat file. Defaults to LocalStateDir + "/cache/icinga2/status.dat". status\_path |**Optional.** Path to the `status.dat` file. Defaults to LocalStateDir + "/cache/icinga2/status.dat".
objects\_path |**Optional.** Path to the objects.cache file. Defaults to LocalStateDir + "/cache/icinga2/objects.cache". objects\_path |**Optional.** Path to the `objects.cache` file. Defaults to LocalStateDir + "/cache/icinga2/objects.cache".
update\_interval|**Optional.** The interval in which the status files are updated. Defaults to 15 seconds. update\_interval|**Optional.** The interval in which the status files are updated. Defaults to 15 seconds.

2
doc/10-icinga-template-library.md
View File

@ -2644,7 +2644,7 @@ interfacetable_noifloadgradient | **Optional.** Disable color gradient from
interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false. interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false. interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s". interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi". interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga" or "icinga-alternate1".
interfacetable_config | **Optional.** Specify a config file to load. interfacetable_config | **Optional.** Specify a config file to load.
interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false. interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false. interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.

63
doc/14-features.md
View File

@ -435,16 +435,17 @@ The [MK Livestatus](https://mathias-kettner.de/checkmk_livestatus.html) project
implements a query protocol that lets users query their Icinga instance for implements a query protocol that lets users query their Icinga instance for
status information. It can also be used to send commands. status information. It can also be used to send commands.
> **Tip**
>
> Only install the Livestatus feature if your web interface or addon requires
> you to do so (for example, [Icinga Web 2](02-getting-started.md#setting-up-icingaweb2)).
> Icinga Classic UI 1.x and Icinga Web 1.x do not use Livestatus as backend.
The Livestatus component that is distributed as part of Icinga 2 is a The Livestatus component that is distributed as part of Icinga 2 is a
re-implementation of the Livestatus protocol which is compatible with MK re-implementation of the Livestatus protocol which is compatible with MK
Livestatus. Livestatus.
> **Tip**
>
> Only install the Livestatus feature if your web interface or addon requires
> you to do so.
> [Icinga Web 2](02-getting-started.md#setting-up-icingaweb2) does not need
> Livestatus.
Details on the available tables and attributes with Icinga 2 can be found Details on the available tables and attributes with Icinga 2 can be found
in the [Livestatus Schema](24-appendix.md#schema-livestatus) section. in the [Livestatus Schema](24-appendix.md#schema-livestatus) section.
@ -454,14 +455,8 @@ You can enable Livestatus using icinga2 feature enable:
After that you will have to restart Icinga 2: After that you will have to restart Icinga 2:
RHEL/CentOS 7/Fedora, SLES 12, Debian Jessie/Stretch, Ubuntu Xenial:
# systemctl restart icinga2 # systemctl restart icinga2
Debian/Ubuntu, RHEL/CentOS 6 and SUSE:
# service icinga2 restart
By default the Livestatus socket is available in `/var/run/icinga2/cmd/livestatus`. By default the Livestatus socket is available in `/var/run/icinga2/cmd/livestatus`.
In order for queries and commands to work you will need to add your query user In order for queries and commands to work you will need to add your query user
@ -635,12 +630,8 @@ status updates in a regular interval.
# icinga2 feature enable statusdata # icinga2 feature enable statusdata
Icinga 1.x Classic UI requires this data set as part of its backend. If you are not using any web interface or addon which uses these files,
you can safely disable this feature.
> **Note**
>
> If you are not using any web interface or addon which uses these files,
> you can safely disable this feature.
## Compat Log Files <a id="compat-logging"></a> ## Compat Log Files <a id="compat-logging"></a>
@ -648,11 +639,11 @@ Icinga 1.x Classic UI requires this data set as part of its backend.
The Icinga 1.x log format is considered being the `Compat Log` The Icinga 1.x log format is considered being the `Compat Log`
in Icinga 2 provided with the `CompatLogger` object. in Icinga 2 provided with the `CompatLogger` object.
These logs are not only used for informational representation in These logs are used for informational representation in
external web interfaces parsing the logs, but also to generate external web interfaces parsing the logs, but also to generate
SLA reports and trends in Icinga 1.x Classic UI. Furthermore the SLA reports and trends.
[Livestatus](14-features.md#setting-up-livestatus) feature uses these logs for answering queries to The [Livestatus](14-features.md#setting-up-livestatus) feature uses these logs
historical tables. for answering queries to historical tables.
The `CompatLogger` object can be enabled with The `CompatLogger` object can be enabled with
@ -662,34 +653,6 @@ By default, the Icinga 1.x log file called `icinga.log` is located
in `/var/log/icinga2/compat`. Rotated log files are moved into in `/var/log/icinga2/compat`. Rotated log files are moved into
`var/log/icinga2/compat/archives`. `var/log/icinga2/compat/archives`.
The format cannot be changed without breaking compatibility to
existing log parsers.
# tail -f /var/log/icinga2/compat/icinga.log
[1382115688] LOG ROTATION: HOURLY
[1382115688] LOG VERSION: 2.0
[1382115688] HOST STATE: CURRENT;localhost;UP;HARD;1;
[1382115688] SERVICE STATE: CURRENT;localhost;disk;WARNING;HARD;1;
[1382115688] SERVICE STATE: CURRENT;localhost;http;OK;HARD;1;
[1382115688] SERVICE STATE: CURRENT;localhost;load;OK;HARD;1;
[1382115688] SERVICE STATE: CURRENT;localhost;ping4;OK;HARD;1;
[1382115688] SERVICE STATE: CURRENT;localhost;ping6;OK;HARD;1;
[1382115688] SERVICE STATE: CURRENT;localhost;processes;WARNING;HARD;1;
[1382115688] SERVICE STATE: CURRENT;localhost;ssh;OK;HARD;1;
[1382115688] SERVICE STATE: CURRENT;localhost;users;OK;HARD;1;
[1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;disk;1382115705
[1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;http;1382115705
[1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;load;1382115705
[1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;ping4;1382115705
[1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;ping6;1382115705
[1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;processes;1382115705
[1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;ssh;1382115705
[1382115706] EXTERNAL COMMAND: SCHEDULE_FORCED_SVC_CHECK;localhost;users;1382115705
[1382115731] EXTERNAL COMMAND: PROCESS_SERVICE_CHECK_RESULT;localhost;ping6;2;critical test|
[1382115731] SERVICE ALERT: localhost;ping6;CRITICAL;SOFT;2;critical test
## Check Result Files <a id="check-result-files"></a> ## Check Result Files <a id="check-result-files"></a>
Icinga 1.x writes its check result files to a temporary spool directory Icinga 1.x writes its check result files to a temporary spool directory

8
doc/23-migrating-from-icinga-1x.md
View File

@ -959,7 +959,7 @@ Please check the migration hints for a detailed
> **Note** > **Note**
> >
> The Classic UI feature named `Command Expander` does not work with Icinga 2. > The Icinga 1.x feature named `Command Expander` does not work with Icinga 2.
#### Environment Macros <a id="differences-1x-2-environment-macros"></a> #### Environment Macros <a id="differences-1x-2-environment-macros"></a>
@ -1252,7 +1252,7 @@ notification configuration problem in Icinga 1.x:
* Service A should notify contact X via SMS * Service A should notify contact X via SMS
* Service B should notify contact X via Mail * Service B should notify contact X via Mail
* Service C should notify contact Y via Mail and SMS * Service C should notify contact Y via Mail and SMS
* Contact X and Y should also be used for authorization (e.g. in Classic UI) * Contact X and Y should also be used for authorization
The only way achieving a semi-clean solution is to The only way achieving a semi-clean solution is to
@ -1421,11 +1421,11 @@ The format is **not** compatible with Icinga 1.x.
### Logging <a id="differences-1x-2-logging"></a> ### Logging <a id="differences-1x-2-logging"></a>
Icinga 1.x supports syslog facilities and writes its own `icinga.log` log file Icinga 1.x supports syslog facilities and writes its own `icinga.log` log file
and archives. These logs are used in Icinga 1.x Classic UI to generate and archives. These logs are used in Icinga 1.x to generate
historical reports. historical reports.
Icinga 2 compat library provides the CompatLogger object which writes the icinga.log and archive Icinga 2 compat library provides the CompatLogger object which writes the icinga.log and archive
in Icinga 1.x format in order to stay compatible with Classic UI and other addons. in Icinga 1.x format in order to stay compatible with addons.
The native Icinga 2 logging facilities are split into three configuration objects: SyslogLogger, The native Icinga 2 logging facilities are split into three configuration objects: SyslogLogger,
FileLogger, StreamLogger. Each of them has their own severity and target configuration. FileLogger, StreamLogger. Each of them has their own severity and target configuration.

18
doc/24-appendix.md
View File

@ -133,21 +133,9 @@ command tables.
Object | Prefix Object | Prefix
------------------------|------------------------ ------------------------|------------------------
CheckCommand | check_ CheckCommand | check\_
EventCommand | event_ EventCommand | event\_
NotificationCommand | notification_ NotificationCommand | notification\_
### Status Files <a id="schema-status-files"></a>
Status files used by Icinga 1.x Classic UI: `status.dat`, `objects.cache`.
Icinga 2 specific extensions:
* host and service objects support 'check_source' (added in Classic UI 1.10.0)
* command objects support custom variables (added in Classic UI 1.11.2)
* host and service objects support 'is_reachable' (added in Classic UI 1.11.3)
* 2.2 adds custom attributes with arrays and dictionaries. They are dumped as JSON encoded string and `_is_json`
is set as additional custom variable in `objects.cache`.
### DB IDO Schema <a id="schema-db-ido"></a> ### DB IDO Schema <a id="schema-db-ido"></a>