Changelog

Notable changes to this project are documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Changed

• Localenv: opendut-carl-postgres container removed, might need manual removal when updating.

Fixed

• The web-UI now shows peers and clusters sorted by name.

0.6.0

Breaking Changes

• The database backend was swapped out for a Key-Value Store.
  Before upgrading, create a backup. Then run the following on the target host within the openDuT repository:

  git fetch
  git checkout v0.6.0
  
  docker stop opendut-carl
  
  export OPENDUT_REPO_ROOT=$(git rev-parse --show-toplevel)
  docker compose --file ${OPENDUT_REPO_ROOT:-.}/.ci/deploy/localenv/docker-compose.yml --env-file ${OPENDUT_REPO_ROOT:-.}/.ci/deploy/localenv/data/secrets/.env run --env OPENDUT_CARL_POSTGRES_MIGRATION=true --env OPENDUT_CARL_IMAGE_VERSION=0.6.0 carl
  

  Then trigger a rollout as normal. If you're using the Ansible deployment, make sure to increment the version there before doing so.

  If you plan to upgrade to a future/newer version, you cannot skip upgrading to v0.6.0 as the migration code is only contained herein.

Added

• Localenv: Add environment variable OPENDUT_CARL_IMAGE_VERSION to override the CARL image in use.
• When a user deletes a peer that is still connected, the peer will be disconnected.
• CLEO now offers to await the online status of a set of peers with the await command.

Fixed

• Updating a cluster configuration does not anymore remove its deployment status.
• Fixed deleting peer group and setup key in the API for NetBird.
• THEO: The test environment is now destroyed at the end, allowing subsequent runs.

0.5.1

Added

• Backups include PKI and other credentials now
• Backups include NetBird Management database now

Fixed

• The web-UI now loads much faster when there are many peers.
• CLEO now outputs network interfaces as a list when running opendut-cleo list peers --output=json.
• Localenv deployment provisioning scripts persist PKI secrets on host now.

0.5.0

Added

• Automation of the backend and edge rollout.
• Automation of database backups.

Changed

• Major upgrade of frontend framework and clean-up of authentication flow.

Fixed

• The monitoring dashboard now shows data from all services.
• Logs from third-party libraries don't get filtered out anymore.

0.4.0

Added

• CLEO now comes with a new subcommand opendut-cleo apply. You may load cluster and peer configurations from a YAML file, similar to how resources are loaded with kubectl apply in Kubernetes. For more information, see Applying Configuration Files.

• A monitoring dashboard is now available in the deployment environment at https://monitoring.opendut.local.

Fixed

• A major upgrade of the networking libraries has been completed.
  This affects HTTP and gRPC, server- and client-side usage, as well as the OpenTelemetry monitoring.

• CARL does not anymore send duplicate Executor and Ethernet bridge name configurations to EDGAR when re-deploying a cluster.
  This may have caused EDGAR to repeatedly delete and recreate these.

0.3.1

Fixed

• Restarting EDGAR while a cluster is deployed doesn't lead to an invalid state anymore.
• CARL doesn't forget about Ethernet bridges and executors anymore, when sending the configuration to a reconnecting EDGAR.
• EDGAR Setup now loads plugins correctly.

0.3.0

Added

• CARL can now persist its state into a database.
• EDGAR Setup now has support for plugins, which can perform hardware- or use-case specific setup tasks.

Changed

• EDGAR Setup now prompts whether to overwrite a mismatched configuration, when used interactively.
• The NetBird server and client was updated to 0.28.9.

Fixed

• EDGAR Service does not require root permissions anymore, if CAN is not used.

Known Issues

• Stopping an EDGAR that has a cluster deployed, does not undeploy the cluster, therefore blocking other EDGARs in the cluster.

0.2.0

OPENDUT_CARL_NETWORK_OIDC_CLIENT_ISSUER_ADMIN_URL=https://keycloak/admin/realms/opendut/

Added

• CARL can now require clients to be authenticated.
• A download button for CLEO and EDGAR has been added in the LEA web-UI.
• LEA and CLEO show when a peer or device is already used in a cluster.
• You can now configure frequently used CAN parameters in LEA and CLEO.
• Setup-Strings can now be copied to the clipboard in LEA.

Changed

• The health of Clusters marked as deployed is now displayed as yellow in LEA.
  This is to reflect that determining the actual cluster state is not yet implemented.
• It's not anymore possible to configure deployment of a peer into two clusters.
  This was never supported to begin with, but the UIs didn't prevent it.
• Various quality-of-life improvements.

Fixed

• Generating a Setup-String now works for peers which had previously been set up.

0.1.0

Added

• Client credentials added to peer setup