Name: pcs-config-dotnet
Owner: ms-iot
Description: The configuration microservice for Azure IoT Solutions
Forked from: Azure/pcs-config-dotnet
Created: 2017-12-16 00:38:45.0
Updated: 2018-04-04 23:34:36.0
Pushed: 2018-04-12 18:18:44.0
Size: 223
Language: C#
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
This service handles communication with the Storage Adapter microservice to complete tasks.
The microservice provides a RESTful endpoint to make CRUD operations for “devicegroups”, “solution-settings”, and “user-settings”. The data will be stored by the Storage Adapter microservice.
Run scripts\env-vars-setup.cmd
on Windows or source scripts/env-vars-setup
on Mac/Linux to set up the environment variables needed to run the service locally.
In Windows you can also set these in your system.
If using envornemnt variables, this service requires the following environment variables to be set:
PCS_STORAGEADAPTER_WEBSERVICE_URL
- the url for
the Storage Adapter Webservice
used for key value storagePCS_TELEMETRY_WEBSERVICE_URL
- the url for
the Telemetry Webservice
used for key value storagePCS_DEVICESIMULATION_WEBSERVICE_URL
- the url for
the Device Simulation Webservice
used for key value storagePCS_IOTHUBMANAGER_WEBSERVICE_URL
- the url for
the IOT Hub Manager Webservice
used for key value storageYou can quickly start the Config service and its dependencies in one simple step, using Docker Compose with the docker-compose.yml file in the project:
cripts/docker
er-compose up
The Docker compose configuration requires the PCS_STORAGEADAPTER_WEBSERVICE_URL
environment variable.
The scripts folder contains scripts for many frequent tasks:
compile
: compile the projects.build
: compile the projects and run the tests.run
: compile the projects and run the service. This will prompt for
elevated privileges in Windows to run the web service.The scripts check for the environment variables setup. You can set the environment variables globally in your OS, or use the “env-vars-setup” script in the scripts folder.
The scripts
folder includes a docker subfolder with the
files required to package the service into a Docker image:
build
: build a Docker container and store the image in the local registryrun
: run the Docker container from the image stored in the local registryPlease follow our contribution guildelines and code style conventions.
Please enter issues, bugs, or suggestions as GitHub Issues here: https://github.com/Azure/pcs-config-dotnet/issues.