Stork 0.8.0, June 10th, 2020, Release Notes

Welcome to the Stork 0.8.0 release. This is the seventh development release of the Stork project, which is a modern, responsive, and scalable dashboard for Kea with a well-defined REST API interface. The long-term goal of the project is to provide a monitoring and management solution for BIND 9 and Kea DHCP. This is the first release we believe is suitable for a broader audience.

The features and changes introduced in this version are:

1. BIND 9 Prometheus Exporter. The Stork agent now supports native statistics export from BIND 9 to Prometheus. The capabilities are modest, but now that we have the code base ready, the number of statistics exported in the near future is expected to grow. Please do let us know which statistics you would like to see in future Stork versions. #218 (closed)

2. Events. A new subsystem has been implemented that collects and distributes events and event notifications. Right now Stork is able to detect and report a number of events, such as detection of new service or a new subnet. It is not possible to subscribe to specific events yet; the main dashboard shows all events. In the near future, this mechanism will be expanded. #275 (closed)

3. Last failover time in Kea. Stork now shows the last failover time, if such an event was recorded by Stork. #308 (closed)

4. Hostnames in Host Reservations. Stork is now able to show hostnames in host reservations, if specified. #303 (closed)

5. Pure Prometheus exporter mode. The Stork agent can be told not to expect the Stork server to ever connect. This effectively turns on Prometheus exporter-only mode. #213 (closed)

6. Support for new status-get command. Kea 1.7.8 features an updated status-get command syntax. Stork 0.8 is now able to understand it. #276 (closed)

7. Bugfixes. A subnet filtering bug has been fixed and subnets are no longer shown multiple times (#245 (closed)); the Stork agent is now able to read BIND 9 configuration files with 600 permission (#273 (closed)); and the demo should now work on MacOS (#132 (closed)).

Release Model

Stork has monthly development releases on the first Wednesday of each month (with some exceptions around holidays), although we sometimes delay it a bit for last-minute changes.

We encourage users to test the development releases and report back their findings on the stork-users mailing list, available at https://lists.isc.org/mailman/listinfo/stork-users.

This text references issue numbers. For more details, visit the Stork GitLab page at https://gitlab.isc.org/isc-projects/stork/issues.

License

This version of Stork is released under the Mozilla Public License, version 2.0.

https://www.mozilla.org/en-US/MPL/2.0

Download

The easiest way to install the software is to use native deb or RPM packages. They can be downloaded from:

https://cloudsmith.io/~isc/repos/stork/

The Stork source and PGP signature for this release may be downloaded from:

https://downloads.isc.org/isc/stork

The signature was generated with the ISC code signing key which is available at:

https://www.isc.org/pgpkey

ISC provides documentation in the Stork Administrator Reference Manual. It is currently available only in the source form in the docs/ directory, and the Sphinx tool is required to build it. This is expected to change in a future release.

We ask users of this software to please let us know how it worked for you and what operating system you tested on. Feel free to share your feedback on the stork-users mailing list (https://lists.isc.org/mailman/listinfo/stork-users). We would also like to hear whether the documentation is adequate and accurate. Please open tickets in the Stork GitLab project for bugs, documentation omissions and errors, and enhancement requests. We want to hear from you even if everything worked.

Support

Professional support for Stork will become available once it reaches the 1.0 milestone. Existing ISC customers that consider themselves very early adopters may get involved in the development process, including roadmap, features planning, and early testing, but the software maturity level does not constitute a typical professional service before the 1.0 milestone.

Free best-effort support is provided by our user community via a mailing list. Information on all public email lists is available at https://www.isc.org/mailinglists/. If you have any comments or questions about working with Stork, please share them to the stork-users list (https://lists.isc.org/mailman/listinfo/stork-users). Bugs and feature requests may be submitted via GitLab at https://gitlab.isc.org/isc-projects/stork/issues.

Changes

The following summarizes changes and important upgrades since the Stork 0.7.0 release.

* 71 [bug] godfryd

    Prevent Stork Agent crashes encountered when unknown statistics
    was returned by Kea.
    (Gitlab #316)

* 70 [func] matthijs

    Implementated Bind exporter and embedded it in Stork Agent.
    It is based on bind_exporter:
    https://github.com/prometheus-community/bind_exporter
    (Gitlab #218)

* 69 [func] godfryd

    Implemented basic events mechanism. The events pertaining to
    machines, apps, daemons, subnets and other entities are displayed
    on the dashboard page. The server-sent events (SSE) mechanism is
    used by the browser to refresh the list of events.
    (Gitlab #275)

* 68 [func] marcin

    Display last failure detected by High Availability for a daemon.
    (Gitlab #308)

* 67 [func] marcin

    Hostname reservations are now fetched from Kea servers and displayed
    in the UI. It is also possible to filter hosts by hostname reservations.
    (Gitlab #303)

* 66 [bug] marcin

    Corrected a bug which caused presenting duplicated subnets when
    the subnets where filtered by text. This issue occurred when
    multiple pools belonging to a subnet were matched by the
    filtering text.
    (Gitlab #245)

* 65 [func] marcin

    Extended High Availability information is displayed for Kea
    versions 1.7.8 and later.
    (Gitlab #276)

* 64 [func] godfryd

    Changed the syntax for search expressions (`is:<flags>` and
    `not:<flag>`). E.g. `is:global` should be used instead of just
    `global`.
    (Gitlab #267)

* 63 [func] tmark

    Added --listen-prometheus-only and --listen-stork-only command line
    flags to stork-agent.
    (Gitlab #213)

Thank you again to everyone who assisted us in making this release possible.

We look forward to receiving your feedback.