Restructure Chariott repo to show the separation between intent brokering and service discovery

.github/workflows/containerize.yaml

@@ -15,9 +15,9 @@ on:
     branches:
       - main
     paths:
-      - "src/**"
-      - "proto/**"
-      - "Dockerfile"
+      - "intent_brokering/src/**"
+      - "intent_brokering/proto/**"
+      - "Dockerfile.intent_brokering"
       - ".github/workflows/containerize.yaml"
       - "rust-toolchain.toml"
 

.github/workflows/dotnet-ci.yml

@@ -8,7 +8,7 @@ on:
     branches:
       - main
     paths:
-      - 'examples/applications/dog-mode-ui/**'
+      - 'intent_brokering/examples/applications/dog-mode-ui/**'
       - '.github/workflows/dotnet-ci.yml'
 
 concurrency:
@@ -24,8 +24,8 @@ jobs:
       - uses: actions/setup-dotnet@v2
         with:
           dotnet-version: 6.0.403
-          global-json-file: examples/applications/dog-mode-ui/global.json
+          global-json-file: intent_brokering/examples/applications/dog-mode-ui/global.json
 
       - run: dotnet --info
 
-      - run: dotnet build examples/applications/dog-mode-ui
+      - run: dotnet build intent_brokering/examples/applications/dog-mode-ui

.github/workflows/e2e-ci.yml

@@ -5,14 +5,14 @@ on:
     branches:
       - main
     paths:
-      - "common/**"
-      - "ess/**"
-      - "examples/**"
-      - "keyvalue/**"
-      - "proto/**"
-      - 'proto.rs/**'
-      - "src/**"
-      - "tests/**"
+      - "intent_brokering/common/**"
+      - "intent_brokering/ess/**"
+      - "intent_brokering/examples/**"
+      - "intent_brokering/keyvalue/**"
+      - "intent_brokering/proto/**"
+      - 'intent_brokering/proto.rs/**'
+      - "intent_brokering/src/**"
+      - "intent_brokering/tests/**"
       - ".github/workflows/e2e.yaml"
       - 'Cargo.lock'
       - 'Cargo.toml'
@@ -50,14 +50,15 @@ jobs:
         uses: docker/build-push-action@v3
         with:
           context: .
+          file: ./Dockerfile.intent_brokering
           load: true
           tags: chariott:1
 
       - name: Build KV-App Container
         uses: docker/build-push-action@v3
         with:
           context: .
-          file: ./examples/applications/Dockerfile.kv-app.ci
+          file: ./intent_brokering/examples/applications/Dockerfile.kv-app.ci
           build-args: APP_NAME=kv-app
           load: true
           tags: kv-app:1

.github/workflows/ess-bench.yml

@@ -8,8 +8,8 @@ on:
     branches:
       - main
     paths:
-      - 'common/**'
-      - 'ess/**'
+      - 'intent_brokering/common/**'
+      - 'intent_brokering/ess/**'
       - '.github/workflows/ess-bench.yml'
 
 concurrency:
@@ -25,7 +25,7 @@ env:
   AUTO_PUSH: ${{ github.event_name == 'push' }}
   # Comment the performance numbers of the load tests only on PRs and if the PR
   # comes from within the Eclipse organization.
-  COMMENT_ALWAYS: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'eclipse/chariott' }}
+  COMMENT_ALWAYS: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'eclipse-chariott/chariott' }}
 
 jobs:
   benchmark:
@@ -41,7 +41,7 @@ jobs:
         run: sudo apt-get install -y protobuf-compiler
 
       - name: Run benchmark
-        run: cargo bench --manifest-path ess/Cargo.toml --bench load_bench -- --output-format bencher | tee output.txt
+        run: cargo bench --manifest-path intent_brokering/ess/Cargo.toml --bench load_bench -- --output-format bencher | tee output.txt
 
       - name: Store benchmark result
         env:

.github/workflows/lt-ci.yml

@@ -8,12 +8,12 @@ on:
     branches:
       - main
     paths:
-      - 'common/**'
-      - 'src/**'
-      - 'tests/**'
-      - 'proto/**'
-      - 'proto.rs/**'
-      - 'examples/**'
+      - 'intent_brokering/common/**'
+      - 'intent_brokering/src/**'
+      - 'intent_brokering/tests/**'
+      - 'intent_brokering/proto/**'
+      - 'intent_brokering/proto.rs/**'
+      - 'intent_brokering/examples/**'
       - '.github/workflows/lt-ci.yml'
       - 'Cargo.lock'
       - 'Cargo.toml'
@@ -32,7 +32,7 @@ env:
   AUTO_PUSH: ${{ github.event_name == 'push' }}
   # Comment the performance numbers of the load tests only on PRs and if the PR
   # comes from within the Eclipse organization.
-  COMMENT_ALWAYS: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'eclipse/chariott' }}
+  COMMENT_ALWAYS: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'eclipse-chariott/chariott' }}
 
 jobs:
   benchmark:
@@ -57,22 +57,23 @@ jobs:
         uses: docker/build-push-action@v3
         with:
           context: .
+          file: Dockerfile.intent_brokering
           load: true
           tags: chariott:1
 
       - name: Build valgrind enabled chariott container
         uses: docker/build-push-action@v3
         with:
           context: .
-          file: ./Dockerfile.valgrind
+          file: ./Dockerfile.intent_brokering.valgrind
           load: true
           tags: val-chariott:1
 
       - name: Build lt-provider-app container
         uses: docker/build-push-action@v3
         with:
           context: .
-          file: ./examples/applications/Dockerfile.lt-provider-app.ci
+          file: ./intent_brokering/examples/applications/Dockerfile.lt-provider-app.ci
           build-args: APP_NAME=lt-provider-app
           load: true
           tags: lt-provider-app:1

.github/workflows/notice-generation.yaml

@@ -20,7 +20,7 @@ jobs:
       - run: |
           git config --global user.email "[email protected]"
           git config --global user.name "Automated Notice Generation Pipeline"
-          ./tools/notice_generation.sh
+          ./notice_generation.sh
         shell: bash
         env:
           GITHUB_PAT_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/rust-ci.yml

@@ -8,14 +8,14 @@ on:
     branches:
       - main
     paths:
-      - 'common/**'
-      - 'src/**'
-      - 'tests/**'
-      - 'proto/**'
-      - 'proto.rs/**'
-      - 'ess/**'
-      - 'keyvalue/**'
-      - 'examples/**'
+      - 'intent_brokering/common/**'
+      - 'intent_brokering/src/**'
+      - 'intent_brokering/tests/**'
+      - 'intent_brokering/proto/**'
+      - 'intent_brokering/proto.rs/**'
+      - 'intent_brokering/ess/**'
+      - 'intent_brokering/keyvalue/**'
+      - 'intent_brokering/examples/**'
       - '.github/workflows/rust-ci.yml'
       - 'Cargo.lock'
       - 'Cargo.toml'

Cargo.toml

@@ -4,60 +4,32 @@
 
 [workspace]
 members = [
-    "common",
-    "ess",
-    "examples/applications/cloud-object-detection",
-    "examples/applications/dog-mode-logic",
-    "examples/applications/kv-app",
-    "examples/applications/invoke-command",
-    "examples/applications/local-object-detection",
-    "examples/applications/lt-consumer",
-    "examples/applications/lt-provider",
-    "examples/applications/mock-vas",
-    "examples/applications/simple-provider",
-    "examples/applications/simulated-camera",
-    "examples/common",
-    "keyvalue",
-    "proto.rs",
+    "intent_brokering",
+    "intent_brokering/common",
+    "intent_brokering/ess",
+    "intent_brokering/examples/applications/cloud-object-detection",
+    "intent_brokering/examples/applications/dog-mode-logic",
+    "intent_brokering/examples/applications/kv-app",
+    "intent_brokering/examples/applications/invoke-command",
+    "intent_brokering/examples/applications/local-object-detection",
+    "intent_brokering/examples/applications/lt-consumer",
+    "intent_brokering/examples/applications/lt-provider",
+    "intent_brokering/examples/applications/mock-vas",
+    "intent_brokering/examples/applications/simple-provider",
+    "intent_brokering/examples/applications/simulated-camera",
+    "intent_brokering/examples/common",
+    "intent_brokering/keyvalue",
+    "intent_brokering/proto.rs",
     "service_discovery/core",
     "service_discovery/samples/simple-discovery/consumer",
     "service_discovery/samples/simple-discovery/provider"
 ]
 
-[package]
-name = "chariott"
-version = "0.1.0"
-edition = "2021"
-license = "MIT"
-
-[[test]]
-name = "store-e2e"
-test = false
-
-[[test]]
-name = "registry-e2e"
-test = false
-
-[dependencies]
-async-recursion = "1.0"
-async-trait = { workspace = true }
-chariott-common = { workspace = true }
-chariott-proto = { workspace = true }
-prost = { workspace = true }
-prost-types = { workspace = true }
-tokio = { workspace = true, features = ["rt-multi-thread", "time"] }
-tokio-util = { workspace = true }
-tonic = { workspace = true }
-tonic-reflection = "0.10"
-tracing = { workspace = true }
-tracing-subscriber = { workspace = true }
-url = { workspace = true }
-
 [workspace.dependencies]
 anyhow = "1.0"
 async-trait = "0.1"
-chariott-common = { path = "./common/" }
-chariott-proto = { path = "./proto.rs/" }
+chariott-common = { path = "./intent_brokering/common/" }
+chariott-proto = { path = "./intent_brokering/proto.rs/" }
 futures = { version = "0.3" }
 lazy_static = "1.4.0"
 parking_lot = "0.12.1"
@@ -77,19 +49,6 @@ uuid = { version = "1.6.1", features = ["v4"] }
 url = "2.5"
 test-case = "2.2.2"
 
-[build-dependencies]
-tonic-build = { workspace = true }
-
-[dev-dependencies]
-anyhow = { workspace = true }
-async-trait = { workspace = true }
-examples-common = { path = "./examples/common" }
-futures = { workspace = true }
-tokio-util = { workspace = true }
-uuid = { workspace = true }
-tokio-stream = { workspace = true }
-test-case = { workspace = true }
-
 [profile.release]
 strip = true
 opt-level = "z"

Dockerfile → Dockerfile.intent_brokering

@@ -32,7 +32,7 @@ COPY ./ .
 
 RUN rustup target add x86_64-unknown-linux-musl
 
-RUN cargo build --release --target=x86_64-unknown-linux-musl
+RUN cargo build --release --target=x86_64-unknown-linux-musl -p chariott
 
 ####################################################################################################
 ## Final image

Dockerfile.arm64 → Dockerfile.intent_brokering.arm64

@@ -35,7 +35,7 @@ COPY ./ .
 
 RUN rustup target add aarch64-unknown-linux-musl
 
-RUN cargo build --release --target=aarch64-unknown-linux-musl
+RUN cargo build --release --target=aarch64-unknown-linux-musl -p chariott
 
 #############################################################x#######################################
 ## Final image

Dockerfile.valgrind → Dockerfile.intent_brokering.valgrind

@@ -32,7 +32,7 @@ WORKDIR /sdv
 
 COPY ./ .
 
-RUN cargo build --release
+RUN cargo build --release -p chariott
 
 #############################################################x#######################################
 ## Final image

README.md

@@ -76,7 +76,7 @@ More information can be found in the protobuf definitions in `./proto`.
 
 There is a separate document that describes the example applications and
 scenarios that are supported by Chariott. It can be found
-[here](./examples/applications/README.md).
+[here](./intent_brokering/examples/applications/README.md).
 
 ## Requirements
 
@@ -236,11 +236,11 @@ use the [grpcurl](https://github.com/fullstorydev/grpcurl) command line tool wit
 and read state. The state is stored in memory and is not persisted. It also demonstrates
 the use of the `ess` and `keyvalue` crates.
 
-This walkthrough is described in the [examples kv-app README](examples/applications/kv-app/README.md).
+This walkthrough is described in the [examples kv-app README](intent_brokering/examples/applications/kv-app/README.md).
 
 ## How to run the dog mode demo
 
-To run the dog mode demo, please refer to the [dog mode demo](./examples/applications/README.md).
+To run the dog mode demo, please refer to the [dog mode demo](./intent_brokering/examples/applications/README.md).
 
 ## Trademarks
 

buf.work.yaml

@@ -1,4 +1,4 @@
 version: v1
 directories:
-  - proto
-  - examples/applications/proto
+  - intent_brokering/proto
+  - intent_brokering/examples/applications/proto

build-all-containers.sh

@@ -18,17 +18,17 @@ if [ -z "$IMAGE_TAG" ]; then
 fi
 
 # Build base image for all example applications
-docker build --tag "chariott:base" --file ./examples/applications/Dockerfile.base .
+docker build --tag "chariott:base" --file ./intent_brokering/examples/applications/Dockerfile.base .
 
 # Build Chariott
-docker build --tag "$(concat_image_registry chariott:"$IMAGE_TAG")" --file ./examples/applications/Dockerfile.generic --build-arg APP_NAME=chariott .
+docker build --tag "$(concat_image_registry chariott:"$IMAGE_TAG")" --file ./intent_brokering/examples/applications/Dockerfile.generic --build-arg APP_NAME=chariott .
 
 # Build Examples
-docker build --tag "$(concat_image_registry cloud-object-detection-app:"$IMAGE_TAG")" --file ./examples/applications/Dockerfile.cloud-object-detection --build-arg APP_NAME=cloud-object-detection-app .
-docker build --tag "$(concat_image_registry dog-mode-logic-app:"$IMAGE_TAG")" --file ./examples/applications/Dockerfile.generic --build-arg APP_NAME=dog-mode-logic-app .
-docker build --tag "$(concat_image_registry kv-app:"$IMAGE_TAG")" --file ./examples/applications/Dockerfile.generic --build-arg APP_NAME=kv-app .
+docker build --tag "$(concat_image_registry cloud-object-detection-app:"$IMAGE_TAG")" --file ./intent_brokering/examples/applications/Dockerfile.cloud-object-detection --build-arg APP_NAME=cloud-object-detection-app .
+docker build --tag "$(concat_image_registry dog-mode-logic-app:"$IMAGE_TAG")" --file ./intent_brokering/examples/applications/Dockerfile.generic --build-arg APP_NAME=dog-mode-logic-app .
+docker build --tag "$(concat_image_registry kv-app:"$IMAGE_TAG")" --file ./intent_brokering/examples/applications/Dockerfile.generic --build-arg APP_NAME=kv-app .
 # Local object detection build is not executed as it is currently not working due to missing tensorflow libraries in the image
-# docker build --tag "$(concat_image_registry local-object-detection-app:"$IMAGE_TAG")" --file ./examples/applications/Dockerfile --build-arg APP_NAME=local-object-detection-app .
-docker build --tag "$(concat_image_registry mock-vas:"$IMAGE_TAG")" --file ./examples/applications/Dockerfile.mock-vas --build-arg APP_NAME=mock-vas .
-docker build --tag "$(concat_image_registry simulated-camera-app:"$IMAGE_TAG")" --file ./examples/applications/Dockerfile.simulated-camera --build-arg APP_NAME=simulated-camera-app .
-docker build --tag "$(concat_image_registry lt-provider-app:"$IMAGE_TAG")" --file ./examples/applications/Dockerfile.generic --build-arg APP_NAME=lt-provider-app .
+# docker build --tag "$(concat_image_registry local-object-detection-app:"$IMAGE_TAG")" --file ./intent_brokering/examples/applications/Dockerfile --build-arg APP_NAME=local-object-detection-app .
+docker build --tag "$(concat_image_registry mock-vas:"$IMAGE_TAG")" --file ./intent_brokering/examples/applications/Dockerfile.mock-vas --build-arg APP_NAME=mock-vas .
+docker build --tag "$(concat_image_registry simulated-camera-app:"$IMAGE_TAG")" --file ./intent_brokering/examples/applications/Dockerfile.simulated-camera --build-arg APP_NAME=simulated-camera-app .
+docker build --tag "$(concat_image_registry lt-provider-app:"$IMAGE_TAG")" --file ./intent_brokering/examples/applications/Dockerfile.generic --build-arg APP_NAME=lt-provider-app .