# Stork 1.0.0, December 8th, 2021, Release Notes Welcome to Stork 1.0.0. With this release we have finished implementing our initial requirements for an effective Kea DHCP monitoring system. The changes introduced in this version are: **Service configuration dump**. Stork can now create an archive of a Kea server's configuration. This one-step action produces a bundle of configuration files, running configuration, logs, and other materials that are potentially useful for debugging [#43]. **More flexible configuration review**. The configuration-review feature can now be triggered in more ways. The review mechanism has only a few checks at the moment, but we plan to add to it in coming releases [#609]. **Security**. The database connection can now be secured using TLS [#403, #573]. The dependencies have been updated, addressing several vulnerabilities [#606]. **Bug fixes**. Pool utilization statistics are now calculated properly for IPv4 subnets [#560]. Fetching the machine state over IPv6 has been fixed; note that link-local IPv6 addresses are not supported [#447]. When removing subnets and shared networks, the Stork server properly cleans up any leftovers [#473, #533]. **Build improvements**. The kea_premium_container target now builds properly if access to Kea premium hooks is available [#618]. The agent.env has more explanatory comments [#632]. The duplicated STORK_AGENT_ADDRESS entry in agent.env has been removed [#631]. We renamed several parameters to make them more consistent: STORK_AGENT_ADDRESS is now STORK_AGENT_HOST [#641], the STORK_ENABLE_METRICS variable has been renamed to STORK_SERVER_ENABLE_METRICS, and STORK_SERVER_URL is now STORK_AGENT_SERVER_URL [#621]. We fixed a freeze in the CI system in tests [#612]. We fixed the demo deployment [#615]. **Documentation**. The Stork ARM now describes alerting using Prometheus and Grafana [#600]. The variable prefixes are now better documented and the logic behind their naming scheme is described [#633]. Many Stork ARM sections were updated and clarified [#642]. The Stork ARM now provides a section about troubleshooting agent registration [#475]. We updated the documentation on how to run Docker without needing root privileges [#602]. We fixed the Readthedocs build [#608]. Please see this link for known issues: https://gitlab.isc.org/isc-projects/stork/-/wikis/Known-issues. ## Incompatible Changes * Several variables have been renamed. The naming is now consistent and easier to predict, i.e. Stork Agent variables now start with the STORK_AGENT_ prefix, Stork Server variables now start with the STORK_SERVER_ prefix, etc. ## 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 0.22.0 release. * 180 [doc] tomek Prometheus and Grafana alerting mechanisms are described briefly. (Gitlab #600) * 179 [build] slawek Renamed Stork Agent configuration variable STORK_AGENT_ADDRESS to STORK_AGENT_HOST. This change requires modifications in the existing agent.env files. (Gitlab #641) * 178 [doc] slawek Extended the comments in the files with environment variables. Unified them with the man pages. (Gitlab #632) * 177 [bug] slawek Stork calculates properly the subnet, shared network, and global utilizations. Fixed the problem with showing more used addresses than available. (Gitlab #560) * 176 [doc] slawek Added the troubleshooting section in the documentation. It contains some hints on how to resolve the agent-related issues. (Gitlab #475) * 175 [doc] slawek Renamed STORK_ENABLE_METRICS server environment variable to STORK_SERVER_ENABLE_METRICS. (Gitlab #621) * 174 [bug] slawek Ensured that the agent registration over IPv6 works correctly excluding link-local scope. (Gitlab #447) * 173 [build] marcin Upgraded UI to use Angular and Primeng 13. (Gitlab #606) * 172 [bug] marcin Fixed a bug in the Stork server, which caused stale subnets, hosts, and shared networks after reconfiguring a monitored Kea server. (Gitlab #473) * 171 [func] slawek Dump machine configuration to file. After pressing the button in the UI, all data related to a specific machine (database entries, configurations, logs) are packed into a single tarball. Next, they can be easily shared with technical support (e.g. as an email attachment). (Gitlab #43) * 170 [func] marcin Kea configuration review can now be requested from the Kea daemon tab in the UI. In addition, the server automatically re-reviews the configurations whenever new configuration checkers are available in the new Stork releases. (Gitlab #609) * 169 [func] marcin Server database connection can be protected with TLS. (Gitlab #403) Thank you again to everyone who assisted us in making this release possible. We look forward to receiving your feedback.