[stork-users] Stork 0.15.0 is now available
Michael McNally
mcnally at isc.org
Wed Mar 3 18:45:52 UTC 2021
Stork 0.15.0 is a new development release of the Stork monitoring and
configuration dashboard and it can be downloaded from:
https://www.isc.org/download#Stork
Documentation for Stork is available at https://stork.readthedocs.io.
-----
# Stork 0.15.0, March 3rd, 2021, Release Notes
Welcome to the Stork 0.15.0 release. This is a development release of
the Stork dashboard. Due to the complexity of the major new feature (TLS
support) and Covid affecting our team, this release took much longer
than usual. Moving forward, we hope to get back on the monthly release
schedule.
The changes introduced in this version are:
* **Secure TLS connections between agents and the server**: Earlier
Stork versions didn't offer any authentication or confidentiality when
agents connected to the server. This deficiency has been addressed. The
server now offers secure communication. The authentication is mutual -
the server verifies the client and the client verifies the server. The
keys and certificates generation is automated. There are two
registration modes available, using server and client tokens. Make sure
to read the Stork ARM to understand how the agent registration works.
The TLS registration procedure is considered experimental, due to its
complexity. We'd love to get your feedback on this. This feature can be
tested in the demo setup #205, #479, #481, #483, #485, #486.
* **Friendly app names**: Names are auto-generated for each app (e.g.
`kea at hostname`) to something more human-readable (e.g. `Kea server on
floor 1`). They are unique and can be edited via dialog box #458, #477.
* **Bug fix: Event list**: Events are now up to date, no longer stale
when switching to a different tab on the machine information page #463.
* **Grafana tooltips**: Tooltips on the dashboard and on the subnets
explain what the chart icon is for #470.
Please see this link for known issues:
https://gitlab.isc.org/isc-projects/stork/-/wikis/Known-issues.
## 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.
It is available on ReadTheDocs.io at
https://stork.readthedocs.io/en/latest/, and in source form in the docs/
directory.
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.14.0 release.
```
* 133 [doc] andrei
Spell checks
(Gitlab #497)
* 132 [doc] sgoldlust
Updates to the Stork ARM.
(Gitlab #476)
* 131 [ui] tomek
Added tooltips for the Grafana links on the dashboard and
subnets view.
(Gitlab #470)
* 130 [func] marcin
Added a dialog box in the UI to rename apps.
(Gitlab #477)
* 129 [doc] godfryd, marcin
Documented secure communication channel between the Stork Server
and the agents in the ARM. The new agent installation and
registration methods were described.
(Gitlab #486)
* 128 [func] godfryd, marcin
Updated Stork demo setup to use new machines registration methods.
Machines automatically request registration using the agent token
method. Their registration can be approved in the machines view.
(Gitlab #485)
* 127 [func] godfryd, tomek, marcin
Secured agent-server channel part 3. Implemented agent deployment
using script downloaded from the server. The script installs
deb/rpm packages with stork agent. Then the script registers
current machine in the server performing key and certs
exchange. Enabled TLS to gRPC traffic between agent and server
using certs that are set up during agent registration. Added
instruction on machines page how to install an agent. Added UI for
presenting and regenerating server token.
(Gitlab #483)
* 126 [func] godfryd
This is the second part of secured agent-server channel
implementation. Added code for registering a machine in the server
and performing key and certs exchange but it is not used fully
yet. Added server-token and agent-token based agent
authorizations. Added REST API for presenting and regenerating
server token, but it is not used in UI yet. Updated content of
reference agent.env agent config file.
(Gitlab #481)
* 125 [func] marcin
Assign friendly names to the apps monitored in Stork. The apps'
names are auto-generated using the following scheme:
[app-type]@[machine-address]%[app-unique-id], e.g.,
kea at machine1.example.org%123. The [app-unique-id] is not appended
to the name of the first first app of the given type on the
particular machine. Thus, the name can be kea at machine1.example.org.
The auto-generated apps' names are presented in the Web UI instead
of the previously used app ID. The names are not yet editable by a
user.
(Gitlab #458)
* 124 [func] godfryd
The first part of secured agent-server channel implementation.
Added generating root CA and server keys and certs,
and server token generation during server startup.
(Gitlab #479)
* 123 [bug] marcin
Corrected an issue with refreshing the events list on the page
displaying the machine information. Previously, when switched
to a different tab, the events list could remain stale.
(Gitlab #463)
* 122 [func] godfryd
Migrated command line processing in agent from jessevdk/go-flags
to urfave/cli/v2. Thanks to this it is possible to define commands
in command line. Previously only switches were possible in command
line. This is a preparation for new agent command: register.
(Gitlab #468)
```
Thank you again to everyone who assisted us in making this release
possible.
We look forward to receiving your feedback.
More information about the Stork-users
mailing list