Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add deprecation/migration note to Databroker #762

Merged
merged 1 commit into from
Apr 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
458 changes: 233 additions & 225 deletions Cargo.lock

Large diffs are not rendered by default.

12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# This repository is deprecated

Components intended to be maintained has been moved 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)

Expand All @@ -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!*
Expand Down
6 changes: 6 additions & 0 deletions kuksa_databroker/README.md
Original file line number Diff line number Diff line change
@@ -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!*

<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<a name="readme-top"></a>

Expand Down
2 changes: 1 addition & 1 deletion kuksa_databroker/databroker-cli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

[package]
name = "databroker-cli"
version = "0.4.1"
version = "0.4.3"
authors = ["Eclipse KUKSA Project"]
edition = "2021"
license = "Apache-2.0"
Expand Down
2 changes: 2 additions & 0 deletions kuksa_databroker/databroker-cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion kuksa_databroker/databroker-proto/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

[package]
name = "databroker-proto"
version = "0.4.1"
version = "0.4.3"
authors = ["Eclipse KUKSA Project"]
edition = "2021"
license = "Apache-2.0"
Expand Down
2 changes: 1 addition & 1 deletion kuksa_databroker/databroker/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

[package]
name = "databroker"
version = "0.4.1"
version = "0.4.3"
authors = ["Eclipse KUKSA Project"]
edition = "2021"
license = "Apache-2.0"
Expand Down
2 changes: 2 additions & 0 deletions kuksa_databroker/databroker/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,8 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
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::<String>("address").unwrap().parse()?;
let port = args
Expand Down
Loading