Skip to content

Releases: thin-edge/thin-edge.io

1.1.1

29 May 15:30
@github-actions github-actions
1.1.1
8bd6a3a
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
1.1.1 Latest
Latest

What's Changed

All notable changes to this project will be documented in this file.

🐛 Bug Fixes

  • (mqtt) Publish mosquitto bridge status to c8y when enabled #2901 #2903

⛵ Refactor

  • (entity) Simplify entity registration code flow #2884

Full Changelog: 1.1.0...1.1.1

Assets 2

1.1.0

22 May 15:42
@github-actions github-actions
1.1.0
ea66825
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
1.1.0

What's Changed

🚀 Features

Highlights

Configure devices in offline mode #2843

Now you can configure your device even if you don't have internet connectivity. This is suitable for factory scenarios, where the devices might not have internet, but you wish to pre-configure thin-edge.io to connect to your cloud provider once internet connection is restored.

Just use the new --offline flag when connecting:

tedge connect c8y --offline
tedge connect aws --offline
tedge connect az --offline

If you're using a self-signed certificate, then you will have to upload the public certificate manually from a machine with internet connectivity (e.g. by copying it via ssh on the local network etc.).

Filter out uninteresting software packages with an exclude filter #2869

Previously thin-edge.io only supported an include filter in the apt specific software management plugin (e.g. tedge-apt-plugin). Now you can specify an include and exclude filter which will be applied to the output of all software management plugins!

This allows you to focus on the software packages that are meaningful to you, and you can save on network bandwidth.

Example

If you want to ignore all of the software packages related to libraries and Linux kernel modules, then just set the following command:

tedge config set software.plugin.exclude "^(glibc|lib|kernel-|iptables-module).*"

Restart the tedge-agent, then you're good to go!

Draft Helm chart for Kubernetes deployment #2775

A draft helm chart has been added to the project so that users can start using thin-edge.io in Kubernetes environments. Contributions are welcomed, and we'll eventually promote it from the Draft status and publish the helm chart.

Create Certificate Signing Request with tedge cli #2783

A new tedge command (tedge cert create-csr) has been added to make it easier to integrate thin-edge.io with your preferred Public Key Infrastructure (PKI). The command will read the existing certificate information from an existing device certificate so it is more convenient then looking up the equivalent openssl command.

Misc.

The following features are maybe not as flashy as the features above, but the are still very useful.

  • (cli): Avoid modifying files if they are up to date in tedge init #2876

  • (cli): Update service manager fallback message #2872

  • (configuration): tedge agent creates tedgeUrl when not provided in config snapshot payload #2826

  • (fts): improve is a directory error detection to support other OS targets #2747

  • (logs): only enable ansi colors in logs when stderr is a terminal #2738

  • (packaging): remove adduser debian dependency declaration #2883

  • (remote-access): support reading child connection string from stdin #2874

  • (software): c8y-mapper sends software list to advanced software management endpoint #2771

  • (watchdog): Limit tedge-watchdog interval to 1s minimum

  • (workflow): improve workflow log readability for humans #2860

🐛 Bug Fixes

  • (certificates): Do not panic changing ownership of device cert to unknown user #2875

  • (cli) Ignore port when comparing configure url with expected url

  • (cli): Honor c8y.mqtt setting on tedge connect #2789

  • (cli): ignore port when comparing cloud urls #2865

  • (cli): set directory ownership using given user/group instead of root #2746

  • (config|log): Uploader supports multipart/form-data and attaches filename #2811

  • (mqtt): Add tedgeUrl field for firmware command created by c8y-mapper #2795

  • (mqtt): apply delay to mqtt connect errors by default #2832

  • (mqtt): Finish auto-registration even on bad input #2737 #2889

  • (remote-access) Spawn process using current process path and config dir

  • (remote-access) Switch to env::args for establishing the executable name #2892

  • (remote-access): spawn process using current process path and config dir #2888

  • (remote-access): Use configured certificates when connecting to auth proxy in remote access plugin #2809

  • (software): tedge-agent publishes "types" for software_list and software_update #2730

  • (software|restart): Check sudo.enable in software and restart managers #2749

  • (file-watcher): use canonical path when watching a directory #2758

📜 Deprecation Notices

Workflow: build-in restart workflow action has been removed #2852

Technically this is a deprecation, however since it was only used in the official firmware integrations (e.g. Rugpi, RAUC, Mender OSS), we have replaced this functionality with the ability to call other workflows from an existing workflow.

📓 Documentation

  • (mapper): remove out of date and unused section #2736

  • (yocto): add missing build dependency file #2765

  • (mqtt): Document commands to de-register entities #2755

  • (mqtt): Correct topic and payload in registration in reference c8y-mapper guide #2827

  • (mqtt): remove retain from cmd/health/check examples #2828

  • (mqtt): Update doc: Troubleshooting > Monitoring Service Health #2855

  • (firmware): use RAUC image in the Yocto build instructions #2861

Full Changelog: 1.0.1...1.1.0

Assets 2

1.0.1

16 Feb 09:42
@github-actions github-actions
1.0.1
64def4e
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
1.0.1

What's Changed

🐛 Bug Fixes

📓 Documentation

📋 Miscellaneous Tasks

Notes

The release artifacts are no longer uploaded to the Github release as these were less useful, however you can download all of the artifacts directly from our cloudsmith.io repositories (for all the linux packages and the tarballs):

Full Changelog: 1.0.0...1.0.1

Contributors

albinsuresh, reubenmiller, and didier-wenzek
Assets 2

1.0.0 - Production grade edge device management

07 Feb 09:19
@reubenmiller reubenmiller
1.0.0
9cf6904
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
1.0.0 - Production grade edge device management

What's Changed in 1.0.0 (Summary)

🎉 thin-edge.io 1.0.0 is here 🚀

Thanks to everyone for contributing to the project, as this is the result of a lot of hard work from many people. And whilst 1.0.0 is a massive milestone in the project, we're still committed to continuing implementing new features, so stay tuned.

The documentation has been improved focussing on consistency and readability. Below are some notable links to highlight some of the features that thin-edge.io provides out of the box:

And if you don't find what you want then you can check out our the new Community Plugins page, to explore the ever growing list of plugins.

Need help upgrading to 1.0.0? Then check out the Legacy Guide.

New Features

Cumulocity - Support software types

You no longer need to prefix software versions in Cumulocity IoT using the ::<type> syntax! We now support the of official software type as defined in the Cumulocity IoT Device Library. This enables users to also filter for software types in the UI.

Check out the user docs for Software Management for more details.

Implemented by @rina23q in #2613

Cumulocity - Listen to Cumulocity Operation in their JSON format

The Cumulocity operations are now received via the c8y/devicecontrol/operations MQTT topic instead of the c8y/s/ds SmartREST topic. This lays the groundwork for a future features.

Implemented by @rina23q in #2596

New command to recreate mosquitto bridges

The mosquitto bridges are automatically recreated when upgrading thin-edge.io, and only the bridges which are configured will be recreated.

You can manually refresh the bridge configuration by running:

tedge refresh-bridges

Implemented by @Bravo555 in #2573

Restart tedge-agent after self updates

Note If you are upgrading from anything prior to 1.0.0, you will still need to restart the tedge-agent (or just restart the whole device). All future self updates of thin-edge.io will not require this step.

Implemented by @albinsuresh in #2587

Minor improvements

  • Add support for commands with multiple arguments in custom operations by @Ruadhri17 in #2602
  • Default configuration for tedge operation plugins by @albinsuresh in #2637
  • Bypass duplicate message filtering on mapper startup with config flag by @Ruadhri17 in #2632

Fixes

Documentation

What's Changed in 1.0.0 (full list)

Read more

Contributors

albinsuresh, reubenmiller, and 7 other contributors
Assets 68

1.0.0 Release Candidate 1

20 Dec 22:59
@reubenmiller reubenmiller
1.0.0-rc.1
152fc2c
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
1.0.0 Release Candidate 1

What's Changed in 1.0.0-rc.1 (Summary)

We made it 🎉 thin-edge.io 1.0.0 (Release Candidate 1) is here 🚀

We wanted to publicly communicate our commitment to bringing the production ready thin-edge.io to the community. We're using the release candidate to enable users to try it out and provide some feedback before the 1.0.0 release. We're still updating some of the documentation around some of the new features, but this will be done before the release candidate phase has ended.

You can monitor the progress of the 1.0.0 release, but the goal is to finalize the 1.0.0 release in January 2024, so please provide feedback as soon as possible.

New Features

Support for Firmware Updates - aka. Operating System A/B Updates

With the help of the workflows feature, thin-edge.io now supports integrating with OS A/B update solutions such as:

  • mender (yocto image)
  • Rugpi

We have included instructions and examples to build two types of images, however the methodology demonstrated can be used to create other integrations like:

  • Rauc
  • SWUpdate

Please reach out to use to assist in adding new integrations.

Consolidated tedge-agent

The tedge-log-plugin and tedge-configuration-plugin are now deprecated, and their functionality has been rolled into the tedge-agent. This makes it much easier to manage as you only have a single service. You can still deactivate the log or configuration functionality via the tedge.toml.

Container

A public container image is now published to the Github Container Registry (ghcr.io). The containers are ideal for running thin-edge.io under a true single-process container setup. The image contains all of the thin-edge.io binaries which can be called.

The image is a multi-platform image which supports the following Platforms/Architectures:

  • linux/arm/v6
  • linux/arm/v7
  • linux/arm64
  • linux/amd64

Two different images are available which are based on our release cycle:

  • tedge-main - Published every time a PR is closed (merged into the main branch)
  • tedge - Published on official releases (e.g. 1.0.0-rc.1)

We're still working on the documentation, however we've added the following demos under the tedge-demo-container repository for working examples on how to use it:

Support for multiple timestamp formats

Telemetry data can now be published either using the previous ISO-8601 format, or unix timestamps (e.g. seconds since 1970-01-01). The unix timestamps accepts floats, so you can also provide the fraction of a second (e.g. 1703083945.123567). Unix timestamps are much easier for machines to parse, and for user's to write their own parsers in plugins.

Below shows a simple example how to use the unix timestamp when creating an event (in the past):

tedge mqtt pub \
    te/device/main///e/example \
    '{"text":"Unix timestamps","time":1703083945.123567}'

HTTPS/TLS support

HTTPS/TLS support has been added to the File Transfer Service (included in the tedge-agent service), and the Cumulocity Auth Proxy Service (included in the tedge-mapper-c8y service). Users with certificate knowledge (e.g. how to create both server and client services)

The configuration of certificates still requires advanced certificate knowledge, as the correct server and client certificates need to be generated etc. We will look at improving the configuration story for beginners in 2024.

Minor Changes

Fixes

  • log entry erroneously set to ERROR when handling device/services registered with custom topic schema by @PradeepKiruvale in #2441
  • Stop duplicate messages being sent by tedge-log-plugin and tedge-configuration-plugin on file reload by @Bravo555 in #2454, #2536
  • Support quotes in Cumulocity failureReason field by @jarhodes314 in #2493
  • Fix broken mosquitto config generation for Azure by @jarhodes314 in #2515
  • adjust the expected return code when user is missing "Tenant manager" admin rights by @reey in #2529

What's Changed in 1.0.0-rc.1 (full list)

Read more

Contributors

albinsuresh, reubenmiller, and 9 other contributors
Assets 68

0.13.1

14 Nov 17:53
@reubenmiller reubenmiller
0.13.1
917fd6e
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
0.13.1

What's Changed in 0.13.1 (Summary)

Fixes

  • c8y: use qos 0 when publishing to c8y/s/uat to request a Cumulocity IoT token by @PradeepKiruvale in #2420
  • c8y: Fix send_event() in c8y_http_proxy to create events under child devices by @rina23q in #2421
  • c8y: custom operation option to disable quoting of results to enable c8y_RelayArray compatibility by @reubenmiller in #2439
  • general: add http.client.host/port setting options by @Bravo555 in #2411
  • troubleshooting: tedge-log-manager - wait for upload before marking operation successful by @Bravo555 in #2435

What's Changed in 0.13.1 (full list)

Full Changelog: 0.13.0...0.13.1

Contributors

albinsuresh, reubenmiller, and 5 other contributors
Assets 101

0.13.0 - New MQTT V1 API

02 Nov 23:00
@reubenmiller reubenmiller
0.13.0
49146ba
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
0.13.0 - New MQTT V1 API

What's Changed in 0.13.0 (Summary)

New Features

Support for any linux distribution

A lot of hard work has gone into supporting thin-edge.io on any linux distribution. A new revamped installation script will automatically detect your linux distribution whether it is Ubuntu/Debian, Rocky Linux, Alpine or Poky (yocto), we have you covered.

thin-edge.io now publishes packages on cloudsmith in the following formats:

  • deb (Debian/Ubuntu)
  • apk (Alpine Linux)
  • rpm (RHEL/Fedora/Rocky Linux/Alma Linux)
  • tarball (for any other linux distribution without one of the above package managers)

The documentation has been updated to included the new simplified instructions so that you can deploy thin-edge.io in a simple memorable one-liner on your preferred linux distribution.

Community support for additional service managers (e.g. for distributions without systemd)

The support for additional service managers has been extended (via the community) allowing thin-edge.io to run seamlessly on linux distributions that don't have systemd installed.

The following service managers are provided along with an easy to use install script which will auto detect the correct system manager for your system (if you don't really know or care about which service manager to use):

  • sysvinit
  • openrc
  • runit
  • s6-overlay
  • supervisord

Check out the documentation for more details.

New MQTT API te/ topics

The new thin-edge.io MQTT API has been implemented to provide a consistent interface across the entire topic.

This release marks the transition from the now deprecated tedge/# topics to the new te/# topics. The new te/# topics implement the same features as the legacy interface plus much more.

The new MQTT API documents the full interface and brings the following functionality:

  • Device/service registration via MQTT
  • Publishing telemetry data to any device, child device or service on running on either types
  • All metrics now support a custom type in the topic
  • Public interface to send commands on the local te/ topic
  • More reliable processing of commands by leveraging MQTT retained messages for state transitions
  • Support custom root prefixes (e.g. being able to replace te/ with a custom prefix)
  • Support for updating digital twin data such as custom fragments (twin)
  • thin-edge.io errors are published on the te/errors topic (replacing tedge/errors)

⚠️ Notes

Services are now registered in Cumulocity IoT under new external identities, which will result in duplicated services in the cloud. The renaming was done so that the external identities would be consistent across all entities (child devices, services etc.). If you don't want to see the older services, then you they can be deleted by using the Cumulocity API or using tools such as go-c8y-cli, for example:

c8y devices list --query "c8y_Agent.name eq 'thin-edge.io'" --includeAll \
| c8y devices services list --includeAll \
| c8y identity list --filter "externalId notlike '*:*'" \
| c8y inventory delete

If you are having trouble with removing the old services then please reach out to us and we can offer assistance!

Local Cumulocity IoT API proxy #2261, #2230

A local Cumulocity IoT API proxy is provided by default to simplify accessing the Cumulocity IoT REST api from 3rd party components which makes requesting a local JWT token a thing of the past!

Check out the documentation for more details.

Generic configuration and log plugins

The c8y-configuration-plugin and c8y-log-plugin plugins have been refactored to be cloud agnostic. The plugins now only rely on the thin-edge.io interface (both local MQTT and API).

The table below shows the package names which are deprecated and their replacements:

Deprecated Package New Package
c8y-configuration-plugin tedge-configuration-plugin
c8y-log-plugin tedge-log-plugin

Note: In the near future, the c8y-firmware-plugin will also be refactored, but it didn't make it into this release.

⚠️ Notes

Since the plugins are now cloud agnostic, the configuration files used by the plugins have been relocated to the following paths, but don't worry this happens automatically during initialization of each plugin.

  • /etc/tedge/c8y/c8y-configuration-plugin.toml ➡️ /etc/tedge/plugins/tedge-configuration-plugin.toml
  • /etc/tedge/c8y/c8y-log-plugin.toml ➡️ /etc/tedge/plugins/tedge-log-plugin.toml

Re-using thin-edge.io plugins on child device

With the changes to the thin-edge.io MQTT API and the rewriting of the generic plugins, it enabled us to be able to run the same plugins either on the main device (e.g. the current/default setup) or on a child device. This allows you to reduce the amount of could you have to write even further.

The following plugins can be run either in main or child device mode:

  • tedge-agent (software management)
  • tedge-log-plugin (log management)
  • tedge-configuration-plugin (configuration management)

Detailed documentation and examples are not yet available, however they will be updated in the next coming weeks. However below shows a brief example how to run the tedge-agent on a child device to provide software management on child devices:

tedge-agent --mqtt-device-topic-id "device/child1//"

~80% Reduction of installation size - #2295

thin-edge.io installation size has dramatically decreased from ~40MB down to 8MB by packaging the binaries as a single "multi-call" binary. This is a significant step forward to reducing the overall footprint to allow running thin-edge.io on even smaller devices.

Minor changes

  • cli: Allow log filtering with $RUST_LOG by @Bravo555 in #2130
  • cli: use tedge instead of mosquitto as owner of mosquitto files/folders by @reubenmiller in #2156
  • feat(azure): extend supported topics on Azure IoT Hub bridge by @reubenmiller in #2278
  • general: Disable lock file if directory does not exist or no permissions by @Ruadhri17 in #2190
  • general: Handle binary uploads/downloads without attempting conversion to UTF-8 by @jarhodes314 in #2319
  • general: tedge-agent creates /var/tedge/cache directory on start-up by @rina23q in #2293
  • monitoring(collectd): increase the default intervals to avoid spamming iot platforms by @reubenmiller in #2141
  • mqtt: allow non-root users to read mosquitto configuration files by @Ruadhri17 in #2269
  • mqtt: Implement a converter that bridges the old MEA (measurements, events and alarms) topics to the new ones by @PradeepKiruvale in #2125
  • troubleshooting: Add support for config-dir flag to c8y-remote-access-plugin by @Ruadhri17 in #2211
  • troubleshooting: Check if sudo is available when using tedge agent operations by @Ruadhri17 in #2224

Bug fixes

  • cli: Exit with code 0 if service manager not present by @Ruadhri17 in #2204
  • cli: Fix the wrong exit code after the cloud connection test failure by @Ruadhri17 in #2182
  • cli: tedge connect c8y --test must not use a persistent MQTT session by @didier-wenzek in #2209
  • configuration: Fix: plugins don't update their internal representation of config files on file change by @Ruadhri17 in #2262
  • installation: explicitly remove all packages to avoid problems when dependencies are changed by @reubenmiller in #2124
  • installation: remove sudo dependency from installation scripts
  • mapper(aws): tedge-mapper-aws health message uses two different timestamp formats for up and down messages by @PradeepKiruvale in #2320
  • mapper(aws): tedge-mapper-aws prints errors for known non-json mosquitto bridge health status messages by @PradeepKiruvale in #2247
  • mapper(azure): azure tedge mapper fails to translate health status messages by @PradeepKiruvale in #2273
  • mapper(c8y): Avoid subscribing to s/dcr and forwarding s/ucr by @jarhodes314 in #2173
  • mapper(c8y): Use MQTT clean session for the mosquitto c8y bridge connection by @jarhodes314 in #2171
  • mqtt: Adding missing tests for c8y-log-manager and fixing a bug that causes mqtt actor termination by @Ruadhri17 in #2161
  • mqtt: Don't log authentication configuration when connecting to MQTT broker by @Bravo555 in #2249
  • mqtt: Enable concurrent processing of incoming and outgoing MQTT messages by @jarhodes314 in #2327
  • mqtt: Fix tedge agent's mqtt actor termination when wrong payload was parsed by @Ruadhri17 in...
Read more

Contributors

albinsuresh, reubenmiller, and 9 other contributors
Assets 101

0.12.0

26 Jul 19:22
@reubenmiller reubenmiller
0.12.0
7071646
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
0.12.0

What's Changed

Features

Fixes

What's Changed in 0.12.0 (full list)

Read more

Contributors

albinsuresh, reubenmiller, and 8 other contributors
Assets 38

0.11.0

17 May 15:14
@reubenmiller reubenmiller
0.11.0
6361b2f
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
0.11.0

Release notes:

This release marks a significant milestone in thin-edges's history. The thin-edge.io components have been refactored to use an Actor model which improves the internal project structure and lays the ground work for even faster releases, with even more features in the future (and not to mention even easier to test features 💯).

Functionally, everything will work as it did before, however you may notice that the traceability of each component has improved significantly, allowing you to better reason with what is going on.

A big thanks to the core team who worked very hard over the last few months to make this happen ❤️

New features

Refactoring

  • Migrate all services to use the actor model (no breaking changes have been introduced) by Core Team (too many PRs to mention here)

Monitoring

MQTT

Telemetry

Packaging

Misc.

Bug fixes

Docs

Developer

What's Changed in 0.11.0 (full list)

Read more

Contributors

albinsuresh, reubenmiller, and 9 other contributors
Assets 38

0.10.0

27 Mar 15:45
@reubenmiller reubenmiller
0.10.0
4f23dd2
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
0.10.0

Release notes:

New features

Cloud Connectors

  • Add aws support - Samuel's version without CSR by @Bravo555 in #1723
  • Add child device support for azure (measurements) by @toewsar in #1805

Commands (CLI)

  • Output tedge config control messages to stderr by @Bravo555 in #1771

Configuration

Device Management

  • Add c8y-firmware-plugin to support Child Devices (only) by @rina23q in #1719
  • Add Cumulocity IoT remote access plugin (c8y-remote-access-plugin) by @jarhodes314 in #1694

Monitoring

MQTT

  • Add address/port config settings for crates using MQTT clients by @Bravo555 in #1789

Telemetry

Bug fixes

  • Fix issues with flock preventing to launch a daemon even if not con… by @didier-wenzek in #1740

Docs

Build

Developer

What's Changed since 0.10.0

Read more

Contributors

albinsuresh, reubenmiller, and 11 other contributors
Assets 29