|
|
# Stork 1.0.0, December 8th, 2021, Release Notes
|
|
|
|
|
|
Welcome to Stork 1.0.0. The changes introduced in this version are:
|
|
|
Welcome to Stork 1.0.0. With this release we have finished implementing our initial requirements for an effective Kea DHCP monitoring system.
|
|
|
|
|
|
**Dump Service Configuration**. 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 potentially useful for debugging problems [#43].
|
|
|
The changes introduced in this version are:
|
|
|
|
|
|
**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].
|
|
|
**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].
|
|
|
|
|
|
**Security**. The database connection can now be secured using TLS [#403,#573]. The dependencies have been updated, addressing several vulnerabilities [#606].
|
|
|
**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].
|
|
|
|
|
|
**Bug fixes**. Pool utilization statistics are now calculated properly for IPv4 subnets [#560]. Fetching machine state over IPv6 has been fixed. Note that link-local IPv6 addresses are not supported [#447]. When removing subnets and shared networks, Stork server cleans up any leftovers properly [#473, #533].
|
|
|
**Security**. The database connection can now be secured using TLS [#403, #573]. The dependencies have been updated, addressing several vulnerabilities [#606].
|
|
|
|
|
|
**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]. Fixed a freeze in the CI system in tests [#612]. Fixed demo deployment [#615].
|
|
|
**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].
|
|
|
|
|
|
**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]. Updated documentation how to run Docker without needing root privileges [#602]. Fixed the Readthedocs build [#608].
|
|
|
**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 `STORK_AGENT_` prefix, Stork Server now start with `STORK_SERVER_` prefix etc.
|
|
|
* 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
|
|
|
|
... | ... | @@ -44,11 +46,11 @@ 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:
|
|
|
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 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).
|
|
|
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.
|
|
|
|
... | ... | |