/app-service-configurable

Owner: Applications WG

Primary LanguageMakefileApache License 2.0Apache-2.0

App Service Configurable

Build Status Code Coverage Go Report Card GitHub Latest Dev Tag) GitHub Latest Stable Tag) GitHub License GitHub go.mod Go version GitHub Pull Requests GitHub Contributors GitHub Committers GitHub Commit Activity

Warning
The main branch of this repository contains work-in-progress development code for the upcoming release, and is not guaranteed to be stable or working. It is only compatible with the main branch of edgex-compose which uses the Docker images built from the main branch of this repo and other repos.

The source for the latest release can be found at Releases.

App-Service-Configurable is provided as an easy way to get started with processing data flowing through EdgeX.

For latest documentation please visit https://docs.edgexfoundry.org/latest/microservices/application/services/AppServiceConfigurable/Purpose/

Build Prerequisites

Please see the edgex-go README.

Build with NATS Messaging

Currently, the NATS Messaging capability (NATS MessageBus) is opt-in at build time. This means that the published Docker image does not include the NATS messaging capability.

make build-nats - Builds local binary with NATS MessageBus support
make docker-nats - Builds local docker image with NATS MessageBus support

The locally built Docker image can then be used in place of the published Docker image in your compose file. See Compose Builder nat-bus option to generate compose file for NATS and local dev images.

Packaging

This component is packaged as docker image.

For docker, please refer to the Dockerfile and Docker Compose Builder scripts.

Versioning

Please refer to the EdgeX Foundry versioning policy for information on how EdgeX services are released and how EdgeX services are compatible with one another. Specifically, device services (and the associated SDK), application services (and the associated app functions SDK), and client tools (like the EdgeX CLI and UI) can have independent minor releases, but these services must be compatible with the latest major release of EdgeX.

Long Term Support

Please refer to the EdgeX Foundry LTS policy for information on support of EdgeX releases. The EdgeX community does not offer support on any non-LTS release outside of the latest release.