Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wilyle committed Feb 6, 2024
1 parent 6343337 commit af50da9
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 22 deletions.
34 changes: 17 additions & 17 deletions container/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -65,10 +65,10 @@ Dockerfile:
docker build -t <image_name> -f <Dockerfile> [--build-arg=APP_NAME=<project 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:
Expand All @@ -87,10 +87,10 @@ command in the project root directory:
docker run --name <container_name> --network=host -it --rm <image_name>
```

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.
Expand All @@ -105,10 +105,10 @@ command in the project root directory:
docker stop <container_name>
```

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
Expand Down Expand Up @@ -139,10 +139,10 @@ environment variable called CONFIG_HOME to the path to the config file:
docker run -v ${CONFIG_HOME}:/mnt/config --name <container_name> --network=host -it --rm <image_name>
```

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
Expand All @@ -164,10 +164,10 @@ Dockerfile:
podman build -t <image_name> -f <Dockerfile> [--build-arg=APP_NAME=<project 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:
Expand All @@ -186,10 +186,10 @@ root directory:
podman run --network=host <image_name>
```

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.
Expand All @@ -200,10 +200,10 @@ root directory:
podman ps -f ancestor=<image_name> --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
Expand Down Expand Up @@ -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 <image_name>
```

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
```
2 changes: 1 addition & 1 deletion freyja_apps/e2e/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 0 additions & 4 deletions freyja_apps/in_memory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit af50da9

Please sign in to comment.