[stork-users] Stork 1.3.0 is now available

Wed May 11 18:02:38 UTC 2022

Stork 1.3.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.3.0, May 11th, 2022, Release Notes

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

**Kea Configuration Management: host reservations**. The long-term goal
is for Stork to be able to manage most aspects of Kea configuration. It
is now possible to create subnet-level or global host reservations in
one or more Kea servers, via a button on the host reservations page
[#717, #720, #729].

**Build improvements**. A substantial effort has been put into the
Rake-based build system. The Rake tasks were reorganized into several
namespaces; as a result, the Stork images are built faster, with a
smaller footprint, and the task names are much more uniform [#709]. This
substantial change also addressed several other problems. A problem with
building with premium hooks has been fixed [#684]. The deploy mechanism
(currently used internally by ISC) has been fixed [#719]. The Rake tasks
related to testing are now consistent [#436]. There is now a way (`rake
check`) to verify whether dependencies for building Stork are available
[#21, #437]. The tasks have better comments [#489]. The installation
using Rake (`rake install:server`, `rake install:agent`) has been redone
and now installs the necessary files in the default locations [#653].
The Rake task for running an agent can now optionally use a custom port
(`rake run:agent PORT=4242`) [#660].

**Restart Stork service on failure**. The systemd services are now
automatically restarted on failure [#721]. Thank you to Kevin Fleming
for the patch!

**Documentation**. The Stork ARM and log messages have been edited for
clarity and consistency [#718].

**Improved machine-dump readability**. Special characters are no longer
escaped in machine dumps, for better readability [#665].

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

## Incompatible Changes

**Different Rakefile tasks** The names of the Rake tasks used in
development automation have changed as a result of the refactorization.
Run `rake --tasks` to get the new set of tasks.

## Release Model

Stork has 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.2.0 release.

* 208 [doc] marcin

     Added "Creating Host Reservations" section in the ARM.
     (Gitlab #729)

* 207 [func] slawek

     Refactored the Rakefile responsible for running the Stork demo. The
demo
     builds faster, uses the Docker layer caching, and produces smaller
images.
     (Gitlab #709)

* 206 [bug] marcin

     Disable escaping special characters in the machine dumps. It improves
     the dumps' readability.
     (Gitlab #665)

* 205 [func] marcin

     It is now possible to create host reservations in Kea using a
     form on the host reservations page.
     (Gitlab #717, #720)

* 204 [build] kpfleming

     Enable automatic Stork services restart with systemd on failure.
     (Gitlab #721)

* 203 [doc] sgoldlust

     Editorial and grammatical corrections in docs, logs, and code
comments.
     (Gitlab #718)

* 202 [func] slawek

     Refactored the Rakefile responsible for building, installing, and
testing
     Stork. It results in changes to the usage of some rake tasks and the
     specification of their arguments.
     (Gitlab #709)

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