README
¶
app-service-examples
Overview
This repo contains various examples of Application Services based on the App Functions SDK. See the App Functions SDK for README for complete details on the SDK.
Build Prerequisites
Please see the edgex-go README.
Quick Start
If you want to see how all of EdgeX works - you can leverage your own Azure or Amazon AWS accounts and deploy EdgeX to the cloud.
Azure
This template leverages Azure Container Instances and will deploy a single group called "edgex-example" with 12 services deployed with 2.4 vCPUs allocated (0.2 vCPUs per service) and 6GB of RAM allocated (0.5 GB per service) with an estimated cost of $0.14904 / hour or $3.57696 / day.
1 container groups * 3600 seconds * 2.4 vCPU * $0.0000135 per vCPU-s = ~$0.11664
1 container groups * 3600 seconds * 6 GB * $0.0000015 per GB-s = $0.0324
memory($0.0324) + cpu($0.11664) = $0.14904 / hour
= $3.57696 / day
AWS
The sample stack can also be launched in AWS Fargate using the quick-create button below.
This Cloudformation template deploys twelve containers split in five Task Definitions, consuming a total of three vCPUs, six GBs of RAM and four Load Balancers. The template will require you to pass a VPC, Private and Public subnets as parameters at launch time. If you need an example on how to build a VPC, AWS provides this VPC Quick Start.
Total cost per day, before traffic, would be about $5.71464
3 vCPUs * $0.04048/hr + 6 GB * $0.004445/hr + 4 NLBs + $0.0225/hr = $0.23811/hr
Building Examples
The makefile is designed to build all/any examples under the app-services folder. Thus the makefile does not need to be updated when a new example is added to the app-services folder
run make build to build all examples.
run make app-services/<example name> to build a specific example, i.e. make app-services/simple-filter-xml
For simplicity, the executable create for each example is named app-service and placed in that examples sub-folder.
Running an Example
After building examples you simply cd to the folder for the example you want to run and run the executable for that example with or without any of the supported command line options.
The following commands will run the simple-filter-xml example
run cd app-services/simple-filter-xml
run ./app-service
Building App Service Docker Image
The simple-filter-xml example contains an example Dockerfile to demonstrate how to build a Docker Image for your Application Service.
The makefile also contains the docker target which will build the Docker Image for the simple-filter-xml example.
run make docker
Note that Application Services no longer use docker profiles. They use Environment Overrides in the docker compose file to make the necessary changes to the configuration for running in Docker. See the Environment Variable Overrides For Docker section in App Service Configurable's README for more details and an example.
Profiles
The profiles folder contains example profiles for use with App Service Configurable.
Directories