Skip to content

Commit ab8f79a

Browse files
CHANGES: add gRPC migration to new 24.1 release
Signed-off-by: Bastian Krause <[email protected]>
1 parent 1a406bc commit ab8f79a

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

CHANGES.rst

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,54 @@
1+
Release 24.1 (Unreleased)
2+
-------------------------
3+
As announced
4+
`before <https://github.com/labgrid-project/labgrid/discussions/1467#discussioncomment-10314852>`_,
5+
this is the first release using gRPC instead of crossbar/autobahn for
6+
communication between client/exporter and coordinator.
7+
8+
Crossbar/autobahn are unfortunately not very well maintained anymore. The
9+
crossbar component was moved to its own virtualenv to cope with the high number
10+
of dependencies leading to conflicts. Support for Python 3.13 is still not
11+
available in a crossbar release on PyPI.
12+
13+
That's why labgrid moves to gRPC with this release. gRPC is a well maintained
14+
RPC framework with a lot of users. As a side effect, the message transfer is
15+
more performant and the import times are shorter.
16+
17+
New Features in 24.1
18+
~~~~~~~~~~~~~~~~~~~~
19+
- All components can be installed into the same virtualenv again.
20+
21+
Bug fixes in 24.1
22+
~~~~~~~~~~~~~~~~~
23+
24+
FIXME
25+
26+
Breaking changes in 24.1
27+
~~~~~~~~~~~~~~~~~~~~~~~~
28+
Maintaining support for both crossbar/autobahn as well as gRPC in labgrid would
29+
be a lot of effort due to the different architectures of those frameworks.
30+
Therefore, a hard migration to gRPC is deemed the lesser issue.
31+
32+
Due to the migration, 24.1 includes the following breaking changes:
33+
34+
- The labgrid environment config option ``crossbar_url`` was renamed to
35+
``coordinator_address``. The environment variable ``LG_CROSSBAR`` was renamed
36+
to ``LG_COORDINATOR``.
37+
- The labgrid environment config option ``crossbar_realm`` is now obsolete as
38+
well as the environment variable ``LG_CROSSBAR_REALM``.
39+
- The coordinator is available as ``labgrid-coordinator`` (instead of
40+
``crossbar start``). No additional configuration file is required.
41+
- The systemd services in ``contrib/systemd/`` were updated.
42+
43+
Other breaking changes include:
44+
45+
FIXME
46+
47+
Known issues in 24.1
48+
~~~~~~~~~~~~~~~~~~~~
49+
50+
FIXME
51+
152
Release 24.0 (Released Aug 12, 2024)
253
------------------------------------
354

0 commit comments

Comments
 (0)