From 2ce1a24dbc3cc97c165739b2cdd2776a7505cd18 Mon Sep 17 00:00:00 2001 From: Erik Jaegervall Date: Thu, 28 Mar 2024 13:09:29 +0100 Subject: [PATCH] Add deprecation/migration note to Databroker --- README.md | 12 +++++++++++- kuksa_databroker/README.md | 6 ++++++ kuksa_databroker/databroker-cli/src/main.rs | 2 ++ kuksa_databroker/databroker/src/main.rs | 2 ++ 4 files changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f37cd322..e06c2f1d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ +# This repository is deprecated + +Components intended to be maintained has been movbed to other repositories: + +| Component | New Repository | +| -------------- | ----------- | +| KUKSA Databroker | https://github.com/eclipse-kuksa/kuksa-databroker +| KUKSA Go Client | https://github.com/eclipse-kuksa/kuksa-incubation +| KUKSA Python SDK | https://github.com/eclipse-kuksa/kuksa-python-sdk + # KUKSA.VAL ![kuksa.val Logo](./doc/pictures/logo.png) @@ -20,7 +30,7 @@ KUKSA.val contains several components | Component | Description | | -------------- | ----------- | -| [KUKSA Databroker](./kuksa_databroker) | Efficient in-vehicle signal broker written in RUST providing authorized access to VSS data using gRPC +| [KUKSA Databroker](https://github.com/eclipse-kuksa/kuksa-databroker) | Efficient in-vehicle signal broker written in RUST providing authorized access to VSS data using gRPC *Note: Moved to a separate repository!* | [KUKSA Server](kuksa-val-server) | Feature rich in-vehicle data server written in C++ providing authorized access to VSS data using W3C VISS websocket protocol **Note: KUKSA Server is deprecated and will reach End-of-Life 2024-12-31!** | [KUKSA Python SDK](https://github.com/eclipse-kuksa/kuksa-python-sdk) | Command line tool to interactively explore and modify the VSS data points and data structure. Python library for easy interaction with KUKSA Databroker and Server. *Note: Moved to a separate repository!* | [KUKSA GO Client](https://github.com/eclipse-kuksa/kuksa-incubation/tree/main/kuksa_go_client) | Example client written in the [GO](https://go.dev/) programming language for easy interaction with KUKSA Databroker and Server *Note: Moved to a separate repository!* diff --git a/kuksa_databroker/README.md b/kuksa_databroker/README.md index 5f63e4a4..027c8de8 100644 --- a/kuksa_databroker/README.md +++ b/kuksa_databroker/README.md @@ -1,4 +1,10 @@ ![Rust](https://img.shields.io/badge/rust-000000.svg?style=for-the-badge&logo=rust&logoColor=white)![Docker](https://img.shields.io/badge/docker-1D63ED.svg?style=for-the-badge&logo=docker&logoColor=white) + + +**The KUKSA Databroker has been moved to a [new repository](https://github.com/eclipse-kuksa/kuksa-databroker)!** + +*Use this repository only for accessing older versions!* + diff --git a/kuksa_databroker/databroker-cli/src/main.rs b/kuksa_databroker/databroker-cli/src/main.rs index 2ac1a83f..33a9b234 100644 --- a/kuksa_databroker/databroker-cli/src/main.rs +++ b/kuksa_databroker/databroker-cli/src/main.rs @@ -20,6 +20,8 @@ mod sdv_cli; #[tokio::main] async fn main() { + println!("WARNING: Databroker has been migrated to https://github.com/eclipse-kuksa/kuksa-databroker"); + println!("Consider migrating to the new repository!"); let mut cli = cli::Cli::parse(); if cli.get_protocol() == CliAPI::SdvDatabrokerV1 { let err = sdv_cli::sdv_main(cli.clone()).await; diff --git a/kuksa_databroker/databroker/src/main.rs b/kuksa_databroker/databroker/src/main.rs index 4332dd8d..f0abcf0a 100644 --- a/kuksa_databroker/databroker/src/main.rs +++ b/kuksa_databroker/databroker/src/main.rs @@ -319,6 +319,8 @@ async fn main() -> Result<(), Box> { databroker::init_logging(); info!("Starting Kuksa Databroker {}", version); + warn!("Databroker has been migrated to https://github.com/eclipse-kuksa/kuksa-databroker"); + warn!("Consider migrating to the new repository!"); let ip_addr = args.get_one::("address").unwrap().parse()?; let port = args