summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/02-Installation.md.d/From-Source.md6
-rw-r--r--doc/05-Upgrading.md10
-rw-r--r--doc/70-REST-API.md8
-rw-r--r--doc/82-Changelog.md160
-rw-r--r--doc/93-Testing.md10
-rw-r--r--doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-01-cidr_based_filters.pngbin0 -> 41770 bytes
-rw-r--r--doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-02-wrap_startup_log_lines.pngbin0 -> 97303 bytes
-rw-r--r--doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-03-template_usage.pngbin0 -> 48540 bytes
-rw-r--r--doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-04-upload_basket_snapshot.pngbin0 -> 42834 bytes
-rw-r--r--doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-05-notification_user-var.pngbin0 -> 59782 bytes
-rw-r--r--doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-06-notification_user-var_rendered.pngbin0 -> 61299 bytes
11 files changed, 179 insertions, 15 deletions
diff --git a/doc/02-Installation.md.d/From-Source.md b/doc/02-Installation.md.d/From-Source.md
index ea17233..8875152 100644
--- a/doc/02-Installation.md.d/From-Source.md
+++ b/doc/02-Installation.md.d/From-Source.md
@@ -20,7 +20,7 @@ Make sure you use `director` as the module name. The following requirements must
* [Icinga Web](https://github.com/Icinga/icingaweb2) (≥2.8.0). All versions since 2.2 should also work fine, but
might show smaller UI bugs and are not actively tested
* The following Icinga modules must be installed and enabled:
- * [incubator](https://github.com/Icinga/icingaweb2-module-incubator) (≥0.18.0)
+ * [incubator](https://github.com/Icinga/icingaweb2-module-incubator) (≥0.21.0)
* If you are using Icinga Web <2.9.0, the following modules are also required
* [ipl](https://github.com/Icinga/icingaweb2-module-ipl) (≥0.5.0)
* [reactbundle](https://github.com/Icinga/icingaweb2-module-reactbundle) (≥0.9.0)
@@ -41,7 +41,7 @@ and extract it to a folder named `director` in one of your Icinga Web module pat
You might want to use a script as follows for this task:
```shell
-MODULE_VERSION="1.10.2"
+MODULE_VERSION="1.11.1"
ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules"
REPO_URL="https://github.com/icinga/icingaweb2-module-director"
TARGET_DIR="${ICINGAWEB_MODULEPATH}/director"
@@ -60,7 +60,7 @@ Simply clone the repository in one of your Icinga web module path directories.
You might want to use a script as follows for this task:
```shell
-MODULE_VERSION="1.10.2"
+MODULE_VERSION="1.11.1"
ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules"
REPO_URL="https://github.com/icinga/icingaweb2-module-director"
TARGET_DIR="${ICINGAWEB_MODULEPATH}/director"
diff --git a/doc/05-Upgrading.md b/doc/05-Upgrading.md
index 63630b6..a4fe56c 100644
--- a/doc/05-Upgrading.md
+++ b/doc/05-Upgrading.md
@@ -15,6 +15,7 @@ you will be told so in your frontend.
Please read more about:
* [Database Backup](#backup-first)
+* [Upgrading to 1.11.x](#upgrade-to-1.11.x)
* [Upgrading to 1.10.x](#upgrade-to-1.10.x)
* [Upgrading to 1.9.x](#upgrade-to-1.9.x)
* [Upgrading to 1.8.x](#upgrade-to-1.8.x)
@@ -41,7 +42,14 @@ use the tools provided by your database backend, like `mysqldump` or `pg_dump`.
Restoring from a backup is trivial, and Director will always be able to apply
pending database migrations to an imported old database snapshot.
-<a name="upgrade-to-1.9.x"></a>Upgrading to 1.10.x
+<a name="upgrade-to-1.11.x"></a>Upgrading to 1.11.x
+--------------------------------------------------
+
+Before upgrading, please upgrade the [incubator module](https://github.com/Icinga/icingaweb2-module-incubator)
+to (at least) v0.21.0. As always, you'll be prompted to apply pending Database
+Migrations.
+
+<a name="upgrade-to-1.10.x"></a>Upgrading to 1.10.x
--------------------------------------------------
Please check module dependencies, we raised some of them. In case you're missing
diff --git a/doc/70-REST-API.md b/doc/70-REST-API.md
index dd5d266..6e7770d 100644
--- a/doc/70-REST-API.md
+++ b/doc/70-REST-API.md
@@ -164,7 +164,7 @@ Enabling `allowOverrides` allows you to let Director figure out, whether your
modified Custom Variables need to be applied to a specific individual Service,
or whether setting Overrides at Host level is the way to go.
- POST director/service?name=Uptime&host=hostname.example.com&allowOverrices
+ POST director/service?name=Uptime&host=hostname.example.com&allowOverrides
```json
{ "vars.uptime_warning": 300 }
@@ -257,7 +257,7 @@ You can of course also use the API to trigger specific actions. Deploying the co
More
----
-Currently we do not handle Last-Modified und ETag headers. This would involve some work, but could be a cool feature. Let us know your ideas!
+Currently, we do not handle Last-Modified und ETag headers. This would involve some work, but could be a cool feature. Let us know your ideas!
Sample scenario
@@ -560,8 +560,8 @@ Another possibility is to pass a list of checksums to fetch the status of
specific deployments and (activity log) activities.
Following, you can see an example of how to do it:
- GET director/config/deployment-status?config_checksums=617b9cbad9e141cfc3f4cb636ec684bd60073be2,
- 617b9cbad9e141cfc3f4cb636ec684bd60073be1&activity_log_checksums=617b9cbad9e141cfc3f4cb636ec684bd60073be1,
+ GET director/config/deployment-status?configs=617b9cbad9e141cfc3f4cb636ec684bd60073be2,
+ 617b9cbad9e141cfc3f4cb636ec684bd60073be1&activitiess=617b9cbad9e141cfc3f4cb636ec684bd60073be1,
028b3a19ca7457f5fc9dbb5e4ea527eaf61616a2
```json
diff --git a/doc/82-Changelog.md b/doc/82-Changelog.md
index 5867b41..08a6632 100644
--- a/doc/82-Changelog.md
+++ b/doc/82-Changelog.md
@@ -4,6 +4,166 @@
Please make sure to always read our [Upgrading](05-Upgrading.md) documentation
before switching to a new version.
+v1.11.1
+-------
+
+### UI
+* FIX: Data fields are now suggested for service templates without a check command (#2815, #2826)
+* FIX: Unsetting a parent host or service of a dependency is now correctly stored (no issue)
+* FIX: The activity log now avoids a bug in PHP introduced with version 8.1.25 (#2828)
+
+### Internals
+* FIX: UserGroup creation failed since v1.10.0 (#2784)
+* FIX: Hostgroup names consisting only of digits are now correctly handled (#2821)
+* FIX: Improved compatibility with PHP 8.1 and 8.2 (#2819, #2827)
+* FIX: The parent host or service of a dependency can now be reliably referenced by custom variable (#2289)
+* FIX: Services in service sets are now fully restored once a removed set is restored (#1065)
+
+### Integrations
+* FIX: Icinga DB integration now works even if the monitoring module is not available (#2635)
+* FIX: Conformity with the content security policy introduced with Icinga Web v2.12 (#2845)
+
+### Fixed issues
+* You can find issues and feature requests related to this release on our
+ [roadmap](https://github.com/Icinga/icingaweb2-module-director/milestone/35?closed=1)
+
+v1.11.0
+-------
+
+Icinga Director v1.11 ships a nice new feature, which has been requested by
+many users: it is now possible to let Notification rules pick User and/or User
+Groups from Host and Service custom variables.
+
+![Notification User Vars](screenshot/director/82_changelog/v1.11.0/82-1.11.0-05-notification_user-var.png)
+
+Behind the scenes, some Icinga DSL assures that Icinga behaves as expected:
+
+![Notification User Vars rendered](screenshot/director/82_changelog/v1.11.0/82-1.11.0-06-notification_user-var_rendered.png)
+
+The IcingaDB module is now supported. This release also ships a fallback template
+for Icinga for Windows 1.11 (and Icinga 2.14). To improve security for those
+relying on default settings, all Host templates are per default rendered to all
+non-global zones in a redundant way, instead of being rendered to the main global
+zone.
+
+For those who want to store Secrets in their Host template definitions, this now
+hinders them from reaching your Agent Endpoints. In addition to this, with this
+release you now have more control over target Zones for services belonging to
+Service Sets. Also, some issues related to permissions and restrictions have been
+addressed.
+
+Various little Import and Sync issues have been addressed, automated Service
+Template import has been fixed. In addition to some minor Property modifier
+improvements, they can now be applied in a conditional way. Such filter rules
+also support CIDR notation. Most prominent use-case: as vSphereDB now ships ALL
+guest IP addresses, you can pick specific addresses for specific use-cases /
+host properties based on their network range:
+
+![CIDR-based filters](screenshot/director/82_changelog/v1.11.0/82-1.11.0-01-cidr_based_filters.png)
+
+This release now officially supports PHP 8.2, addresses issues when integrating
+with the IcingaDB web module, and some dark-mode glitches. Search functionality
+has been improved, Preview Diff shows more details, editing multiple single
+Services with the very same name has been fixed, and the interactive Startup log
+renderer now wraps log lines in a nice way:
+
+![Wrap Startup Log lines](screenshot/director/82_changelog/v1.11.0/82-1.11.0-02-wrap_startup_log_lines.png)
+
+Performance has greatly been improved for those, who trigger a lot of single API
+requests, instead of relying on Import/Sync mechanism. Our template usage overview
+now also summarizes and links objects used in Services belonging to Service Sets:
+
+![Template Usage overview](screenshot/director/82_changelog/v1.11.0/82-1.11.0-03-template_usage.png)
+
+Commands can now be cloned with their field definitions, and custom variables
+from set_if flags make now part of the "suggested fields" list.
+
+In addition to major refactoring and technical improvements related to our
+configuration baskets, it's now also possible to upload additional snapshots for
+existing baskets:
+
+![Basket Snapshot upload](screenshot/director/82_changelog/v1.11.0/82-1.11.0-04-upload_basket_snapshot.png)
+
+Speaking of baskets, they have been reworked in a way giving especially Icinga
+Partners and Plugin authors more control over related objects. As UUIDs are now
+supported in Baskets too, it is for example possible to rename an object with a
+new Basket Snapshot.
+
+### Breaking Changes
+* Module and system dependencies have been raised, [Upgrading](05-Upgrading.md)
+ and [Installation](02-Installation.md) documentations contain related details
+
+### UI
+* FEATURE: allow to clone commands with fields (#2264)
+* FEATURE: Data Fields are now sorted in a case-insensitive way (#2358)
+* FEATURE: Data Field search is now case-insensitive (#2359)
+* FEATURE: Deployment Log now breaks lines (#2677)
+* FEATURE: Sort Template trees by name (#2691)
+* FEATURE: Branch and Sync diff/preview now shows related host for services (#2736)
+* FEATURE: Show more details for assign filter parsing errors (#2667)
+* FEATURE: Fields from set_if are now being proposed (#514)
+* FEATURE: Template usage table now shows Set members (#2378)
+* FIX: do not fail for (some) Service Dependencies (#2669, #1142)
+* FIX: Service Sets can now be searched by Service name in branches too (#2738)
+* FIX: Template usage table had no header (#2780)
+* FIX: Strikethrough for deactivated services in applied Service Set (#2746, #2766)
+* FIX: editing multi-selected services with the same name has been fixed (#2798, 2801, #2599)
+* FIX: Service Sets table with PostgreSQL (#2799)
+* FIX: Dark mode for some clone forms (#2670)
+
+### Icinga Configuration
+* FEATURE: render fallback template for IfW 1.11 for Icinga &lt; 2.14 (#2776)
+* FEATURE: render host templates to all non-global zones per default (#2410)
+* FEATURE: notifications can pick user(groups) from host/service vars (#462)
+* FIX: render Set Services to individual zones where required (#1589, #2356)
+* FIX: special characters like &amp; and | caused trouble in filters (#2667)
+
+### Import and Sync
+* FEATURE: regular expression based modifier allows explicit NULL on no match (#2705)
+* FEATURE: property modifiers can now be applied based on filters (#2756)
+* FEATURE: CIDR notation (network ranges) is supported in such filters (#2757)
+* FEATURE: trigger group membership resolution on group sync conditionally (#2812)
+* FIX: synchronizing Service (and -Set) Templates has been fixed (#2745, #2217)
+* FIX: null properties with Sync policy "ignore" are now being ignored (#2657)
+* FIX: Import Source shows available columns for Core API Import (#2763)
+* FIX: JSON-decode now explicitly fails for non-string inputs (#2810)
+
+### Integrations
+* FIX: don't throw an error, when editing a Service via IcingaDB link (#2533, #2563)
+
+# Configuration Baskets
+* FEATURE: it's now possible to upload snapshots for existing baskets (#1952)
+* FIX: basket now shows where to expect changes for lists from snapshots (#2791)
+* FIX: Icinga DSL parts for Commands are now restored from Baskets (#2811)
+
+### REST API
+* FIX: Commands give 204 w/o ghost changes for same properties (#2660)
+
+### Permissions and Restrictions
+* FIX: monitoring-related permission checks have been refactored (#2712)
+* FIX: Hostgroup-Filters have not been applied to Overview tables (#2775)
+* FIX: error editing Hosts with hostgroup restriction in place (#2164, #2809)
+
+### Configuration Branches
+* FEATURE: with this release, directorbranches v1.3 supports a "default branch" (#2688)
+* FEATURE: users with default branches get warnings in the main branch (#2689)
+* FIX: create a branched set, add services, modify them (#2710)
+
+### Health Check
+* FIX: complaint about overdue jobs was not correct (#2680, #2681)
+
+### Internals
+* FEATURE: support PHP 8.2 (#2777, #2792)
+* FEATURE: Unit Tests are now being triggered as GitHub workflows (no issue)
+* FIX: group membership is no longer resolved when not needed (#2048)
+* FIX: require Auth object for all object tables (#2808)
+* FIX: group membership is no longer resolved when not needed (#2048)
+
+### Fixed issues
+* You can find issues and feature requests related to this release on our
+ [roadmap](https://github.com/Icinga/icingaweb2-module-director/milestone/33?closed=1)
+
+
v1.10.2
-------
diff --git a/doc/93-Testing.md b/doc/93-Testing.md
index 7d2f8fb..7bdf4df 100644
--- a/doc/93-Testing.md
+++ b/doc/93-Testing.md
@@ -12,16 +12,12 @@ there is probably already someone running them from time to time. So, just
lean back with full trust in our development toolchain and spend your time
elsewhere ;-) Cheers!
-### Tests on Travis-CI
+### Tests on GitHub
When pushing to [GitHub](https://github.com/Icinga/icingaweb2-module-director/)
-or sending pull requests, Unit-Tests are automatically triggered on
-[Travis-CI](https://travis-ci.org/Icinga/icingaweb2-module-director):
+or sending pull requests, Unit-Tests are automatically triggered.
-[![Build Status](https://travis-ci.org/Icinga/icingaweb2-module-director.svg?branch=master)](https://travis-ci.org/Icinga/icingaweb2-module-director)
-
-We run our tests against MySQL and PostgreSQL, with PHP versions ranging from
-5.3 to 7.1, including nightly builds.
+![Build Status](https://github.com/Icinga/icingaweb2-module-director/workflows/PHP%20Tests/badge.svg?branch=master)
### Tests for supported Platforms
diff --git a/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-01-cidr_based_filters.png b/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-01-cidr_based_filters.png
new file mode 100644
index 0000000..7f612a9
--- /dev/null
+++ b/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-01-cidr_based_filters.png
Binary files differ
diff --git a/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-02-wrap_startup_log_lines.png b/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-02-wrap_startup_log_lines.png
new file mode 100644
index 0000000..35e714a
--- /dev/null
+++ b/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-02-wrap_startup_log_lines.png
Binary files differ
diff --git a/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-03-template_usage.png b/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-03-template_usage.png
new file mode 100644
index 0000000..59b1040
--- /dev/null
+++ b/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-03-template_usage.png
Binary files differ
diff --git a/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-04-upload_basket_snapshot.png b/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-04-upload_basket_snapshot.png
new file mode 100644
index 0000000..87ec640
--- /dev/null
+++ b/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-04-upload_basket_snapshot.png
Binary files differ
diff --git a/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-05-notification_user-var.png b/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-05-notification_user-var.png
new file mode 100644
index 0000000..31fa5ea
--- /dev/null
+++ b/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-05-notification_user-var.png
Binary files differ
diff --git a/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-06-notification_user-var_rendered.png b/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-06-notification_user-var_rendered.png
new file mode 100644
index 0000000..0a72cde
--- /dev/null
+++ b/doc/screenshot/director/82_changelog/v1.11.0/82-1.11.0-06-notification_user-var_rendered.png
Binary files differ