From 7ded2bf19d9cd73d44b3ae552f72758e09a8585b Mon Sep 17 00:00:00 2001 From: Thomas Gelf Date: Thu, 26 Sep 2019 00:22:05 +0200 Subject: [PATCH] doc, module.info: refresh, cleanup, prepare v1.7.0 --- doc/02-Installation.md | 8 +++--- doc/05-Upgrading.md | 6 +++++ doc/79-Jobs.md | 56 ++++-------------------------------------- doc/82-Changelog.md | 35 +++++++++++++++++++++----- module.info | 2 +- 5 files changed, 46 insertions(+), 61 deletions(-) diff --git a/doc/02-Installation.md b/doc/02-Installation.md index 1d6a7a0e0..ede405272 100644 --- a/doc/02-Installation.md +++ b/doc/02-Installation.md @@ -27,6 +27,9 @@ Requirements for MySQL we suggest using at least 5.5.3, for PostgreSQL 9.4. * PHP (>= 5.6.3). For best performance please consider use 7.x * php-curl +* php-pcntl (might already be built into your PHP binary) +* php-posix (on RHEL/CentOS this is php-process, or rh-php7x-php-process) +* php-sockets (might already be built into your PHP binary) Database -------- @@ -89,7 +92,7 @@ You might want to use a script as follows for this task: ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules" REPO_URL="https://github.com/icinga/icingaweb2-module-director" TARGET_DIR="${ICINGAWEB_MODULEPATH}/director" - MODULE_VERSION="1.6.2" + MODULE_VERSION="1.7.0" URL="${REPO_URL}/archive/v${MODULE_VERSION}.tar.gz" install -d -m 0755 "${TARGET_DIR}" wget -q -O - "$URL" | tar xfz - -C "${TARGET_DIR}" --strip-components 1 @@ -106,7 +109,7 @@ It will be immediately ready for use: ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules" REPO_URL="https://github.com/icinga/icingaweb2-module-director" TARGET_DIR="${ICINGAWEB_MODULEPATH}/director" - MODULE_VERSION="1.6.2" + MODULE_VERSION="1.7.0" git clone "${REPO_URL}" "${TARGET_DIR}" --branch v${MODULE_VERSION} You can now directly use our current GIT master or check out a specific version. @@ -132,4 +135,3 @@ tab. Either way you'll reach the kickstart wizards. Follow the instructions and you're all done! - diff --git a/doc/05-Upgrading.md b/doc/05-Upgrading.md index 3827f1683..7f336db83 100644 --- a/doc/05-Upgrading.md +++ b/doc/05-Upgrading.md @@ -50,6 +50,12 @@ modules have been installed and enabled: * [incubator](https://github.com/Icinga/icingaweb2-module-incubator) (>=0.5.0) * [reactbundle](https://github.com/Icinga/icingaweb2-module-reactbundle) (>=0.7.0) +Also, the following PHP libraries should be available: + +* php-pcntl (might already be built into your PHP binary) +* php-posix (on RHEL/CentOS this is php-process, or rh-php7x-php-process) +* php-sockets (might already be built into your PHP binary) + Apart from this, in case you are running 1.6.x or any GIT master since then, all you need is to replace the Director module folder with the new one. Or to run `git checkout v1.7.x` in case you installed Director from GIT. diff --git a/doc/79-Jobs.md b/doc/79-Jobs.md index 45f791fee..09ab6020a 100644 --- a/doc/79-Jobs.md +++ b/doc/79-Jobs.md @@ -1,8 +1,11 @@ Jobs ===================== -Director allows you to schedule eventually long-running tasks so that they -can run in the background. Currently this includes: +The [background daemon](75-Background-Daemon.md) is responsible for running +Jobs accoring our schedule. Director allows you to schedule eventually long- +running tasks so that they can run in the background. + +Currently this includes: * Import runs * Sync runs @@ -27,55 +30,6 @@ executed all around the clock. That's why you have the possibility to assign time periods to your jobs. Choose an Icinga timeperiod, the job will only be executed within that period. -Execution methods ------------------ - -Jobs are executed on CLI, basically with the `jobs` CLI command and its -available actions and options. A call to... - -```sh -icingacli director jobs run -``` - -...would run all currently pending jobs just once. As cron jobs should not run -forever, the command terminates after this. In case you want it to keep on -running, just add `forever` (or `--forever`) to the command: - -```sh -icingacli director jobs run forever -``` - -This could be used to run the Job Runner as a daemon, preferrably with a -systemd unit file looking as follows: - -```ini -[Unit] -Description=Director Job runner - -[Service] -Type=simple -ExecStart=/usr/bin/icingacli director jobs run forever -Restart=on-success -``` - -However, `forever` is not forever. In case Director detects that too much -memory has been used (and not freed), it terminates itself with exit code 0. -So, like the above init script, please expect the Job Runner to terminate at -any time. - -Want so see more details? Add `--verbose` to get colorful log lines on STDERR. -In case the Job Runner is running with Systemd, those log lines will find its -way to your system log. - -An example script is included as [contrib](../contrib/systemd/director-jobs.service) -and can simply stored in `/etc/systemd/system/director-jobs.service`. To enable -and start the job afterwards run: - -```sh -systemctl enable director-jobs.service -systemctl start director-jobs.service -``` - Time periods ------------ diff --git a/doc/82-Changelog.md b/doc/82-Changelog.md index 25d639546..f21c767e7 100644 --- a/doc/82-Changelog.md +++ b/doc/82-Changelog.md @@ -4,14 +4,13 @@ Please make sure to always read our [Upgrading](05-Upgrading.md) documentation before switching to a new version. -1.7.0 (unreleased) ------------------- +1.7.0 +----- ### Breaking Changes * At least PHP 5.6.3 is now required, Director 1.7.x will refuse to work with older versions -* New dependencies have been introduced: you're now required to install the ipl -* Please check [packages.icinga.com](https://packages.icinga.com), we're now - shipping official packages for the Icinga Director +* New dependencies have been introduced, [Upgrading](05-Upgrading.md) and + [Installation](02-Installation.md) documentations contain related details ### Fixed issues * You can find issues and feature requests related to this release on our @@ -25,16 +24,35 @@ before switching to a new version. * FIX: Import preview in combination with Black/Whitelisting (#1825) * FIX: Routing/redirection when working with Data Fields (#1847) * FIX: Auto-suggestion field was positioned wrongly once scrolled down +* FIX: Timezone inconsistencie have been fixed (#1700) +* FIX: Link-like buttons where shortened on Icinga Web 2.7 (#1928) +* FIX: Search in range-filtered Activity Log no longer fails (#1381) * FEATURE: It's now possible to clone a Service to a different Host (#1796) * FEATURE: Scheduled Downtimes for "Hosts AND their services" (#1831) -* FEATURE: auto-suggestion and more for Fields based on Data Lists (#1846) +* FEATURE: Auto-suggestion and more for Fields based on Data Lists (#1846) +* FEATURE: Show missing dependencies (#1938) + +### Translations +* FEATURE: German translation has been refreshed (#1951) +* FEATURE: Japanese is now available (#1869) ### Import and Sync * FIX: Avoid caching between multiple runs of sync (#1836) +* FIX: Imported Rows Table (history) eventually failed on Icinga Web 2 (#1925) +* FIX: Improved error handling on preview (#1941) * FEATURE: When fetching invalid data, Import refers erroneous rows (#1741) * FEATURE: Sync now offers a preview, showing what would happen (#1754) * FEATURE: ParseURL property modifier has been added (#1746) * FEATURE: There is a new generic REST API Import Source (#1818) +* FEATURE: Sync now supports Notifications and Dependencies (#1212, #925, #1209) +* FEATURE: Limits (memory, execution time) raised for Import runs via UI (#1954) + +### Configuration Baskets +* FIX: snapshots do no longer fail for deleted elements on snapshot (#1940) +* FEATURE: baskets now support External Commands (#1854) + +### REST API +* FIX: Command Arguments can now be managed via API (#1416) ### CLI * FIX: importsource fetch did not apply configured property modifiers (#1819) @@ -42,8 +60,13 @@ before switching to a new version. ### Icinga Configuration * FIX: Allow to render single configuration files larger than 16MB (#1787) +* FIX: Icinga v2.11 version detection for Agent Installation script (#1957) +* DEPRECATED: magic-apply-for (a hidden feature) is now deprecated (#1850) * FEATURE: It's now possible to define Scheduled Downtimes (#347, #1828) * FEATURE: Allow to render command definitions as (v1.x-like) strings (#1809) +* FEATURE: host address now allows 255 characters (#1890) +* FEATURE: Director now assists with Services applied to parent Zones (#1634) +* FEATURE: Warn affected setups when affected by a specific core issue (#1958) ### Documentation * FIX: Installation instructions have been adjusted to fit MySQL 8 diff --git a/module.info b/module.info index deaa1e05b..295a49ce1 100644 --- a/module.info +++ b/module.info @@ -1,5 +1,5 @@ Name: Icinga Director -Version: master +Version: 1.7.0 Depends: reactbundle (>=0.7.0), ipl (>=0.3.0), incubator (>=0.5.0) Description: Director - Config tool for Icinga 2 Icinga Director is a configuration tool that has been designed to make