From af50da9bb51b17a10e62db03bdc7291090efda71 Mon Sep 17 00:00:00 2001 From: William Lyles <26171886+wilyle@users.noreply.github.com> Date: Tue, 6 Feb 2024 11:45:51 -0800 Subject: [PATCH] update docs --- container/README.md | 34 ++++++++++++++++----------------- freyja_apps/e2e/README.md | 2 +- freyja_apps/in_memory/README.md | 4 ---- 3 files changed, 18 insertions(+), 22 deletions(-) diff --git a/container/README.md b/container/README.md index 5eec059..56b9e58 100644 --- a/container/README.md +++ b/container/README.md @@ -17,7 +17,7 @@ These dockerfiles default to the Currently the following example applications are supported: - [In Memory Example Application](../freyja_apps/in_memory/README.md) -- [Ibeji Adapter Example Application](../freyja_apps/ibeji_adapter/README.md) +- [Freyja-Ibeji Integration Example Application](../freyja_apps/ibeji_integration/README.md) - [End to End Example Application](../freyja_apps/e2e/README.md) See [Docker Containers](#docker-containers) or [Podman Containers](#podman-containers) for @@ -65,10 +65,10 @@ Dockerfile: docker build -t -f [--build-arg=APP_NAME=] . ``` - For example, to build an image for the `ibeji-adapter` project: + For example, to build an image for the `freyja-ibeji-integration-app` project: ```shell - docker build -t ibeji_adapter -f Dockerfile.freyja_apps.amd64 --build-arg APP_NAME=freyja-ibeji-adapter-app . + docker build -t ibeji_integration -f Dockerfile.freyja_apps.amd64 --build-arg APP_NAME=freyja-ibeji-integration-app . ``` Or to build an image for the `azure digital twins cloud connector` example for aarch64: @@ -87,10 +87,10 @@ command in the project root directory: docker run --name --network=host -it --rm ``` - For example, to run the `ibeji_adapter` image built in step 1: + For example, to run the `ibeji_integration` image built in step 1: ```shell - docker run --name ibeji_adapter --network=host -it --rm ibeji_adapter + docker run --name ibeji_integration --network=host -it --rm ibeji_integration ``` >Note: A custom network is recommended when using a container for anything but testing. @@ -105,10 +105,10 @@ command in the project root directory: docker stop ``` - For example, to stop the `ibeji_adapter` container started in step 2: + For example, to stop the `ibeji_integration` container started in step 2: ```shell - docker stop ibeji_adapter + docker stop ibeji_integration ``` ### Running in Docker with overridden configuration @@ -139,10 +139,10 @@ environment variable called CONFIG_HOME to the path to the config file: docker run -v ${CONFIG_HOME}:/mnt/config --name --network=host -it --rm ``` - For example, to run the `ibeji_adapter` image with overridden configuration: + For example, to run the `ibeji_integration` image with overridden configuration: ```shell - docker run -v ${CONFIG_HOME}:/mnt/config --name ibeji_adapter --network=host -it --rm ibeji_adapter + docker run -v ${CONFIG_HOME}:/mnt/config --name ibeji_integration --network=host -it --rm ibeji_integration ``` ## Podman Containers @@ -164,10 +164,10 @@ Dockerfile: podman build -t -f [--build-arg=APP_NAME=] . ``` - For example, to build an image for the `ibeji-adapter` project: + For example, to build an image for the `freyja-ibeji-integration-app` project: ```shell - podman build -t ibeji_adapter -f Dockerfile.freyja_apps.amd64 --build-arg APP_NAME=freyja-ibeji-adapter-app . + podman build -t ibeji_integration -f Dockerfile.freyja_apps.amd64 --build-arg APP_NAME=freyja-ibeji-integration-app . ``` Or to build an image for the `azure digital twins cloud connector` example for aarch64: @@ -186,10 +186,10 @@ root directory: podman run --network=host ``` - For example, to run the `ibeji_adapter` image built in step 1: + For example, to run the `ibeji_integration` image built in step 1: ```shell - podman run --network=host ibeji_adapter + podman run --network=host ibeji_integration ``` >Note: A custom network is recommended when using a container for anything but testing. @@ -200,10 +200,10 @@ root directory: podman ps -f ancestor= --format="{{.Names}}" | xargs podman stop ``` - For example, to stop the `ibeji_adapter` container started in step 2: + For example, to stop the `ibeji_integration` container started in step 2: ```shell - podman ps -f ancestor=localhost/ibeji_adapter:latest --format="{{.Names}}" | xargs podman stop + podman ps -f ancestor=localhost/ibeji_integration:latest --format="{{.Names}}" | xargs podman stop ``` ### Running in Podman with overridden configuration @@ -234,8 +234,8 @@ environment variable called CONFIG_HOME to the path to the config file: podman run --mount=type=bind,src=${CONFIG_HOME},dst=/mnt/config,ro=true --network=host ``` - For example, to run the `ibeji_adapter` image with overridden configuration: + For example, to run the `ibeji_integration` image with overridden configuration: ```shell - podman run --mount=type=bind,src=${CONFIG_HOME},dst=/mnt/config,ro=true --network=host ibeji_adapter + podman run --mount=type=bind,src=${CONFIG_HOME},dst=/mnt/config,ro=true --network=host ibeji_integration ``` diff --git a/freyja_apps/e2e/README.md b/freyja_apps/e2e/README.md index de2ac76..7b37dd7 100644 --- a/freyja_apps/e2e/README.md +++ b/freyja_apps/e2e/README.md @@ -1,6 +1,6 @@ # End-To-End Freyja Example Application -This Freyja Example Application utilizes the [Ibeji Digital Twin Adapter](../../freyja_adapters/digital_twin/ibeji_adapter/) and the [Azure Cloud Connector Adapter](../../freyja_adapters/cloud/azure_cloud_connector_adapter/) to show a minimal end-to-end example of how to sync data from the vehicle to the cloud. +This Freyja Example Application utilizes the [Ibeji Digital Twin Adapter](https://github.com/eclipse-ibeji/freyja/tree/main/adapters/digital_twin/ibeji_adapter/) and the [Azure Cloud Connector Adapter](../../freyja_adapters/cloud/azure_cloud_connector_adapter/) to show a minimal end-to-end example of how to sync data from the vehicle to the cloud. ## Build and Run diff --git a/freyja_apps/in_memory/README.md b/freyja_apps/in_memory/README.md index e2607db..105b5d6 100644 --- a/freyja_apps/in_memory/README.md +++ b/freyja_apps/in_memory/README.md @@ -12,10 +12,6 @@ cargo run -p freyja-in-memory-app This will rebuild the `freyja-in-memory-app` application as necessary and then run it. -## Supported Versions - -This template is integrated with [revision `a07b033`](https://github.com/eclipse-ibeji/freyja/commit/a07b03349d23b14d0c215ace341e05d9e4e5195e) (authored 2023-11-09) of the Freyja main project. - ## Containerize the In Memory Freyja Example Application To build and run the application in a container, follow the steps under