[stork-users] Stork 1.8.0 is now available

[Everett B. Fulton]

Stork 1.8.0 is a new development release of the Stork dashboard for
monitoring Kea servers.

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://www.isc.org/download#Stork

Documentation for Stork is available at:

     https://stork.readthedocs.io

-----
# Stork 1.8.0, December 07th, 2022, Release Notes

Welcome to Stork 1.8.0, another development release. The changes
introduced in this version are:

1. **Configuring client classes in host reservations**: The host
reservation form was extended with an input box to assign static client
classes to a DHCP client. A host reservation can be shared between
multiple Kea DHCP servers; typically each server receives the same set
of client classes. However, the form allows different client classes to
be specified for Kea servers sharing the host reservation [#884].

2. **Loading environment file**: Stork does not have a configuration
file per se, as it reads its configuration from environment variables.
However, most people run Stork as a service with environment vars stored
in a file, making the distinction somewhat blurry. Now you can tell
Stork to read the environment file on its own (``--use-env-file``) or
specify its non-standard location (``--env-file path-to-a-file``) [#830].

3. **Stork hooks design**: After much deliberation and countless rounds
of reviews and updates, the team decided it's time to declare the hooks
design complete. Along with the design, we now have a proof of concept
that will be turned into production-grade code in a future release
[#778].

4. **User interface improvements**: We fixed a problem with resetting
pagination while browsing the resources (subnets, shared networks,
machines, applications) pages [#881]. The presentation of Kea hook
details is now improved. By default, only the library name is presented,
rather than the full path, making it easier to read. A full path is
still available, just one click away. Also, a link is provided to the
hook's description in the Kea ARM, making it easier to learn what the
loaded hook does [#142]. To make the UI interface more consistent across
the board, we added breadcrumb navigation on the events and config
checker pages, which previously didn't have it or had it set
incorrectly. We also added UI tests to ensure that the navigation is
visible on all other pages [#511].

5. **Events**: Reloading the server using SIGHUP (e.g. by sending the
signal directly or by doing `systemctl reload`) now causes the Stork
server to record a reload event [#878].

6. **Build improvements**: We improved portability: earlier Stork
versions made assumptions regarding some tools being always located in
`/usr/bin`, which is not always the case on some systems such as FreeBSD
or OpenBSD. Now the build system uses whatever is provided in the PATH
[#821]. The Go linter has been upgraded to the latest version [#883].
Some dependencies were updated [#903].

7. **Test improvements**: We added system tests for host reservations
retrieved via the host_cmds Kea hook library [#836].

Please see this link for known issues:
https://gitlab.isc.org/isc-projects/stork/-/wikis/Known-issues.

## Incompatible Changes

None.

## Release Model

Stork has bi-monthly development releases, with some exceptions.

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

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
(ARM). It is available on ReadTheDocs.io at
https://stork.readthedocs.io/en/latest/, and in source form in [the doc/
directory](https://gitlab.isc.org/isc-projects/stork/-/tree/master/doc).

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

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
1.6.0 release.

* 260 [build] slawek

      Improved the system dependencies detection. The build system
searches now
      in PATH instead of relying on fixed paths.
      (Gitlab #821)

* 259 [func] slawek

     Upgraded Angular to version 14.2.10.
     (Gitlab #903)

* 258 [func] marcin

     Stork server emits an event when it is reloaded with the SIGHUP
signal.
     (Gitlab #878)

* 257 [func] slawek

     The configuration review checkers generate the reports even if they
find no
     issues. A user can see all checkers executed for a daemon.
     (Gitlab #816)

* 256 [func] marcin

     Client classes can be specified in the host reservation form.
     (Gitlab #884)

* 255 [func] slawek

     Extended Kea Prometheus exporter to handle counters with summarized
lease
     statistics.
     (Gitlab #839)

* 254 [func] slawek

     Added a command line switch to the Stork programs to specify that
they
     should read the environment variables from the environment files to
     configure. Previously, they could only use the environment files when
     started via systemd. By default, the environment files are located in
     /etc/stork. The new command line switch allows for reading the files
from
     a custom location.
     (Gitlab #830)

* 253 [build] slawek

     Extended system tests of host reservations.
     (Gitlab #836)

* 252 [func] slawek

     Fixed a problem resetting pagination while browsing the resources
(subnets,
     shared networks, machines, applications) pages.
     (Gitlab #881)

* 251 [func] andrei

     The Kea app page now shows the name of the hook libraries instead of
their
     entire path. Each item can be clicked to reveal the full path.
Additionally,
     a link to each hook's specific documentation is available inline.
     (Gitlab #142)

* 250 [build] slawek

     Upgraded go-related dependencies.
     (Gitlab #883)

* 249 [bug] andrei

     Added breadcrumbs to the events page.
     (Gitlab #541)

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

We look forward to receiving your feedback.

-- 
Everett B. Fulton
ISC Support