diff --git a/cloud_connectors/azure/README.md b/cloud_connectors/azure/README.md index 4a97387..94132c5 100644 --- a/cloud_connectors/azure/README.md +++ b/cloud_connectors/azure/README.md @@ -16,6 +16,8 @@ The [Digital Twins Connector](./digital_twins_connector/README.md) updates an Az The deployment scripts in the `{freyja-root-dir}/cloud_connectors/azure/scripts` directory will automate the deployment of necessary Azure resources depending on which Azure Cloud Connector sample you wish to use. +>NOTE: The deployment scripts are compatible with the [`mixed` sample for Ibeji](https://github.com/eclipse-ibeji/ibeji/tree/main/samples/mixed). Modification of the Cloud Digital Twin may be required for other scenarios. + To run the deployment scripts, you will need to complete each prerequisite section specified below. Alternatively, you can create Azure resources via the Azure portal. Please see [Manual Azure Digital Twins Setup](./digital_twins_connector/README.md#manual-azure-digital-twins-setup) for the Digital Twins Connector sample, and [Manual Deployment of Azure Key Vault, Event Grid, and Azure Function App](./mqtt_connector/README.md#manual-deployment-of-azure-key-vault-event-grid-and-azure-function-app) for the MQTT Connector sample. diff --git a/freyja_apps/e2e/README.md b/freyja_apps/e2e/README.md index 37fbc19..bfe12e4 100644 --- a/freyja_apps/e2e/README.md +++ b/freyja_apps/e2e/README.md @@ -6,7 +6,7 @@ This Freyja Example Application utilizes the [Ibeji Digital Twin Adapter](../../ To build and run the application, follow these steps: -1. (Optional) If necessary, author configuration overrides for the [`InMemoryMockMappingClient`](https://github.com/eclipse-ibeji/freyja/tree/main/mapping_clients/in_memory_mock_mapping_client). Refer to the adapter README files for instructions on how to do this. This repository provides overrides in the [`.freyja`](../../.freyja/) directory that can be used with the [`mixed` sample provided by Ibeji](https://github.com/eclipse-ibeji/ibeji/tree/main/samples/mixed). +1. (Optional) If necessary, author configuration overrides for the [`InMemoryMockMappingClient`](https://github.com/eclipse-ibeji/freyja/tree/main/mapping_clients/in_memory_mock_mapping_client). Refer to the adapter README files for instructions on how to do this. This repository provides overrides for the samples listed under [Supported Samples](../ibeji_adapter/README.md#supported-samples). 1. Set the `$FREYJA_HOME` environment variable. If you are using the provided overrides, you can run the following command to set the variable: diff --git a/freyja_apps/ibeji_adapter/README.md b/freyja_apps/ibeji_adapter/README.md index 5936558..450c531 100644 --- a/freyja_apps/ibeji_adapter/README.md +++ b/freyja_apps/ibeji_adapter/README.md @@ -6,7 +6,7 @@ This Freyja Example Application utilizes the [Ibeji Digital Twin Adapter](../../ To build and run the application, follow these steps: -1. (Optional) If necessary, author configuration overrides for the [`InMemoryMockMappingClient`](https://github.com/eclipse-ibeji/freyja/tree/main/mapping_clients/in_memory_mock_mapping_client). Refer to the adapter README files for instructions on how to do this. This repository provides overrides in the [`.freyja`](../../.freyja/) directory that can be used with the [`mixed` sample`](https://github.com/eclipse-ibeji/ibeji/tree/main/samples/mixed), [`managed subscribe` sample](https://github.com/eclipse-ibeji/ibeji/tree/main/samples/managed_subscribe), and ['property' sample](https://github.com/eclipse-ibeji/ibeji/tree/main/samples/property) found in Ibeji. +1. (Optional) If necessary, author configuration overrides for the [`InMemoryMockMappingClient`](https://github.com/eclipse-ibeji/freyja/tree/main/mapping_clients/in_memory_mock_mapping_client). Refer to the adapter README files for instructions on how to do this. This repository provides overrides for the samples listed under [Supported Samples](#supported-samples). 1. Set the `$FREYJA_HOME` environment variable. If you are using the provided overrides, you can run the following command to set the variable: @@ -20,6 +20,14 @@ To build and run the application, follow these steps: This will rebuild the `freyja-ibeji-adapter-app` application as necessary and then run it. +## Supported Samples + +This repository provides overrides in the [`.freyja`](../../.freyja/) directory that support the following Ibeji samples: + +- [`managed subscribe` sample](https://github.com/eclipse-ibeji/ibeji/tree/main/samples/managed_subscribe) +- [`mixed` sample`](https://github.com/eclipse-ibeji/ibeji/tree/main/samples/mixed) +- ['property' sample](https://github.com/eclipse-ibeji/ibeji/tree/main/samples/property) + ## Containerize the Ibeji Adapter Freyja Example Application To build and run the application in a container, follow the steps under [Docker](#docker) or