The storage adapter micro service for IoT PCS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

DEPRECATED: This repository is no longer maintained. It has been moved to a new location. Please visit our new repository here. This microservice is present under services sub-module.

Build Issues Gitter

Storage Adapter Overview

This service allows management of of key-values, abstracting the storage service semantic and presenting a simple interface to store data of any format using Azure Cosmos DB.

Values are organized in collections, it is possible to work on individual values and to fetch entire collections. Complex data structures are serialized by the clients and managed as simple text payload.

The service provides a RESTful endpoint to Create-Read-Update-Delete values, where each value has a unique Id referenced also as "Key", supporting concurrency.

IDs can be provided by the client or automatically generated by the service (i.e. Guids).

Dependencies

How to use the microservice

Quickstart - Running the service with Docker

  1. Install Docker Compose: https://docs.docker.com/compose/install
  2. Create your Azure Cosmos DB account with API type SQL
  3. Find your Azure Cosmos DB account connection string. See Update your Connection Strings if you need help finding it.
  4. Store the "Azure Cosmos DB account connection string" in the env-vars-setup script, then run the script.
  5. Run the Storage Adapter service using docker compose docker-compose up
  6. Use an HTTP client such as Postman, to exercise the RESTful API to create a collection.

Running the service with Visual Studio or VS Code

The service can be started from any C# IDE and from the command line. The only difference you might notice, is how environment variables are configured. See the Configuration and Environment variables documentation below for more information.

  1. [Install .NET Core 2.x][dotnet-install]
  2. Install any recent edition of Visual Studio (Windows/MacOS) or Visual Studio Code (Windows/MacOS/Linux). a. If you already have Visual Studio installed, then ensure you have .NET Core Tools for Visual Studio 2017 installed.
  3. Create your Azure Cosmos DB account with API type SQL
  4. Open the solution in Visual Studio or VS Code
  5. Define the following environment variables. See Configuration and Environment variables for detailed information for setting these for your enviroment.
    • PCS_STORAGEADAPTER_DOCUMENTDB_CONNSTRING = {your DocumentDB connection string}
  6. Start the WebService project (e.g. press F5)
  7. Using an HTTP client like Postman, use the RESTful API to create a collection.

Running the service with IntelliJ Rider

  1. Open the solution using the pcs-storage-adapter.sln file.
  2. When the solution is loaded, go to Run -> Edit Configurations and create a new .NET Project configuration.
  3. In the configuration select the WebService project
  4. Add a new environment variable with name PCS_STORAGEADAPTER_DOCUMENTDB_CONNSTRING storing your DocumentDB connection string.
  5. Save the settings and run the configuration just created, from the IDE toolbar.
  6. You should see the service bootstrap messages in IntelliJ Run window, with details such as the URL where the web service is running, plus the service logs.
  7. Using an HTTP client like Postman, use the RESTful API to create a collection.

Project Structure

This microservice contains the following projects:

  • WebService.csproj - C# web service exposing REST interface for storage functionality
  • WebService.Test.csproj - Unit tests for web services functionality
  • Services.csproj - C# assembly containining business logic for interacting with Azure Cosmoze account with type DocumentDb
  • Services.Test.csproj - Unit tests for services functionality
  • Solution/scripts - contains build scripts, docker container creation scripts, and scripts for running the microservice from the command line

Build and Run from the command line

The scripts folder contains scripts for many frequent tasks:

  • build: compile all the projects and run the tests.
  • compile: compile all the projects.
  • run: compile the projects and run the service. This will prompt for elevated privileges in Windows to run the web service.

Updating the Docker image

The scripts folder includes a docker subfolder with the files required to package the service into a Docker image:

  • Dockerfile: docker images specifications
  • build: build a Docker container and store the image in the local registry
  • run: run the Docker container from the image stored in the local registry
  • content: a folder with files copied into the image, including the entry point script

You can also start Device Simulation and its dependencies in one simple step, using Docker Compose with the docker-compose.yml file in the project:

cd scripts/docker
docker-compose up

The Docker compose configuration requires the IoTHub and StorageAdapter web serviceURL environment variables, described previously.

Configuration and Environment variables

The service configuration is stored using ASP.NET Core configuration adapters, in appsettings.ini. The INI format allows to store values in a readable format, with comments. The application also supports inserting environment variables, such as credentials and networking details.

The configuration file in the repository references some environment variables that need to created at least once. Depending on your OS and the IDE, there are several ways to manage environment variables:

  1. If you're using Visual Studio or Visual Studio for Mac, the environment variables are loaded from the project settings. Right click on WebService, and select Options/Properties, and find the section with the list of env vars. See WebService/Properties/launchSettings.json.
  2. Visual Studio Code loads the environment variables from .vscode/launch.json
  3. When running the service with Docker or from the command line, the application will inherit environment variables values from the system.
  4. IntelliJ Rider: env. vars can be set in each Run Configuration, similarly to IntelliJ IDEA (https://www.jetbrains.com/help/idea/run-debug-configuration-application.html)

Contributing to the solution

Please follow our contribution guildelines. We love PRs too.

Troubleshooting

Feedback

Please enter issues, bugs, or suggestions as GitHub Issues here: https://github.com/Azure/pcs-storage-adapter-dotnet/issues.